food_info 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Deviantech, Inc.
+
+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.markdown

@@ -0,0 +1,111 @@
+# FoodInfo
+
+FoodInfo is a ruby gem that retrieves food nutrition information from various online data sources.
+
+
+
+## Installation
+
+FoodInfo is available as a gem, so installation is as simple as:
+
+    gem install food_info
+
+
+
+## Supported Data Sources
+
+There's currently only one adapter implemented, which pulls data from [FatSecret's REST API](http://platform.fatsecret.com/api/Default.aspx?screen=rapih).  The code's modular and adding additional data sources should be fairly straightforward, but since DailyBurn discontinued their API access I don't know of any other solid sources (if you do, though, please let me know and/or add an adapter!).
+
+
+
+## Usage
+
+### Housekeeping
+
+To use the FatSecret API (currently your only option), you'll first need to [sign up for a free developer account](http://platform.fatsecret.com/api/Default.aspx?screen=r) and retrieve the "REST API Consumer Key" and "REST API Consumer Secret" from your "My Account" tab.
+
+Once that's done, the first step is to tell FoodInfo which adapter you want to use and what authorization to send.
+
+    FoodInfo.establish_connection(:fat_secret, :key => 'YOUR-KEY', :secret => 'YOUR-KEY')
+
+
+### Searching
+
+Now we can search for foods.
+
+    cheese = FoodInfo.search('cheese')
+    cheese.total_results    # => 2469
+    cheese.per_page         # => 20
+    cheese.page             # => 1
+    cheese.results          # => ... big array ...
+    cheese.results.first    # => 
+    # {
+    #     "description" => "Per 100g - Calories: 403kcal | Fat: 33.14g | Carbs: 1.28g | Protein: 24.90g",
+    #              "id" => "33689",
+    #            "kind" => "Generic",
+    #            "name" => "Cheddar Cheese",
+    #             "url" => "http://www.fatsecret.com/calories-nutrition/usda/cheddar-cheese"
+    # }
+
+(As an aside, I get that pretty, nicely-lined-up console formatting from the remarkably awesome [AwesomePrint Gem](https://github.com/michaeldv/awesome_print)).
+
+Also, note that search supports pagination via the <tt>page</tt> and <tt>per_page</tt> (max 50) parameters:
+
+    FoodInfo.search('cheese', :page => 2, :per_page => 50)
+
+
+### Nutritional Details
+
+Once you have a specific food item in mind from the search results, you can retrieve a whole lot of additional information.
+
+    cheddar = FoodInfo.search('cheese').results.first
+    info = FoodInfo.details( cheddar.id ) # => ... a whole lotta data ...
+
+General metadata about the cheese includes id, name, kind, and url, which are identical to what you'd get from the <tt>search</tt> method.  It also has one or more servings, however, and this is where we finally get our nutrition info.
+
+    serving = info.servings.first # =>
+    # {
+    #                     "calcium" => 95,
+    #                    "calories" => 532.0,
+    #                "carbohydrate" => 1.69,
+    #                 "cholesterol" => 139.0,
+    #                         "fat" => 43.74,
+    #                       "fiber" => 0.0,
+    #                          "id" => "29131",
+    #                        "iron" => 5,
+    #     "measurement_description" => "cup, diced",
+    #       "metric_serving_amount" => 132.0,
+    #         "metric_serving_unit" => "g",
+    #         "monounsaturated_fat" => 12.396,
+    #             "number_of_units" => 1.0,
+    #         "polyunsaturated_fat" => 1.243,
+    #                   "potassium" => 129.0,
+    #                     "protein" => 32.87,
+    #               "saturated_fat" => 27.841,
+    #         "serving_description" => "1 cup diced",
+    #                      "sodium" => 820.0,
+    #                       "sugar" => 0.69,
+    #                   "trans_fat" => 0.0,
+    #                         "url" => "http://www.fatsecret.com/calories-nutrition/usda/cheddar-cheese?portionid=29131&portionamount=1.000",
+    #                   "vitamin_a" => 26,
+    #                   "vitamin_c" => 0
+    # }
+    
+For full details on what each of those fields contains, check [the FatSecret documentation](http://platform.fatsecret.com/api/Default.aspx?screen=rapiref&method=food.get#methodResponse).
+
+
+## Legal Note
+
+The FatSecret TOS requires you not to store, well, [pretty much anything](http://platform.fatsecret.com/api/Default.aspx?screen=rapisd) aside from food or serving IDs for more than 24 hours.  This is annoying, but I figured I'd give you a heads up.
+
+
+## Note on Patches/Pull Requests
+
+Contributions are welcome, particularly adding adapters for additional data sources.
+
+As always, the process is to fork this project on Github, make your changes (preferably in a topic branch, and without changing the gem version), send a pull request, and then receive much appreciation!
+
+## License
+
+Copyright &copy; 2011 [Deviantech, Inc.](http://www.deviantech.com) and released under the MIT license.
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/TODO.txt

@@ -0,0 +1,4 @@
+* Error handling (currently returns empty results for invalid key)
+* Better search API (search('cheese'), not search('cheese').results)
+* Add DB caching
+* It'd be great to have a connection pool, so we could process multiple requests concurrently. I've added a skeleton for it, but actually using it would require a non-blocking HTTP library in HTTParty.

data/food_info.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/food_info/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kali Donovan"]
+  gem.email         = ["kali@deviantech.com"]
+  gem.description   = %q{Generic Ruby interface to look up nutritional information on food.  Design is modular so other adapters can be plugged in, but only data source currently implemented is FatSecret.}
+  gem.summary       = %q{API for researching nutritional information of various foods}
+  gem.homepage      = "https://github.com/deviantech/food_info"
+
+  gem.add_dependency('httparty', '>= 0.7.7')
+  gem.add_dependency('hashie', '>= 1.1.0')
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "food_info"
+  gem.require_paths = ["lib"]
+  gem.version       = FoodInfo::VERSION
+end

data/lib/food_info/adapters/fat_secret/data/food_item.rb

@@ -0,0 +1,23 @@
+module FoodInfo
+  module Adapters
+    class FatSecret
+      module Data
+      
+        class FoodItem < Hashie::Trash
+          property :servings
+          property :id,    :from => :food_id
+          property :name,  :from => :food_name
+          property :kind,  :from => :food_type
+          property :url,   :from => :food_url
+          property :brand, :from => :brand_name
+
+          def initialize(*args)
+            super(*args)
+            self[:servings] = self[:servings]['serving'].collect{|s| FoodServing.new(s) }
+          end
+        end
+      
+      end
+    end
+  end
+end

data/lib/food_info/adapters/fat_secret/data/food_serving.rb

@@ -0,0 +1,45 @@
+module FoodInfo
+  module Adapters
+    class FatSecret
+      module Data
+      
+        class FoodServing < Hashie::Trash
+          property :id, :from => :serving_id
+          property :url, :from => :serving_url
+          
+          # These are strange from FatSecret, we'll set them as properties to get it by Hashie::Trash, then clean up after initialized
+          property :metric_serving_amount     # => "132.000"
+          property :metric_serving_unit       # => "g"
+          property :serving_description       # => "1 cup, diced"
+          property :measurement_description   # => "cup, diced"
+          property :number_of_units           # => "1.000"
+          
+          # For all attributes expected, see http://platform.fatsecret.com/api/Default.aspx?screen=rapiref&method=food.get
+          DECIMALS = %w(calories carbohydrate protein fat saturated_fat polyunsaturated_fat monounsaturated_fat trans_fat cholesterol sodium potassium fiber sugar)
+          INTEGERS = %w(vitamin_a vitamin_c calcium iron)
+          (DECIMALS + INTEGERS).each {|n| property(n) }
+
+          def initialize(*args)
+            super(*args)
+            normalize_data
+          end
+          
+          def normalize_data
+            self[:metric_serving_amount] = self[:metric_serving_amount].to_f
+            self[:number_of_units] = self[:number_of_units].to_f
+            
+            INTEGERS.each do |n|
+              self[n.to_sym] = self[n.to_sym].to_i
+            end
+
+            DECIMALS.each do |n|
+              self[n.to_sym] = self[n.to_sym].to_f
+            end
+          end
+          
+        end
+
+      end
+    end
+  end
+end

data/lib/food_info/adapters/fat_secret/data/search_result.rb

@@ -0,0 +1,18 @@
+module FoodInfo
+  module Adapters
+    class FatSecret
+      module Data
+
+        class SearchResult < Hashie::Trash
+          property :id,    :from => :food_id
+          property :name,  :from => :food_name
+          property :kind,  :from => :food_type
+          property :url,   :from => :food_url
+          property :brand, :from => :brand_name
+          property :description, :from => :food_description
+        end
+
+      end
+    end
+  end
+end

data/lib/food_info/adapters/fat_secret/data/search_results.rb

@@ -0,0 +1,31 @@
+module FoodInfo
+  module Adapters
+    class FatSecret
+      module Data
+    
+        class SearchResults < Hashie::Trash
+          property :results,  :from => :food
+          property :page,     :from => :page_number
+          property :per_page, :from => :max_results
+          property :total_results
+      
+          def initialize(*args)
+            super(*args)
+            normalize_data
+          end
+          
+          def normalize_data
+            [:page, :per_page, :total_results].each do |n|
+              self[n] = self[n].to_i
+            end
+            
+            self[:page] += 1 # FatSecret indexes their pages from 0
+            self[:results] = [self[:results]] unless self[:results].is_a?(Array)
+            self[:results] = (self[:results] || []).collect {|result| SearchResult.new(result) }
+          end
+        end
+    
+      end
+    end
+  end
+end

data/lib/food_info/adapters/fat_secret/request.rb

@@ -0,0 +1,70 @@
+require 'base64'
+require 'hmac-sha1'
+
+module FoodInfo
+  module Adapters
+    class FatSecret
+
+      class Request
+        HOST = 'http://platform.fatsecret.com/rest/server.api'
+  
+        # Returns the query string necessary to run the specified +method+
+        # against the FatSecret API, using the +auth+ (+key+ and +secret+)
+        # to sign it.
+        #
+        # If this class were accessed externally, I'd refactor it a bit
+        # so it didn't require auth info to be passed on every request.
+        def initialize(method, auth, optional_params = {})
+          @auth          = auth
+          @request_nonce = (0...10).map{65.+(rand(25)).chr}.join
+          @request_time  = Time.now.to_i.to_s
+          @http_method   = optional_params.delete(:http_method) || 'GET'
+
+          @params = {
+            :method => method,
+            :format => 'json'
+          }.merge(optional_params || {})
+        end
+  
+        def signed_request
+          "#{HOST}?#{make_query_string(query_params)}&oauth_signature=#{request_signature}"
+        end
+
+        
+        protected
+
+        def request_signature(token=nil)
+          signing_key  = [@auth[:secret], token].join('&')
+    
+          sha = HMAC::SHA1.digest(signing_key, signature_base_string)
+          Base64.encode64(sha).strip.oauth_escape
+        end
+
+        def signature_base_string
+          [@http_method, HOST, make_query_string(query_params)].map(&:oauth_escape).join('&')
+        end
+  
+        def make_query_string(pairs)
+          sorted = pairs.sort{|a,b| a[0].to_s <=> b[0].to_s}
+          sorted.collect{|p| p.join('=')}.join('&')
+        end
+  
+        def query_params
+          oauth_components.merge(@params)
+        end
+      
+        def oauth_components
+          {
+            :oauth_consumer_key => @auth[:key],
+            :oauth_signature_method => 'HMAC-SHA1',
+            :oauth_timestamp => @request_time,
+            :oauth_nonce => @request_nonce,
+            :oauth_version => '1.0'
+          }
+        end
+
+      end
+  
+    end
+  end
+end

data/lib/food_info/adapters/fat_secret.rb

@@ -0,0 +1,45 @@
+require 'httparty'
+require 'food_info/adapters/fat_secret/request'
+require 'food_info/adapters/fat_secret/data/search_result'
+require 'food_info/adapters/fat_secret/data/search_results'
+require 'food_info/adapters/fat_secret/data/food_item'
+require 'food_info/adapters/fat_secret/data/food_serving'
+
+module FoodInfo
+  module Adapters
+    class FatSecret
+      include HTTParty
+      
+      def initialize(opts = {})
+        raise AuthorizationError.new("Missing required argument :key")    unless @key    = opts[:key]
+        raise AuthorizationError.new("Missing required argument :secret") unless @secret = opts[:secret]
+      end
+
+      def search(q, opts = {})
+        params = {
+          :search_expression => q,
+          :page_number => opts[:page] || 1,
+          :max_results => opts[:per_page] || 20
+        }
+        params[:page_number] = [params[:page_number].to_i - 1, 0].max # FatSecret's pagination starts at 0
+        params[:max_results] = [params[:max_results].to_i, 50].min    # FatSecret's max allowed results per page
+        
+        data = query('foods.search', params)
+        Data::SearchResults.new( data['foods'] )
+      end
+  
+      def details(food_id)
+        data = query('food.get', :food_id => food_id)
+        Data::FoodItem.new( data['food'] )
+      end
+  
+      protected
+  
+      def query(method, opts = {})
+        query_url = Request.new(method, {:key => @key, :secret => @secret}, opts).signed_request
+        self.class.get( query_url )
+      end
+      
+    end
+  end
+end

data/lib/food_info/adapters.rb

@@ -0,0 +1,9 @@
+require "food_info/adapters/fat_secret"
+
+module FoodInfo
+  # All FoodInfo adapters must expose two public methods, +search+ and +details+, and will need to
+  # define their own classes to return data in a unified manner consistent with that laid out by
+  # the existing FatSecret adapter's <tt>search_results</tt>, <tt>search_result</tt>, and <tt>details</tt> classes.
+  module Adapters
+  end
+end

data/lib/food_info/errors.rb

@@ -0,0 +1,5 @@
+module FoodInfo
+  class NoAdapterSpecified < StandardError; end
+  class UnsupportedAdapter < StandardError; end
+  class AuthorizationError < StandardError; end
+end

data/lib/food_info/utils.rb

@@ -0,0 +1,5 @@
+class String 
+  def oauth_escape
+    CGI.escape(self).gsub("%7E", "~").gsub("+", "%20") 
+  end 
+end

data/lib/food_info/version.rb

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

data/lib/food_info.rb

@@ -0,0 +1,57 @@
+require 'hashie'
+
+require "food_info/utils"
+require "food_info/errors"
+require "food_info/adapters"
+require "food_info/version"
+
+
+module FoodInfo
+  
+  # Allow extending to additional data sources in the future
+  # Each adapter should implement +search+ and +details+ methods.
+  ADAPTERS = {:fat_secret => FoodInfo::Adapters::FatSecret}
+  
+  class << self
+
+    # Sets the adapter we'll be pulling data from.
+    def establish_connection(adapter_name, opts = {})
+      klass = ADAPTERS[adapter_name.to_sym]
+      raise UnsupportedAdapter.new("Requested adapter ('#{adapter_name}') is unknown") unless klass
+      @@pool = []
+      @@cursor = 0
+      (opts.delete(:pool) || 1).to_i.times do
+        @@pool << klass.new(opts) 
+      end
+      
+      true
+    end
+
+    def search(q, opts = {})
+      next_adapter.search(q, opts)
+    end
+    
+    def details(id)
+      next_adapter.details(id)
+    end
+
+
+    # FUTURE: This connection pool code won't do much good until HTTParty is non-blocking
+    def next_adapter
+      raise NoAdapterSpecified.new("You must run FoodInfo.establish_connection first") unless @@pool
+      @@cursor = (@@cursor + 1) % @@pool.length
+      @@pool[@@cursor]
+    end
+    
+  end
+end
+
+
+__END__
+
+FoodInfo.establish_connection(:fat_secret, :key => ENV['KEY'], :secret => ENV['SECRET'])
+a=FoodInfo.search('cheese')
+a=FoodInfo.search('cheese', :page => 1, :per_page => 1)
+
+FoodInfo.establish_connection(:fat_secret, :key => ENV['KEY'], :secret => ENV['SECRET'])
+a=FoodInfo.details("33689")

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: food_info
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kali Donovan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+description: Generic Ruby interface to look up nutritional information on food.  Design is modular so other adapters can be plugged in, but only data source currently implemented is FatSecret.
+email: 
+- kali@deviantech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- TODO.txt
+- food_info.gemspec
+- lib/food_info.rb
+- lib/food_info/adapters.rb
+- lib/food_info/adapters/fat_secret.rb
+- lib/food_info/adapters/fat_secret/data/food_item.rb
+- lib/food_info/adapters/fat_secret/data/food_serving.rb
+- lib/food_info/adapters/fat_secret/data/search_result.rb
+- lib/food_info/adapters/fat_secret/data/search_results.rb
+- lib/food_info/adapters/fat_secret/request.rb
+- lib/food_info/errors.rb
+- lib/food_info/utils.rb
+- lib/food_info/version.rb
+homepage: https://github.com/deviantech/food_info
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: API for researching nutritional information of various foods
+test_files: []
+