Prahapp backend

Disclaimer!!

This document has vastly outdated API descriptions and contains references to wappuapp which the implementation is based on.

Dependencies:

Node 4.x or 5.x + npm 2.x

Use NPM 2.x, the current Babel configuration has issues with NPM 3.x and doesn't work ~~properly~~ at all with it

Postgres with PostGis extension

Postgres.app has a built-in support.

Note: The command below has been done already for wappuapp-backend app. It is only useful if you create a new Heroku app.

You can add Postgis support to Heroku Postgres with:
```
heroku pg:psql -a wappuapp-backend
create extension postgis;
```
Heroku toolbelt

Get started

bash ./tools/reset-database.sh

If this doesn't work, you can manually run SQL commands from ./tools/init-database.sql in Postgres console.
cp .env-sample .env && cp .env-test-sample .env-test
Fill in the blanks in .env and .env-test files

Ask details from Kimmo Brunfeldt or Tomi Turtiainen.
source .env or bash .env

Or use autoenv.
npm install
npm install -g knex
knex migrate:latest Run migrations to local database
knex seed:run Create seed data to local database
npm start Start express server locally
Server runs at http://localhost:9000

Start using API endpoints.

Environments:

qa https://wappuapp-backend-qa.herokuapp.com
prod https://wappuapp-backend.herokuapp.com

Techstack

Node.js express app. Architecture explained here https://github.com/kimmobrunfeldt/express-example/
Written in ES6
Winston for logging
Postgres

Heroku/Cloud env

#!/bin/bash
heroku addons:create --app wappuapp-backend papertrail
heroku addons:create --app wappuapp-backend heroku-postgresql:hobby-dev
heroku addons:create --app wappuapp-backend newrelic

Add Postgis:

heroku pg:psql -a wappuapp-backend
create extension postgis;

Google Cloud Storage is used for storing images.

Common tasks

Release

Migrations and seeds are automatically run in Heroku when you deploy via git push. Migrations are run if knex detects new files in migrations directory. Seeds must be replayable, they must be upsert operations so they can be run on each push.

Commit changes
Check that tests pass, remember to test migrations locally before push
Take manual backup of postgres

heroku pg:backups capture --app wappuapp-backend
Push changes to production environment:
```
git checkout master
git pull
git push prod
```
For testing environments:

You can also release a certain local branch. For example releasing from node branch to dev: git push dev my-local-branch:master.
Check that the environment responds and logs(Papertrail) look ok.

Quick test endpoints:

Update events

NOTE: Some data is added to the original Excel file via fuzzy match mappings. This was done because initially we did not want to modify the original Excel file itself to prevent csv export and character encoding problems. This is not true anymore but some of the data is still added via fuzzy match mappings. These could be transferred to the xlsx file already.

Download newest .xlsx file containing events (in Drive)
Open it in Excel
Save as -> Windows Comma Separated. Note: use this specifically, not the general csv.
If it asks: press "Save active Sheet" and "Continue"

Run parse script:

node tools/parse-events-csv.js ~/Downloads/wapputapahtumat.csv > data/events.json

Make sure events.json looks fine
Push newest code to remote, the events are directly read from JSON file

Update markers

Download the map markers spreadsheet as CSV

Run parse script:

node tools/parse-markers-csv.js ~/Downloads/markers.csv > data/markers.json

Make sure markers.json looks fine
Delete existing map markers from remote Postgres
Push new code to production, knex seeds will update the markers to database

Shadow ban user

UPDATE users SET is_banned = true WHERE uuid='D47DA01C-51BB-4F96-90B6-D64B77225EB7';

API Endpoints

READ THIS:

Always use content-type: application/json header when doing POST, PUT, PATCH requests
All data is transferred in JSON format

Even images are transferred as base64 strings in JSON. Why?
- Why not?
Be prepared that some of these endpoints are not documented correctly
Token authentication is required. Token is sent in x-token header.

`GET /api/events`

List events

Query parameters:

cityId Integer. If specified, returns only events in the city with given id.
showPast Boolean. Should events that have ended also be returned. Defaults to false.

