Mastermind Challenge

See on github - http://github.com/adaoraul/mastermind

API cURL Test

API Methods

Authentication

Endpoint: https://axiomzen-mastermind.herokuapp.com/api/authentication.json
Method: [POST]

params:

{
  "name": "Adão Raul",
  "email": "adao.raul@gmail.com"
}

response:

{
  "name": "Adão Raul",
  "email": "adao.raul@gmail.com",
  "avatar": "https://secure.gravatar.com/avatar/a89f0cdd5105a822fdd7b5ea17c1c36a.png?r=PG",
  "api_key": "Acyg0rNS5ATBE6AktSUE1wtt"
}

Game

List

Endpoint: https://axiomzen-mastermind.herokuapp.com/api/games.json
Method: [GET]

header:

Authorization Token token=$api_key

response:

{
  "list": [
    {
      "codemaker": {
        "name": "Adão Raul"
      },
      "hashed_id": "356a192b7913b04c54574d18c28d46e6395428ab",
      "played": true
    }
  ]
}

Create

Endpoint: https://axiomzen-mastermind.herokuapp.com/api/games.json
Method: [POST]

header:

Authorization Token token=$api_key

params:

{
  "colors": ["R","P","Y","G","O","G","O","P"]
}

response:

{
  "hashed_id": "356a192b7913b04c54574d18c28d46e6395428ab"
}

Show

Endpoint: https://axiomzen-mastermind.herokuapp.com/api/games/:id.json
Method: [GET]

header:

Authorization Token token=$api_key

response:

{
  "status": true,
  "codemaker": {
    "name": "André Souza",
  },
  "codebreaker": {
    "name": "Adão Raul",
  },
  "colors": ["R","P","Y","G","O","G","O","P"],
  "solved": true,
  "time_taken": 64.75358,
  "turns": [
    {
      "guess": ["R","P","Y","G","O","G","O","P"],
      "exact": 3,
      "near": 2
    },
    {
      "guess": ["R","P","Y","G","O","G","O","P"],
      "exact": 2,
      "near": 1
    },
    {
      "guess": ["R","P","Y","G","O","G","O","P"],
      "exact": 3,
      "near": 2
    }
  ]
}

Play

Endpoint: https://axiomzen-mastermind.herokuapp.com/games/:game_id/play.json
Method: [GET]

header:

Authorization Token token=$api_key

response:

{
  "hashed_id": "356a192b7913b04c54574d18c28d46e6395428ab",
  "time_left": 299.980998
}

Guess

Endpoint: https://axiomzen-mastermind.herokuapp.com/api/games/:game_id/guess.json
Method: [POST]

header:

Authorization Token token=$api_key

params:

{
  "colors": ["R","P","Y","G","O","G","O","P"]
}

response:

{
  "status": true,
  "exact": 3,
  "near": 2,
  "solved": false,
  "turns": 1,
  "time_limit": 256
}

Running Locally

Make sure you have Ruby and the Heroku Toolbelt installed.

$ git clone git@github.com:adaoraul/axiomzen-mastermind.git # or clone your own fork
$ cd axiomzen-mastermind
$ bundle install
$ rake db:create db:migrate
$ foreman start

Your app should now be running on localhost:5000.

Deploying to Heroku

$ heroku create
$ git push heroku master
$ heroku open