hyperoslo / hyper-recipes

Introduction

This is the backend for the Hyper Recipes app. To be able to use it, you will need an access token that your contact inside Hyper will provide you with when you begin your quest. This is helpful so other applicants don't modify your recipes in any way.

The base HTTP endpoints is: http://hyper-recipes.herokuapp.com

Retrieve recipes

GET: /recipes

Sample:

[
  {
    "id": 437,
    "name": "Strawberries and Cream Cake",
    "description": "Makes an elegant presentation without too much fuss.",
    "instructions": "eee",
    "favorite": false,
    "difficulty": 3,
    "created_at": "2014-09-29T10:43:00.072Z",
    "updated_at": "2014-11-26T11:53:58.451Z",
    "photo": {
      "url": "https://hyper-recipes.s3.amazonaws.com/uploads/recipe/photo/437/Strawberries_and_Cream_Cake.jpg",
      "thumbnail_url": "https://hyper-recipes.s3.amazonaws.com/uploads/recipe/photo/437/thumbnail_Strawberries_and_Cream_Cake.jpg"
    }
  }
]

In Curl it would be something like that:

curl -H 'Authorization: Token token="replace-with-token"' http://hyper-recipes.herokuapp.com/recipes

Create recipes

POST: /recipes

• name:string (obligatory field)
• difficulty:integer (obligatory field) [Valid values: 1, 2 and 3]
• description:text
• instructions:text
• favorite:boolean
• recipe[photo]:image == Multipart form request

Sample:

{
  "recipe": {
    "name": "New name",
    "difficulty": 1
  }
}

In Curl it would be something like that:

curl -H 'Authorization: Token token="2e3e72bbbcfd13eb27f4"' -d "recipe[name]=Meatballs" -d "recipe[difficulty]=1" http://hyper-recipes.herokuapp.com/recipes

Update recipes

PUT or PATCH: /recipes/:id

• name:string (obligatory field)
• difficulty:integer (obligatory field) [Valid values: 1, 2 and 3]
• description:text
• instructions:text
• favorite:boolean
• recipe[photo]:image == Multipart form request

Sample:

{
  "recipe": {
    "name": "New name",
    "difficulty": 1
  }
}

In Curl it would be something like that:

curl -H 'Authorization: Token token="0b71145b7474d575632b"' -d "recipe[name]=Meatballzz" -d "recipe[difficulty]=2" -X PUT http://hyper-recipes.herokuapp.com/recipes/22

Delete recipes

DELETE: /recipes/:id In Curl it would be something like that:

curl -H 'Authorization: Token token="0b71145b7474d575632b"' -X DELETE http://hyper-recipes.herokuapp.com/recipes/22

hyper-recipes's Issues

Add Travis

Check access rights for recipe 14

The images for recipe 14
full
thumb
give Access Denied error. Please fix :)

Simplify thumbnail JSON structure

Should something like this be better?

photo: {
  "url": "https://hyper-recipes.s3.amazonaws.com/uploads/recipe/photo/11/PeachCobbler.jpg",
  "thumbnail_url": "https://hyper-recipes.s3.amazonaws.com/uploads/recipe/photo/11/thumbnail_PeachCobbler.jpg"
}

Current is:

photo: {
  "url": "https://hyper-recipes.s3.amazonaws.com/uploads/recipe/photo/11/PeachCobbler.jpg",
  "thumbnail": {
    "url": "https://hyper-recipes.s3.amazonaws.com/uploads/recipe/photo/11/thumbnail_PeachCobbler.jpg"
  }
}

Should instructions be an array instead?

Or maybe have an array with ingredients?
"ingredients": [ "4 apples", "3 diamonds", "a pinch of thyme"]
or
"ingredients": [{"name": "apples", "amount" : "4"}, {"name" : "diamonds", "amount" : "3"}, {"name" : "thyme", "amount" : "a pinch of"}]

Have a field for time

We should have a field for how much time each recipe would take, in minutes. Like
time: 45

Normalize string literal quoting

According to Ruby style guide: https://github.com/bbatsov/ruby-style-guide#strings

Spec and test directories

Are we using RSpec, MiniTest or Test::Unit on this project?

Login Endpoint

Hi,
There is a API for user registration but I don't see any end point for user login. :)
Thanks :)

Isolate the data set

A lot of applicants use this API in their applications, which means that things could randomly change. One applicant might delete all of the recipes, for example, and somewhere else in the world another might wonder why his application suddenly "stopped working".

It would be pretty neat if applicants could work on their own isolated data set somehow. We might accomplish that with a prefix to the path (like hyper-recipes.herokuapp.com/jgorset/recipes), or perhaps a header of some sort (like X-Namespace: jgorset) — or maybe something else entirely!

The user creation not working!

Hi,
The user creation API http://hyper-recipes.herokuapp.com is still not working.