tienyuan/open-todo

A public API demo for a open task list

Open Todo API Description

This project adds an external API to a todo app forked from open-todo

Made with my mentor, Eliot Sykes at Bloc.

Setup Instructions

Clone this repository.

Setup postgres

Create a postgres test user and a postgres development user.

Then copy config/application.example.yml to config/application.yml and add database information.

SECRET_KEY_BASE: 
DEV_DATABASE_USERNAME: 
DEV_DATABASE_PASSWORD: 
TEST_DATABASE_USERNAME: 
TEST_DATABASE_PASSWORD:

Run bundle install to install all relevant gems.

Run rspec to test the application.

Usage Instructions

First start the app and make an account by going to the web app, http://localhost:3000/

Then visit the user's account page to get an access token. Access tokens must be passed in as a custom header called X-ACCESS-TOKEN

Once you have a token, you can use the following endpoints and json formats to see and create additional users, lists, and items. Lists and items can be changed or deleted via the API. Users must be deleted via the web app.

Endpoints

GET /api/v1/users/

Returns json for a list of user ids and usernames

curl -H "X-ACCESS-TOKEN: access_token_string_goes_here" http://localhost:3000/api/v1/users

GET /api/v1/users/{user_id}/lists

Returns a list of all open and viewable lists and their items for a user. If you are the user, you will also see your private lists.

curl -H "X-ACCESS-TOKEN: access_token_string_goes_here" http://localhost:3000/api/v1/users/1/lists

POST /api/v1/users/ {user: {username: 'testuser', password: 'testpass'}}

Creates a new user and returns json for the new user's id and username. Username must be unique

curl -X POST -H "X-ACCESS-TOKEN: access_token_string_goes_here" -H "Content-type:application/json" -d "{\"user\": {\"username\": \"superman\", \"password\": \"krptonite\"}}" http://localhost:3000/api/v1/users/

GET /api/v1/lists/

Returns json for all open and viewable lists and their items

curl -H "X-ACCESS-TOKEN: access_token_string_goes_here" http://localhost:3000/api/v1/lists

GET /api/v1/lists/{list_id}

Returns json for a single list and it's items

curl -H "X-ACCESS-TOKEN: access_token_string_goes_here" http://localhost:3000/api/v1/lists/1

POST /api/v1/lists/ {user_id: user_id, list: {name: 'test_list', permissions: 'open'}}

Creates a new list, user_id, name, and permissions are all required. List names must be unique and Permissions can only be set to open, viewable or private.

curl -X POST -H "X-ACCESS-TOKEN: access_token_string_goes_here" -H "Content-type:application/json" -d "{\"user_id\": \"1\", \"list\": {\"name\": \"People to Rescue\", \"permissions\": \"open\"}}" http://localhost:3000/api/v1/lists/

PATCH /api/v1/lists/{list_id} {user_id: user_id, id: list_id {name: 'Kittens to Rescue', permissions: 'private'}}

Updates a list with a new name or permission if you own the list or if the list is open.

curl -X PATCH -H "X-ACCESS-TOKEN: access_token_string_goes_here" -H "Content-type:application/json" -d "{\"user_id\": \"1\", \"id\": \"4\", \"list\": {\"name\": \"Kittens to Rescue\", \"permissions\": \"open\"}}" http://localhost:3000/api/v1/lists/4

DELETE /api/v1/lists/{list_id}

Deletes a list

curl -X DELETE -H "X-ACCESS-TOKEN: access_token_string_goes_here" http://localhost:3000/api/v1/lists/4

POST /api/v1/lists/{list_id}/items {item: {description: 'test_item'}}

Creates a new item if you own the list or if the list is open. Description is required.

curl -X POST -H "X-ACCESS-TOKEN: access_token_string_goes_here" -H "Content-type:application/json" -d "{\"item\": {\"description\": \"Morris the Cat\"}}" http://localhost:3000/api/v1/lists/4/items

PATCH /api/v1/lists/{list_id}/items/{item_id} {item: {description: 'Mittens the kitten'}

Updates an item with a description if you own the list or if the list is open.

curl -X PATCH -H "X-ACCESS-TOKEN: access_token_string_goes_here" -H "Content-type:application/json" -d "{\"item\": {\"description\": \"Mittens the Kitten\"}}" http://localhost:3000/api/v1/lists/4/items/7/

DELETE /api/v1/items/{item_id}

Deleting an item marks it as complete and hides it from the list. You have permission to do so if you own the list or the list is open

curl -X DELETE -H "X-ACCESS-TOKEN: access_token_string_goes_here" http://localhost:3000/api/v1/items/7/