Responses:

200 OK List of event objects.

`GET /api/events/:id`

Get event details

Responses:

200 OK Body is one of event object with an array of images that are image feed objects.
404 Not Found Event not found

`GET /api/teams`

List all teams

Query parameters:

city Integer. If specified, returns only teams based in the city with given id.

Responses:

200 OK List of team objects.

`POST /api/actions`

Create a new action

Query parameters:

cityId Integer. If specified, generated feed item show in this city's feed. Does nothing when checking into event.

Body is one of action objects.

Responses:

200 OK
404 No such city id or on CHECK_IN_EVENT; no such event id.
403 On CHECK_IN_EVENT; off time, off site or duplicate check in attempt.

`PUT /api/vote`

Vote on an feed item

Body is one of vote object.

Responses:

200 OK
404 Not found Feed item not found

`GET /api/users`

Get user details

Query parameters:

userId Integer. Required. User to whose details fetched

Responses:

200 OK Body is one of user details object.
404 Not Found User not found

`PUT /api/users/:uuid`

Create or update a user

Body is one of user object.

Responses:

200 OK

`GET /api/users/:uuid`

Get user details

Responses:

200 OK Body is one of user object.
404 Not Found User not found

`GET /api/action_types`

List action types available

Body is one of action type object.

Responses:

200 OK

`GET /api/markers`

List map markers

Body is list of marker objects.

Responses:

200 OK

`GET /api/cities`

List participating cities

Body is list of city objects.

Query parameters:

id Integer. If specified, returns only cities with the given ID.
name String. If specified, returns only cities with the given name.

Responses:

200 OK

`GET /api/feed`

Get list of feed

Body is one of feed objects.

Query parameters:

beforeId Return items before this id, can be used for "infinite scroll" in client.
limit Integer. Default: 20. 1-100. If specified, at max this many items are returned.
sort String. Default: 'new'. In which order the result should be returned. One of: 'new', 'hot'.
cityId Integer. If specified, returns only posts by users belonging to guilds based in the city with given id.
type String. If specified, only feed items of that type are returned. One of: 'IMAGE', 'TEXT'.
since String. ISO-8601 format timestamp. If specified, only feed items created after given timestamp are returned. Note: If no time zone is specified, UTC is assumed.
offset Integer. If specified, offsets the returned list by given amount.

Examples:

Get 30 newest feed items: GET /api/feed?limit=30
Get top 5-20 images: GET /api/feed?sort=top&limit=15&offset=5&type=IMAGE
Load 20 more feed items: GET /api/feed?beforeId=123&limit=20

Assuming the id of oldest/last feed item client currently has is 123.

Responses:

200 OK

`GET /api/feed/id`

Get list of feed

Body is one of feed objects.

Responses:

200 OK

`GET /api/image/:id`

Get specific image

Body is one of image objects.

Responses:

200 OK
404 Not found

`DELETE /api/feed/:id`

Delete item from feed

:id Is the id of an item in the feed.

`GET /api/mood`

Get list of day by day mood

Query parameters:

userId Integer. If specified, returned ratingCity is for the given user.
cityId Integer. If specified, returned ratingCity is for the given city.
teamId Integer. If specified, returned ratingTeam is for the given team.

Body is a list of mood objects.

`PUT /api/mood`

Create or update mood

Body is one of mood objects.

Responses:

200 OK
403 Forbidden If uuid has not been included in header.

`GET /api/radio`

Get list of radio stations.

Query parameters:

cityId String. If specified, returns only stations active in the given city.

Responses:

200 OK Body is list of radio objects.

`GET /api/radio/:id`

Get one of radio stations.

Responses:

200 OK Body is one of radio objects.

Response objects

Event object

