README.md
[](https://travis-ci.org/andela/ah-infinity-stones) [](https://coveralls.io/github/andela/ah-infinity-stones?branch=develop)
Authors Haven - A Social platform for the creative at heart.
=======
## Vision
Create a community of like minded authors to foster inspiration and innovation
by leveraging the modern web.
---
## Database configuration
Follow the following steps to configure PostgreSQL database engine in your local machine.
1. Install PostgreSQL: `brew install postgresql`
2. Create a new postgres user: `CREATE USER sample_user WITH PASSWORD 'sample_password';`
3. Grant privileges to the new user: `GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO sample_user;`
4. Install dependencies: `pip3 install -r requirements.txt`
5. Create database: `CREATE DATABASE sample_database WITH OWNER sample_user;`
6. Create test database: `CREATE DATABASE sample_database WITH OWNER sample_user;`
7. Create a .env file and set configuration variables as shown below. Replace the values with your own:
```
export DATABASE_NAME='your_database_name'
export DATABASE_TEST='your_test_database_name'
export DATABASE_USER='sample_user_you_created_above'
export DATABASE_PASSWORD='password_for_the_sample_user'
export DATABASE_HOST='your_host'
export DATABASE_PORT='your_port_number e.g 5432'
export DB_SECRET='your_scret_key'
```
8. Export .env values: `source .env`
9. Run migrations:
`python3 manage.py makemigrations`
`python3 manage.py migrate`
## API Spec
The preferred JSON object to be returned by the API should be structured as follows:
### Users (for authentication)
```source-json
{
"user": {
"email": "jake@jake.jake",
"token": "jwt.token.here",
"username": "jake",
"bio": "I work at statefarm",
"image": null
}
}
```
### Profile
```source-json
{
"profile": {
"username": "jake",
"bio": "I work at statefarm",
"image": "image-link",
"following": false
}
}
```
### Single Article
```source-json
{
"article": {
"slug": "how-to-train-your-dragon",
"title": "How to train your dragon",
"description": "Ever wonder how?",
"body": "It takes a Jacobian",
"tagList": ["dragons", "training"],
"createdAt": "2016-02-18T03:22:56.637Z",
"updatedAt": "2016-02-18T03:48:35.824Z",
"favorited": false,
"favoritesCount": 0,
"author": {
"username": "jake",
"bio": "I work at statefarm",
"image": "https://i.stack.imgur.com/xHWG8.jpg",
"following": false
}
}
}
```
### Multiple Articles
```source-json
{
"articles":[{
"slug": "how-to-train-your-dragon",
"title": "How to train your dragon",
"description": "Ever wonder how?",
"body": "It takes a Jacobian",
"tagList": ["dragons", "training"],
"createdAt": "2016-02-18T03:22:56.637Z",
"updatedAt": "2016-02-18T03:48:35.824Z",
"favorited": false,
"favoritesCount": 0,
"author": {
"username": "jake",
"bio": "I work at statefarm",
"image": "https://i.stack.imgur.com/xHWG8.jpg",
"following": false
}
}, {
"slug": "how-to-train-your-dragon-2",
"title": "How to train your dragon 2",
"description": "So toothless",
"body": "It a dragon",
"tagList": ["dragons", "training"],
"createdAt": "2016-02-18T03:22:56.637Z",
"updatedAt": "2016-02-18T03:48:35.824Z",
"favorited": false,
"favoritesCount": 0,
"author": {
"username": "jake",
"bio": "I work at statefarm",
"image": "https://i.stack.imgur.com/xHWG8.jpg",
"following": false
}
}],
"articlesCount": 2
}
```
### Single Comment
```source-json
{
"comment": {
"id": 1,
"createdAt": "2016-02-18T03:22:56.637Z",
"updatedAt": "2016-02-18T03:22:56.637Z",
"body": "It takes a Jacobian",
"author": {
"username": "jake",
"bio": "I work at statefarm",
"image": "https://i.stack.imgur.com/xHWG8.jpg",
"following": false
}
}
}
```
### Multiple Comments
```source-json
{
"comments": [{
"id": 1,
"createdAt": "2016-02-18T03:22:56.637Z",
"updatedAt": "2016-02-18T03:22:56.637Z",
"body": "It takes a Jacobian",
"author": {
"username": "jake",
"bio": "I work at statefarm",
"image": "https://i.stack.imgur.com/xHWG8.jpg",
"following": false
}
}],
"commentsCount": 1
}
```
### List of Tags
```source-json
{
"tags": [
"reactjs",
"angularjs"
]
}
```
### Errors and Status Codes
If a request fails any validations, expect errors in the following format:
```source-json
{
"errors":{
"body": [
"can't be empty"
]
}
}
```
### Other status codes:
401 for Unauthorized requests, when a request requires authentication but it isn't provided
403 for Forbidden requests, when a request may be valid but the user doesn't have permissions to perform the action
404 for Not found requests, when a resource can't be found to fulfill the request
Endpoints:
----------
### Authentication:
`POST /api/users/login`
Example request body:
```source-json
{
"user":{
"email": "jake@jake.jake",
"password": "jakejake"
}
}
```
No authentication required, returns a User
Required fields: `email`, `password`
Alternatively, a user can login through their Google, Facebook or Twitter account.
To the developers who want to add this functionality, they need to login in to their Google, Facebook and Twitter account. Then they need to go to developer settings and create an app and the service provider will give them access_key and access_key secret. Hence when Authors Haven users log in, they simply need to login to their preferred service provider instead of going through the tedious process of having to register within the app.
### Registration:
`POST /api/users`
Example request body:
```source-json
{
"user":{
"username": "Jacob",
"email": "jake@jake.jake",
"password": "jakejake"
}
}
```
No authentication required, returns a User
Required fields: `email`, `username`, `password`
### Get Current User
`GET /api/user`
Authentication required, returns a User that's the current user
### Update User
`PUT /api/user`
Example request body:
```source-json
{
"user":{
"email": "jake@jake.jake",
"bio": "I like to skateboard",
"image": "https://i.stack.imgur.com/xHWG8.jpg"
}
}
```
Authentication required, returns the User
Accepted fields: `email`, `username`, `password`, `image`, `bio`
### Get Profile
`GET /api/profiles/:username`
Authentication optional, returns a Profile
### Follow user
`POST /api/profiles/:username/follow`
Authentication required, returns a Profile
No additional parameters required
### Unfollow user
`DELETE /api/profiles/:username/follow`
Authentication required, returns a Profile
No additional parameters required
### List Articles
`GET /api/articles`
Returns most recent articles globally by default, provide `tag`, `author` or `favorited` query parameter to filter results
Query Parameters:
Filter by tag:
`?tag=AngularJS`
Filter by author:
`?author=jake`
Favorited by user:
`?favorited=jake`
Limit number of articles (default is 20):
`?limit=20`
Offset/skip number of articles (default is 0):
`?offset=0`
Authentication optional, will return multiple articles, ordered by most recent first
### Feed Articles
`GET /api/articles/feed`
Can also take `limit` and `offset` query parameters like List Articles
Authentication required, will return multiple articles created by followed users, ordered by most recent first.
### Get Article
`GET /api/articles/:slug`
No authentication required, will return single article
### Create Article
`POST /api/articles`
Example request body:
```source-json
{
"article": {
"title": "How to train your dragon",
"description": "Ever wonder how?",
"body": "You have to believe",
"tagList": ["reactjs", "angularjs", "dragons"]
}
}
```
Authentication required, will return an Article
Required fields: `title`, `description`, `body`
Optional fields: `tagList` as an array of Strings
### Update Article
`PUT /api/articles/:slug`
Example request body:
```source-json
{
"article": {
"title": "Did you train your dragon?"
}
}
```
Authentication required, returns the updated Article
Optional fields: `title`, `description`, `body`
The `slug` also gets updated when the `title` is changed
### Delete Article
`DELETE /api/articles/:slug`
Authentication required
### Add Comments to an Article
`POST /api/articles/:slug/comments`
Example request body:
```source-json
{
"comment": {
"body": "His name was my name too."
}
}
```
Authentication required, returns the created Comment
Required field: `body`
### Get Comments from an Article
`GET /api/articles/:slug/comments`
Authentication optional, returns multiple comments
### Delete Comment
`DELETE /api/articles/:slug/comments/:id`
Authentication required
### Favorite Article
`POST /api/articles/:slug/favorite`
Authentication required, returns the Article
No additional parameters required
### Unfavorite Article
`DELETE /api/articles/:slug/favorite`
Authentication required, returns the Article
No additional parameters required
### Get Tags
`GET /api/tags`