SandyyMarie / lunch_and_learn

Repository for Lunch and Learn

Instructions for Assignment

Table of Contents

1. Architecture and Design
2. End Points

• Recipe End Point
  • Index
• Learning Resources End Point
  • Index -Users End Point
  • Create
• Favorites End Points
  • Create
  • Index

3. Local Setup
4. Versions

Architecture and Design

End Points:

Recipe End Point

Recipe Index

Returns the top recipes for a given country.

GET /api/v1/recipes?country={country}

• if you don't send in a country param, a random Country will be chosen for you.

Example Input:

GET http://localhost:3000/api/v1/recipes?country=Peru

Example Output:

{
    "data": [
        {
            "id": null,
            "type": "recipe",
            "attributes": {
                "title": "Arriba Peru",
                "url": "http://www.myrecipes.com/recipe/arriba-peru",
                "country": "Peru",
                "image": "https://edamam-product-images.s3.amazonaws.com/web-img/94a/...."
            }
        }
    ]
}

Learning Resources End Point

Learning Resources Index

Returns a informational video link and related images to the given search country.

GET /api/v1/learning_resources?country={country}

Example Input:

GET http://localhost:3000/api/v1/learning_resources?country=laos

Example Output:

{
    "data": {
        "id": null,
        "type": "learning_resources",
        "attributes": {
            "country": "laos",
            "video": {
                "title": "Vietnam War | The 20th century | World history | Khan Academy",
                "youtube_video_id": "9e9GWdT2pEQ"
            },
            "images": [
                {
                    "alt_tag": "time lapse photography of flying hot air balloon",
                    "url": "https://images.unsplash.com/photo-1540611025311-01df3cef54b5?ixid=MnwzODExMzJ8MHwxfHNlYXJjaHwxfHxsYW9zfGVufDB8fHx8MTY2ODU5NTA4OA&ixlib=rb-4.0.3"
                },
                {
                    "alt_tag": "aerial view of city at daytime",
                    "url": "https://images.unsplash.com/photo-1570366583862-f91883984fde?ixid=MnwzODExMzJ8MHwxfHNlYXJjaHwyfHxsYW9zfGVufDB8fHx8MTY2ODU5NTA4OA&ixlib=rb-4.0.3"
                },
				...
            ]
        }
    }
}

Users End Point

Users Create

Creates a new user if the given email isn't already taken, auto generates a fake API key per user'

POST /api/v1/users

• add name and email in the body of the request

Example Input: POST http://localhost:3000/api/v1/users

{
  "name": "Joe Bob",
  "email": "[e-mail]"
}

Example Output:

{
    "data": {
        "id": "1",
        "type": "user",
        "attributes": {
            "name": "Joe Bob",
            "email": "[e-mail]",
            "api_key": "T43jXp1MqG"
        }
    }
}

Favorites End Points

Favorites Create

Adds the given recipe to a given users favorites.

POST /api/v1/favorites

Example Input:

POST http://localhost:3000/api/v1/favorites

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

Example Output:

{
    "success": "Favorite added successfully"
}

Favorites Index

Lets you see all the favoites of a given user.

GET /api/v1/favorites

Example Input:

PUT http://localhost:3000/api/v1/favorites

{
    "api_key": "jgn983hy48thw9begh98h4539h4"
}

Example Output:

{
    "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-16T13:20:15.475Z"
            }
        },
        {
            "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-16T13:20:15.478Z"
            }
        }
    ]
}

Local Setup

• Fork this repository
• Clone your fork
• From the command line, install gems and set up your DB:
  • bundle
  • rails db:{drop,create,migrate,seed}
  • bundle exec figaro install
• Add your API keys within the application.yaml file in config.
• Run the test suite with bundle exec rspec.
• Run your development server with rails s to see the app in action.

Versions

• Ruby 2.7.4

• Rails 5.2.8

Back To Top