{
  "id": 121,
  "name": "Spinnin iltapäiväkertho",
  "locationName": "Spinnin kerhohuone SA014",
  "startTime": "2017-02-21T10:00:00.000Z",
  "endTime": "2017-04-21T15:00:00.000Z",
  "description": "Raining and freezing outside? Studying terrifies and starting to miss kindergarden times? Spinni solves your problems!\r\r\r\rClimb stairs down to the basement of Sähkötalo and arrive to the club room of Spinni, SA014 on <päivämäärä> starting at 1 PM. Spinni offers some snacks, coloring books (for adults), games, lot of friends to play with - not to mention awesome music and lights. Additionally you may have a look at the regular life of electronic music club that is celebrating its 20th anniversary this year.\r\r\r\rSpinni <3 you",
  "organizer": "Spinni",
  "contactDetails": "spinni-hallitus@listmail.tut.fi; Valtteri Taimela, valtteri.taimela@student.tut.fi",
  "teemu": false,
  "location": {
    "latitude": 61.450364,
    "longitude": 23.858384
  },
  "coverImage": "https://storage.googleapis.com/wappuapp/assets/spinni.jpg",
  "city": 3,
  "fbEventId": null,
  "attendingCount": 0,
  "radius": 400,
  "images": []
}

Team object

{
  "id": 1,
  "name": "Tietoteekkarikilta",
  "image_path": "foo.com/path_to_image.jpg",
  "score": "10",
  "city": 3
}

User details object

Images is an array of feed objects.

{
  "name": "Hessu Kypärä",
  "team": "TiTe",
  "numSimas": "1",
  "images": [
    {
      "id": "2",
      "type": "IMAGE",
      "votes": "0",
      "userVote": 0,
      "hotScore": "195.2537",
      "author": {
        "id": "1",
        "name": "Hessu Kypärä",
        "team": "TiTe",
        "type": "ME"
      },
      "createdAt": "2017-04-12T16:40:14.308Z",
      "location": {
        "latitude": 0.123,
        "longitude": 0.123
      },
      "url": "https://storage.googleapis.com/wappuapp/user_content/123.jpg"
    }
  ]
}```

### User object

```js
{
  "uuid": "de305d54-75b4-431b-adb2-eb6b9e546014",
  "name": "Hessu Kypärä",
  "profilePicture": "http://foo.com/image/bar.png" // May be null
}

Action type object

{
  "id": "3",
  "code": "CIDER",
  "name": "Grab a cider",
  "value": 10,
  "cooldown": 300000
}

Marker object

{
  location: {
    latitude: -1.2345,
    longitude: 56.2322
  },

  // One of STORE, ALKO, TOILET, TAXI, BAR, RESTAURANT
  type: "STORE",
  title: "K-Supermarket Herkkuduo",
  imageUrl: "http://www.foo.bar", // Nullable

  // Optional url
  url: "http://www.k-supermarket.fi/"
}

Vote object

{
  // one of 1, -1
  "value": 1,
  "feedItemId": 12
}

City object

{
  "id": 2,
  "name": "helsinki"
}

Radio object

{
  "id": 2,
  "name": "Radiodiodi",
  "stream": null,
  "website": null,
  "cityId": 2,
  "nowPlaying": {
    "programTitle": "Mustia kukkia ja kielimoukareita",
    "programHost": "Santtu, Jaati, Lari",
    "song": null,
    "left": 1132504   // How much longer the program is gonna be playing, in ms
  }
}

Mood objects

GET mood object

{
  "date": "2016-04-15T22:00:00.000Z",
  "ratingCity": "3.3333",     // May be null
  "ratingTeam": "5.0000",     // May be null
  "ratingPersonal": "10.0000" // May be null
}

PUT mood object

{
  // Dacimal. Range [0, 10]. Rounded to 4th decimal mark.
  "rating": 10,
  // Optional
  "description": "Its friday!"

}

Action objects

Basic action object

type is one of SIMA, CHECK_IN_EVENT.

{
  // required when event type 'CHECK_IN_EVENT'
  location: {
    latitude: -1.2345,
    longitude: 56.2322
  },
  type: "SIMA",
  team: 1,
  user: 'UUID',
  // required when event type 'CHECK_IN_EVENT'
  eventId: 1
}

Image action object

{
  location: {
    latitude: -1.2345,
    longitude: 56.2322
  },
  type: "IMAGE",
  team: 1,
  imageData: 'base64encodedimage',
  user: 'UUID'
}

