Game Night: Sinatra Microservice API

Table of Contents

• What It Does
• Technology
• How to Install
• Testing
• Endpoints
• Roadmap
• Contributors
• Acknowledgments

What It Does

This is a Sinatra micro-service API app that supports GameNight (about below). This microservice communicates with the Board Game Atlas API to provide customized board game information via an API endpoint to the main back-end application for GameNight.

GameNight Description: Plan your next game night with GameNight! With this app you can add games to your shelf, get your friends to do the same, and when it is time to plan a game night, leave the planning to us. We will get all the games collated and allow your party to vote on the game(s) you want to play before the game night!

Technology

This ruby API application is built on Sinatra with support from:

• JSON:API Serializer
• Faraday
• Figaro
• and many other gems! 🤩

How to Install

To install and run this application locally:

1. To setup the repository locally, from your command line:

$ git clone [email protected]:turinggamenight/Sinatra.git
$ bundle install

2. Add your Board Game Atlas CLIENT_ID to the application.yml file created after running:

$ figaro install

3. You may need to install the shotgun gem (used for running a local server) if not already installed:

$ gem install shotgun

4. To start the Sinatra server, run:

$ shotgun

5. You may access the search API endpoint in Postman with the base URL http://localhost:9393. Success! 🎉

6. You may also use the production application using the base URL: https://turinggamenightsinatra.herokuapp.com without needing to install this application locally.

Testing

RSpec was used for the testing of this project.

To run all tests, run the command below from the root directory

$ bundle exec rspec

Endpoints

Search

This Microservice has an endpoint to search for board games by name

get '/api/v1/search'

A query param for name can be passed to return all board games matching that name from the Board Game Atlas API. Up to a maximum of 20 board games are returned.

Sample Response

Querying the endpoint GET /api/v1/search?name=clue returns the following sample data:

{
    "data": [
        {
            "id": null,
            "type": "board_game",
            "attributes": {
                "name": "Clue",
                "description": "<p>The classic detective game! In <strong>Clue</strong>, players move from room to room in a mansion to solve the mystery of: who done it, with what, and where? Players are dealt character, weapon, and location cards after the top card from each card type is secretly placed in the confidential file in the middle of the board. Players must move to a room and then make an accusation against a character saying they did it in that room with a specific weapon. The player to the left must show one of any cards accused to the accuser if in that player's hand. Through deductive reasoning each player must figure out which character, weapon, and location are in the secret file. To do this, each player must uncover what cards are in other players hands by making more and more accusations. Once a player knows what cards the other players are holding, they will know what cards are in the secret file. A great game for those who enjoy reasoning and thinking things out.</p>",
                "age_range": "8+",
                "duration": 60,
                "image": "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1559254847936-611WyTryCvL.jpg",
                "num_players": "3-6",
                "game_type": "Deduction, Family Game"
            }
        },
        {
            "id": null,
            "type": "board_game",
            "attributes": {
                "name": "13 Clues",
                "description": "<p>The city of London has been shaken by heinous crimes, and Scotland Yard is groping in the dark. 13 Clues, set at the end of the 19th century, puts players in the shoes of the detectives, each trying to solve their own mystery. Each player sees the clues - person + location + weapon - for the other players but not their own. They investigate by asking questions, by consulting the secret informant, and by making accusations in order to collect clues and rule out suspects. The goal of the game is to identify which of the 13 clues match their case before the others do!</p>",
                "age_range": "14+",
                "duration": 45,
                "image": "https://s3-us-west-1.amazonaws.com/5cc.images/games/uploaded/1540939172028",
                "num_players": "2-6",
                "game_type": ""
            }
        }
    ]
}

Roadmap

See the open issues for a list of proposed features, known issues, and project extensions.

Contributors

• Austin Aspaas - -
• Eduardo Parra - -
• Garrett Cottrell - -
• Grant Dempsey - -
• Greg Mitchell - -
• Kate Tester - -
• Philip DeFraties - -
• Shaun James - -
• Shaunda Cunningham - -
• Taylor Phillips - -

Acknowledgments

Thank you to the Board Game Atlas API for providing the board game data that this project relies on.