yummly 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+.idea
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yummly.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Theo Mills
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Yummly
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yummly'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yummly
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/yummly/api.rb

@@ -0,0 +1,35 @@
+# This class is the primary mechanism to execute Yummly API calls.
+#
+# Currently Yummly only has two public API calls: one for searching recipes and the other to retrieve a specific recipe.
+#
+# @example
+#   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
+
+  # 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

data/lib/yummly/configuration.rb

@@ -0,0 +1,36 @@
+# Configuration class that stores configuration options for the Yummly API.
+#
+# Yummly requires an App ID and APP key combination to authenticate against its API. At the very least these must be
+# supplied in the configuration.
+#
+# Additionally for certain paid plans Yummly offers SSL API access, so setting the configuration option use_ssl to true
+# will send all API calls over HTTPS. This options defaults to false.
+#
+# Configuration options are typically set via the Yummly.config method.
+# @see Yummly.configure
+# @example
+#   Yummly.configure do |config|
+#     config.app_id = "12345"
+#     config.app_key = "XXXXXXXXXXXXXXXXXXXXXXXX"
+#   end
+class Yummly::Configuration
+
+  attr_accessor :app_key,
+                :app_id,
+                :use_ssl
+
+  # 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
+
+end

data/lib/yummly/connection.rb

@@ -0,0 +1,29 @@
+# This class handles the HTTP interactions with the Yummly API calls.
+class Yummly::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.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
+
+  def self.protocol
+    Yummly.configuration.use_ssl? ? 'https' : 'http'
+  end
+
+  def self.api_version
+    Yummly::API_VERSION
+  end
+
+end

data/lib/yummly/flavor.rb

@@ -0,0 +1,19 @@
+# Contains the flavor scores for a recipe, each on a range from 0 to 1.
+class Yummly::Flavor
+
+  attr_accessor :spiciness,
+                :bitterness,
+                :sweetness,
+                :savoriness,
+                :saltiness,
+                :sourness
+
+  def initialize(values)
+    @spiciness = values["spicy"]
+    @bitterness = values["bitter"]
+    @sweetness = values["sweet"]
+    @savoriness = values["meaty"]
+    @sourness = values["sour"]
+  end
+
+end

data/lib/yummly/image.rb

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

data/lib/yummly/nutrition_estimate.rb

@@ -0,0 +1,25 @@
+# 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
+
+  # Nutrition attribute’s search parameter name.
+  attr_accessor :attribute
+
+  # Display name of this nutrition attribute.
+  attr_accessor :description
+
+  # Nutrition attribute value for this recipe.
+  attr_accessor :value
+
+  # 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
+
+end

data/lib/yummly/recipe.rb

@@ -0,0 +1,101 @@
+# This class maps a Yummly response 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,
+# the "images" attribute on the response maps to the #images method which returns a collection of Yummlly::Image
+# objects.
+class Yummly::Recipe
+
+  attr_accessor :response
+
+  def initialize(recipe_json)
+    @response = recipe_json
+  end
+
+  # Nutrition attribute’s search parameter name.
+  def attribute
+    response["attribute"]
+  end
+
+  def attributes
+    response["attributes"]
+  end
+
+  def attribution
+    response["attribution"]
+  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 [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 strings of ingredients.
+  def ingredients
+    response["ingredients"]
+  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
+
+  # @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
+
+  def rating
+    response["rating"]
+  end
+
+  def recipe_name
+    response["recipeName"]
+  end
+
+  def total_time
+    response["totalTime"]
+  end
+
+  def total_time_in_seconds
+    response["totalTimeInSeconds"]
+  end
+
+  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
+
+end

data/lib/yummly/source.rb

@@ -0,0 +1,19 @@
+# Contains details about the origin of the recipe.
+class Yummly::Source
+
+  # 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 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
+
+end

data/lib/yummly/unit.rb

@@ -0,0 +1,23 @@
+# The implied unit of measure for a nutrition estimate.
+class Yummly::Unit
+
+  # Single unit display name for unit of measure.
+  attr_accessor :name
+
+  # Single unit abbreviation for unit of measure.
+  attr_accessor :abbreviation
+
+  # Plural display name for unit of measure.
+  attr_accessor :plural
+
+  # 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
+
+end

data/lib/yummly/version.rb

@@ -0,0 +1,3 @@
+module Yummly
+  VERSION = "0.0.1"
+end

data/lib/yummly.rb

@@ -0,0 +1,25 @@
+require "yummly/api"
+require "yummly/configuration"
+require "yummly/flavor"
+require "yummly/image"
+require "yummly/nutrition_estimate"
+require "yummly/recipe"
+require "yummly/source"
+require "yummly/unit"
+require "yummly/version"
+
+module Yummly
+
+  API_VERSION = 'v1'
+
+  class << self
+
+    attr_accessor :configuration
+
+    def configure
+      configuration = Yummly::Configuration.new
+      yield(configuration)
+      self.configuration = configuration
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe Yummly::Configuration do
+  subject { Yummly::Configuration.new }
+
+  specify { subject.should respond_to(:app_key) }
+  specify { subject.should respond_to(:app_id) }
+
+  describe "#use_ssl?" do
+    specify { subject.use_ssl?.should be_false }
+
+    context "when set" do
+      before { subject.use_ssl = true }
+      specify { subject.use_ssl?.should be_true }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+require 'yummly'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/yummly_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Yummly do
+  subject { Yummly::Configuration.new }
+
+  describe ".configure" do
+
+    let(:app_id) { "12345" }
+    let(:app_key) { "XEARSGSTH12345789" }
+
+    before do
+      Yummly.configure do |config|
+        config.use_ssl = true
+        config.app_id = app_id
+        config.app_key = app_key
+      end
+    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 }
+  end
+
+end

data/yummly.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yummly/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "yummly"
+  gem.version       = Yummly::VERSION
+  gem.authors       = ["Theo Mills"]
+  gem.email         = ["twmills@twmills.com"]
+  gem.description   = %q{Ruby wrapper to the Yummly API}
+  gem.summary       = %q{Ruby wrapper to the Yummly API}
+  gem.homepage      = "https://github.com/twmills/yummly"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('faraday', '>= 0.8.7')
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: yummly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Theo Mills
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper to the Yummly API
+email:
+- twmills@twmills.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yummly.rb
+- lib/yummly/api.rb
+- lib/yummly/configuration.rb
+- lib/yummly/connection.rb
+- lib/yummly/flavor.rb
+- lib/yummly/image.rb
+- lib/yummly/nutrition_estimate.rb
+- lib/yummly/recipe.rb
+- lib/yummly/source.rb
+- lib/yummly/unit.rb
+- lib/yummly/version.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/yummly_spec.rb
+- yummly.gemspec
+homepage: https://github.com/twmills/yummly
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper to the Yummly API
+test_files:
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/yummly_spec.rb