Pipes - angela - api muncher by awilson2017 · Pull Request #26 · Ada-C8/api-muncher

awilson2017 · 2017-11-06T09:10:44Z

API Muncher

Congratulations! You're submitting your assignment!

Comprehension Questions

Question	Answer
How did you go about exploring the Edamam API, how did you try querying the API?	I used Edamam docs to figure out the structure of the API call and then Postman to parse the JSON
Describe your API Wrapper. How did you decide on the methods you created?	The wrapper has methods list the recipes and then find a recipe. These allow for one location that parses the JSON in case data structure changes in the future we can just change it in one place. How I decided, I looked at the Edamam docs and saw there were two applicable queries (q= and r=) and build the methods based on that. In addition I used slack-api as an example.
Describe an edge case or failure case test you wrote for your API Wrapper.	I gave the url a bogus API token and raised an ApiError when the request failed.
Explain how VCR aids in testing an API.	It records the JSON data in a yml file. By recording it we can use it instead of making costly API calls for each test run.
What is the Heroku URL of your deployed application?	https://fathomless-hollows-55266.herokuapp.com/

… Recipe class. still working on associated tests.

…that 10

… instances

…n controller from command line.

…links to recipe details, view incomplete.

…mbol is not permitted

…uting error.

…r name

droberts-sea · 2017-11-08T22:48:41Z

API Muncher

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene	yes
Comprehension questions	yes
General
Rails fundamentals (RESTful routing, use of named paths)	yes
Semantic HTML	yes
Errors are reported to the user	some - You've got the `flash` reporting section in `application.html.erb` set up nicely, but I was not able to get it to actually display a message for me. Make sure you're detecting error cases accurately, and actually reporting problems to the user.
API Wrapper to handle the API requests	yes
Controller testing	Good start, especially around show, but there's still some pieces missing here. See inline.
Lib testing	yes
Search Functionality	yes
List Functionality	yes
Show individual item functionality (link to original recipe opens in new tab)	yes
Styling
Foundation Styling for responsive layout	yes
List View shows 10 items at a time/pagination	yes
The app is styled to create an attractive user interface	yes
API Features
The App attributes Edaman	yes
The VCR casettes do not contain the API key	yes
External Resources
Link to Trello Board	yes
Link to deployed app on Heroku	yes
Overall	Good job overall! It seems like you've got a solid grasp on the core learning goals for this assignment. One area worth focusing on going forward is error handling, and making sure that errors are plumbed all the way from the source (in this case an API call) to being displayed to a user. There were a few cases where there was a disconnect, and valuable information ended up being lost. Fixing this means knowing whether a method throws an exception, returns a sentinel value like `nil`, or returns something like an empty array, and being able to handle it appropriately wherever the method is called. This sort of information also manifests when coming up with test cases, which is a big portion of why we study testing in this course. Other than that I'm pretty happy with this submission. Keep up the hard work!

droberts-sea · 2017-11-08T21:06:22Z

app/controllers/recipes_controller.rb

+  def index
+    @query = params[:search]
+
+    if params[:search]


Because the empty string is truthy in Ruby, even if you search for nothing you won't end up in the error handling here. Instead, you might have something like if params[:search] && params[:search] != "".

droberts-sea · 2017-11-08T21:13:17Z

app/controllers/recipes_controller.rb

+
+  def new
+
+  end


I don't think the new action is used in your app.

droberts-sea · 2017-11-08T21:15:21Z

app/controllers/recipes_controller.rb

+
+    unless @recipe
+      head :not_found
+    end


I like this idea, but I do not believe the code will ever get here. Your API wrapper throws an error if the recipe is not found, but here you check for a nil response. You have two options to make the connection:

Use a begin/rescue block here to catch the exception

Instead of throwing an error, return nil from ApiWrapper.find_recipe if the recipe can't be found.

droberts-sea · 2017-11-08T21:18:48Z

lib/api_wrapper.rb

+
+
+    # parse the JSON data in order to get recipe details for the show page
+    if data.empty?


It looks like you're missing a call to check_status here. If the API returns an error like not_authed (as opposed to no results), as is this method won't be able to detect it.

droberts-sea · 2017-11-08T21:27:21Z

test/controllers/recipes_controller_test.rb

