yummly 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ab5e084a8a21890f80631110a6dae76b3b181d4
-  data.tar.gz: 2c1aaa4ffac1ca5944c2d9d926c7eedcb1d6c3fb
+  metadata.gz: c539e8304b8fe711901718d2b642daa7656371b4
+  data.tar.gz: 40c0a00eab72d42cbf1810d5968de82fb8e4199a
 SHA512:
-  metadata.gz: 70474e03659e2dca715213fa5781e5f8b1dc289d74e318a8e4c270dad85b7c15e676dda51e8cb154a1194d5ec6ea3b3d7b7c903ccee5c3f23fb6dc3793be646c
-  data.tar.gz: d00a4777f6350e080311928d0d11b3fcd10642a0277a390bc09c6d0b0ce1e06911a1c362ef1896d0d65622dda9bb923129eafdfcbca181e7daacad43e635172d
+  metadata.gz: ed5afcf72c428be79cf1c8fa3d455114f2e8325d5ae2a73fe661139680da7ba0c361933791f2c9976a83b95e3038e9250fa105f42b6f03477c7e3bd782f0f698
+  data.tar.gz: 492406d015d80b610487cfd4cf160a54e4aa388822d114ed3e21f8a35093304d9fc5b03c40409e9a88777a569e73175d1f7da8f01e1f980ec69249690dac0d19

data/README.md

@@ -38,10 +38,12 @@ Once configured, you have access to two API calls:
 
 #### Search
 
-The search command returns a Yummly::SearchResult object, which is a customer Enumerable collection of Recipe objects:
+The search command returns a Yummly::SearchResult object, which is a custom Enumerable collection of Recipe objects:
 
     result = Yummly.search('Onion soup')
-    result.total # returns 10
+    result.total # returns 43350
+    result.size # returns 10
+    result.collect { |recipe| recipe.name }
 
 #### Find
 

data/lib/yummly/configuration.rb

@@ -19,12 +19,12 @@ module Yummly
     attr_accessor :app_key,
                   :app_id,
                   :use_ssl,
-                  :test
+                  :http_adapter
 
     # Creates a configuration object, defaulting use_ssl to false.
     def initialize
       @use_ssl = false
-      @test = false
+      @http_adapter = Yummly::FaradayAdapter
     end
 
     # Returns true if API calls to Yummly should use SSL.

data/lib/yummly/connection.rb

@@ -16,7 +16,7 @@ module Yummly
       end
 
       def adapter
-        @adapter || Yummly::FaradayAdapter
+        Yummly.configuration.http_adapter
       end
 
       def parse_response(response)
@@ -29,6 +29,8 @@ module Yummly
             JSON.parse(response.body)
           when 501 then
             raise Yummly::NotImplementedError, response.body
+          when 500 then
+            raise Yummly::InternalServerError, "An internal error on the Yummly servers was encountered: #{response.body}"
         end
       end
 

data/lib/yummly/version.rb

@@ -1,3 +1,3 @@
 module Yummly
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/yummly.rb

@@ -43,4 +43,5 @@ module Yummly
   class NotFoundError < Error; end
   class PermissionError < Error; end
   class NotImplementedError < Error; end
+  class InternalServerError < Error; end
 end

data/spec/configuration_spec.rb

@@ -6,6 +6,14 @@ describe Yummly::Configuration do
   specify { subject.should respond_to(:app_key) }
   specify { subject.should respond_to(:app_id) }
 
+  describe "http_adapter" do
+    specify { subject.http_adapter.should == Yummly::FaradayAdapter }
+    context "when set" do
+      before { subject.http_adapter = String }
+      specify {subject.http_adapter.should == String}
+    end
+  end
+
   describe "#use_ssl?" do
     specify { subject.use_ssl?.should be_false }
 

