MeatBar

Meat Bar Consumption Analytics

Simple REST-like service for tracking and analyzing Meat Bar consumption by registered users.

Development

This project is written in Elixir. In order to build and run it, you will need to install Elixir. On Mac OS X, if you have homebrew installed, this can be done with:

brew install elixir

To load dependencies and compile the project:

mix deps.get
mix compile

To create the SQLite database and load the table definitions:

mix ecto.create
mix ecto.migrate
sqlite3 meat_bar.sqlite3 .schema

To Run Tests

Run tests from the root directory with:

mix test

This currently populates the development database, so if you wish to clean up the development version, run:

mix ecto.drop
mix ecto.migrate

Running Locally

To launch the application along with an interactive shell:

iex -S mix

This should expose endpoints such as:

curl http://127.0.0.1:8282/people

Releasing

This project is configured to use distillery to build a release.

MIX_ENV=prod mix release --env prod

This does not set up the database. In order to use the database generated by the DataImport module using the data.csv file, move the SQLite file into the release.

cp priv/static/meat_bar.sqlite3 rel/meat_bar/

The release can then be run with:

cd rel/meat_bar
./bin/meat_bar console

API

The following endpoints are supported.

GET /people

Returns a list of all registered Meat Bar consumers.

Example:

curl http://127.0.0.1:8282/people

[ "ashton", "bob", "chuck" ]

GET /consumption

Returns a list of all known Meat Bar consumption.

Example:

curl http://127.0.0.1:8282/consumption

[ { "person": "ashton", "type": "beef", "date": "2015-01-01T01:00:00.000Z" }
, { "person": "bob", "type": "lamb", "date": "2015-01-01T08:00:00.000Z" }
]

POST /consumption

Record a new Meat Bar consumption.

Example:

curl -H "Content-Type: application/json" -X POST -d '{ "person": "chuck", "meat-bar-type": "bison", "date": "2015-05-01T06:00:00.000Z" }' http://127.0.0.1:8282/consumption

GET /reports/streaks

Generate a report of all streaks of days (allowing for days off) when more and more meat bars were consumed. A streak is defined a three or more days where the total number of bars consumed increased. TODO: Confirm this definition.

Example:

curl http://127.0.0.1:8282/reports/streaks

[ [ "2015-01-01" ]
, [ "2015-01-02" ]
, [ "2015-01-03", "2015-01-06", "2015-01-07" ]
, [ "2015-01-08" ]
]

GET /reports/monthly_peaks

Generate a report of month peak consumption dates. For each month, this is the day of the month when consumption by all people was at its highest.

Example:

curl http://127.0.0.1:8282/reports/monthly_peaks

{ "2015-01":"2015-01-07"
, "2015-02":"2015-02-01"
, "2015-03":"2015-03-01"
, "2015-04":"2015-04-01"
, "2015-05":"2015-05-01"
, "2015-08":"2015-08-01"
}