yummly 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c543836edc5084b18fc2f74f83c580808310eeef
-  data.tar.gz: 6b55ff04a87be2cd86c12c1573c8390407a3da6b
+  metadata.gz: 78e584a537c9ead08a12229ece8b465b98182324
+  data.tar.gz: 4231fb36513103e5392bd5b38d3a548574fc791a
 SHA512:
-  metadata.gz: d2a6c05a915f931d0740a61bb84b28f5fc7fe9583ed47e33a939e36796cdf8796c2ff9c7048011a9654333b2952a42bedf8798c11c6497f01daafac600dbad1d
-  data.tar.gz: 8f663597afe7489ebc0c5029c303ddd95512ecdacaa424f33f27b4339d46b5eea04942439d9c08640d53f719673aeeea71c9c0d0a31dc3b64537102f5ea486db
+  metadata.gz: 609b03d8ba5bf41c245bf9d00458b5a5cdea08397c134499dc965fce3e1e48e751ea9b962d8504fced923d60928bc61ec8af832416cd8569bc2c32b5e677ee37
+  data.tar.gz: bbd42efa959d1b8a60de140da85805000606b4437c6803f5a9fcaf549effc1dbc2f064c2a508175a38907038d903397cff0befc7e0369127c40ee67f8735ded6

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "1.9.2"
+  - jruby-19mode
+  - rbx-19mode
+  - jruby-18mode

data/README.md