Feed objects

Image feed object

{
  id: 1,
  // location is optional so it might be not provided
  location: {
    latitude: -1.2345,
    longitude: 56.2322
  },
  type: "IMAGE",
  createdAt: "2016-04-20T09:00:00.000Z",
  votes: 10,
  hotScore: 178.0032,
  author: {
    name: "Nahkasimo",
    team: "Sähkökilta",
    // Can be 'ME', 'OTHER_USER', 'SYSTEM'
    type: "ME",
    profilePicture: "http://foo.com/image/bar.png" // May be null
  },
  url: "https://storage.googleapis.com/wappuapp/user_content/123.jpg"
}

Image objects

{
  createdAt: "2016-04-20T09:00:00.000Z",
  votes: 10,
  hotScore: 178.0032,
  author: {
    name: "Nahkasimo",
    team: "Sähkökilta",
    profilePicture: "http://foo.com/image/bar.png" // May be null
  },
  url: "https://storage.googleapis.com/wappuapp/user_content/123.jpg"
}

Text feed object

{
  id: 1,
  // location is optional so it might be not provided
  location: {
    latitude: -1.2345,
    longitude: 56.2322
  },
  type: "TEXT",
  createdAt: "2016-04-20T09:00:00.000Z",
  votes: 10,
  // If and how the user has voted. One of [-1, 0, 1].
  userVote: 0,
  hotScore: 178.0021,
  author: {
    name: "Nahkasimo",
    team: "Sähkökilta",
    // Can be 'ME', 'OTHER_USER', 'SYSTEM'
    type: "ME",
    profilePicture: "http://foo.com/image/bar.png" // May be null
  },
  text: "Joujou"
}

Error handling

When HTTP status code is 400 or higher, response is in format:

{
  "error": "Internal Server Error"
}

=======

Acknowledgements

This project is a grateful recipient of the Futurice Open Source sponsorship program. ♥

Name		Name	Last commit message	Last commit date
Latest commit History 682 Commits
data		data
migrations		migrations
seeds		seeds
src		src
test		test
tools		tools
.babelrc		.babelrc
.editorconfig		.editorconfig
.env-sample		.env-sample
.env-test-sample		.env-test-sample
.eslintrc		.eslintrc
.gitignore		.gitignore
.jscs.json		.jscs.json
.travis.yml		.travis.yml
LICENSE		LICENSE
Procfile		Procfile
README.md		README.md
knexfile.js		knexfile.js
newrelic.js		newrelic.js
package.json		package.json

License

kaupunki-apina/prahapp-backend

Folders and files

Latest commit

History

Repository files navigation

Prahapp backend

Get started

Techstack

Heroku/Cloud env

Common tasks

Release

Update events

Update markers

Shadow ban user

API Endpoints

GET /api/events

GET /api/events/:id

GET /api/teams

POST /api/actions

PUT /api/vote

GET /api/users

PUT /api/users/:uuid

GET /api/users/:uuid

GET /api/action_types

GET /api/markers

GET /api/cities

GET /api/feed

GET /api/feed/id

GET /api/image/:id

DELETE /api/feed/:id

GET /api/mood

PUT /api/mood

GET /api/radio

GET /api/radio/:id

Response objects

Event object

Team object

User details object

Action type object

Marker object

Vote object

City object

Radio object

Mood objects

GET mood object

PUT mood object

Action objects

Basic action object

Image action object

Feed objects

Image feed object

Image objects

Text feed object

Error handling

Acknowledgements

About

Resources

License

Stars

Watchers

Forks

Languages

`GET /api/events`

`GET /api/events/:id`

`GET /api/teams`

`POST /api/actions`

`PUT /api/vote`

`GET /api/users`

`PUT /api/users/:uuid`

`GET /api/users/:uuid`

`GET /api/action_types`

`GET /api/markers`

`GET /api/cities`

`GET /api/feed`

`GET /api/feed/id`

`GET /api/image/:id`

`DELETE /api/feed/:id`

`GET /api/mood`

`PUT /api/mood`

`GET /api/radio`

`GET /api/radio/:id`