data/spec/connection_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+describe Yummly::Connection do
+
+  let(:app_id) { "123456" }
+  let(:app_key) { "ABCDEFG123456" }
+
+  before do
+    Yummly.configure do |config|
+      config.app_id = app_id
+      config.app_key = app_key
+      config.http_adapter = MockHttpAdapter
+    end
+  end
+
+  describe "get" do
+    it "parses a successful response" do
+      response = Yummly::Connection.get("recipe/French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364")
+      response.should be_a(Hash)
+    end
+
+    it "returns nil when a 404 is encountered" do
+      response = Yummly::Connection.get("recipe/missing-recipe-1234")
+      response.should be_nil
+    end
+
+    it "raises a permission exception when access is denied" do
+      expect { Yummly::Connection.get("recipe/permission-denied") }.to raise_error(Yummly::PermissionError)
+    end
+
+    it "raises an exception when an internal error occurs" do
+      expect { Yummly::Connection.get("recipe/internal-error") }.to raise_error(Yummly::InternalServerError)
+    end
+  end
+
+
+end

data/spec/fixtures/get_recipe.json

@@ -0,0 +1,211 @@
+{
+    "attribution": {
+        "html": "<a href='http://www.yummly.com/recipe/Hot-Turkey-Salad-Sandwiches-Allrecipes'>Hot Turkey Salad Sandwiches recipe</a> information powered by <img src='http://static.yummly.com/api-logo.png'/>",
+        "url": "http://www.yummly.com/recipe/Hot-Turkey-Salad-Sandwiches-Allrecipes",
+        "text": "Hot Turkey Salad Sandwiches recipes: information powered by Yummly",
+        "logo": "http://static.yummly.com/api-logo.png"
+    },
+    "ingredientLines": [
+        "2 cups diced cooked turkey",
+        "2 celery ribs, diced",
+        "1 small onion, diced",
+        "2 hard-cooked eggs, chopped",
+        "3/4 cup mayonnaise",
+        "1/2 teaspoon salt",
+        "1/4 teaspoon pepper",
+        "6 hamburger buns, split"
+    ],
+    "flavors": {
+        "Salty": 0.004261637106537819,
+        "Meaty": 0.0019220244139432907,
+        "Piquant": 0,
+        "Bitter": 0.006931612268090248,
+        "Sour": 0.009972159750759602,
+        "Sweet": 0.0032512755133211613
+    },
+    "nutritionEstimates": [
+        {
+            "attribute": "ENERC_KCAL",
+            "description": "Energy",
+            "value": 317.4,
+            "unit": {
+                "name": "calorie",
+                "abbreviation": "kcal",
+                "plural": "calories",
+                "pluralAbbreviation": "kcal"
+            }
+        },
+        {
+            "attribute": "FAT",
+            "description": "Total lipid (fat)",
+            "value": 13.97,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "FASAT",
+            "description": "Fatty acids, total saturated",
+            "value": 2.7,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "CHOLE",
+            "description": "Cholesterol",
+            "value": 0.11,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "NA",
+            "description": "Sodium, Na",
+            "value": 0.66,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "K",
+            "description": "Potassium, K",
+            "value": 0.2,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "CHOCDF",
+            "description": "Carbohydrate, by difference",
+            "value": 29.92,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "FIBTG",
+            "description": "Fiber, total dietary",
+            "value": 1.3,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "SUGAR",
+            "description": "Sugars, total",
+            "value": 5.25,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "PROCNT",
+            "description": "Protein",
+            "value": 17.6,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "VITA_IU",
+            "description": "Vitamin A, IU",
+            "value": 159.13,
+            "unit": {
+                "name": "IU",
+                "abbreviation": "IU",
+                "plural": "IU",
+                "pluralAbbreviation": "IU"
+            }
+        },
+        {
+            "attribute": "VITC",
+            "description": "Vitamin C, total ascorbic acid",
+            "value": 0,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "CA",
+            "description": "Calcium, Ca",
+            "value": 0.08,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        },
+        {
+            "attribute": "FE",
+            "description": "Iron, Fe",
+            "value": 0,
+            "unit": {
+                "name": "gram",
+                "abbreviation": "g",
+                "plural": "grams",
+                "pluralAbbreviation": "grams"
+            }
+        }
+    ],
+    "images": [
+        {
+            "hostedLargeUrl": "http://i2.yummly.com/Hot-Turkey-Salad-Sandwiches-Allrecipes.l.png",
+            "hostedSmallUrl": "http://i2.yummly.com/Hot-Turkey-Salad-Sandwiches-Allrecipes.s.png"
+        }
+    ],
+    "name": "Hot Turkey Salad Sandwiches",
+    "yield": "6 servings",
+    "totalTime": "30 Min",
+    "attributes": {
+        "holiday": [
+            "Christmas",
+            "Thanksgiving"
+        ],
+        "cuisine": [
+            "Italian",
+            "Soul food",
+            "American"
+        ]
+    },
+    "totalTimeInSeconds": 1800,
+    "rating": 4.44,
+    "numberOfServings": 6,
+    "source": {
+        "sourceRecipeUrl": "http://allrecipes.com/Recipe/hot-turkey-salad-sandwiches/detail.aspx",
+        "sourceSiteUrl": "http://www.allrecipes.com",
+        "sourceDisplayName": "AllRecipes"
+    },
+    "id": "Hot-Turkey-Salad-Sandwiches-Allrecipes"
+}