@@ -1,11 +1,12 @@
+[![Code Climate](https://codeclimate.com/repos/51b73d4a13d6371539009033/badges/9791fe90f214cf14a27b/gpa.png)](https://codeclimate.com/repos/51b73d4a13d6371539009033/feed)
+[![Build Status](https://travis-ci.org/twmills/yummly.png?branch=master)](https://travis-ci.org/twmills/yummly)
+
 # Yummly
 
 This is the unofficial ruby wrapper to the Yummly API, "the world's largest and most powerful recipe search site".
 
 https://developer.yummly.com/
 
-Still in the baking phase. Tests are being written, lots of churn at the moment.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,6 +25,7 @@ Or install it yourself as:
 
 First, configure Yummly with your APP key and ID, for example in an initializer if you're using Rails:
 
+    # config/initializers/yummly.rb
     Yummly.configure do |config|
       config.app_id = "21334"
       config.app_key = "XXXXXXXXXXXXXXXXX"
@@ -68,6 +70,18 @@ For example, to access the thumbnail image for a recipe:
 
 Explore the Yummly::Recipe class to see the full range of available attributes.
 
+## Errors
+
+The yummly gem handles the API's exceptions by raising the following errors:
+
+* **Yummly::PermissionError** - When your credentials are incorrect or you've exceeded the rate limit.
+* **Yummly::InternalServerError** - When something's gone wrong on Yummly's servers
+* **Yummly::Error** - Any other unexpected error that is returned.
+
+_**Note:** There had been some discussion about raising an exception when a 404 is encountered, i.e. when a recipe doesn't
+exist for a given ID. Currently the find call returns nil if a recipe cannot be found, but I may raise a new error in
+the future if this is considered a truly exceptional case._
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/yummly.rb

@@ -40,8 +40,6 @@ module Yummly
   end
 
   class Error < StandardError; end
-  class NotFoundError < Error; end
   class PermissionError < Error; end
-  class NotImplementedError < Error; end
   class InternalServerError < Error; end
 end

data/lib/yummly/api.rb

@@ -18,7 +18,7 @@ module Yummly
     #   recipe = Yummly::Api.find('French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364')
     def self.find(id)
       recipe_json = Yummly::Connection.get("recipe/#{id}")
-      Yummly::Recipe.new(recipe_json)
+      recipe_json.nil? ? nil : Yummly::Recipe.new(recipe_json)
     end
 
     # Searches for recipes that match the supplied search terms.

data/lib/yummly/connection.rb

@@ -27,10 +27,10 @@ module Yummly
             nil
           when 200 then
             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}"
+          else
+            raise Yummly::Error, response.body
         end
       end
 

data/lib/yummly/recipe.rb

@@ -1,43 +1,43 @@
-# This class maps a Yummly response to attributes on to a recipe object. Because the search and find API calls return
+# This class maps a Yummly json to attributes on to a recipe object. Because the search and find API calls return
 # recipe data slightly different structures, it also automatically rectifies these differences where possible.
 #
-# When a response attribute is an array, collections of related objects will be created for convenience. For example,
+# When a json attribute is an array, collections of related objects will be created for convenience. For example,
 # the "images" attribute on the response maps to the #images method which returns a collection of Yummlly::Image
 # objects.
 module Yummly
   class Recipe
 
-    attr_accessor :response
+    attr_accessor :json
 
-    def initialize(recipe_json)
-      @response = recipe_json
+    def initialize(json)
+      @json = json
     end
 
     # Nutrition attribute’s search parameter name.
     def attribute
-      response["attribute"]
+      json["attribute"]
     end
 
     def attributes
-      response["attributes"]
+      json["attributes"]
     end
 
     def attribution
-      @attribution ||= Yummly::Attribution.new(response["attribution"])
+      @attribution ||= Yummly::Attribution.new(json["attribution"])
     end
 
     def description
-      response["description"]
+      json["description"]
     end
 
     # @return [Yummly::Flavor] instance of a Yummly::Flavor object
     def flavor
-      @flavor ||= Yummly::Flavor.new(response["flavors"])
+      @flavor ||= Yummly::Flavor.new(json["flavors"])
     end
 
     # @return [String] the Yummly id for this recipe.
     def id
-      response["id"]
+      json["id"]
     end
 
     # @return [Array] collection of Yummly::Image objects.
@@ -47,23 +47,23 @@ module Yummly
 
     # @return [Array] collection of strings of ingredients.
     def ingredients
-      response["ingredients"] || ingredient_lines
+      json["ingredients"] || ingredient_lines
     end
 
     # @return [Array] collection of strings of ingredients.
     def ingredient_lines
-      response["ingredientLines"]
+      json["ingredientLines"]
     end
 
-    # Returns the name of the recipe, automatically finding it using the correct response node.
+    # Returns the name of the recipe, automatically finding it using the correct json node.
     # @return [String] name of the recipe
     def name
-      response["name"] || recipe_name
+      json["name"] || recipe_name
     end
 
     # @return [Integer] number of servings this recipe provides.
     def number_of_servings
-      response["numberOfServings"]
+      json["numberOfServings"]
     end
 
     # The nutritional composition of the recipe, in the form of a list of nutrients and their amounts, per serving. We
@@ -71,23 +71,23 @@ module Yummly
     # are only estimates and you should be clear about that in what you tell your users.
     # @return [Array] collection of Yummly::NutritionEstimate objects.
     def nutrition_estimates
-      @nutrition_estimates ||= response["nutritionEstimates"].collect { |ne| Yummly::NutritionEstimate.new(ne) }
+      @nutrition_estimates ||= json["nutritionEstimates"].collect { |ne| Yummly::NutritionEstimate.new(ne) }
     end
 
     def rating
-      response["rating"]
+      json["rating"]
     end
 
     def recipe_name
-      response["recipeName"]
+      json["recipeName"]
     end
 
     def total_time
-      response["totalTime"]
+      json["totalTime"]
     end
 
     def total_time_in_seconds
-      response["totalTimeInSeconds"]
+      json["totalTimeInSeconds"]
     end
 
     def thumbnail
@@ -98,11 +98,11 @@ module Yummly
 
     private
 
-    # The search and find API calls populate different image attribute nodes in their respective responses. This method
+    # The search and find API calls populate different image attribute nodes in their respective jsons. This method
     # determines which one has been populated and returns a populated node for the images collection method to use. This
     # allows the developer using this API to only use one method to access images.
     def images_node
-      response["images"] || response["smallImageUrls"].collect { |url| {"hostedSmallUrl" => url} }
+      json["images"] || json["smallImageUrls"].collect { |url| {"hostedSmallUrl" => url} }
     end
 
   end

data/lib/yummly/search_result.rb

@@ -7,10 +7,10 @@ module Yummly
 
     include Enumerable
 
-    attr_accessor :response, :params, :max_result, :start
+    attr_accessor :json, :params, :max_result, :start
 
-    def initialize(response)
-      @response = response
+    def initialize(json)
+      @json = json
     end
 
     def each(&block)
@@ -22,20 +22,20 @@ module Yummly
     end
 
     def matches
-      response["matches"] || []
+      json["matches"] || []
     end
 
     def total_match_count
-      response["totalMatchCount"]
+      json["totalMatchCount"]
     end
     alias_method :total, :total_match_count
 
     def attribution
-      Yummly::Attribution.new(response["attribution"])
+      Yummly::Attribution.new(json["attribution"])
     end
 
     def criteria
-      response["criteria"]
+      json["criteria"]
     end
 
   end

data/lib/yummly/version.rb

@@ -1,3 +1,3 @@
 module Yummly
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/spec/api_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Yummly::Api do
+
+  before do
+    Yummly.configure do |config|
+      config.app_id = "12345"
+      config.app_key = "XEARSGSTH12345789"
+      config.http_adapter = MockHttpAdapter
+    end
+  end
+
+  subject { }
+
+  describe "#find" do
+    let(:result) { Yummly::Api.find('French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364') }
+
+    specify { result.should be_a(Yummly::Recipe) }
+
+    it "populates the recipe object with the json response" do
+      result.json.should == read_json_file('get_recipe.json')
+    end
+
+    context "no recipe found" do
+      let(:result) { Yummly::Api.find('missing-recipe-1234') }
+      specify { result.should be_nil }
+    end
+  end
+
+end
+
+def read_json_file(name)
+  path = File.expand_path("spec/fixtures/#{name}")
+  JSON.parse(File.open(path, 'rb').read)
+end

data/yummly.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.name          = "yummly"
   gem.version       = Yummly::VERSION
   gem.authors       = ["Theo Mills"]
+  gem.license       = 'MIT'
   gem.email         = ["twmills@twmills.com"]
   gem.description   = %q{Ruby wrapper to the Yummly API}
   gem.summary       = "This is the unofficial ruby wrapper to the Yummly API, \"the world's largest and most powerful recipe search site\""
@@ -17,7 +18,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.add_dependency('faraday', '>= 0.8.7')
-  gem.add_dependency('rack', "~> 1.4.5")
+  gem.add_dependency('rack', ">= 1.4.5")
   gem.add_dependency('json', "~> 1.8.0")
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yummly
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Theo Mills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-10 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -28,14 +28,14 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.4.5
 - !ruby/object:Gem::Dependency
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
@@ -75,6 +89,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,6 +109,7 @@ files:
 - lib/yummly/unit.rb
 - lib/yummly/url_builder.rb
 - lib/yummly/version.rb
+- spec/api_spec.rb
 - spec/configuration_spec.rb
 - spec/connection_spec.rb
 - spec/fixtures/get_recipe.json
@@ -104,7 +120,8 @@ files:
 - spec/yummly_spec.rb
 - yummly.gemspec
 homepage: https://github.com/twmills/yummly
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -122,12 +139,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: This is the unofficial ruby wrapper to the Yummly API, "the world's largest
   and most powerful recipe search site"
 test_files:
+- spec/api_spec.rb
 - spec/configuration_spec.rb
 - spec/connection_spec.rb
 - spec/fixtures/get_recipe.json
@@ -136,4 +154,3 @@ test_files:
 - spec/support/mock_http_adapter.rb
 - spec/url_builder_spec.rb
 - spec/yummly_spec.rb
-has_rdoc: