Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Michelle - Edges - API-Muncher #31

Open
wants to merge 32 commits into
base: master
Choose a base branch
from
Open

Conversation

kangazoom
Copy link

@kangazoom kangazoom commented Nov 5, 2018

API Muncher

Congratulations! You're submitting your assignment!

Comprehension Questions

Question Answer
How did you go about exploring the Edamam API, and how did you try querying the API? I heavily relied on Postman for these stages. I also consulted the documentation.
What is an API Wrapper? Why is it in lib? How would your project change if you needed to interact with more than one API (aka more than just the Edamam API)? An API wrapper interfaces between the API-provider endpoint and my controller. It is in 'lib' because it is not associated with the controller or model. If I needed to interact with more than one API, I'd need to create multiple API wrappers.
Describe your API wrapper, the methods you created in it, and why you decided to create those methods/how they were helpful My API wrapper can grab (up to 100) queries based on a search term. It can also show a single recipe based on a unique identifier. A third method passes takes the API hash as input and creates an instance or instances of Recipe.
What was an edge case or failure case test you wrote for your API Wrapper? What was a nominal case? A nominal case includes returning a single recipe instance using valid unique identifier input. An edge case includes returning an error message when trying to enter an invalid unique identifier as an address. I definitely could have thought of more edge cases (like maybe a blank input for the search).
How does VCR aid in testing an API? It 'records' the API data as fixtures the first time you run it. Moving forward, you won't need to make potentially-costly API calls as it's all been stored for you.
What is the Heroku URL of your deployed application? http://mc-muncher.herokuapp.com/

@Hamled
Copy link

Hamled commented Nov 15, 2018

API Muncher

What We're Looking For

Feature Feedback
Core Requirements
Git hygiene
Comprehension questions
General
Rails fundamentals (RESTful routing, use of named paths)
Semantic HTML
Errors are reported to the user
API Wrapper to handle the API requests
Controller testing
Lib testing
Search Functionality
List Functionality
Show individual item functionality
Styling
List view shows 10 items at a time and/or has pagination
Attractive and usable UI
API Features
The App attributes Edamam
The VCR cassettes do not contain the API key
External Resources
Link to deployed app on Heroku
Overall Looks great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants