jamiely / buzzword-bingo-api

The API for the Buzzword Bingo Game

Home Page:http://jamie.ly/wordpress/programming/software/buzzy-bingo/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Intro

For use with the BuzzwordBingo application

Running

Tested with Ruby 1.9.3

bundle install
foreman start

Routes

The base url is /api/v0.1.

GET /lists

Returns an array of list names

GET /lists/:name

Returns a JSON object like:

{
  "name": "list name",
  "words": [ "word1", "word2" ]
}

Examples

curl -v localhost:5000/api/v0.1/lists

Returns

[
  "States",
  "State Capitals",
  "...",
  "Time's Top 100 Books",
  "Greek Mythology",
  "Metaphysicians"
]
curl -v localhost:5000/api/v0.1/lists/States

Returns

{
  "name": "States",
  "words": [
    "Alabama",
    "Alaska",
    "American Samoa",
    "Arizona",
    "Arkansas",
    "...",
    "Washington",
    "West Virginia",
    "Wisconsin",
    "Wyoming"
  ]
}

Troubleshooting

Problems installing event machine?

bundle config build.eventmachine \
  --with-cppflags=-I$(brew --prefix openssl)/include

About

The API for the Buzzword Bingo Game

http://jamie.ly/wordpress/programming/software/buzzy-bingo/


Languages

Language:Ruby 100.0%