Installation

Local

git clone https://github.com/falconhoof/Game-Jam-2012-Server
cd Game-Jam-2012-Server
gem install bundler
bundle install
export DATABASE_URL=mysql://[USERNAME]:[PASSWORD]@[HOSTNAME]/[DATABASE]

Heroku

heroku create [APPLICATION NAME]
heroku config:add DATABASE_URL=mysql://[USERNAME]:[PASSWORD]@[HOSTNAME]/[DATABASE]
git push heroku master

Usage

API Client

GET requests

Is the API up?

curl falconhoof.heroku.com/api/v1/

{"message":"Up (yer maw)"}

Get the top 20 high scores

curl falconhoof.heroku.com/api/v1/scores

[
    {
        "username": "davidfarrell",
        "score": 337
    },
    {
        "username": "leereilly",
        "score": 120
    },
    {
        "username": "leereilly",
        "score": 110
    },
    {
        "username": "leereilly",
        "score": 100
    }
]

Get the highest score for a particular user (not implemented)

curl falconhoof.heroku.com/api/v1/scores/:user

Get the global game stats

curl falconhoof.heroku.com/api/v1/stats

[
    {
        "key": "explosions",
        "val": 2
    },
    {
        "key": "deaths",
        "val": 37
    },
    {
        "key": "fucks_given",
        "val": 99
    }
]

Get the stats recorded for a particular user (not implemented)

curl falconhoof.heroku.com/api/v1/stats/:user

POST requests

Submit a report

http://falconhood.heroku.com/api/v1/report

Takes the following parameters:

• levelId
• username (optional)
• email (optional)
• score (optional)
• explosions
• platforms
• spawn_points
• trees
• pickups

NOTE: Every other key/value pair provided is expected to be a recorded stat. E.g. the following request does the following:

1. Records a new high score for the player of 10
2. Increments the players total number of explosions by 4, deaths by 5 and trees by 4.
3. Also, increments the total/global number of explosions by 4, deaths by 5 and trees by 4.
4. Returns player and global stats for client-side processing.

Example request:

curl -d "username=leereilly&email=lee@leereilly.net&score=10&explosions=4&deaths=5&trees=4" http://falconhood.heroku.com/api/v1/report
curl -d "levelId=1&explosions=1&platforms=2&spawn_points=3&trees=4&pickups=5" http://falconhood.heroku.com/api/v1/report

Example response:

[
    {
        "player": [
            {
                "key": "trees",
                "val": 8
            },
            {
                "key": "deaths",
                "val": 10
            },
            {
                "key": "explosions",
                "val": 8
            }
        ]
    },
    {
        "global": [
            {
                "key": "explosions",
                "val": 20
            },
            {
                "key": "deaths",
                "val": 222
            },
            {
                "key": "trees",
                "val": 8
            },
        ]
    }
]

Report a new high score

falconhoof.heroku.com/api/v1/scores

Takes the following parameters:

• username
• email (optional)
• score

Example request:

curl -d "username=leereilly&email=lee@leereilly.net&score=100" http://falconhoof.heroku.com/api/v1/scores

Example response:

[{"id":25,"user":"leereilly1234","score":100}]

Report new game stats

falconhoof.heroku.com/api/v1/stats

Example request:

curl -d "explosions=2&deaths=37&fucks_given=99" http://falconhoof.heroku.com/api/v1/stats/

Takes the following parameters:

• all of things (literally)
  • falconhoof.heroku.com/api/v1/stats/explosions=37&death=42&[some_stat]=[some_integer_to_INCREMENT_a_counter]

Example response:

[
    {
        "key": "explosions",
        "val": 2
    },
    {
        "key": "deaths",
        "val": 37
    },
    {
        "key": "fucks_given",
        "val": 99
    }
]

Web Client

• http://falconhoof.heroku.com
• http://falconhoof.heroku.com/statistics
• http://falconhoof.heroku.com/high-scores

Notes

Create a user

curl -d "username=leereilly&email=lee@leereilly.net" http://falconhoof.heroku.com/api/v1/users

Create a user high score

curl -d "username=leereilly&email=lee@leereilly.net&score=100" http://falconhoof.heroku.com/api/v1/scores

Create some users stats

curl -d "username=leereilly&email=lee@leereilly.net&dicks=37" http://falconhoof.heroku.com/api/v1/users/stats

Create some stats

curl -d "explosions=2&deaths=37&fucks_given=99" http://falconhoof.heroku.com/api/v1/stats/

LIMITATIONS

GLOBAL STATISTICS

• Support for integer values stats only right now. When you report a stat name for the first time, it is created and the counter is set to the value provided. Subsequent calls to the named stat increments the counter value by the value provided.

MISC

• No security built around the API
• Database hosted outside Heroku on a shared Dreamhost server <- single point of failure