zssn v1.0.0

zssn-api

This describes the resources that make up the REST API for ZSSN (Zombie Survival Social Network).

The diagram below shows the architecture of the implementation, which is based on MVC patterns and HTTP request message routing.

The code style follows this JavaScript Style Guide, which uses the ESLint rules for JavaScript. The code organization and configuration also tries to follow the Node.js best practices list.

Table of Contents

• Installation
• Usage
• API
  • List survivors
  • Add survivor
  • Update a survivor location
  • Flag survivor as infected
  • Percentage of infected survivors
  • Percentage of non-infected survivors
  • Points lost because of infected survivor
• Testing
• Contributing
• License

Installation

Dependencies

• Node.js
• MongoDB

When the dependencies are up and running, install zssn-api via its npm package:

npm install zssn-api

Usage

To start the server, run:

npm start

API

List survivors

List all the survivors.

GET /api/survivors

Request

GET https://zssn.azurewebsites.net/api/survivors

Response

If successful, this method returns a response body with the following structure:

{
    "infected": boolean,
    "_id": string,
    "name": string,
    "age": number,
    "sex": string,
    "reportMessages": array,
    "totalInfections": number,
    "inventory": {
        "water": number,
        "food": number,
        "medication": number,
        "ammunition": number
    },
    "location": {
        "latitude": number,
        "longitude": number
    }
}

Add a survivor

Creates a new survivor.

POST /api/survivors

Request

POST https://zssn.azurewebsites.net/api/survivors

Supply a new survivor, with the following properties:

Response

If successful, this method returns a response body with the following structure:

{
    "_id": string,
    "name": string,
    "age": number,
    "sex": string,
    "infected": boolean,
    "inventory": {
        "water": number,
        "food": number,
        "medication": number,
        "ammunition": number
    },
    "location": {
        "latitude": number,
        "longitude": number
    }
}

Update a survivor location

Update a survivor's location with new latitudes and longitudes.

PATCH /api/survivors/location/:id

Request

PATCH https://zssn.azurewebsites.net/api/survivors/location/:id

Supply the new latitude and the new longitude, according to the rules of patch semantics, with the following properties:

Response

If successful, this method returns a response body with the following structure:

{
    "location": {
        "latitude": number,
        "longitude": number
    }
}

Flag survivor as infected

Flag a survivor as infected. A survivor is marked as infected when at least three other survivors report their contamination.

POST /api/survivors/:id/report

Request

POST https://zssn.azurewebsites.net/api/survivors/:id/report

The following report message is optional:

Response

If successful, this method returns a response body with the following structure:

{
    "message": "Survivor successfully reported as infected!"
}

Trade items

Exchange items between two survivors. Infected survivors can't trade items among themselves.

Survivors must respect the price table below, where the value of an item is described in terms of points. Both sides of the trade should offer the same amount of points. For example, 1 Water and 1 Medication (1 x 4 + 1 x 2) is worth 6 ammunition (6 x 1) or 2 Food items (2 x 3).

POST /api/:first_id/:second_id/trade

Request

POST https://zssn.azurewebsites.net/api/:first_id/:second_id/trade

Supply the trade items of both survivors, with the following properties:

Response

If successful, this method returns a response body with the following structure:

{
    "message": "Trade completed!"
}

Percentage of infected survivors

Reports the percentage of infected survivors.

GET /api/survivors/reports/perc_infected

Request

GET https://zssn.azurewebsites.net/api/survivors/reports/perc_infected

Response

If successful, this method returns a response body with the following structure:

{
    "percentage": number
}

Percentage of non-infected survivors

Reports the percentage of non-infected survivors.

GET /api/survivors/reports/perc_non_infected

Request

GET https://zssn.azurewebsites.net/api/survivors/reports/perc_non_infected

Response

If successful, this method returns a response body with the following structure:

{
    "percentage": number
}

Averade amount of each kind of resource by survivor

Reports the average amount of each kind of resource by survivor.

GET /api/survivors/reports/avg_resources

Request

GET https://zssn.azurewebsites.net/api/survivors/reports/avg_resources

Response

If successful, this method returns a response body with the following structure:

{
    "amount": number
}

Points lost because of infected survivor

Reports the amount of points lost because of an infected survivor.

GET /api/survivors/reports/points_lost

Request

GET https://zssn.azurewebsites.net/api/survivors/reports/points_lost

Response

If successful, this method returns a response body with the following structure:

{
    "amount": number
}

Testing

Automated tests were written with Mocha and SuperTest. To run the tests:

npm test

Contributing

PRs accepted.

License

MIT © Richard McRichface.