scores

type HighScore struct {
	// GameID is the identifier of the game that we're tracking the score for.
	GameID string `json:"gameID"`
	// PlayerName is the handle of the player who got the score. In a *real* system, this would
	// likely be a PlayerID instead, but to keep this example a bit more simple, I didn't want to
	// add a third service into the mix. But you would treat it exactly like the game service if
	// you wanted to track player data separately.
	PlayerName string `json:"playerName"`
	// Score is the numeric score that the player attained. This score may mean different things for
	// different games. For Tetris, it is the actual score, but for something like Dark Souls maybe it
	// is how many New Game + runs did you complete before dying.
	Score uint64 `json:"score"`
	// Date is the date/time that the player attained this score.
	Date time.Time `json:"date"`
}

type HighScoreList []HighScore

type HighScoresForGameRequest struct {
	// GameID is the identifier of the game that we're looking up scores for.
	GameID string `json:"gameID"`
	// HowMany limits the results to just the top N scores. (Default=5)
	HowMany int `json:"howMany"`
}

type HighScoresForGameResponse struct {
	Scores []HighScore `json:"scores"`
}

type NewHighScoreRequest struct {
	// GameID is the identifier of the game that we're tracking the score for.
	GameID string `json:"gameID"`
	// PlayerName is the handle of the player who got the score. In a *real* system, this would
	// likely be a PlayerID instead, but to keep this example a bit more simple, I didn't want to
	// add a third service into the mix. But you would treat it exactly like the game service if
	// you wanted to track player data separately.
	PlayerName string `json:"playerName"`
	// Score is the numeric score that the player attained. This score may mean different things for
	// different games. For Tetris, it is the actual score, but for something like Dark Souls maybe it
	// is how many New Game + runs did you complete before dying.
	Score uint64 `json:"score"`
}

type NewHighScoreResponse HighScore

type Repo interface {
	// Create adds a high score record to the store.
	Create(ctx context.Context, score HighScore) (HighScore, error)
	// ByGame searches for a list of all scores posted for the given game.
	ByGame(ctx context.Context, gameID string) (HighScoreList, error)
}

type ScoreService interface {
	// NewHighScore captures a player's high score for the given game.
	//
	// HTTP 201
	// POST /game/:GameID/highscore
	NewHighScore(context.Context, *NewHighScoreRequest) (*NewHighScoreResponse, error)

	// HighScoresForGame fetches the top "N" high scores achieved by any player
	// for the specified game. If you don't specify the HowMany value, this will default
	// to returning the top 5 scores.
	//
	// Frodo Notes: The request has 2 attributes. The GameID field will be populated via the
	// path parameters, but HowMany will be specified via the query string. The auto-generated
	// clients will do this by default under the hood, but if you use curl/Postman, that's how
	// you would supply that (e.g. "/v2/game/2/highscore?howMany=3" for the top 3).
	//
	// GET /game/:GameID/highscore
	HighScoresForGame(context.Context, *HighScoresForGameRequest) (*HighScoresForGameResponse, error)
}

type ScoreServiceHandler struct {
	// Games is our client to interact with the GameService.
	//
	// Frodo Notes: In cmd/main.go we'll pass "games.NewGameServiceClient()" in for this value. Both the
	// gateway and the client implement the GameService interface, so we don't actually care which
	// we are getting here. This makes it easy for you to run everything in the same process if you want
	// or distribute them across different processes/servers.
	Games games.GameService
	// Repo manages access to the underlying data store. Even when working with Frodo-powered services
	// you can still use standard Go dependency injection to get your services running.
	Repo Repo
}