shopify_unlimited 0.0.5 → 0.0.6

data/README.md

@@ -1,6 +1,8 @@
 # ShopifyUnlimited
 
-TODO: Write a gem description
+1. Allows API calls like products = Product.find(:all, params:{limit: false}), which will make as many requests as needed to fetch all Products in batches of 250. The result set can be queried for the number of requests required: ```products.requests_made```
+2. 
+2. Attempts to record api limits a little better by adding ```ShopifyAPI::Base.connection.shopify_credit```. This object contains the credit used since the first request (in a given process) and the time of the first request. It resets when the credit used goes down or the time elapsed has been more than 5 minutes.
 
 ## Installation
 
@@ -16,10 +18,6 @@ Or install it yourself as:
 
     $ gem install shopify_unlimited
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it

data/lib/shopify_unlimited/active_resource/connection_extensions.rb

@@ -0,0 +1,43 @@
+module ::ShopifyUnlimited
+  class CreditUsed
+    SHOPIFY_CREDIT_LIMIT_PERIOD = 5.minutes
+
+    attr_accessor :time, :used
+    def initialize(used)
+      @time = Time.now
+      @used = used
+    end
+
+    def stale?(used)
+      (@used > used) || ((Time.now - @time) > SHOPIFY_CREDIT_LIMIT_PERIOD)
+    end
+
+    def estimated_time_until_reset
+      est = SHOPIFY_CREDIT_LIMIT_PERIOD - (Time.now - @time)
+      [est, 0].max
+    end
+
+  end
+end
+
+module ::ActiveResource
+  class Connection
+    SHOPIFY_CREDIT_LIMIT_HEADER_PARAM = 'http_x_shopify_shop_api_call_limit'
+
+    attr_reader :shopify_credit
+    def handle_response_with_response_time_capture(response)
+      handle_response_without_response_time_capture(response)
+      if(shopify_credit_header = response[SHOPIFY_CREDIT_LIMIT_HEADER_PARAM])
+        used = shopify_credit_header.split('/').shift.to_i
+
+        if @shopify_credit.nil? || @shopify_credit.stale?(used)
+          @shopify_credit = ::ShopifyUnlimited::CreditUsed.new(used)
+        else
+          @shopify_credit.used = used
+        end
+      end
+      response
+    end
+    alias_method_chain :handle_response, :response_time_capture
+  end
+end

data/lib/shopify_unlimited/version.rb

@@ -1,3 +1,3 @@
 module ShopifyUnlimited
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_unlimited
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -122,6 +122,7 @@ files:
 - Rakefile
 - lib/shopify_unlimited.rb
 - lib/shopify_unlimited/active_resource/base_extensions.rb
+- lib/shopify_unlimited/active_resource/connection_extensions.rb
 - lib/shopify_unlimited/version.rb
 - shopify_unlimited.gemspec
 - spec/spec_helper.rb
@@ -140,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 202707212439120603
+      hash: -4386607660778254027
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 202707212439120603
+      hash: -4386607660778254027
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25