Skip to content

sepehrvakili/abstract-be

BranchesTags
 
 

Repository files navigation

Abstract App API

Abstract Screenshot

Welcome to the Abstract App API documentation.

The url params are called Path parameters

Methods

###Retrieve a Specific Comment

##User Methods

###Registration

This request will create a new user in the system and return back an auth_token back. The auth_token must be used for all subsequent requests (except for User Login).

URL /register

Method POST

Request

Form Params Type Description
firstname String (required) User's first name
lastname String (required) User's last name
username String (required) User's username
email String ​*(required)*​ Users email address, must follow the format text@text.text
password String ​*(required)*​ password for the user

Response

If successful, you will receive:

Status Code: 201 - Created

{
  "user": {
    "id": 8,
    "firstname": "Hootan",
    "lastname": "Vakili",
    "username": "hootan",
    "email": "hootan1990@gmail.com",
    "auth_token": "abe63b71bfb14015c4bbb4047064087c",
    "created_at": "2015-12-13T19:13:59.026Z",
    "updated_at": "2015-12-13T19:13:59.026Z"
  }
}

If unsuccessful, you will receive:

Status Code: 422 - Unprocessable Entity

{
  "errors": [
    "Email has already been taken",
    "Username has already been taken"
  ]
}

###Login

This request will allow an existing user in the system to send their username and password and return back an auth_token back. The auth_token must be used for all subsequent requests (except for User Registration).

URL /login

Method POST

Request

Form Params Type Description
username String ​*(required)*​ existing user's username
password String ​*(required)*​ password for the user

Response

If successful, you will receive:

Status Code: 202 - Accepted

{
  "user": {
    "id": 8,
    "firstname": "Hootan",
    "lastname": "Vakili",
    "username": "hootan",
    "email": "hootan1990@gmail.com",
    "auth_token": "abe63b71bfb14015c4bbb4047064087c",
    "created_at": "2015-12-13T19:13:59.026Z",
    "updated_at": "2015-12-13T19:13:59.026Z"
  }
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not find user for sepehr or wrong password."
}

###Delete User

This request will allow an existing user in the system to delete their account. The users posts, profile, and behaviors will also be removed (eg. likes).

URL /users/:id

Method DELETE

Request

Path Params Type Description
id integer ​*(required)*​ the id of the user to be deleted

Response

If successful, you will receive:

Status Code: 202 - Accepted

{
  "message": "Hootan's account has been deleted."
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "message": "kiarash is not the rightful owner of this account."
}

###Retrieve One User

This request will allow a user to retrieve a profile of any other user as long as you provide an Auth-Token.

URL /users/:id

Method GET

Request

Path Params Type Description
id integer ​*(required)*​ the user's id whose profile you want.

Response

If successful, you will receive:

Status Code: 202 - Accepted

{
  "user": {
    "id": 4,
    "username": "kiarash",
    "bio": "Kiarash is sepehrs fav cousin.",
    "website": "http://GT-BadAss.com",
    "location": "Atlanta, GA",
    "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752",
    "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752",
    "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752",
    "profile_id": 15,
    "tags": "atlanta, ga-tech university, engineer"
  }
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "errors": "Profile does not exist."
}

###Retrieve All Users

This request will allow a user to retrieve profiles of all users, paginated, as long as an Auth-Token is provided. Each request will provide 20 profiles at most. Providing a page param will allow you to get consequent profiles. For first 20 users page can be empty since default value is 1. For second 20 users (eg. users 21-40) page should be 2 and so on.

URL /users?page=1

Method GET

Request

Path Params Type Description
page integer ​*(optional)*​ the page you want to start showing from, default is 1.

Response

If successful, you will receive:

Status Code: 202 - Accepted

