API-muncher Brennan Octos #40

MississippiBrenn · 2018-05-07T16:39:24Z

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 copied from the version in the slackapi project, then changed things as needed.
Describe your API Wrapper. How did you decide on the methods you created?	I created the least amount of
Describe an edge case or failure case test you wrote for your API Wrapper.	Only works with one parameter
Explain how VCR aids in testing an API.	It takes in the test data from the api and runs tests against that.
What is the Heroku URL of your deployed application?	https://edamam-cbrenn.herokuapp.com/
Provide a link to the Trello board you used	https://trello.com/b/y2f3P628/edamam

droberts-sea · 2018-05-09T23:11:59Z

API Muncher

What We're Looking For

Feature	Feedback
Core Requirements
Git hygiene	I would like to see more frequent commits with more descriptive commit messages. If this is something you struggle with, this article might be interesting to you.
Comprehension questions	These are incomplete!
General
Rails fundamentals (RESTful routing, use of named paths)	yes
Semantic HTML	seems like your views are a little confused - see inline
Errors are reported to the user	no - When I mangled the recipe URI, I got an exception instead of a polite error message
API Wrapper to handle the API requests	yes
Controller testing	no
Lib testing	no
Search Functionality	yes
List Functionality	yes
Show individual item functionality (link to original recipe opens in new tab)	yes
Styling
Responsive layout	no
List View shows 10 items at a time/pagination	no
The app is styled to create an attractive user interface	no
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	Gives me an application error - did you set up your API keys?
Overall

This submission is concerning to me. You were able to get the core API functionality working, which is a good start. However there are many important pieces that are missing or broken, including error handling, testing, styling, git hygiene and deployment. Remembering how to write "regular" Ruby code is part of the challenge of this assignment, but it seems like you're still struggling with Rails and Ruby fundamentals.

Many of the problems I'm seeing are things that will hamper the rest of your development process. For example, having a good story around error handling makes everything else easier, because when something goes wrong you get a clear reason why instead of having to hunt for it.

When you meet with Charles this week, it would be worthwhile to go over some of these pieces, particularly error handling and testing. Aside from being important on their own, having these locked in a little better will help when we switch to JavaScript next week too.

droberts-sea · 2018-05-09T21:45:30Z

app/controllers/recipes_controller.rb

+  def index
+    if params[:search]
+
+      #returns all recipes for GET request from API


I like the idea of using the same action/view for the homepage and search results.

droberts-sea · 2018-05-09T21:50:55Z

app/views/layouts/application.html.erb

+
+<h1>Search recipes for </h1>
+
+<%= form_tag(root_path, method: 'get') do %>


You should put these in some sort of sectioning element - maybe a <header>?

droberts-sea · 2018-05-09T21:53:34Z

app/views/layouts/application.html.erb

+<% end %>
+
+<%= yield %>
+  </body>


You should always put the yield inside a <main> tag, since it's where the main content of your page will appear. Doing this will make debugging easier, since when you inspect the page it'll be clear whether content came from the layout or the view template.

droberts-sea · 2018-05-09T21:55:37Z

app/views/recipes/index.html.erb

+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">


You shouldn't be putting a full HTML document into your view templates, since they'll be inserted inside of views/layouts/application.html.erb

droberts-sea · 2018-05-09T21:56:11Z

app/views/recipes/index.html.erb

+<main>
+  <% @recipes.each do |recipe|%>
+  <secton class = "recipe section">
+  <%= image_tag(recipe.image, alt: "picture of the image") %>


This is good semantic HTML.

droberts-sea · 2018-05-09T22:07:45Z

app/controllers/recipes_controller.rb

+  def catch_api_error
+    begin
+
+      yield


You've copy-pasted this method here from the lecture notes, but you've commented out the around_action above, and the error you're looking for doesn't match what your API wrapper is producing. It would be worth spending some time studying this to understand how it is supposed to fit together.

droberts-sea · 2018-05-09T22:08:58Z

lib/edamam_api_wrapper.rb

+    url = url_root + uri + "&app_id=#{APP_ID}" + "&app_key=#{APP_KEY}"
+
+    response = HTTParty.get(url).parsed_response
+


You should be checking the response for errors here.

droberts-sea · 2018-05-09T22:09:39Z

lib/recipe.rb

+  # This is a factory method! It reads the data
+  # we got back from the API, and turns it into
+  # an instance of Channel by calling self.new
+


What is a factory method?

droberts-sea · 2018-05-09T22:14:33Z

test/controllers/recipes_controller_test.rb

+    it "can get the index path" do
+      get root_path
+
+      must_respond_with :ok


You need a lot more in the way of controller tests. At the very least you need the following:

Index:

A good search result is provided

A search result is provided but produces no results

Show:

A good recipe URI is provided

A bad recipe URI is provided

You should also be wrapping these tests in VCR, since the controller make API calls via the API wrapper.

droberts-sea · 2018-05-09T22:17:25Z

test/lib/edamame_api_wrapper_test.rb

+  it 'can create an instance of itself' do
+    a = EdamamApiWrapper.new
+    a.wont_be_nil
+  end


Your application doesn't ever call new on EdamamApiWrapper - it only has self methods and isn't meant to be instantiated. Why are you testing this functionality?

Here is my list of test cases I'd look for in this file:

Call list_recipes with a good search term, get back a list of Recipe objects

Call list_recipes with a bogus search term like adlsfjaog, get back an empty array or an error

Call show_recipe with a good URL, get back a Recipe object

Call show_recipe with a bogus URL, get back an error or nil

MississippiBrenn added 6 commits May 2, 2018 17:03

showing that I can commit

00d1669

Initial controller tests passing

d56c31a

Passing initial Controller and API tests"

4654a9d

Search functionality working

90c1d5f

Show page and index baseline

8123f0a

up to date

7f71f75

droberts-sea reviewed May 9, 2018

View reviewed changes

removed require pry from api wrapper

5a946fd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API-muncher Brennan Octos #40

API-muncher Brennan Octos #40

MississippiBrenn commented May 7, 2018

droberts-sea commented May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018

droberts-sea May 9, 2018


		<h1>Search recipes for </h1>

		<%= form_tag(root_path, method: 'get') do %>

		url = url_root + uri + "&app_id=#{APP_ID}" + "&app_key=#{APP_KEY}"

		response = HTTParty.get(url).parsed_response

API-muncher Brennan Octos #40

Are you sure you want to change the base?

API-muncher Brennan Octos #40

Conversation

MississippiBrenn commented May 7, 2018

API Muncher

Comprehension Questions

droberts-sea commented May 9, 2018

API Muncher

What We're Looking For

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment