usersservice

type Claims interface {
	Valid() error
}

type Profile interface {
	// GetName returns the profile's name
	GetName() string

	// GetRiches returns the profile's riches, counted in 1/1000th of a dollars
	// i.e, a value of 1000 would be $1
	GetRiches() int

	// GetStocks returns the profile's stocks
	GetStocks() []Stock

	// GetUserID returns the profile's ID in the system
	GetUserID() string
}

type StandardClaims struct {
	Audience  []string `json:"aud,omitempty"`
	ExpiresAt int64    `json:"exp,omitempty"`
	ID        string   `json:"jti,omitempty"`
	IssuedAt  int64    `json:"iat,omitempty"`
	Issuer    string   `json:"iss,omitempty"`
	NotBefore int64    `json:"nbf,omitempty"`
	Subject   string   `json:"sub,omitempty"`
}

type Stock interface {
	// GetQuantity returns the quantity of the stock
	GetQuantity() int

	// GetTicker returns the ticker of the stock
	GetTicker() string
}

type User interface {
	// GetAccessToken returns the user's access token
	GetAccessToken() string

	// GetIDToken returns the user's ID token
	GetIDToken() string

	// GetProfile returns the user profile
	GetProfile() Profile

	// GetRefreshToken returns the user's refresh token
	GetRefreshToken() string

	// JSON serializes the user record
	JSON() ([]byte, error)
}

type UsersService interface {
	// GetProfile retrieves a profile for a userID
	GetProfile(userID string) (Profile, error)

	// ListTopProfiles returns the top 10 profiles based
	// on current riches
	ListTopProfiles() ([]Profile, error)

	// Login exchanges the code for a user profile
	// and then upserts the user profile into persistent
	// storage
	Login(code string) (User, int, error)

	// RefreshToken exchanges the refresh token for a user profile
	// and then upserts the user profile into persistent
	// storage
	RefreshToken(refreshToken string) (User, error)

	// UpdateForBuyOrderByUserID removes riches from the user and adds
	// to the stock quantity for the given ticker. Will
	// return an error if the user cannot be found
	UpdateForBuyOrderByUserID(userID, ticker string, quantity int, price int) error

	// UpdateForSellOrderByUserID adds to the user's riches. Will
	// return an error if the user cannot be found
	UpdateForSellOrderByUserID(userID, ticker string, quantity int, amount int) error

	// UserIDForAccessToken verifies the RS256 signature
	// of a JWT access token
	UserIDForAccessToken(accessToken string) (string, error)
}

type ValidationError struct {
	Inner  error  // stores the error returned by external dependencies, i.e.: KeyFunc
	Errors uint32 // bitfield.  see ValidationError... constants
	// contains filtered or unexported fields
}