yummly 0.0.3 → 0.0.4

data/README.md

@@ -51,8 +51,8 @@ The find command returns a single Yummly::Recipe object:
 ## The Recipe object
 
 The Yummly ruby wrapper returns all results as recipe objects. These objects normalize the API responses to make it
-easier for developers to interact with recipes from ruby. All Yummly recipe attributes have been directly mapped, and
-in cases where the JSON response returned an array for a specific attribute and array of related objects are returned
+easier for developers to interact with recipes from ruby. All Yummly recipe attributes have been directly mapped.
+In cases where the JSON response returned an array for a specific attribute, an array of appropriate objects are returned
 from the ruby Recipe object.
 
 For example, to access the thumbnail image for a recipe:
@@ -60,6 +60,8 @@ For example, to access the thumbnail image for a recipe:
     recipe = Yummly.find('French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364')
     recipe.images.first.small_url
 
+(Shhhh, there's also a Recipe#thumbnail convenience method!)
+
 Explore the Yummly::Recipe class to see the full range of available attributes.
 
 ## Contributing

data/lib/yummly/api.rb

@@ -6,30 +6,33 @@
 #   Yummly::Api.find('French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364')
 # @example
 #   Yummly::Api.search('Onion soup')
-class Yummly::Api
 
-  # Retrieves a single recipe.
-  #
-  # @param [String] id The yummly recipe identifier.
-  # @return [Yummly::Recipe] a instance of a recipe object
-  # @example
-  #   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)
-  end
+module Yummly
+  class Api
 
-  # Searches for recipes that match the supplied search terms.
-  #
-  # @param [String] terms A string of terms used to search API
-  # @param [Hash] params Additional options to pass to the search API
-  # @return [Array] a collection of recipe objects
-  # @example
-  #   recipes = Yummly::Api.search('Onion soup')
-  def self.search(terms, params = {})
-    params[:q] = terms unless params.has_key?(:q)
-    result = Yummly::Connection.get(:recipes, params)
-    result["matches"].collect { |recipe_json| Yummly::Recipe.new(recipe_json) }
-  end
+    # Retrieves a single recipe.
+    #
+    # @param [String] id The yummly recipe identifier.
+    # @return [Yummly::Recipe] a instance of a recipe object
+    # @example
+    #   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)
+    end
 
+    # Searches for recipes that match the supplied search terms.
+    #
+    # @param [String] terms A string of terms used to search API
+    # @param [Hash] params Additional options to pass to the search API
+    # @return [Array] a collection of recipe objects
+    # @example
+    #   recipes = Yummly::Api.search('Onion soup')
+    def self.search(terms, params = {})
+      params[:q] = terms unless params.has_key?(:q)
+      result = Yummly::Connection.get(:recipes, params)
+      result["matches"].collect { |recipe_json| Yummly::Recipe.new(recipe_json) }
+    end
+
+  end
 end

data/lib/yummly/configuration.rb

@@ -13,24 +13,26 @@
 #     config.app_id = "12345"
 #     config.app_key = "XXXXXXXXXXXXXXXXXXXXXXXX"
 #   end
-class Yummly::Configuration
+module Yummly
+  class Configuration
 
-  attr_accessor :app_key,
-                :app_id,
-                :use_ssl
+    attr_accessor :app_key,
+                  :app_id,
+                  :use_ssl
 
-  # Creates a configuration object, defaulting use_ssl to false.
-  def initialize
-    @use_ssl  = false
-  end
+    # Creates a configuration object, defaulting use_ssl to false.
+    def initialize
+      @use_ssl = false
+    end
 
-  # Returns true if API calls to Yummly should use SSL.
-  #
-  # @return [Boolean] true if API calls to Yummly should use SSL
-  # @example
-  #   Yummly.configuration.use_ssl?
-  def use_ssl?
-    use_ssl
-  end
+    # Returns true if API calls to Yummly should use SSL.
+    #
+    # @return [Boolean] true if API calls to Yummly should use SSL
+    # @example
+    #   Yummly.configuration.use_ssl?
+    def use_ssl?
+      use_ssl
+    end
 
+  end
 end

data/lib/yummly/connection.rb

@@ -1,29 +1,51 @@
 # This class handles the HTTP interactions with the Yummly API calls.
-class Yummly::Connection
+module Yummly
+  class Connection
 
-  attr_accessor :connection
+    attr_accessor :connection
 
-  def self.get(command, params = {})
-    params['_app_id'] = Yummly.configuration.app_id
-    params['_app_key'] = Yummly.configuration.app_key
-    response = self.api_connection.get("/#{self.api_version}/api/#{command}?#{Rack::Utils.build_query(params)}")
-    JSON.parse(response.body)
-  end
+    def self.get(command, params = {})
+      response = self.api_connection.get(build_uri(command, params))
+      self.parse_response(response)
+    end
 
-  def self.api_connection
-    Faraday.new(:url => "#{self.protocol}://api.yummly.com") do |faraday|
-      faraday.request  :url_encoded             # form-encode POST params
-      faraday.response :logger                  # log requests to STDOUT
-      faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+    def self.api_connection
+      Faraday.new(:url => "#{self.protocol}://api.yummly.com") do |faraday|
+        faraday.request :url_encoded # form-encode POST params
+        faraday.response :logger # log requests to STDOUT
+        faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
+      end
     end
-  end
 
-  def self.protocol
-    Yummly.configuration.use_ssl? ? 'https' : 'http'
-  end
+    def self.parse_response(response)
+      case response.status
+        when 409 then
+          raise Yummly::PermissionError, response.body
+        when 404 then
+          nil
+        when 200 then
+          JSON.parse(response.body)
+      end
+    end
 
-  def self.api_version
-    Yummly::API_VERSION
-  end
+    def build_uri(command, params)
+      query_string = build_params_query_string(params)
+      "/#{self.api_version}/api/#{command}?#{query_string}"
+    end
 
+    def self.build_params_query_string(params)
+      params['_app_id'] = Yummly.configuration.app_id
+      params['_app_key'] = Yummly.configuration.app_key
+      Rack::Utils.build_query(params)
+    end
+
+    def self.protocol
+      Yummly.configuration.use_ssl? ? 'https' : 'http'
+    end
+
+    def self.api_version
+      Yummly::API_VERSION
+    end
+
+  end
 end

data/lib/yummly/flavor.rb

@@ -1,20 +1,22 @@
 # Contains the flavor scores for a recipe, each on a range from 0 to 1.
-class Yummly::Flavor
+module Yummly
+  class Flavor
 
-  attr_accessor :spiciness,
-                :bitterness,
-                :sweetness,
-                :savoriness,
-                :saltiness,
-                :sourness
+    attr_accessor :spiciness,
+                  :bitterness,
+                  :sweetness,
+                  :savoriness,
+                  :saltiness,
+                  :sourness
 
-  def initialize(values)
-    @spiciness = values["Piquant"]
-    @bitterness = values["Bitter"]
-    @sweetness = values["Sweet"]
-    @savoriness = values["Meaty"]
-    @sourness = values["Sour"]
-    @saltiness = values["Salty"]
-  end
+    def initialize(values)
+      @spiciness = values["Piquant"]
+      @bitterness = values["Bitter"]
+      @sweetness = values["Sweet"]
+      @savoriness = values["Meaty"]
+      @sourness = values["Sour"]
+      @saltiness = values["Salty"]
+    end
 
+  end
 end

data/lib/yummly/image.rb

@@ -1,19 +1,21 @@
 # The image that should be displayed along with the recipe if images are available. Comes in 3 different sizes.
-class Yummly::Image
+module Yummly
+  class Image
 
-  # small (90×60)
-  attr_accessor :small_url
+    # small (90×60)
+    attr_accessor :small_url
 
-  # medium (180×120)
-  attr_accessor :medium_url
+    # medium (180×120)
+    attr_accessor :medium_url
 
-  # large (360×240)
-  attr_accessor :large_url
+    # large (360×240)
+    attr_accessor :large_url
 
-  def initialize(values)
-    @large_url = values["hostedLargeUrl"]
-    @medium_url = values["hostedMediumUrl"]
-    @small_url = values["hostedSmallUrl"]
-  end
+    def initialize(values)
+      @large_url = values["hostedLargeUrl"]
+      @medium_url = values["hostedMediumUrl"]
+      @small_url = values["hostedSmallUrl"]
+    end
 
+  end
 end

data/lib/yummly/nutrition_estimate.rb

@@ -1,25 +1,27 @@
 # The nutritional composition of the recipe, in the form of a list of nutrients and their amounts, per serving. Yummly
 # will return nutrition estimates only for those recipes where we are reasonably confident in their accuracy. These are
 # only estimates and you should be clear about that in what you tell your users.
-class Yummly::NutritionEstimate
+module Yummly
+  class NutritionEstimate
 
-  # Nutrition attribute’s search parameter name.
-  attr_accessor :attribute
+    # Nutrition attribute’s search parameter name.
+    attr_accessor :attribute
 
-  # Display name of this nutrition attribute.
-  attr_accessor :description
+    # Display name of this nutrition attribute.
+    attr_accessor :description
 
-  # Nutrition attribute value for this recipe.
-  attr_accessor :value
+    # Nutrition attribute value for this recipe.
+    attr_accessor :value
 
-  # Implied unit of measure as a Yummly::Unit object.
-  attr_accessor :unit
+    # Implied unit of measure as a Yummly::Unit object.
+    attr_accessor :unit
 
-  def initialize(values)
-    @attribute = values["attribute"]
-    @description = values["description"]
-    @value = values["value"]
-    @unit = Yummly::Unit.new(values["unit"])
-  end
+    def initialize(values)
+      @attribute = values["attribute"]
+      @description = values["description"]
+      @value = values["value"]
+      @unit = Yummly::Unit.new(values["unit"])
+    end
 
+  end
 end

data/lib/yummly/recipe.rb

@@ -4,104 +4,106 @@
 # When a response 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.
-class Yummly::Recipe
+module Yummly
+  class Recipe
 
-  attr_accessor :response
+    attr_accessor :response
 
-  def initialize(recipe_json)
-    @response = recipe_json
-  end
+    def initialize(recipe_json)
+      @response = recipe_json
+    end
 
-  # Nutrition attribute’s search parameter name.
-  def attribute
-    response["attribute"]
-  end
+    # Nutrition attribute’s search parameter name.
+    def attribute
+      response["attribute"]
+    end
 
-  def attributes
-    response["attributes"]
-  end
+    def attributes
+      response["attributes"]
+    end
 
-  def attribution
-    response["attribution"]
-  end
+    def attribution
+      response["attribution"]
+    end
 
-  def description
-    response["description"]
-  end
+    def description
+      response["description"]
+    end
 
-  # @return [Yummly::Flavor] instance of a Yummly::Flavor object
-  def flavor
-    @flavor ||= Yummly::Flavor.new(response["flavors"])
-  end
+    # @return [Yummly::Flavor] instance of a Yummly::Flavor object
+    def flavor
+      @flavor ||= Yummly::Flavor.new(response["flavors"])
+    end
 
-  # @return [String] the Yummly id for this recipe.
-  def id
-    response["id"]
-  end
+    # @return [String] the Yummly id for this recipe.
+    def id
+      response["id"]
+    end
 
-  # @return [Array] collection of Yummly::Image objects.
-  def images
-    @images ||= images_node.collect { |image| Yummly::Image.new(image) }
-  end
+    # @return [Array] collection of Yummly::Image objects.
+    def images
+      @images ||= images_node.collect { |image| Yummly::Image.new(image) }
+    end
 
-  # @return [Array] collection of strings of ingredients.
-  def ingredients
-    response["ingredients"] || ingredient_lines
-  end
+    # @return [Array] collection of strings of ingredients.
+    def ingredients
+      response["ingredients"] || ingredient_lines
+    end
 
-  # @return [Array] collection of strings of ingredients.
-  def ingredient_lines
-    response["ingredientLines"]
-  end
+    # @return [Array] collection of strings of ingredients.
+    def ingredient_lines
+      response["ingredientLines"]
+    end
 
-  # Returns the name of the recipe, automatically finding it using the correct response node.
-  # @return [String] name of the recipe
-  def name
-    response["name"] || recipe_name
-  end
+    # Returns the name of the recipe, automatically finding it using the correct response node.
+    # @return [String] name of the recipe
+    def name
+      response["name"] || recipe_name
+    end
 
-  # @return [Integer] number of servings this recipe provides.
-  def number_of_servings
-    response["numberOfServings"]
-  end
+    # @return [Integer] number of servings this recipe provides.
+    def number_of_servings
+      response["numberOfServings"]
+    end
 
-  # The nutritional composition of the recipe, in the form of a list of nutrients and their amounts, per serving. We
-  # will return nutrition estimates only for those recipes where we are reasonably confident in their accuracy. These
-  # 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) }
-  end
+    # The nutritional composition of the recipe, in the form of a list of nutrients and their amounts, per serving. We
+    # will return nutrition estimates only for those recipes where we are reasonably confident in their accuracy. These
+    # 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) }
+    end
 
-  def rating
-    response["rating"]
-  end
+    def rating
+      response["rating"]
+    end
 
-  def recipe_name
-    response["recipeName"]
-  end
+    def recipe_name
+      response["recipeName"]
+    end
 
-  def total_time
-    response["totalTime"]
-  end
+    def total_time
+      response["totalTime"]
+    end
 
-  def total_time_in_seconds
-    response["totalTimeInSeconds"]
-  end
+    def total_time_in_seconds
+      response["totalTimeInSeconds"]
+    end
 
-  def thumbnail
-    if images
-      images.first.small_url
+    def thumbnail
+      if images
+        images.first.small_url
+      end
     end
-  end
 
-  private
+    private
 
-  # The search and find API calls populate different image attribute nodes in their respective responses. 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 } }
-  end
+    # The search and find API calls populate different image attribute nodes in their respective responses. 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} }
+    end
 
+  end
 end

data/lib/yummly/source.rb

@@ -1,19 +1,21 @@
 # Contains details about the origin of the recipe.
-class Yummly::Source
+module Yummly
+  class Source
 
-  # The original source url of this recipe.
-  attr_accessor :recipe_url
+    # The original source url of this recipe.
+    attr_accessor :recipe_url
 
-  # The url of the source site of this recipe.
-  attr_accessor :site_url
+    # The url of the source site of this recipe.
+    attr_accessor :site_url
 
-  # The display name of the source site.
-  attr_accessor :display_name
+    # The display name of the source site.
+    attr_accessor :display_name
 
-  def initialize(values)
-    @recipe_url = values["sourceRecipeUrl"]
-    @site_url = values["sourceSiteUrl"]
-    @display_name= values["sourceDisplayName"]
-  end
+    def initialize(values)
+      @recipe_url = values["sourceRecipeUrl"]
+      @site_url = values["sourceSiteUrl"]
+      @display_name= values["sourceDisplayName"]
+    end
 
+  end
 end

data/lib/yummly/unit.rb

@@ -1,23 +1,25 @@
 # The implied unit of measure for a nutrition estimate.
-class Yummly::Unit
+module Yummly
+  class Unit
 
-  # Single unit display name for unit of measure.
-  attr_accessor :name
+    # Single unit display name for unit of measure.
+    attr_accessor :name
 
-  # Single unit abbreviation for unit of measure.
-  attr_accessor :abbreviation
+    # Single unit abbreviation for unit of measure.
+    attr_accessor :abbreviation
 
-  # Plural display name for unit of measure.
-  attr_accessor :plural
+    # Plural display name for unit of measure.
+    attr_accessor :plural
 
-  # Plural unit abbreviation for unit of measure.
-  attr_accessor :plural_abbreviation
+    # Plural unit abbreviation for unit of measure.
+    attr_accessor :plural_abbreviation
 
-  def initialize(values)
-    @name = values["name"]
-    @abbreviation = values["abbreviation"]
-    @plural = values["plural"]
-    @plural_abbreviation = values["pluralAbbreviation"]
-  end
+    def initialize(values)
+      @name = values["name"]
+      @abbreviation = values["abbreviation"]
+      @plural = values["plural"]
+      @plural_abbreviation = values["pluralAbbreviation"]
+    end
 
+  end
 end

data/lib/yummly/version.rb

@@ -1,3 +1,3 @@
 module Yummly
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/yummly.rb

@@ -1,6 +1,6 @@
 require "yummly/api"
-require "yummly/connection"
 require "yummly/configuration"
+require "yummly/connection"
 require "yummly/flavor"
 require "yummly/image"
 require "yummly/nutrition_estimate"
@@ -31,4 +31,7 @@ module Yummly
       Yummly::Api.find(recipe_id)
     end
   end
+
+  class Error < StandardError; end
+  class PermissionError < Error; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummly
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper to the Yummly API