Ampers: Nora Peters by npeters5 · Pull Request #32 · Ada-C9/api-muncher

npeters5 · 2018-05-07T08:10:52Z

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 read the API docs carefully and tested out a few different requests (q vs. r params) using Postman.
Describe your API Wrapper. How did you decide on the methods you created?	I created two methods in my RecipeApiWrapper: self.find_recipes to use the 'q' parameter based on user's search terms, to populate index view; and self.get_recipe to make another api request using the 'r' query parameter to look up a specific recipe based on the object's URI, and returning a new Recipe object to display in the show view.
Describe an edge case or failure case test you wrote for your API Wrapper.	I wrote a test to check that find_recipes returned an empty array if there was no match for the search terms provided.
Explain how VCR aids in testing an API.	Calls to APIs can be expensive, and if the API is down, we're down. VCR helps reduce this external dependency when testing.
What is the Heroku URL of your deployed application?	https://api-nosher.herokuapp.com/
Provide a link to the Trello board you used	https://trello.com/b/VyU1uMaR/api-muncher-nora

NOTE: I keep getting the error: "uninitialized constant Minitest::Rails::TestUnit (NameError)". I tried all of the things mentioned in Slack and tried troubleshooting a bunch on my own, but I still can't get my tests to run.

…ch terms

…oning of this app but casually left out by Rails...cool.

…adds get_recipe method for search#show

CheezItMan · 2018-05-09T20:53:51Z

API Muncher

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene	Good number of commits and good commit messages
Comprehension questions	Check,
General
Rails fundamentals (RESTful routing, use of named paths)	Check, but it would be better if the search results went to the path `/search`
Semantic HTML	Check
Errors are reported to the user	No errors reported when there are no search results. The show page does show a message when the URI is wrong.
API Wrapper to handle the API requests	Check
Controller testing	Lot of issues with controller testing, for one thing you're making calls to the wrapper instead of just using the controller in these tests. You shouldn't be accessing the wrapper directly here. See my inline notes.
Lib testing	Lots of problems here. See my inline notes.
Search Functionality	Check
List Functionality	Check
Show individual item functionality (link to original recipe opens in new tab)	Check
Styling
Responsive layout	Responsive both on the index and show pages.
List View shows 10 items at a time/pagination	Check
The app is styled to create an attractive user interface
API Features
The App attributes Edaman	MISSING
The VCR cassettes do not contain the API key	Check
External Resources
Link to Trello Board	Check
Link to deployed app on Heroku	Check
Overall	You did well with the API, but you have some serious problems with your testing. Please review my notes and let me know where I can clarify. You won't have any more opportunities for Rails testing and like you to take some time and see if you can see where you went wrong and how to do the testing properly. I'm happy to go through it with you if needed. You hit the API goals for the project, and had trouble with the testing, but you did well with the most visible portions of the project. I hope you enjoyed Rails and learn to love JavaScript starting next week!

CheezItMan

The most obvious thing is you missed the "monkey" patch which we had to include from the SlackAPi project. That might explain your testing problems.

CheezItMan · 2018-05-09T20:15:18Z

test/test_helper.rb

+
+require "minitest/rails"
+require "minitest/reporters"  # for Colorized output
+


You need to have this in here:

# MonkeyPatch for This version of Rails :( if ActionPack::VERSION::STRING >= "5.2.0" Minitest::Rails::TestUnit = Rails::TestUnit end

CheezItMan · 2018-05-09T20:19:42Z

app/views/search/index.html.erb

@@ -0,0 +1,17 @@
+<h3>Results for: "<%= @search_terms %>"</h3>
+<section>
+  <div>


Not sure this div is really needed here.

CheezItMan · 2018-05-09T20:24:53Z

lib/recipe_api_wrapper.rb

+      @recipes_list = []
+    end
+
+    encoded_search_terms = URI.encode(search_terms)


There's no checking to ensure that search_terms is a string and it's non-empty.

CheezItMan · 2018-05-09T20:27:12Z

app/controllers/search_controller.rb

+
+  def index
+    @search_terms = params[:search_terms]
+    @recipes = RecipeApiWrapper.find_recipes(@search_terms).paginate(page: params[:page], per_page: 10)


You need some sort of check to ensure that @search_terms is not null. The same applies to params[:page]

CheezItMan · 2018-05-09T20:28:07Z

test/controllers/search_controller_test.rb

+  it "can get recipes index" do
+
+    VCR.use_cassette("recipes") do
+      get recipes_path


This test is failing because you're not setting a param here for this path.

get recipes_path, params: {search_terms: query}

CheezItMan · 2018-05-09T20:28:55Z

test/controllers/search_controller_test.rb

