shopify-api-limits 0.0.7 → 0.0.8

data/lib/shopify-api-limits.rb

@@ -4,6 +4,8 @@ module ShopifyAPI
   module Limits
     # Connection hack
     require 'shopify-api-limits/active_resource/connection'
+    require 'shopify-api-limits/active_resource/base'
+    
     require 'shopify-api-limits/shopify_api/limits'
     
     def self.included(klass)

data/lib/shopify-api-limits/active_resource/base.rb

@@ -0,0 +1,39 @@
+##
+# Redefines #find_every to automatically compose resultsets from multiple ShopifyAPI queries due to API limit of 250 records / request.
+# Seemlessly stitches all requests to #all, #find(:all), etc, as if there were no LIMIT.
+# @see http://wiki.shopify.com/Retrieving_more_than_250_Products%2C_Orders_etc.
+#
+module ActiveResource
+  class Base     
+    SHOPIFY_API_MAX_LIMIT = 250
+    
+    class << self
+      # get reference to unbound class-method #find_every
+      find_every = self.instance_method(:find_every)
+      
+      define_method(:find_every) do |options|
+        options[:params] ||= {}
+        
+        # Determine number of ShopifyAPI requests to stitch together all records of this query.
+        limit = options[:params][:limit]
+        
+        # Bail out to default functionality unless limit == false
+        return find_every.bind(self).call(options) unless limit == false
+        
+        total = count(options).to_f
+        options[:params][:limit] = SHOPIFY_API_MAX_LIMIT
+        pages = (total/SHOPIFY_API_MAX_LIMIT).ceil
+          
+        # raise Limits::Error if not enough credits to retrieve entire recordset
+        raise ShopifyAPI::Limits::Error.new unless ShopifyAPI.credit_left >= pages
+
+        # Iterate from 1 -> max-pages and call the original #find_every, capturing the responses into one list
+        rs = []        
+        1.upto(pages) {|page| 
+          rs.concat find_every.bind(self).call(options.update(:page => page))
+        }
+        rs                  
+      end
+    end      
+  end
+end

data/lib/shopify-api-limits/active_resource/connection.rb

@@ -11,6 +11,6 @@ module ActiveResource
     # re-implement #handle_response to capture the returned HTTPResponse to an instance var.    
     define_method(:handle_response) do |response| 
       @response = handle_response.bind(self).call(response)
-    end 
-  end
+    end         
+  end    
 end

data/lib/shopify-api-limits/version.rb

@@ -1,5 +1,5 @@
 module ShopifyAPI
   module Limits
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/spec/query_spec.rb

@@ -0,0 +1,23 @@
+require './spec/boot'
+
+describe "Query" do
+  it "Can retrieve an all query with empty params" do
+    rs = ShopifyAPI::Product.all
+    (rs.length == ShopifyAPI::Product.count).should be_true    
+  end
+  
+    
+  it "Can respect limit param when provided" do
+    rs = ShopifyAPI::Product.all(:params => {:limit => 1})
+    puts "limit rs: #{rs.length}"
+    (rs.length == 1).should be_true
+  end
+  
+  it "Can aggregate resultset by using :limit => false" do
+    rs = ShopifyAPI::Product.all(:params => {:limit => false})
+    puts "len: #{rs.length}"
+    (rs.length == ShopifyAPI::Product.count).should be_true
+  end
+    
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: shopify-api-limits
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Chris Scott
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -04:00
+date: 2011-05-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,12 +61,14 @@ files:
 - README.rdoc
 - Rakefile
 - lib/shopify-api-limits.rb
+- lib/shopify-api-limits/active_resource/base.rb
 - lib/shopify-api-limits/active_resource/connection.rb
 - lib/shopify-api-limits/shopify_api/limits.rb
 - lib/shopify-api-limits/version.rb
 - shopify-api-limits.gemspec
 - spec/boot.rb
-- spec/limits.rb
+- spec/credits_spec.rb
+- spec/query_spec.rb
 - spec/shopify_api.yml.example
 has_rdoc: true
 homepage: ""
@@ -98,5 +100,6 @@ specification_version: 3
 summary: This gem adds the ability to read shopify API call limits to the ShopifyAPI gem
 test_files: 
 - spec/boot.rb
-- spec/limits.rb
+- spec/credits_spec.rb
+- spec/query_spec.rb
 - spec/shopify_api.yml.example