+      #    #
+       #
+      #    get recipe_path params: { search: "chicken", url: "http://www.edamam.com/ontologies/edamam.owl%23recipe_637913ec61d9da69eb451818c3293df2" + "fake-url"}
+      #    must_respond_with :not_found


I think this test is failing because the controller action is handling the error incorrectly. See comments above.

droberts-sea · 2017-11-08T21:28:17Z

test/lib/api_wrapper_test.rb

+      begin # something which might raise an exception
+        origin_token = ApiWrapper::TOKEN
+        ApiWrapper::TOKEN = "bogus_token"
+        VCR.use_cassette("recipes") do


I like this way of testing an invalid token - much simpler than what we did in class.

awilson2017 added 30 commits October 31, 2017 14:46

made new rails project and got api token.

c7448dd

add routes and api-wrapper functionaloty

7e56d00

generate controller recipes and both recipes index and show views.

4766262

start writing api wrapper tests. tests are incomplete

4c2b583

work on hiding sensitive data like app id and token

8c76f93

build Recipe class and Recipe#initialize

f4d2636

write ApiWrapper#check_status and associated test.

12c8dd0

save APiWrapper.rb file

09ba296

decide to make original_url, ingredients, and dietLabels required for…

88478ec

… Recipe class. still working on associated tests.

write Recipe class tracks required parameters test and all code passes.

85f05dc

write Recipe class tracks optional parameters test and all code passes.

4570fac

notice the api call returns 10 results added code to bring back more …

074411f

…that 10

add ApiWrapper#list_recipe test to check contents of array are Recipe…

de6e1f8

… instances

generate a main controller for a main index page

4d2b65c

add foundation and make search form for home page

9f17cdb

add ApiWrapper#find_recipe, it still needs tests.

e9d375f

write test for ApiWrapper#list_recipes eg No recipes = []

a998d87

write ApiWrapper#find_recipe bogus uri test and pass

fd49bad

write ApiWrapper#find_recipe valid uri test and it passes.

346ebb3

made home page part of recipes contoller, route made, and destroy mai…

d43ab0d

…n controller from command line.

got search form to work

9005030

recipe Index view: add recipes to page with picture and recipe title …

11507b5

…links to recipe details, view incomplete.

add pagination functionality, success (exclamation point since the sy…

6efbd74

…mbol is not permitted

working on displaying the recipe show page. not working because of ro…

da8ff4e

…uting error.

got routing to recipe show page to work

4c75cc7

styling to website

30ffb77

write test for recipe controller

787b189

working on heroku deployment

3f18977

change controller require_dependency path name to match my api wrappe…

720d111

…r name

make source link open in new tab

594babc

droberts-sea reviewed Nov 8, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pipes - angela - api muncher#26

Pipes - angela - api muncher#26
awilson2017 wants to merge 30 commits intoAda-C8:masterfrom
awilson2017:master

awilson2017 commented Nov 6, 2017 •

edited

Loading

Uh oh!

droberts-sea commented Nov 8, 2017

Uh oh!

droberts-sea Nov 8, 2017

Uh oh!

droberts-sea Nov 8, 2017

Uh oh!

droberts-sea Nov 8, 2017

Uh oh!

droberts-sea Nov 8, 2017

Uh oh!

droberts-sea Nov 8, 2017

Uh oh!

droberts-sea Nov 8, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants



		# parse the JSON data in order to get recipe details for the show page
		if data.empty?

Conversation

awilson2017 commented Nov 6, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Muncher

Comprehension Questions

Uh oh!

droberts-sea commented Nov 8, 2017

API Muncher

What We're Looking For

Uh oh!

droberts-sea Nov 8, 2017

Choose a reason for hiding this comment

Uh oh!

droberts-sea Nov 8, 2017

Choose a reason for hiding this comment

Uh oh!

droberts-sea Nov 8, 2017

Choose a reason for hiding this comment

Uh oh!

droberts-sea Nov 8, 2017

Choose a reason for hiding this comment

Uh oh!

droberts-sea Nov 8, 2017

Choose a reason for hiding this comment

Uh oh!

droberts-sea Nov 8, 2017

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

awilson2017 commented Nov 6, 2017 •

edited

Loading