+      get recipes_path
+
+      query = "chicken"
+      RecipeApiWrapper.find_recipes(query)


Why are you making API Wrapper calls directly here? This should be only making controller calls.

CheezItMan · 2018-05-09T20:32:28Z

test/controllers/search_controller_test.rb

+      get recipe_path("7bf4a371c6884d809682a72808da7dc2")
+
+      recipe_id = "7bf4a371c6884d809682a72808da7dc2"
+      RecipeApiWrapper.get_recipe(recipe_id)


Again, this is a controller test, not a test of the wrapper.

CheezItMan · 2018-05-09T20:34:35Z

test/lib/recipe_api_wrapper_test.rb

+      VCR.use_cassette("get_recipe") do
+        RecipeApiWrapper.find_recipes("chicken")
+        recipe_id = "7bf4a371c6884d809682a72808da7dc2"
+        @recipe = RecipeApiWrapper.find_recipe(recipe_id)


Should be:

@recipe = RecipeApiWrapper.get_recipe(recipe_id)

CheezItMan · 2018-05-09T20:48:02Z

test/lib/recipe_api_wrapper_test.rb

+
+    it "Returns empty array if there are no query matches" do
+      VCR.use_cassette("recipes2") do
+        query = 2429384725434.229384687


shouldn't this be in quotes?

npeters5 added 30 commits May 2, 2018 07:46

ran rails new .

5f64a90

adds dotenv, webmock, minitest vcr, and httparty gems

37a8e71

generates search controller;

89060be

adds recipe.rb and recipe wrapper file to app lib directory

095c501

defines search#index

e1e68a3

adds basic search index view to list all recipes found from user sear…

80d6544

…ch terms

creates search box form for search#new view

8f4eb67

adds that stupid line that is apparently critical to the whole functi…

dfedc69

…oning of this app but casually left out by Rails...cool.

adds routes for root/new, index, and show

afaa20b

Recipe class

b249586

recipeapiwrapper with #self.find_recipes(search_terms)

2332de7

adds search#show

b293b1d

adds section for rendering flash messages to appp layout

e2a620c

adds basic search results index page

25a35e2

adds basic show view for recipe

29602ce

fixes routes for index and show

4505787

refactors recipe class in lib

3938ca9

empties recipes_list in apiwrapper each time find_recipes is called. …

18ee64c

…adds get_recipe method for search#show

adds load_paths line to app config for heroku

eba6177

adds base styles

0f0e582

adds header with logo and partial search form to app layout

8a16573

adds grid container and class for grid items to index view

9932d30

replaces form with partial view

0e1021e

adds container elements and external link for full recipe to show view

6f7e730

adds recipe url to recipe class

27f1b4a

adds nosher logo to image assets

520b27f

creates partial view for search#new form

c526a08

adds will_paginate gem

7608dab

adds will_paginate gem to Gemfile.lock

6a9bd27

adds styling for pagination, header, search form

7d6628c

npeters5 added 23 commits May 4, 2018 16:50

adds pagination styling to search scss

1798ed1

adds .paginate method call to index collection

69960d4

changes header class name on app layout

359e702

adds class to search new form

1a2d710

changes h1 to h3, adds pagination at bottom of page

9011cc9

adds new initializer file to allow pagination for arrays

2a10194

adds div wrapper to form

b391bf8

styling

0ee777c

removes unused routes

674d8ff

edits wrapper#get_recipe to make new api request w/r parameter

abc8965

adds minitest-vcr and webmock gems

a8d3dac

resizes logo

e2342ae

styles footer, header, title, headers, ul, body. adds media query

3024e8e

adds Edamam attribution script in head and badge in footer

c9b94ec

adds vcr, webmock to test helper

edad47b

removes capybara gem, adds minitest

5c8293c

tweaking config.eager_load_paths line in app config

4475571

adds tests for search controller

bfc84eb

adds tests for recipe class

315894e

minor tweak to test helper

ae8c98b

empty schema file?

7be174c

adds tests for recipe api wrapper

0078675

trying to fix bug

259aebf

CheezItMan reviewed May 9, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ampers: Nora Peters#32

Ampers: Nora Peters#32
npeters5 wants to merge 53 commits intoAda-C9:masterfrom
npeters5:master

npeters5 commented May 7, 2018

Uh oh!

CheezItMan commented May 9, 2018

Uh oh!

CheezItMan left a comment

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

CheezItMan May 9, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		require "minitest/rails"
		require "minitest/reporters" # for Colorized output

Conversation

npeters5 commented May 7, 2018

API Muncher

Comprehension Questions

Uh oh!

CheezItMan commented May 9, 2018

API Muncher

What We're Looking For

Uh oh!

CheezItMan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants