food_info 0.0.1 → 0.0.2

data/HISTORY.markdown

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.0.2 September 11, 2011
+* Added propagation of errors from data source
+* API improvement: No need to call <tt>results</tt> on FoodItem.search to access search results
+
+## 0.0.1  September 10, 2011
+* Initial release. FatSecret adapter supports both <tt>search</tt> and <tt>details</tt> methods.

data/README.markdown

@@ -49,16 +49,28 @@ Now we can search for foods.
 
 (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:
+#### Pagination
+
+Search supports pagination via the <tt>page</tt> and <tt>per_page</tt> (max 50) parameters:
 
     FoodInfo.search('cheese', :page => 2, :per_page => 50)
 
+#### Access to search results
+
+You can access the results of the search explicitly:
+
+    FoodInfo.search('cheese').results # => ... lots of results ...
+
+But the SearchResults class includes Enumerable, so you can also just call enumerable methods on it directly:
+
+    FoodInfo.search('cheese').map(&:name) # => array of names of matching foods
+    
 
 ### 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
+    cheddar = FoodInfo.search('cheese').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.

data/TODO.txt

@@ -1,4 +1,2 @@
-* Error handling (currently returns empty results for invalid key)
-* Better search API (search('cheese'), not search('cheese').results)
-* Add DB caching
+* Add DB caching (or is that better left to the client, who can control the caching layer completely?)
 * 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/lib/food_info/adapters/fat_secret/data/search_results.rb

@@ -4,6 +4,8 @@ module FoodInfo
       module Data
     
         class SearchResults < Hashie::Trash
+          include Enumerable
+          
           property :results,  :from => :food
           property :page,     :from => :page_number
           property :per_page, :from => :max_results
@@ -23,6 +25,12 @@ module FoodInfo
             self[:results] = [self[:results]] unless self[:results].is_a?(Array)
             self[:results] = (self[:results] || []).collect {|result| SearchResult.new(result) }
           end
+          
+          # Allow direct enumerable access to search results without calling search('cheese').results.each
+          def each(&block)
+            self[:results].each{|result| block.call(result)}
+          end
+          
         end
     
       end

data/lib/food_info/adapters/fat_secret.rb

@@ -37,7 +37,10 @@ module FoodInfo
   
       def query(method, opts = {})
         query_url = Request.new(method, {:key => @key, :secret => @secret}, opts).signed_request
-        self.class.get( query_url )
+        data = self.class.get( query_url )        
+        raise DataSourceException.new(data['error']['message']) if data['error']
+        
+        return data
       end
       
     end

data/lib/food_info/errors.rb

@@ -2,4 +2,5 @@ module FoodInfo
   class NoAdapterSpecified < StandardError; end
   class UnsupportedAdapter < StandardError; end
   class AuthorizationError < StandardError; end
+  class DataSourceException < StandardError; end
 end

data/lib/food_info/version.rb

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

data/lib/food_info.rb

@@ -50,8 +50,8 @@ end
 __END__
 
 FoodInfo.establish_connection(:fat_secret, :key => ENV['KEY'], :secret => ENV['SECRET'])
+a=FoodInfo.search('cheese', :page => 1, :per_page => 1).results.first
 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

@@ -1,66 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: food_info
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Kali Donovan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-10 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156585880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 0
-        - 7
-        - 7
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.7.7
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2156585880
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &2156585140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         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: 
+  prerelease: false
+  version_requirements: *2156585140
+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: 
+files:
 - .gitignore
 - Gemfile
+- HISTORY.markdown
 - LICENSE
 - README.markdown
 - Rakefile
@@ -79,36 +63,26 @@ files:
 - lib/food_info/version.rb
 homepage: https://github.com/deviantech/food_info
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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: []
-