{
  "page": 1,
  "page_count": 1,
  "users": [
    {
      "id": 1,
      "username": "sepehr",
      "bio": "Arrigatto!",
      "website": "http://sepehr.io",
      "location": "The Universe",
      "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/009/sepehr-bali.jpg?1449025389",
      "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/009/sepehr-bali.jpg?1449025389",
      "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/009/sepehr-bali.jpg?1449025389",
      "profile_id": 9,
      "tags": ""
    },
    {
      "id": 2,
      "username": "kaveh",
      "bio": "Kaveh is illest of 'em all.",
      "website": "http://kaveh.io",
      "location": "Washington, DC",
      "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611",
      "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/012/yazd.jpg?1449069611",
      "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/012/yazd.jpg?1449069611",
      "profile_id": 12,
      "tags": ""
    },
    {
      "id": 4,
      "username": "kiarash",
      "bio": "Kiarash is sepehrs fav cousin.",
      "website": "http://GT-BadAss.com",
      "location": "Atlanta, GA",
      "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752",
      "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752",
      "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752",
      "profile_id": 15,
      "tags": "atlanta, ga-tech university, engineer"
    },
    {
      "id": 8,
      "username": "hootan",
      "bio": "Hootan is from Dastjerd!",
      "website": "http://hootan.com",
      "location": "Atlanta",
      "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/019/Sepehr_Profile.jpg?1450035759",
      "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/019/Sepehr_Profile.jpg?1450035759",
      "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/019/Sepehr_Profile.jpg?1450035759",
      "profile_id": 19,
      "tags": "hootan profile pic"
    }
  ]
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: ''"
}

###Retrieve Followers

Each request will provide 20 followers at most. Providing a page param will allow you to get subsequent followers. For first 20 followers page can be empty since default value is 1. For second 20 users (eg. users 21-40) page should be 2 and so on.

URL /users/:id/followers?page=1

Method GET

Request

Path Params Type Description
page integer ​*(optional)*​ the page you want to start showing from, default is 1
id integer ​*(optional)*​ the id of the user whose following you want, it is id not user_id

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "page": 1,
  "page_count": 1,
  "followers": [
    {
      "user_id": 2,
      "username": "kaveh",
      "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611",
      "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/012/yazd.jpg?1449069611",
      "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/012/yazd.jpg?1449069611"
    }
  ]
}

If unsuccessful, you will receive:

Status Code: 404 - Not Found

###Retrieve Following

This request will allow you to retrieve the users being followed by any one user. Each request will provide 20 followings at most. Providing a page param will allow you to get subsequent followings. For first 20 followings page can be empty since default value is 1. For second 20 users (eg. users 21-40) page should be 2 and so on.

URL /users/:id/following?page=1

Method GET

Request

Path Params Type Description
page integer ​*(optional)*​ the page you want to start showing from, default is 1
id integer ​*(optional)*​ the id of the user whose following you want, it is id not user_id

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "page": 1,
  "page_count": 1,
  "following": [
    {
      "user_id": 3,
      "username": "hootan",
      "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/014/58277_2475495443955_494366159_n.jpg?1449075312",
      "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/014/58277_2475495443955_494366159_n.jpg?1449075312",
      "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/014/58277_2475495443955_494366159_n.jpg?1449075312"
    },
    {
      "user_id": 4,
      "username": "kiarash",
      "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752",
      "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752",
      "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752"
    }
  ]
}

If unsuccessful, you will receive:

Status Code: 404 - Not Found

##Profile Methods

###Create

This request will allow a user to create a profile immediately after signing up.

URL /profiles

Method POST

Request

Form Params Type Description
picture File ​*(required)*​ the user's profile image
bio String ​*(required)*​ brief text bio of the user
website String (required) user's website url
location String (required) user's current location
tag_phrases string (optional) optional field, must return comma separated words

Response

If successful, you will receive:

Status Code: 202 - Accepted

{
  "profile": {
    "id": 19,
    "bio": "Hootan is from Dastjerd!",
    "website": "http://hootan.com",
    "location": "Atlanta",
    "picture_thumb": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/019/Sepehr_Profile.jpg?1450035759",
    "picture_medium": "http://abstract-test.s3.amazonaws.com/profiles/medium/000/000/019/Sepehr_Profile.jpg?1450035759",
    "picture_large": "http://abstract-test.s3.amazonaws.com/profiles/large/000/000/019/Sepehr_Profile.jpg?1450035759",
    "user_id": 8,
    "username": "hootan",
    "tags": "hootan profile pic"
  }
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: '89a9b31ad1bd2a5c7e2010b29dbc31a2f'"
}

