• Requirements
• Setup
• API Endpoints
  • Register Game
    1. Registration Success Response
    2. Registration Error Response
  • Play the game
    1. Scoring Format
    2. Success Responses
       • Open Frame - Success Response
       • Strike - Success Response
       • Spare - Success Response
    3. Error
       • Game Not Found
       • Invalid Scoring Format
       • Game Not Found
       • Two threads attempting to score at the same time
  • Get Frame Score
    1. Success Response
    2. Error
       • Game Not Found

• Python 3.6.5
• Django framework
• Django Rest Framework

• Clone the repository.

• Install Python 3.6.5 and above. You can use your favourite tool to install the software (HomeBrew, pyenv)

• Set up virtualenv with the following command virtualenv -p `which python3` env

• Install the python packages required by the project by executing pip install -r requirements.txt.

• Run the migration scripts by executing the following commands from the home directory cd bowling_game && python manage.py migrate

• Run the command python manage.py runserver to start the server.

Registers a bowling game for the contestant and assigns a unique 16 character alpha numeric string representing a unique game id.

A response body will include:

● a status code of 201 Created

● Response Body Properties

{
    "game_id": "MYCjFlD8Rc9dzu5W",
    "created": "2018-07-19T22:05:41.647970Z"
}

A error response will be an error of error objects.

where each error object consists of the following fields

The sample response is given below:

{
    "errors": [
        {
          'error_code': 403,
          'error_message': 'Forbidden from registering a game.'
        }
    ]
}

Registers the score of the contestant for a given frame, and returns the total score in the response payload.

Response body after playing a frame is given below:

All scores in an open frame are separated by -. For example, a score of 7-2 indicates that the player knocked down 7 pins in the first attempt, and 2 pins in the second attempt.

The sample response below gives the score after an open frame.

{
    "game": "MYCjFlD8Rc9dzu5W",
    "frame": 6,
    "frame_score": 9,
    "total_score_for_frame": 105
}

The sample response below gives the score after a strike or a spare.

{
    "game": "MYCjFlD8Rc9dzu5W",
    "frame": 6,
    "frame_score": null,
    "total_score_for_frame": 105/<null> (score that has been calculated so far, or `null` if it can not be calculated until now)
}

The error response is body is an array of errors.

where each error object consists of the following fields

Some of the sample responses are given below

This will return a 404 error if no record for the game was found in the database.

{
    "errors": [
        {
          "error_code": 404,
          "error_message" : "No game was found for the game id: <game_id>."
        }
    ]
}

This will return a 404 error if no record for the game was found in the database.

{
    "errors": [
        {
          "error_code": 400,
          "error_message" : "Score format: <score> is invalid."
        }
    ]
}

This will return a 404 error if no record for the game was found in the database.

{
    "errors": [
        {
          "error_code": 400,
          "error_message" : "Game:\'<game_id>\' has already been played."
        }
    ]
}

This will return a 404 error if no record for the game was found in the database.

{
    "errors": [
        {
          "error_code": 500,
          "error_message" : "Unable to save score: '<score>' for game: '<game_id>'."
        }
    ]
}

Returns the score of the game at any given time.

The response body consists of

The sample response is given below.

{
    "total_score": 182,
    "game_id": "<game_id>"
}

The error response is body is an array of errors.

where each error object consists of the following fields

Some of the sample responses are given below

{
    "errors": [
        {
            "error_code": 404,
            "error_message": "No game was found for the game id: <game_id>."
        }
    ]
}