Description

This is the back-end API for a fictional app "Lunch and Learn", an application that allows users to search for recipes by country, favorite recipes, and learn more about a particular country. The endpoints exposed on this API can be consumed by a team of front-end developers to build out the functionality of the app.

This app consumes four external APIs and consolidates the data to be consumed by the front end:

• Randomizing a country for the user to learn about is provided by consuming the REST Countries API
• Exploring recipes specific to a country is provided by consuming the Edamam Recipe API
• Learning resources for a particular country, including images of that country and a short history video, are provided by consuming the Unsplash API and the Youtube API

Technology Used

• Rails 5.2.6
• Ruby 2.7.4
• PostgreSQL Database
• jsonapi-serializer for API response serialization

Gems

Local Setup Directions

git clone git@github.com:sjmann2/lunch-and-learn.git

cd lunch-and-learn

bundle install

rails db:{create,migrate}

rails s

Database Schema Diagram

Endpoints Available

Base URL

http://localhost:3000/api/v1

Get recipes for a random country

GET /recipes

Example response

{
    "data": [
        {
            "id": null,
            "type": "recipe",
            "attributes": {
                "title": "Singapore Fling",
                "url": "https://food52.com/recipes/82481-singapore-fling",
                "country": "Singapore",
                "image": "https://edamam-product-images.s3.amazonaws.com..."
            }
        },
        {
            "id": null,
            "type": "recipe",
            "attributes": {
                "title": "Singapore Noodles",
                "url": "http://norecipes.com/blog/2011/11/13/singapore-noodles-recip/",
                "country": "Singapore",
                "image": "https://edamam-product-images.s3.amazonaws.com..."
            }
        }
    ]
}    

Get recipes for a specified country

GET /recipes?country=thailand

Example response

{
    "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..."
            }
        },
        {
            "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..."
            }
        }
    ]
}   

Get learning resources for a specified country

GET /learning_resources?country=thailand

Example response

{
    "data": {
        "id": null,
        "type": "learning_resource",
        "attributes": {
            "country": "thailand",
            "video": {
                "title": "THE HISTORY OF THAILAND in 10 minutes",
                "youtube_video_id": "zo1e7XUWkME"
            },
            "images": [
                {
                    "alt_tag": "standing statue and temples landmark during daytime",
                    "url": "https://images.unsplash.com/photo-1528181304800-259b08848526?ixid=MnwzNzk5ODB8MHwxfHNlYXJjaHwxfHx0aGFpbGFuZHxlbnwwfHx8fDE2Njg0NjA3Mjc&ixlib=rb-4.0.3"
                },
                {
                    "alt_tag": "five brown wooden boats",
                    "url": "https://images.unsplash.com/photo-1552465011-b4e21bf6e79a?ixid=MnwzNzk5ODB8MHwxfHNlYXJjaHwyfHx0aGFpbGFuZHxlbnwwfHx8fDE2Njg0NjA3Mjc&ixlib=rb-4.0.3"
                },
                {
                    "alt_tag": "orange temples during daytime",
                    "url": "https://images.unsplash.com/photo-1563492065599-3520f775eeed?ixid=MnwzNzk5ODB8MHwxfHNlYXJjaHwzfHx0aGFpbGFuZHxlbnwwfHx8fDE2Njg0NjA3Mjc&ixlib=rb-4.0.3"
                },
                {
                    "alt_tag": "aerial photography of body of water surrounded with mountains",
                    "url": "https://images.unsplash.com/photo-1506665531195-3566af2b4dfa?ixid=MnwzNzk5ODB8MHwxfHNlYXJjaHw0fHx0aGFpbGFuZHxlbnwwfHx8fDE2Njg0NjA3Mjc&ixlib=rb-4.0.3"
                },
                {...},
                {etc}
            ]
        }     
    }
}

Post user registration

POST /users passing in a body containing user name, email, password, password confirmation

{
  "name": "Jim Beans",
  "email": "jimmybean@yahoo.com",
  "password": "password",
  "password_confirmation": "password"
}

Example response

{
  "data": {
    "type": "user",
    "id": "1",
    "attributes": {
      "name": "Jim Beans",
      "email": "jimmybean@yahoo.com",
      "api_key": "jgn983hy48thw9begh98h4539h4"
    }
  }
}

Post user login

POST /users passing in a body containing user name and email

{
  "name": "Jim Beans",
  "email": "jimmybean@yahoo.com"
}

Example Response

{
  "data": {
    "type": "user",
    "id": "1",
    "attributes": {
      "name": "Jim Beans",
      "email": "jimmybean@yahoo.com",
      "api_key": "jgn983hy48thw9begh98h4539h4"
    }
  }
}

Post favorite recipes for a user

POST /favorites passing in a body containing api key specific to the user, country, recipe link and recipe name

{
    "api_key": "jgn983hy48thw9begh98h4539h4",
    "country": "thailand",
    "recipe_link": "https://www.tastingtable.com/.....",
    "recipe_title": "Crab Fried Rice (Khaao Pad Bpu)"
}

Example response

{
    "success": "Favorite added successfully"
}

Get a user's favorites

GET /favorites passing in a body containing api key specific to the user

{
    "api_key": "jgn983hy48thw9begh98h4539h4"
}

Example response

{
    "data": [
        {
            "id": "1",
            "type": "favorite",
            "attributes": {
                "recipe_title": "Recipe: Egyptian Tomato Soup",
                "recipe_link": "http://www.thekitchn.com/recipe-egyptian-tomato-soup-weeknight....",
                "country": "egypt",
                "created_at": "2022-11-02T02:17:54.111Z"
            }
        },
        {
            "id": "2",
            "type": "favorite",
            "attributes": {
                "recipe_title": "Crab Fried Rice (Khaao Pad Bpu)",
                "recipe_link": "https://www.tastingtable.com/.....",
                "country": "thailand",
                "created_at": "2022-11-07T03:44:08.917Z"
            }
        }
    ]
 }    

Delete a user's favorite

DELETE /favorites passing in a body containing api key specific to the user and the favorite id

{
    "api_key": "jgn983hy48thw9begh98h4539h4",
    "favorite_id": 2
}