samjo's recipe-muncher

[sjlee3157]

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 used curl and Postman to help me explore the API.
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)?	The API Wrapper limits the interface of the Edamam API and my app in order to isolate dependency. I think it's in lib because it's not part of the Rails MVC architecture. My app does interact with more than one API if you count OAuth strategies and the Google People API. Omniauth is doing most of the "wrapper" work for me, but if it wasn't, I would be creating another wrapper class and figuring out how to parse the JSON/XML responses.
Describe your API wrapper, the methods you created in it, and why you decided to create those methods/how they were helpful	I created these methods: self.list_recipes, self.get_recipe, self.list_tags, and the self.build_recipe factory method. The methods were necessitated by the structure of the Edamam API, which just happens to accept GET requests formatted in specific ways that I addressed in my methods.
What was an edge case or failure case test you wrote for your API Wrapper? What was a nominal case?	Edge: trying to "get" a result from Edamam API with a bogus recipe id. Nominal: trying to get a result with a valid recipe id.
How does VCR aid in testing an API?	VCR records and plays back API calls which is useful because API calls are often limited, expensive, and unreliable!
What is the Heroku URL of your deployed application?	https://hello-munchy.herokuapp.com

Trello: https://trello.com/b/HL0gtltd/sj-api-muncher
See Trello for what remains to be done. I'm not finished with testing, but a lot of what's left is testing that I've practiced with MR-R and bEtsy. While TDD is a good practice, for this project I decided to prioritize learning new skills, like OAuth Google and filtering search results.

[dHelmgren]

API Muncher

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene	yes
Comprehension questions	good
General
Rails fundamentals (RESTful routing, use of named paths)	Yes!
Semantic HTML	That Index page has a lotta divs.
Errors are reported to the user	Mostly see comment on Index testing.
API Wrapper to handle the API requests	yes
Controller testing	Pretty good see comments
Lib testing	good!
Search Functionality	yes
List Functionality	yes
Show individual item functionality	yes
Styling
List view shows 10 items at a time and/or has pagination	yes
Attractive and usable UI	so so. I think the flippy recipe cards are great, I had a hard time spotting your search bar.
API Features
The App attributes Edamam	You need to attribute it on every page. This is really important! When you're designing code for money, using someone else's work without attribution is a good way to end up in legal trouble.
The VCR cassettes do not contain the API key	yes!
External Resources
Link to deployed app on Heroku	Yes
Overall	This is a good showing! You hit the learning goals very well, just make sure that your Attributions are complete in the future.

[dHelmgren]

Nice work setting these with resources

[dHelmgren]

I would say you're over-validating here. In general, you should only validate fields that will cause your app to break if they're not there. In this case, that's label, uri and possibly image. Anything beyond that is an unnecessary dependency on the data coming from the API and is an extra thing for you to test.

[dHelmgren]

yay!

[dHelmgren]

There are some interesting cases you're not covering here:

• What happens if no search term is provided?
• What if the search returns no results?

It might also be worthwhile to add some tests around the paging parameters:

• What happens if they're absent?
• Do you get different results when they change?
• What if you send a bogus value, like a negative page number?

Just FYI, Your pagination breaks if I give it a negative page.