1. Update the value of application in app.yaml to the app ID you have registered in the App Engine admin console and would like to use to host your instance of this sample.
2. Run the app with the devserver using dev_appserver.py DIR, and ensure it's running by visiting your local server's address (by default localhost:8080.)
3. (Optional) Generate your client library(ies) with the endpoints tool. Deploy your application.

Tic-Tac-Toe is a simple two player game. Game instructions are available here. Games can also be created to use board with size up to 100x100.

The board is represented as a 1-D list of squares with indexes as follows:
[0, 1, 2
3, 4, 5
6, 7, 8]

Indexes on bigger boards will follow the pattern. For example below is 5x5 board:

[0, 1, 2, 3, 4
5, 6, 7, 8, 9
10, 11, 12, 13, 14
15, 16, 17, 18, 19
20, 21, 22, 23, 24]

In the example we have following situation on the board:
| X | O | X
| O | X |
| O |     |

Next move is on user_x which let's say name is Mouse. He can make move to positions with following indexes: 5, 7, 8. By making his move on index 8 he will win the game. So calling make_move endpoint with user_name Mouse and move 8 will result in winning him the game.

• api.py: Contains endpoints and game playing logic.
• app.yaml: App configuration.
• cron.yaml: Cronjob configuration.
• form.py: Messages definitions.
• main.py: Handler for taskqueue handler.
• models.py: Entity definitions and their helpful functions.
• utils.py: Helper function for retrieving ndb.Models by urlsafe Key string.

• cancel_game

  • Path: 'game/{urlsafe_game_key}'
  • Method: DELETE
  • Parameters: urlsafe_game_key
  • Returns: StringMessage
  • Description: Deletes game provided with key. Game must not have finished yet.

• create_user

  • Path: 'user'
  • Method: POST
  • Parameters: user_name
  • Returns: Message confirming creation of the User.
  • Description: Creates a new User. user_name provided must be unique. Will raise a ConflictException if a User with that user_name already exists.

• new_game

  • Path: 'game'
  • Method: POST
  • Parameters: user_x, user_y, board_size
  • Returns: GameForm with initial game state.
  • Description: Creates a new Game. user_x and user_o are the names of the 'X' and 'O' player respectively. Board size represents board as board_size x board_size.

• get_game

  • Path: 'game/{urlsafe_game_key}'
  • Method: GET
  • Parameters: urlsafe_game_key
  • Returns: GameForm with current game state.
  • Description: Returns the current state of a game.

• make_move

  • Path: 'game/{urlsafe_game_key}'
  • Method: PUT
  • Parameters: urlsafe_game_key, user_name, move
  • Returns: GameForm with new game state.
  • Description: Accepts a move and returns the updated state of the game. A move is a number from 0 - max index on board depending od board size, corresponding to one of the possible positions on the board. If this causes a game to end, a corresponding Score entity will be created.

• get_scores

  • Path: 'scores'
  • Method: GET
  • Parameters: None
  • Returns: ScoreForms.
  • Description: Returns all Scores in the database (unordered).

• get_user_scores

  • Path: 'scores/user/{user_name}'
  • Method: GET
  • Parameters: user_name
  • Returns: ScoreForms.
  • Description: Returns all Scores recorded by the provided player (unordered). Will raise a NotFoundException if the User does not exist.

• get_finished_games

  • Path: 'games/finished_games'
  • Method: GET
  • Parameters: None
  • Returns: StringMessage
  • Description: Gets the number of games played from a previously cached memcache key.

• get_game_history

  • Path: 'game/{urlsafe_game_key}/history'
  • Method: GET
  • Parameters: urlsafe_game_key
  • Returns: StringMessage
  • Description: Return a Game's move history.

• get_user_games

  • Path: 'user/games'
  • Method: GET
  • Parameters: user_name, email
  • Returns: GameForms
  • Description: Return all User's active games.

• get_user_rankings

  • Path: 'user/ranking'
  • Method: GET
  • Parameters: None
  • Returns: UserForms sorted by user points.
  • Description: Return all Users ranked by their points.

• User

  • Stores unique user_name and (optional) email address.
  • Also keeps track of wins, ties and total_played.

• Game

  • Stores unique game states. Associated with User models via KeyProperties user_x and user_o.

• Score

  • Records completed games. Associated with Users model via KeyProperty as well.

• GameForm
  • Representation of a Game's state (urlsafe_key, board, user_x, user_o, game_over, winner).
• GameForms
  • Multiple GameForm container.
• NewGameForm
  • Used to create a new game (user_x, user_o)
• MakeMoveForm
  • Inbound make move form (user_name, move).
• ScoreForm
  • Representation of a completed game's Score (date, winner, loser).
• ScoreForms
  • Multiple ScoreForm container.
• UserForm
  • Representation of User. Includes winning percentage
• UserForms
  • Container for one or more UserForm.
• StringMessage
  • General purpose String container.