Potion

Potion is a custom RESTful API built with Flask.

The API exposes a “potions inventory” loosely based on Diablo II’s potions system. Based on their type, the potions stored in the inventory regenerate a character's status meters or deal damage to an enemy. There are four classes of potions: life, mana, fire, and poison.

Table of Contents

• Install
• Usage
• Tests

Install

• Clone this repository git clone https://github.com/HigitusFigitus/potion.git
• cd into the repo directory
• Build the Docker image docker build -t potion:1.0 .
• Verify that the image built correctly docker images
• Start the container docker run -p 5000:5000 -d potion:1.0
• Verify that the container is running docker ps
• Start an interactive session inside the container docker exec -it <CONTAINER ID> /bin/bash
• Seed the database with sample data python seed.py
• Exit the interactive shell exit
• Access the API by navigating to http://0.0.0.0:5000/api/v1/potions

Usage

• Every potion has a potion name, which is a string. It must be between 4 and 64 characters long and globally unique. Also, potion names can only contain alphanumeric ascii characters, underscores, and dashes, and cannot start with an underscore or dash.

• Every potion has a potion type, which is a string and must be either active or passive.

• Every potion has a potion class, which is a string and depends on its potion type. For potions of type passive, the potion type can be life or mana. For potions of type active, it can be fire or poison.

• A potion cannot be deleted. Also its name, type, and class cannot be modified.

  • Retrieve the whole list of potions:
    curl http://0.0.0.0:5000/api/v1/potions

  • Retrieve a single potion by name:
    curl http://0.0.0.0:5000/api/v1/potions/light_mana_potion

  • Filter potions by specifying a potion class or a potion type:
    curl http://0.0.0.0:5000/api/v1/potions?potion_class=fire

  • Authorized users can create potions. To do so, they must supply the potion name, potion type, and potion class.
    Authorization header must be set to admin:
    curl -X POST -H "Authorization:admin" -d '{"potion_name":"elixir", "potion_type":"passive", "potion_class":"life"}' http://0.0.0.0:5000/api/v1/potions

Tests

To run the tests: python tests.py

To get a coverage report: coverage run --source=. --omit=tests.py tests.py and then coverage report

Name             Stmts   Miss  Cover
------------------------------------
app.py              52      2    96%
seed.py              8      8     0%
validations.py      33      0   100%
------------------------------------
TOTAL               93     10    89%