##Post Methods

###Create

There are currently 4 post types including: image, text, link, quote, or moodboard. When a user creates a new post the must select one of these four post types. This should be a dropdown field that is populated by the front-end app.

This request will allow a user to create a post immediately after signing up.

URL /posts

Method POST

Request

Given that there is one Post model all fields are optional except post_type. However, the front-end app can perform validation to ensure all fields relavent to a selected post type are provided.

Form Params Type Description
post_type string ​*(required)*​ the type of post being created
image file ​*(optional)*​ should be provided if user is creating post_type image
title string ​*(optional)*​ should be provided if user is creating post_type image
status string *(optional)*​ should be provided if user is creating post_type text
url string (optional) should be provided if user is creating post_type link
description String (optional) should be provided if user is creating post_type link or image
quote string (optional) should be provided if user is creating post_type quote
tag_phrases string (optional) must provide comma separated words or phrases
moodboard_css_class string (optional) must be provided if the post_type is moodboard

Response

If successful, you will receive:

Status Code: 202 - Accepted

{
  "post": {
    "id": 24,
    "post_type": "image",
    "moodboard_css_class": null,
    "title": "Travel Photo",
    "url": null,
    "description": null,
    "status": null,
    "quote": null,
    "image_thumb": "http://abstract-test.s3.amazonaws.com/posts/thumb/000/000/024/gorgan_road.jpg?1449612321",
    "image_medium": "http://abstract-test.s3.amazonaws.com/posts/medium/000/000/024/gorgan_road.jpg?1449612321",
    "image_large": "http://abstract-test.s3.amazonaws.com/posts/large/000/000/024/gorgan_road.jpg?1449612321",
    "user_id": 4,
    "username": "kiarash",
    "likes_count": 0,
    "tags": "gorgan, iran, travel",
    "created_at": "2015-12-08T22:05:22.416Z",
    "updated_at": "2015-12-08T22:05:22.416Z",
    "moodpieces": []
  }
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: '89a9bad1bd2a5c7e2010b29dbc31a2f'"
}

###Retrieve A Specific Post

URL /posts/:id

Method GET

Request

Path Params Type Description
id integer ​*(required)*​ the id of the post you're retrieving

Response

If successful, you will receive:

Status Code: 202 - Accepted

{
  "post": {
    "id": 20,
    "post_type": "moodboard",
    "moodboard_css_class": "template1",
    "title": "Travel Photo",
    "url": null,
    "description": null,
    "status": null,
    "quote": null,
    "image_thumb": "/images/thumb/missing.png",
    "image_medium": "/images/medium/missing.png",
    "image_large": "/images/large/missing.png",
    "user_id": 4,
    "username": "kiarash",
    "likes_count": 0,
    "tags": "gorgan, iran, travel, nature",
    "created_at": "2015-12-08T19:05:19.063Z",
    "updated_at": "2015-12-08T22:08:29.801Z",
    "moodpieces": [
      {
        "id": 1,
        "div_id": "position1",
        "color": null,
        "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/001/gorgan_road.jpg?1449602063"
      },
      {
        "id": 2,
        "div_id": "position1",
        "color": null,
        "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/002/gorgan_road.jpg?1449602189"
      },
      {
        "id": 3,
        "div_id": "position3",
        "color": null,
        "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/003/gorgan_road.jpg?1449602459"
      }
    ],
    "comments": [
      {
        "id": 10,
        "message": "hellow comment ",
        "created_at": "2015-12-08T21:20:51.524Z",
        "updated_at": "2015-12-08T21:20:51.524Z",
        "user_id": 2,
        "username": "kaveh",
        "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
      },
      {
        "id": 11,
        "message": "hellow comment@@@111 ",
        "created_at": "2015-12-08T21:21:08.794Z",
        "updated_at": "2015-12-08T21:21:08.794Z",
        "user_id": 2,
        "username": "kaveh",
        "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
      }
    ]
  }
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: '89a9bad1bd2a5c7e2010b29dbc31a2f'"
}

###Retrieve All Posts For a User

URL /users/:user_id/posts?page=1

Method GET

Request

