jobv/tw_api

Therewhere API

Therewhere API

Setup

1. Develop on Mac OSX Yosemite or later
2. Use ruby 2.2.0
3. Use http://postgresapp.com/ for Postgres. It includes Postgis, which we need.
4. Don't forget to create Postgis extension in your database:

$ psql <database_name>
CREATE EXTENSION Postgis;

Tests

Run tests automatically with:

bundle exec guard

Leave it open. It will run on changes.

Location Gems

We use RGeo with the AR Postgis adapter.

API Design guide

Try to make things easy.

Remember to only return useful error messages if authorised. Otherwise you're creating security issues.

Test all code. It's a pain in the ass to have untested code around. Ruby is too easy to not write untested code.

API

Prepend everything with /api/v1

Current User

post /location/:x:y:z:m

Set location x, y, z (optional), m (optional) of current user.

Pre-auth implementation: add param id to specify user.

get /location

Get last stored location of current user.

Pre-auth implementation: add param id to specify user.

get /friends

Get friends of current user.

post /friends

Adds one or more friends by phone_nrs in an array.

Params:

• phone_nrs (Array with Strings)

For example:

post /api/v1/users/1/friends?phone_nrs=['12345']

Users

get /users/:id

Returns user with :id.

get /users

Returns all users.

post /users

Creates a user.

Params:

• first_name
• last_name
• email

put /users/:id

Update a user.

delete /users/:id

Delete a user.

Meetups

get /users/:id/meetups

Returns all pending meetups.

post /users/:id/meetups/:friend_id

Request a meetup if none is outstanding.

Accept a meetup if one is outstanding.