This API accomplishes several learning goals involving API exposure. They are as follows:
- To build understanding of and demonstrate ability to expose a variety of API endpoints for use by front end developers
- To use basic authentication
- To create endpoints that call for authentication tokens
- To expose endpoints for CRUD functionality
- To plan and complete an API to suit the needs of other developers
- To synthesize several external APIs to create yet another API
- To use TDD and a mocking tool to achieve all of the above
- Fork this repository and clone it to your local machine in the directory it belongs.
cdinto the directory and runbundle installfrom the command line.- To set up the database run:
rails db:{drop,create,migrate,seed}
- Before you proceed, you'll need API keys for the various external APIs this API consumes.
- Unsplash
- YouTube
- Lunch and Learn uses the search list endpoint
- Edamam
- Make sure you get an API key for the "Recipe Search" application. There are several.
- Rest Countries
- You'll find documentation here, but you won't need an API key.
- Lunch and learn uses the figaro gem to secure api keys. To set up figaro run this:
bundle exec figaro install
If this throws an error, don't fret. It's likely that this was unsuccessful in adding the yml file it created to your .gitignore file. Just verify that in your config directory you now have an application.yml file. If so, verify that your .gitignore file includes /config/application.yml, and add it if necessary. You're good to go.
In your application.yml file, you'll need to add your api keys as follows:
app_id: <Edamam app id>
app_key: <Edamam app key>
youtube_key: <YouTube API key>
unsplash_access_key: <Unsplash access key>
unsplash_secret_key: <Unsplash secret key>
- The first time you run the test suite with
bundle exec rspec, VCR will record the API calls for replay later. There are two API endpoint usages that rely on randomized data. The tests for those are stubbed using WebMock
In order to hit the endpoints Lunch and Learn exposes, you'll need to spin up a server for it somewhere. It's not currently hosted anywhere. As such, only the URIs for the endpoints are listed. The endpoints for this API are as follows:
GET /api/v1/recipes?country={country}
This endpoint returns JSON for a collection of recipes from the country searched:
{
"data": [
{
"id": "null",
"type": "recipe",
"attributes": {
"url": "http://honestcooking.com/easter-in-croatia-and-traditional-easter-cake/",
"title": "Easter in Croatia and traditional Easter cake",
"country": "Croatia",
"image": <image url>
}
},
{
"id": "null",
"type": "recipe",
"attributes": {
"url": "https://www.epicurious.com/recipes/food/views/stuffed-red-bell-peppers-106226",
"title": "Stuffed Red Bell Peppers",
"country": "Croatia",
"image": <image url>
}
},
{
"id": "null",
"type": "recipe",
"attributes": {
"url": "http://www.jamieoliver.com/recipes/rice-recipes/croatian-style-cuttlefish-risotto/",
"title": "Croatian-style cuttlefish risotto",
"country": "Croatia",
"image": <image url>
}
}
...
]
}
GET /api/v1/recipes
If no country is passed in, a collection of recipes from an arbitrary country will be returned in the same format as above.
GET api/v1/learning_resources?country={country}
This endpoint returns JSON for a learning resource that includes a video and images for the country searched thus:
{
"data": {
"id": null,
"type": "learning_resource",
"attributes": {
"country": "jordan",
"video": {
"title": "A Super Quick History of Jordan",
"youtube_video_id": "PHrjmg1sYlM"
},
"images": [
{
"alt_tag": "Petra - Instagram @filippo_cesarini; brown concrete building during daytime",
"url": <image url>
},
{
"alt_tag": "The ruined city of Jerash is Jordan's largest and most interesting Roman site, and a major tourist draw card. Its imposing ceremonial gates, colonnaded avenues, temples and theaters all speak to the time when this was an important imperial center.; brown concrete building under blue sky during daytime",
"url": <image url>
}
...
]
}
}
}
GET api/v1/learning_resources
If no country is specified, a learning resource from a country chosen at random will be returned likewise.
POST /api/v1/users
To register a new user the following info must be passed in the request body as a JSON payload:
{
"name": <name>,
"email": <email>,
"password": <password>,
"password_confirmation": <password confirmation>
}
Successful user creation returns the following:
{
"data": {
"id": <id>,
"type": "user",
"attributes": {
"name": <name>,
"email": <email>,
"api_key": <API key>
}
}
}
POST /api/v1/sessions
To begin a new user session the following info must be passed in the request body as a JSON payload:
{
"email": <valid email>
"password": <valid password>
}
A successful request returns the following user information:
{
"data": {
"id": <id>,
"type": "user",
"attributes": {
"name": <name>,
"email": <email>,
"api_key": <API key>
}
}
}
POST /api/v1/favorites
To add a favorite recipe to a user's collection of favorite recipes the following info must be passed in the request body as a JSON payload:
{
"api_key": <API key>,
"country": <country>,
"recipe_link": <recipe link>,
"recipe_title": <recipe title>
}
Successful favorite addition returns this success message:
{
"success": "Favorite added successfully."
}
GET /api/v1/favorites?api_key={API key}
For this endpoint, API keys are sent as query parameters. Successfully hitting this endpoint returns a collection of all the favorites of the user to whom the api key belongs thus:
{
"data": [
{
"id": "1",
"type": "favorite",
"attributes": {
"recipe_link": <recipe link>,
"recipe_title": <recipe title>,
"country": <country>,
"created_at": <timestamp>
}
},
{
"id": "2",
"type": "favorite",
"attributes": {
"recipe_link": <recipe link>,
"recipe_title": <recipe title>,
"country": <country>,
"created_at": <timestamp>
}
},
{
"id": "3",
"type": "favorite",
"attributes": {
"recipe_link": <recipe link>,
"recipe_title": <recipe title>,
"country": <country>,
"created_at": <timestamp>
}
}
]
}