data/spec/fixtures/{search_response.txt → search_response.json}

@@ -1,6 +1,6 @@
 {
     "attribution": {
-        "html": "<a href='http://www.yummly.com/recipes/soup'>soup recipes</a> search powered by <img src=''/>",
+        "html": "<a href='http://www.yummly.com/recipes/soup'>soup recipes</a> search powered by <img src=''/>",
         "url": "http://www.yummly.com/recipes/soup",
         "text": "soup recipes: search powered by Yummly",
         "logo": ""
@@ -1183,7 +1183,7 @@
                 "salt",
                 "coriander root"
             ],
-            "recipeName": "Hot &amp; Sour Tom Yum Soup"
+            "recipeName": "Hot & Sour Tom Yum Soup"
         },
         {
             "attributes": {

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require 'bundler/setup'
-require 'webmock/rspec'
-require "url_mocks"
 require 'yummly'
+require 'support/mock_http_adapter'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/spec/support/mock_http_adapter.rb

@@ -0,0 +1,27 @@
+class MockHttpAdapter
+
+  def self.connection(url = nil)
+    Faraday.new(:url => url) do |faraday|
+      faraday.adapter :test, self.stubs
+    end
+  end
+
+  def self.stubs
+    Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.get(uri('recipe/French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364')) {[ 200, {}, response("get_recipe.json") ]}
+      stub.get(uri('recipe/missing-recipe-1234')) {[ 404, {}, nil ]}
+      stub.get(uri('recipe/permission-denied')) {[ 409, {}, "Permission denied. Please check your app id and app key and try again later." ]}
+      stub.get(uri('recipe/internal-error')) {[ 500, {}, "BOOM!" ]}
+    end
+  end
+
+  def self.uri(path_fragment)
+    "/#{Yummly::API_VERSION}/api/#{path_fragment}?_app_id=#{Yummly.configuration.app_id}&_app_key=#{Yummly.configuration.app_key}"
+  end
+
+  def self.response(name)
+    path = File.expand_path("spec/fixtures/#{name}")
+    File.open(path, 'rb').read
+  end
+
+end

data/spec/url_builder_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe Yummly::UrlBuilder do
+
+  let(:ssl) { false }
+  let(:app_id) { "123456" }
+  let(:app_key) { "ABCDEFG123456" }
+
+  before do
+    Yummly.configure do |config|
+      config.use_ssl = ssl
+      config.app_id = app_id
+      config.app_key = app_key
+    end
+  end
+
+  describe ".domain" do
+    context "when ssl is not enabled" do
+      specify { Yummly::UrlBuilder.domain.should == "http://api.yummly.com" }
+    end
+
+    context "when ssl is enabled" do
+      let(:ssl) { true }
+      specify { Yummly::UrlBuilder.domain.should == "https://api.yummly.com" }
+    end
+  end
+
+  describe ".protocol" do
+    context "when ssl is not enabled" do
+      specify { Yummly::UrlBuilder.protocol.should == "http" }
+    end
+
+    context "when ssl is enabled" do
+      let(:ssl) { true }
+      specify { Yummly::UrlBuilder.protocol.should == "https" }
+    end
+  end
+
+  describe ".build_params_query_string" do
+    let(:query_string) { Yummly::UrlBuilder.build_params_query_string(:name => 'test') }
+    it "contains the app key" do
+      query_string.should match /_app_key=#{app_key}/
+    end
+    it "contains the app id" do
+      query_string.should match /_app_id=#{app_id}/
+    end
+    it "contains the name parameter" do
+      query_string.should match /name=test/
+    end
+  end
+
+  describe ".uri" do
+    let(:uri) { Yummly::UrlBuilder.uri(:search, :name => 'test') }
+    specify { uri.should == "/#{Yummly::API_VERSION}/api/search?name=test&_app_id=123456&_app_key=ABCDEFG123456"}
+  end
+
+end

data/spec/yummly_spec.rb

@@ -1,11 +1,10 @@
 require "spec_helper"
 
 describe Yummly do
-  subject { Yummly::Configuration.new }
 
   describe ".configure" do
-    let(:app_id) { ENV['YUMMLY_APP_ID'] || "12345" }
-    let(:app_key) { ENV['YUMMLY_APP_KEY'] || "XEARSGSTH12345789" }
+    let(:app_id) { "12345" }
+    let(:app_key) { "XEARSGSTH12345789" }
 
     before do
       Yummly.configure do |config|
@@ -13,14 +12,11 @@ describe Yummly do
         config.app_id = app_id
         config.app_key = app_key
       end
-
-      UrlMocks.register_api_url_stubs
     end
 
     specify { Yummly.configuration.use_ssl?.should be_true }
     specify { Yummly.configuration.app_id.should == app_id }
     specify { Yummly.configuration.app_key.should == app_key }
-    specify { Yummly.search("soup recipes").should be_an_instance_of(Array)}
   end
 
 end

data/yummly.gemspec

@@ -20,5 +20,4 @@ Gem::Specification.new do |gem|
   gem.add_dependency('rack', "~> 1.5.2")
   gem.add_dependency('json', "~> 1.8.0")
   gem.add_development_dependency "rspec"
-  gem.add_development_dependency "webmock"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummly
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Theo Mills
@@ -66,20 +66,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Ruby wrapper to the Yummly API
 email:
 - twmills@twmills.com
@@ -109,9 +95,12 @@ files:
 - lib/yummly/url_builder.rb
 - lib/yummly/version.rb
 - spec/configuration_spec.rb
-- spec/fixtures/search_response.txt
+- spec/connection_spec.rb
+- spec/fixtures/get_recipe.json
+- spec/fixtures/search_response.json
 - spec/spec_helper.rb
-- spec/url_mocks.rb
+- spec/support/mock_http_adapter.rb
+- spec/url_builder_spec.rb
 - spec/yummly_spec.rb
 - yummly.gemspec
 homepage: https://github.com/twmills/yummly
@@ -139,8 +128,11 @@ specification_version: 4
 summary: Ruby wrapper to the Yummly API
 test_files:
 - spec/configuration_spec.rb
-- spec/fixtures/search_response.txt
+- spec/connection_spec.rb
+- spec/fixtures/get_recipe.json
+- spec/fixtures/search_response.json
 - spec/spec_helper.rb
-- spec/url_mocks.rb
+- spec/support/mock_http_adapter.rb
+- spec/url_builder_spec.rb
 - spec/yummly_spec.rb
 has_rdoc: 

data/spec/url_mocks.rb

@@ -1,8 +0,0 @@
-module UrlMocks
-  def self.register_api_url_stubs
-    File.open(File.join(File.dirname(__FILE__), "fixtures", "search_response.txt")) do |file|
-      WebMock::API.stub_request(:get, Regexp.new(Yummly::Connection.domain + "/v1/api/recipes?" + ".*")).to_return(status: 200, body: file)
-    end
-    #stub_request(:any, Regexp.new(Yummly::Connection.domain + ".*")).to_return(:body => "Catch all error until urls are defined.", :status => 501 )
-  end
-end