Path Params Type Description
user_id integer ​*(required)*​ the id of the user whose post you're retrieving
page integer ​*(optional)*​ the page you want to start showing from, default is 1.

Response

If successful, you will receive:

Status Code: 202 - Accepted

{
  "page": 1,
  "page_count": 1,
  "posts": [
    {
      "post": {
        "id": 21,
        "post_type": "moodboard",
        "title": "This is a moodboard post.",
        "url": null,
        "description": null,
        "status": null,
        "quote": null,
        "image_thumb": "/images/thumb/missing.png",
        "image_medium": "/images/medium/missing.png",
        "image_large": "/images/large/missing.png",
        "user_id": 4,
        "username": "kiarash",
        "likes_count": 0,
        "tags": "apple, bannanaa, moodboard, banana!!!",
        "created_at": "2015-12-08T21:38:58.638Z",
        "updated_at": "2015-12-08T21:38:58.638Z",
        "moodboard_css_class": "template1",
        "moodpieces": [],
        "comments": []
      }
    },
    {
      "post": {
        "id": 20,
        "post_type": "moodboard",
        "title": "This is a moodboard post.",
        "url": null,
        "description": null,
        "status": null,
        "quote": null,
        "image_thumb": "/images/thumb/missing.png",
        "image_medium": "/images/medium/missing.png",
        "image_large": "/images/large/missing.png",
        "user_id": 4,
        "username": "kiarash",
        "likes_count": 0,
        "tags": "apple, bannanaa, moodboard, banana!!!",
        "created_at": "2015-12-08T19:05:19.063Z",
        "updated_at": "2015-12-08T19:05:19.063Z",
        "moodboard_css_class": "template1",
        "moodpieces": [
          {
            "id": 1,
            "div_id": "position1",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/001/gorgan_road.jpg?1449602063"
          },
          {
            "id": 2,
            "div_id": "position1",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/002/gorgan_road.jpg?1449602189"
          },
          {
            "id": 3,
            "div_id": "position3",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/003/gorgan_road.jpg?1449602459"
          }
        ],
        "comments": [
          {
            "id": 10,
            "message": "hellow comment ",
            "created_at": "2015-12-08T21:20:51.524Z",
            "updated_at": "2015-12-08T21:20:51.524Z",
            "user_id": 2,
            "username": "kaveh",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
          },
          {
            "id": 11,
            "message": "hellow comment@@@111 ",
            "created_at": "2015-12-08T21:21:08.794Z",
            "updated_at": "2015-12-08T21:21:08.794Z",
            "user_id": 2,
            "username": "kaveh",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
          }
        ]
      }
    }
  ]
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: '89a9bad1bd2a5c7e2010b29dbc31a2f'"
}

###Retrieve All Posts on the Site

URL /posts?page=1

Method GET

Request

Path Params Type Description
page integer ​*(optional)*​ the page you want to start showing from, default is 1.

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "page": 1,
  "page_count": 1,
  "posts": [
    {
      "post": {
        "id": 21,
        "post_type": "moodboard",
        "title": "This is a moodboard post.",
        "url": null,
        "description": null,
        "status": null,
        "quote": null,
        "image_thumb": "/images/thumb/missing.png",
        "image_medium": "/images/medium/missing.png",
        "image_large": "/images/large/missing.png",
        "user_id": 4,
        "username": "kiarash",
        "likes_count": 0,
        "tags": "apple, bannanaa, moodboard, banana!!!",
        "created_at": "2015-12-08T21:38:58.638Z",
        "updated_at": "2015-12-08T21:38:58.638Z",
        "moodboard_css_class": "template1",
        "moodpieces": [],
        "comments": []
      }
    },
    {
      "post": {
        "id": 20,
        "post_type": "moodboard",
        "title": "This is a moodboard post.",
        "url": null,
        "description": null,
        "status": null,
        "quote": null,
        "image_thumb": "/images/thumb/missing.png",
        "image_medium": "/images/medium/missing.png",
        "image_large": "/images/large/missing.png",
        "user_id": 4,
        "username": "kiarash",
        "likes_count": 0,
        "tags": "apple, bannanaa, moodboard, banana!!!",
        "created_at": "2015-12-08T19:05:19.063Z",
        "updated_at": "2015-12-08T19:05:19.063Z",
        "moodboard_css_class": "template1",
        "moodpieces": [
          {
            "id": 1,
            "div_id": "position1",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/001/gorgan_road.jpg?1449602063"
          },
          {
            "id": 2,
            "div_id": "position1",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/002/gorgan_road.jpg?1449602189"
          },
          {
            "id": 3,
            "div_id": "position3",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/003/gorgan_road.jpg?1449602459"
          }
        ],
        "comments": [
          {
            "id": 10,
            "message": "hellow comment ",
            "created_at": "2015-12-08T21:20:51.524Z",
            "updated_at": "2015-12-08T21:20:51.524Z",
            "user_id": 2,
            "username": "kaveh",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
          },
          {
            "id": 11,
            "message": "hellow comment@@@111 ",
            "created_at": "2015-12-08T21:21:08.794Z",
            "updated_at": "2015-12-08T21:21:08.794Z",
            "user_id": 2,
            "username": "kaveh",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
          }
        ]
      }
    }
  ]
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: '89a9bad1bd2a5c7e2010b29dbc31a2f'"
}

