Eat and Educate

A rails back-end REST API. Eat and Educate allows a front-end app to find recipes from a country, and combine them with informative videos and images from that country. Also implements secure registration so users can favorite recipes. Created in a five day sprint.

Created with Rails 5.2.8

Reach out to me on Linkedin or Github

Table of contents

• Database setup
• Endpoints
  • Get recipes from a country
  • Get learning resources from a country
  • Register a new user
  • User login
  • User logout
  • Add a new favorite recipe
  • Get a user's favorites
  • Delete a user's favorites

Database Setup

Fork and clone the project, then install the required gems with bundle.

bundle install

Reset and seed the database:

rake db:{drop,create,migrate,seed}

You will need to create API keys to run this back-end server. You will need the following keys:

• Edamam
• Youtube Data API
• Unsplash
• Geoapify Places

Once you have your keys, set up your environment with

bundle exec figaro install

Then add your keys to config/application.yml:

RECIPE_KEY: <YOUR_EDAMAM_KEY>

VIDEO_KEY: <YOUR_YOUTUBE_KEY>

IMAGE_KEY: <YOUR_UNSPLASH_KEY>

PLACES_KEY: <YOUR_PLACES_KEY>

Start a rails server, and you're ready to query

rails s

Endpoints

GET /api/v1/recipes

Back to top

Gets recipes from a single country.

Parameter	Description	Parameter type	Data type
country	Optional - specify a country	query	String

If no country parameter is included, recipes for a random country will be returned

Sample response (status 200)

{
   "data": [
       {
           "id": null,
           "type": "recipe",
           "attributes": {
               "title": "Andy Ricker's Naam Cheuam Naam Taan Piip (Palm Sugar Simple Syrup)",
               "url": "https://www.seriouseats.com/recipes/2013/11/andy-rickers-naam-cheuam-naam-taan-piip-palm-sugar-simple-syrup.html",
               "country": "thailand",
               "image": "https://edamam-product-images.s3.amazonaws.com/web-img/611/611..."
           }
       },
       {
           "id": null,
           "type": "recipe",
           "attributes": {
               "title": "THAI COCONUT CREMES",
               "url": "https://food52.com/recipes/37220-thai-coconut-cremes",
               "country": "thailand",
               "image": "https://edamam-product-images.s3.amazonaws.com/web-img/8cd/8c..."
           }
       },
       {
           "id": null,
           "type": "recipe",
           "attributes": {
               "title": "Sriracha",
               "url": "http://www.jamieoliver.com/recipes/vegetables-recipes/sriracha/",
               "country": "thailand",
               "image": "https://edamam-product-images.s3.amazonaws.com/web-img/cb5..."
           }
       }
   ]
}

---

GET /api/v1/learning_resources

Back to top

Gets learning resources from a single country.

Parameter	Description	Parameter type	Data type
country	Country to get resources for	query	String

Sample response (status 200)

{
   "data": {
       "id": null,
       "type": "learning_resource",
       "attributes": {
           "country": "laos",
           "video": {
               "title": "A Super Quick History of Laos",
               "youtube_video_id": "uw8hjVqxMXw"
           },
           "images": [
               {
                   "alt_tag": "time lapse photography of flying hot air balloon",
                   "url": "https://images.unsplash.com/photo-154..."
               },
               {
                   "alt_tag": "aerial view of city at daytime",
                   "url": "https://images.unsplash.com/photo-157..."
               }
           ]
       }
   }
}

---

POST /api/v1/users

Back to top

Register a new user. For this endpoint, all parameters are required.

Parameter	Description	Parameter type	Data type
name	User name	body	String
email	User email must be unique	body	String
password	Secure password required	body	String
password_confirmation	Must match password	body	String

Sample response (status 201)

{
   "data": {
       "id": "3",
       "type": "user",
       "attributes": {
           "name": "Athena Dao",
           "email": "[email protected]",
           "api_key": "58ec6581e4ce87b5b154332c7bbd6b1c"
       }
   }
}

---

POST /api/v1/sessions

Back to top

User login. For this endpoint, all parameters are required.

Parameter	Description	Parameter type	Data type
email	User email	body	String
password	User password	body	String

Sample response (status 201)

{
   "data": {
       "id": "3",
       "type": "user",
       "attributes": {
           "name": "Athena Dao",
           "email": "[email protected]",
           "api_key": "58ec6581e4ce87b5b154332c7bbd6b1c"
       }
   }
}

---

DELETE /api/v1/sessions

Back to top

Logs a user out/ ends their session.

A successful response will return return a 204 No Content status code.

---

POST /api/v1/favorites

Back to top

Add a new favorite recipe. For this endpoint, all parameters are required.

Parameter	Description	Parameter type	Data type
country	Country of origin	body	String
recipe_link	Link to recipe	body	String
recipe_title	Secure password required	body	String
api_key	Must match a user's API key	body	String

Sample response (status 201)

{
   "success": "Favorite added successfully"
}

---

GET /api/v1/favorites

Back to top

Get a user's favorites

Parameter	Description	Parameter type	Data type
api_key	Must match a user's API key	query	String

Sample response (status 200)

{
   "data": [
       {
           "id": "1",
           "type": "favorite",
           "attributes": {
               "recipe_title": "recipe title",
               "recipe_link": "recipe url",
               "country": "Benin",
               "created_at": "2022-11-15T17:44:49.306Z"
           }
       },
       {
           "id": "2",
           "type": "favorite",
           "attributes": {
               "recipe_title": "another_url",
               "recipe_link": "some_url",
               "country": "France",
               "created_at": "2022-11-15T21:54:59.105Z"
           }
       }
   ]
}

---

DELETE /api/v1/favorites

Back to top

Delete one of the user's favorited recipes.

Parameter	Description	Parameter type	Data type
api_key	User's API key	query	String
id	The primary key of the favorite to be deleted	query	Integer

A successful response will return return a 204 No Content status code.