food_info 0.0.6 → 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8b2e3a8689708f445b743d999bb38af47fe07a5
+  data.tar.gz: 2e705705c0d40d234460f3efd16edb076bda8bf9
+SHA512:
+  metadata.gz: 786ff75020061bb4c9e5737bf8b9dc8fc946cf11c060e00ffe340777c72fbb906244fdd0559f64d2a6b07382d8e070d35c5ed8ba7c61a75f321e15d8f234cd39
+  data.tar.gz: a50c3920280484191fcb2f8ab56b5ad4dc3e4d295f33cc9169e6ae47aeeb49a2fe3483bc16efe361df36a64dd69f992c9f13b469d56a504b9de50e42affe9f68

data/HISTORY.markdown

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.0.7 December 5, 2013
+* Pulling in misc bugfixes from eclipxe
+* Adding caching: can pass in memcache-compatible object to use caching
+
 ## 0.0.6 October 21, 2011
 * FatSecret: Retry once if timestamp invalid (API only supports single request/second)
 

data/README.markdown

@@ -29,6 +29,16 @@ Once that's done, the first step is to tell FoodInfo which adapter you want to u
     FoodInfo.establish_connection(:fat_secret, :key => 'YOUR-KEY', :secret => 'YOUR-KEY')
 
 
+### Caching
+
+To cache results, FoodInfo supports passing in an instance of a memcache-API-compatible (i.e. responds to <code>get</code> and <code>set</code>) caching object.  I recommend using the [Dalli gem](https://github.com/mperham/dalli).
+
+    require 'dalli'
+    client = Dalli::Client.new('localhost:11211')
+    FoodInfo.establish_connection(:fat_secret, :key => 'YOUR-KEY', :secret => 'YOUR-KEY', :cache => client)
+
+With that in place repeated <code>search</code> or <code>details</code> requests will pull from the cache, and not the API endpoint.
+
 ### Searching
 
 Now we can search for foods.

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/TODO.txt

@@ -1,2 +1,5 @@
-* 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.
+
+FatSecret ratelimits requests to one/second.
+  - Could add queue and only process one per second (then separate event loop running while pool full, can't necessarily handle additional requests in meantime)
+  - Could roundrobin between multiple API keys, but presumably violates TOS

data/food_info.gemspec

@@ -11,6 +11,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency('httparty', '>= 0.7.7')
   gem.add_dependency('hashie', '>= 1.1.0')
   gem.add_dependency('ruby-hmac')
+  
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

data/lib/food_info.rb

@@ -3,6 +3,7 @@ require 'hashie'
 require "food_info/utils"
 require "food_info/errors"
 require "food_info/adapters"
+require "food_info/cache_adapters"
 require "food_info/version"
 
 
@@ -15,18 +16,35 @@ module FoodInfo
   class << self
 
     # Sets the adapter we'll be pulling data from.
+    #
+    # Example usage:
+    #   FoodInfo.establish_connection(:fat_secret, :key => '...', :secret => '...')
+    #
+    # Example with cache:
+    #   require 'dalli' # Use dalli gem to interface with memcache
+    #   client = Dalli::Client.new('localhost:11211')
+    #   FoodInfo.establish_connection(:fat_secret, :key => '...', :secret => '...', :cache => client)
     def establish_connection(adapter_name, opts = {})
       klass = ADAPTERS[adapter_name.to_sym]
       raise UnsupportedAdapter.new("Requested adapter ('#{adapter_name}') is unknown") unless klass
+      
+      # Set up the pool of workers (net yet implemented, so defaulting to "pool" of one)
       @@pool = []
       @@cursor = 0
       (opts.delete(:pool) || 1).to_i.times do
         @@pool << klass.new(opts) 
       end
       
+      # Set up the cache, if any provided
+      obj = opts.delete(:cache)
+      @cache = obj ? FoodInfo::CacheAdapters::MemCacheCompatible.new(obj) : FoodInfo::CacheAdapters::Default.new
+      
       true
     end
 
+    # ======================
+    # = Public API Methods =
+    # ======================
     def search(q, opts = {})
       cached(:search, q, opts)
     end
@@ -36,11 +54,13 @@ module FoodInfo
     end
 
 
-
-
-    def cached(method, param, opts = {}, &block)
-      # TODO - implement caching strategy
-      next_adapter.send(method, param, opts)
+    # ==========================
+    # = Implementation details =
+    # ==========================
+    def cached(method, param, opts = {})
+      key = request_key(method, param, opts)
+      
+      @cache.get(key) || @cache.set(key, next_adapter.send(method, param, opts))
     end
 
     # FUTURE: This connection pool code won't do much good until HTTParty is non-blocking
@@ -50,6 +70,14 @@ module FoodInfo
       @@pool[@@cursor]
     end
     
+    # Convert method + args into a string for use as the cache key
+    def request_key(method, param, opts = {})
+      # {:param => 123, :other => "something"} # => "other=something:param=123"
+      str_opts = opts.sort{|a,b| a.to_s <=> b.to_s}.map{|pair| pair.join('=')}.join(':')
+      
+      "FoodInfo:#{method}:#{param}:#{str_opts}"
+    end
+    
   end
 end
 

data/lib/food_info/adapters/fat_secret.rb

@@ -19,7 +19,7 @@ module FoodInfo
 
       def search(q, opts = {})
         params = {
-          :search_expression => q,
+          :search_expression => URI.escape(q),
           :page_number => opts[:page] || 1,
           :max_results => opts[:per_page] || 20
         }
@@ -42,7 +42,7 @@ module FoodInfo
         data = self.class.get( query_url )
         
         if data['error']  # Invalid timestamp can happen if more than one request/second. Allow retrying once.
-          if data['error']['message'] =~ 'Invalid/expired timestamp' && retried < RETRY_INVALID_TIMESTAMP
+          if data['error']['message'] =~ /Invalid\/expired timestamp/ && retried < RETRY_INVALID_TIMESTAMP
             return query(method, opts, retried + 1)
           else
             raise DataSourceException.new(data['error']['message'])

data/lib/food_info/cache_adapters.rb

@@ -0,0 +1,9 @@
+require "food_info/cache_adapters/default"
+require "food_info/cache_adapters/mem_cache_compatible"
+
+module FoodInfo
+  # All FoodInfo CacheAdapters must expose two public methods, +set+ and +get+, and will need to
+  # behave compatibly with the memcache API.
+  module CacheAdapters
+  end
+end

data/lib/food_info/cache_adapters/default.rb

@@ -0,0 +1,15 @@
+module FoodInfo
+  module CacheAdapters
+    class Default
+      
+      def get(key)
+        nil
+      end
+
+      def set(key, val)
+        val
+      end
+      
+    end
+  end
+end

data/lib/food_info/cache_adapters/mem_cache_compatible.rb

@@ -0,0 +1,34 @@
+module FoodInfo
+  module CacheAdapters
+    class MemCacheCompatible
+      
+      def initialize(obj = nil)
+        if obj && obj.respond_to?(:get) && obj.respond_to?(:set)
+          @cache = obj
+        else
+          raise "FoodInfo::CacheAdapters::MemCacheCompatible must be initialized with an object that responds to get and set (look into the Dalli gem)"
+        end
+      end
+      
+      def set(key, val)
+        begin
+          @cache.set(key, val)
+        rescue Exception => e
+          STDERR.puts "FoodInfo Cache Error (set): #{e}"
+        end
+        
+        val
+      end
+
+      def get(key)
+        begin
+          @cache.get(key)
+        rescue Exception => e
+          STDERR.puts "FoodInfo Cache Error (get): #{e}"
+          return nil
+        end
+      end
+      
+    end
+  end
+end

data/lib/food_info/version.rb

@@ -1,3 +1,3 @@
 module FoodInfo
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/test/fat_secret_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class FatSecretTest < Minitest::Test
+  
+  def setup
+    FoodInfo.establish_connection(:fat_secret, :key => ENV['FS_KEY'], :secret => ENV['FS_SECRET'])
+  end
+  
+  def test_retreives_details
+    f = FoodInfo.details("33689")
+    assert_equal "Cheddar Cheese", f.name
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'food_info'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -1,49 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: food_info
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
 - Kali Donovan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-21 00:00:00.000000000Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70256719087420 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.7
   type: :runtime
   prerelease: false
-  version_requirements: *70256719087420
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.7
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70256719086900 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70256719086900
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
-  requirement: &70256719086520 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256719086520
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: 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.
@@ -69,32 +105,37 @@ files:
 - 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/cache_adapters/mem_cache.rb
+- lib/food_info/cache_adapters.rb
+- lib/food_info/cache_adapters/default.rb
+- lib/food_info/cache_adapters/mem_cache_compatible.rb
 - lib/food_info/errors.rb
 - lib/food_info/utils.rb
 - lib/food_info/version.rb
+- test/fat_secret_test.rb
+- test/test_helper.rb
 homepage: https://github.com/deviantech/food_info
 licenses: []
+metadata: {}
 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.10
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: API for researching nutritional information of various foods
-test_files: []
+test_files:
+- test/fat_secret_test.rb
+- test/test_helper.rb

data/lib/food_info/cache_adapters/mem_cache.rb

@@ -1,7 +0,0 @@
-module FoodInfo
-  module CacheAdapters
-    class MemCache
-      
-    end
-  end
-end