###Retrieve All Posts for a User's Following

URL /posts?page=1&?following=true

Method GET

Request

Path Params Type Description
page integer ​*(optional)*​ the page you want to start showing from, default is 1.
following string (optional) set to true to retrieve only the posts for the current user's following

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "page": 1,
  "page_count": 1,
  "posts": [
    {
      "post": {
        "id": 21,
        "post_type": "moodboard",
        "title": "This is a moodboard post.",
        "url": null,
        "description": null,
        "status": null,
        "quote": null,
        "image_thumb": "/images/thumb/missing.png",
        "image_medium": "/images/medium/missing.png",
        "image_large": "/images/large/missing.png",
        "user_id": 4,
        "username": "kiarash",
        "likes_count": 0,
        "tags": "apple, bannanaa, moodboard, banana!!!",
        "created_at": "2015-12-08T21:38:58.638Z",
        "updated_at": "2015-12-08T21:38:58.638Z",
        "moodboard_css_class": "template1",
        "moodpieces": [],
        "comments": []
      }
    },
    {
      "post": {
        "id": 20,
        "post_type": "moodboard",
        "title": "This is a moodboard post.",
        "url": null,
        "description": null,
        "status": null,
        "quote": null,
        "image_thumb": "/images/thumb/missing.png",
        "image_medium": "/images/medium/missing.png",
        "image_large": "/images/large/missing.png",
        "user_id": 4,
        "username": "kiarash",
        "likes_count": 0,
        "tags": "apple, bannanaa, moodboard, banana!!!",
        "created_at": "2015-12-08T19:05:19.063Z",
        "updated_at": "2015-12-08T19:05:19.063Z",
        "moodboard_css_class": "template1",
        "moodpieces": [
          {
            "id": 1,
            "div_id": "position1",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/001/gorgan_road.jpg?1449602063"
          },
          {
            "id": 2,
            "div_id": "position1",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/002/gorgan_road.jpg?1449602189"
          },
          {
            "id": 3,
            "div_id": "position3",
            "color": null,
            "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/003/gorgan_road.jpg?1449602459"
          }
        ],
        "comments": [
          {
            "id": 10,
            "message": "hellow comment ",
            "created_at": "2015-12-08T21:20:51.524Z",
            "updated_at": "2015-12-08T21:20:51.524Z",
            "user_id": 2,
            "username": "kaveh",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
          },
          {
            "id": 11,
            "message": "hellow comment@@@111 ",
            "created_at": "2015-12-08T21:21:08.794Z",
            "updated_at": "2015-12-08T21:21:08.794Z",
            "user_id": 2,
            "username": "kaveh",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
          }
        ]
      }
    }
  ]
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: '89a9bad1bd2a5c7e2010b29dbc31a2f'"
}

###Update

URL /posts/:id

Method PUT

Request

Path Params Type Description
id integer ​*(required)*​ the id of the post you're updating

Note

Given that there is one Post model all fields are optional except post_type. However, the front-end app can perform validation to ensure all fields relavent to a selected post type are provided.

