perryao/players-api-skeleton

players-api-skeleton

Instructions

Welcome to an Alchemy Engineering candidate assignment!

To complete this assignment, you will create the API to power the below conditions. Imagine, if you will, a web front end that allows admins to create users, who can then create ping pong players. Your job, should you choose to accept it, is to create an application to cover all of the use cases detailed in the documentation.

As you can see, you'd be better suited to use node to complete this task. If you choose not to, however, the tests in the test directory must still pass.

TL;DR:

1. Refer to the documentation below
2. Build the API
3. Ensure all tests are passing
4. Send us your code
5. Win

Tests

Tests currently require a running postgres instance. To run tests locally, first execute

docker-compose up -d postgres

and then

npm test

To run tests in a single command, execute

npm run test-compose

This will launch a postgres container and a nodejs container to run the tests in. Requires docker-compose

User API

Part of the player-api is managing admin users who are then able to manage players. A user can only interact with players they have created themselves.

A user consists of the following information:

{
  "id": "<number>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>"
}

Create User

Create a new admin user. Each use must have a unique email address.

POST /api/user

Arguments

Field	Type	Description
first_name	string	User first name
last_name	string	User last name
email	string	User email address
password	string	User password
confirm_password	string	User password confirmation

Response

Field	Type	Description
success	boolean	Success indicator
user	object	User details
token	string	JWT token

Example

curl -XPOST \
  -H 'Content-Type: application/json' \
  -d '{"first_name": "Jim", "last_name": "Bob", "email": "jim@bob.com", "password": "foobar", "confirm_password": "foobar"}' \
  http://localhost:3000/api/user

User Login

Login an admin user.

POST /api/login

Arguments

Field	Type	Description
email	string	User email address
password	string	User password

Response

Field	Type	Description
success	boolean	Success indicator
user	object	User details
token	string	JWT token

Example

curl -XPOST \
  -H 'Content-Type: application/json' \
  -d '{"email": "jim@bob.com", "password": "foobar"}' \
  http://localhost:3000/api/login

Player API

Players are managed by users, which are identified by a JWT.

Players consist of the following information:

{
  "first_name": "<string>",
  "last_name": "<string>",
  "rating": "<number",
  "handedness": "left|right"
}

List Players

List all current players in the system. Players are scoped to the current user.

GET /api/players

Headers

Name	Description
Authorization	JWT passed in bearer format

Response

Field	Type	Description
success	boolean	Success indicator
players	array	List of players

Example

curl -XGET \
  -H 'Authorization: Bearer <my_jwt_token>' \
  http://localhost:3000/api/players

Create Player

Create new player in the system. Players must have unique first name / last name combinations.

POST /api/players

Headers

Name	Description
Authorization	JWT passed in bearer format

Arguments

Field	Type	Description
first_name	string	Player first name
last_name	string	Player last name
rating	string	Player rating
handedness	enum	Player handedness (left or right)

Response

Field	Type	Description
success	boolean	Success indicator
player	object	Player information

Example

curl -XPOST \
  -H 'Authorization: Bearer <my_jwt_token>' \
  -H 'Content-Type: application/json' \
  -d '{"first_name": "Ma", "last_name": "Long", "rating": 9000, "handedness": "right"}' \
  http://localhost:3000/api/players

Delete players

Delete player from the system.

DELETE /api/players/:id

Headers

Name	Description
Authorization	JWT passed in bearer format

Parameters

Name	Description
id	Player identifier

Response

Field	Type	Description
success	boolean	Success indicator

Example

curl -XDELETE \
  -H 'Authorization: Bearer <my_jwt_token>' \
  http://localhost:3000/api/players/1