Form Params Type Description
post_type string ​*(required)*​ the type of the post being created
image file ​*(optional)*​ should be provided if user is creating post_type image
title string ​*(optional)*​ should be provided if user is creating post_type image
status string *(optional)*​ should be provided if user is creating post_type text
url string (optional) should be provided if user is creating post_type link
description string (optional) should be provided if user is creating post_type link or image
quote string (optional) should be provided if user is creating post_type quote
tag_phrases string (optional) optional field, must return comma separated words
moodboard_css_class string (optional) must be provided if the post_type is moodboard

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "post": {
    "id": 20,
    "post_type": "moodboard",
    "moodboard_css_class": "template1",
    "title": "Travel Photo",
    "url": null,
    "description": null,
    "status": null,
    "quote": null,
    "image_thumb": "/images/thumb/missing.png",
    "image_medium": "/images/medium/missing.png",
    "image_large": "/images/large/missing.png",
    "user_id": 4,
    "username": "kiarash",
    "likes_count": 0,
    "tags": "gorgan, iran, travel, nature",
    "created_at": "2015-12-08T19:05:19.063Z",
    "updated_at": "2015-12-08T22:08:29.801Z",
    "moodpieces": [
      {
        "id": 1,
        "div_id": "position1",
        "color": null,
        "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/001/gorgan_road.jpg?1449602063"
      },
      {
        "id": 2,
        "div_id": "position1",
        "color": null,
        "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/002/gorgan_road.jpg?1449602189"
      },
      {
        "id": 3,
        "div_id": "position3",
        "color": null,
        "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/003/gorgan_road.jpg?1449602459"
      }
    ],
    "comments": [
      {
        "id": 10,
        "message": "hellow comment ",
        "created_at": "2015-12-08T21:20:51.524Z",
        "updated_at": "2015-12-08T21:20:51.524Z",
        "user_id": 2,
        "username": "kaveh",
        "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
      },
      {
        "id": 11,
        "message": "hellow comment@@@111 ",
        "created_at": "2015-12-08T21:21:08.794Z",
        "updated_at": "2015-12-08T21:21:08.794Z",
        "user_id": 2,
        "username": "kaveh",
        "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/012/yazd.jpg?1449069611"
      }
    ]
  }
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: '89a9bad1bd2a5c7e2010b29dbc31a2f'"
}

###Delete

URL /posts/:id

Method DELETE

Request

Path Params Type Description
user_id integer ​*(required)*​ the id of the user whose post you're retrieving
id integer ​*(required)*​ the id of the post you're retrieving

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "message": "My new post has been deleted."
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "message": "User Amit does not have access to this post."
}

##Comment Methods

###Create

This request will allow a user to create a comment.

URL /posts/:post_id/comments

Method POST

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post being commented on
Form Params Type Description
message string ​*(required)*​ the comment message being left

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "comment": {
    "id": 4,
    "message": "hello comment today here now!",
    "commentable_id": 5,
    "commentable_type": "Post",
    "created_at": "2015-12-06T17:05:20.597Z",
    "updated_at": "2015-12-07T16:47:42.990Z",
    "user_id": 4
  }
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "message": "User Amit does not have access to this post."
}

###Retrieve a Specific Comment

This request will allow you to retrieve a comment with its id.

URL /posts/:post_id/comments/:id

Method GET

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post being commented on
id integer ​*(required)*​ the id of the comment

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "comments": [
    {
      "id": 4,
      "message": "hello comment today here now!",
      "commentable_id": 5,
      "commentable_type": "Post",
      "created_at": "2015-12-06T17:05:20.597Z",
      "updated_at": "2015-12-07T16:47:42.990Z",
      "user_id": 4
    },
    {
      "id": 8,
      "message": "hello world",
      "commentable_id": 5,
      "commentable_type": "Post",
      "created_at": "2015-12-07T19:11:15.366Z",
      "updated_at": "2015-12-07T19:11:15.366Z",
      "user_id": 4
    },
    {
      "id": 9,
      "message": "hello world11",
      "commentable_id": 5,
      "commentable_type": "Post",
      "created_at": "2015-12-07T19:14:05.692Z",
      "updated_at": "2015-12-07T19:14:05.692Z",
      "user_id": 4
    }
  ]
}

###Retrieve Comments for a Post

This request will allow you to retrieve a comment with its id.

URL /posts/:post_id/comments

Method GET

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post being commented on

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "comments": [
    {
      "id": 4,
      "message": "hello comment today here now!",
      "commentable_id": 5,
      "commentable_type": "Post",
      "created_at": "2015-12-06T17:05:20.597Z",
      "updated_at": "2015-12-07T16:47:42.990Z",
      "user_id": 4
    },
    {
      "id": 8,
      "message": "hello world",
      "commentable_id": 5,
      "commentable_type": "Post",
      "created_at": "2015-12-07T19:11:15.366Z",
      "updated_at": "2015-12-07T19:11:15.366Z",
      "user_id": 4
    },
    {
      "id": 9,
      "message": "hello world11",
      "commentable_id": 5,
      "commentable_type": "Post",
      "created_at": "2015-12-07T19:14:05.692Z",
      "updated_at": "2015-12-07T19:14:05.692Z",
      "user_id": 4
    }
  ]
}

###Delete

URL /posts/:post_id/comments/:id

Method DELETE

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post being commented on
id integer ​*(required)*​ the id of the comment

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "message": "Comment has been deleted."
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "message": "User Amit does not have access to this comment."
}

##Like Methods

###Create

This request will allow a user to like anything likeable, eg. Post, Discussion, etc.

URL /posts/:post_id/likes

Method POST

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post being liked

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "message": "Item has been liked."
}

If unsuccessful, you will receive:

Status Code: 500 - Internal Server Error

{
  "errors": [
    "User can only like an item once."
  ]
}

###Retrieve A User's Likes

This request will allow you to retrieve all likeables of a specified type that a user has liked.

URL /users/:user_id/likes?likeable_type=post

Method GET

Request

Path Params Type Description
user_id integer ​*(required)*​ the id of the user whose likes you want
likeable_type string ​*(required)*​ the type of likeable, eg. post

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "page": "1",
  "page_count": 1,
  "likes": [
    {
      "like": {
        "id": 5,
        "post_type": "text",
        "title": "Multi words This is polymorphic by sepehr",
        "url": null,
        "description": "Hello World",
        "status": "what done happen was is that...",
        "quote": null,
        "image_thumb": "http://abstract-test.s3.amazonaws.com/posts/thumb/000/000/005/sepehr-bali.jpg?1449017810",
        "image_medium": "http://abstract-test.s3.amazonaws.com/posts/medium/000/000/005/sepehr-bali.jpg?1449017810",
        "image_large": "http://abstract-test.s3.amazonaws.com/posts/large/000/000/005/sepehr-bali.jpg?1449017810",
        "user_id": 1,
        "username": "sepehr",
        "likes_count": 1,
        "tags": "atlanta, polymorphic, multiple words phrase",
        "created_at": "2015-12-02T00:56:50.659Z",
        "updated_at": "2015-12-03T20:51:30.630Z",
        "moodboard_css_class": null,
        "moodpieces": [],
        "comments": [
          {
            "id": 4,
            "message": "hello comment today here now!",
            "created_at": "2015-12-06T17:05:20.597Z",
            "updated_at": "2015-12-07T16:47:42.990Z",
            "user_id": 4,
            "username": "kiarash",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752"
          },
          {
            "id": 8,
            "message": "hello world",
            "created_at": "2015-12-07T19:11:15.366Z",
            "updated_at": "2015-12-07T19:11:15.366Z",
            "user_id": 4,
            "username": "kiarash",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752"
          },
          {
            "id": 9,
            "message": "hello world11",
            "created_at": "2015-12-07T19:14:05.692Z",
            "updated_at": "2015-12-07T19:14:05.692Z",
            "user_id": 4,
            "username": "kiarash",
            "picture": "http://abstract-test.s3.amazonaws.com/profiles/thumb/000/000/015/Screen_Shot_2015-12-02_at_10.38.51_PM.png?1449176752"
          }
        ]
      }
    },
    {
      "like": {
        "id": 19,
        "post_type": "text",
        "title": "This is a new post by Kaveh",
        "url": null,
        "description": null,
        "status": null,
        "quote": "This post has a quote!",
        "image_thumb": "/images/thumb/missing.png",
        "image_medium": "/images/medium/missing.png",
        "image_large": "/images/large/missing.png",
        "user_id": 4,
        "username": "kiarash",
        "likes_count": 2,
        "tags": "apple, bannanaa",
        "created_at": "2015-12-08T03:32:36.962Z",
        "updated_at": "2015-12-08T03:32:36.962Z",
        "moodboard_css_class": null,
        "moodpieces": [],
        "comments": []
      }
    }
  ]
}

If unsuccessful, you will receive:

Status Code: 500 - Internal Server Error

{
  "errors": "You must provide a likeable_type path param."
}

###Delete

URL /posts/:post_id/likes

Method DELETE

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post being commented on

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "message": "Amit's like has been removed."
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "error": "Could not authenticate with token: '9dbd3e79ea32134fa2487cee2f'"
}

##Moodboard Methods

###Create

This request will allow a user to add a moodboard piece after selecting the post_type: moodboard.

URL /posts/:post_id/moodpieces

Method POST

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post that the moodpiece belongs to

Note Either color or image should be provided along with div_id.

Form Params Type Description
div_id string ​*(required)*​ the id of the div where the color or image piece should be located
color string ​*(optional)*​ the color of the moodpiece container
image file ​*(optional)*​ the image of the moodpiece container

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "moodpiece": {
    "id": 10,
    "div_id": "topright",
    "color": null,
    "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/010/1440626408_n.jpg?1449789534",
    "post_id": 20,
    "created_at": "2015-12-10T23:18:54.138Z",
    "updated_at": "2015-12-10T23:18:54.138Z"
  }
}

If unsuccessful, you will receive:

Status Code: 500 - Internal Server Error

{
  "errors": [
    "Div can't be blank"
  ]
}

###Retrieve

Moodboard retrieval is the same as retrieving a post since moodboard pieces (moodpieces) belong to and collectively form a post.

Go to Post Methods above for moodboard retrieval.

###Update

URL /posts/:post_id/moodpieces/:id

Method PUT

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post which the moodpiece belongs to
id integer (required) the id of the moodpiece to be updated

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "moodpiece": {
    "id": 10,
    "div_id": "topright",
    "color": null,
    "image": "http://abstract-test.s3.amazonaws.com/moodpieces/original/000/000/010/1440626408_n.jpg?1449789534",
    "post_id": 20,
    "created_at": "2015-12-10T23:18:54.138Z",
    "updated_at": "2015-12-10T23:18:54.138Z"
  }
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "message": "Amit does not have access to this moodpiece."
}

###Delete

URL /posts/:post_id/moodpieces/:id

Method DELETE

Request

Path Params Type Description
post_id integer ​*(required)*​ the id of the post which the moodpiece belongs to
id integer (required) the id of the moodpiece to be deleted

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "message": "Moodpiece has been removed."
}

If unsuccessful, you will receive:

Status Code: 401 - Not Authorized

{
  "message": "Amit does not have access to this moodpiece."
}

##Relationship Methods

###Create

This request will allow the current user to follow another user by creating an asymmetric active relationship.

URL /relationships

Method POST

Request

Form Params Type Description
followed_id integer ​*(required)*​ the id of the user being followed

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "message": "You are now following cori."
}

If unsuccessful, you will receive:

Status Code: 500 - Internal Server Error

{
  "errors": [
    "User can only like an item once."
  ]
}

###Delete

URL /relationships/:id

Method DELETE

Request

Path Params Type Description
id integer ​*(required)*​ the id of the relationship

Response

If successful, you will receive:

Status Code: 200 - OK

{
  "message": "You are no longer following cori."
}

If unsuccessful, you will receive:

Status Code: 404 - Not Found

o____o

About

RESTful API application I built for an online community for makers.

abstract.surge.sh/

Resources

Readme
Activity

Stars

1 star

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 90.3%
  • HTML 7.6%
  • CSS 1.1%
  • JavaScript 1.0%