shopify-api-limits 0.0.4 → 0.0.5

data/README.rdoc

@@ -50,4 +50,29 @@ Now it's possible to access the HTTPResponse instance directly from ActiveResour
   foo = ActiveResource::Base.connection.response['http-header-param-foo']
   
   
-== Installation
+== Installation
+  gem "shopify_api"
+  gem "shopify-api-limits"
+
+== Usage
+  count_shop = ShopifyAPI.call_count :shop
+  limit_shop = ShopifyAPI.call_limit :shop
+  
+  count_global = ShopifyAPI.call_count :global
+  limit_global = ShopifyAPI.call_limit :global
+  
+Generally, you shouldn't need to use the methods above directly -- rather they're used under-the-hood by the following helpful methods which don't require a scope (:shop/:global):  If the <b>:global</b> scope has fewer calls available than the <b>:local</b> scope, the methods will operate upon the <b>:global</b> scope; otherwise, values will be returned based upon the <b>:shop</b> scope.   
+ 
+  unless ShopifyAPI.maxed?
+    #make some ShopifyAPI calls
+  end
+  
+  until ShopifyAPI.maxed?
+    # make some ShopifyAPI calls
+  end
+  
+  while ShopifyAPI.available_calls
+    # make some ShopifyAPI calls
+  end  
+
+

data/lib/shopify-api-limits.rb

@@ -22,3 +22,5 @@ module ShopifyAPI
     class ShopError < Error; status_code(2) ; end
   end
 end
+
+ShopifyAPI.send(:include, ShopifyAPI::Limits)

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

@@ -2,21 +2,15 @@ require 'active_resource'
 
 module ActiveResource
   class Connection
-    # HACK 1:  Add an attr_reader for response
+    # HACK:  Add an attr_reader for response
     attr_reader :response
-  
-    def request(method, path, *arguments)      
-      result = ActiveSupport::Notifications.instrument("request.active_resource") do |payload|
-        payload[:method]      = method
-        payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
-        payload[:result]      = http.send(method, path, *arguments)
-      end  
-      # HACK 2:  Save response to instance var @response  
-      @response = handle_response(result)
-    rescue Timeout::Error => e
-      raise TimeoutError.new(e.message)
-    rescue OpenSSL::SSL::SSLError => e
-      raise SSLError.new(e.message)
-    end  
+    
+    # capture the original #handle_response as unbound method instead of using alias 
+    handle_response = self.instance_method(:handle_response)
+    
+    # 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

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

@@ -1,16 +1,22 @@
 module ShopifyAPI
-  # Takes form num_requests_executed/max_requests
-  # Eg: 101/3000
-  CALL_LIMIT_HEADER_PARAM = {
-    :global => 'http_x_shopify_api_call_limit',
-    :shop => 'http_x_shopify_shop_api_call_limit'
-  }
+  module Limits            
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+    end
+  end
   
-  class << self
-    ##
+  module ClassMethods
+    
+    # Takes form num_requests_executed/max_requests
+    # Eg: 101/3000
+    CALL_LIMIT_HEADER_PARAM = {
+      :global => 'http_x_shopify_api_call_limit',
+      :shop => 'http_x_shopify_shop_api_call_limit'
+    }
+    
+      ##
     # How many more API calls can I make?
-    # GLOBAL: 10/3000   2999/3000
-    # SHOP:   250/300     60/300
+    # @return {Integer}
     #
     def available_calls
       shop = call_limit(:shop) - call_count(:shop)
@@ -20,6 +26,7 @@ module ShopifyAPI
 
     ##
     # Have I reached my API call limit?
+    # @return {Boolean}
     #
     def maxed?
       available_calls == 0
@@ -28,7 +35,8 @@ module ShopifyAPI
     ##
     # How many total API calls can I make?
     # NOTE: subtracting 1 from call_limit because I think ShopifyAPI cuts off at 299/2999 or shop/global limits.
-    # @return Integer
+    # @param {Symbol} scope [:shop|:global]
+    # @return {Integer}
     #
     def call_limit(scope=:shop)
       @api_call_limit ||= {}
@@ -37,20 +45,28 @@ module ShopifyAPI
 
     ##
     # How many API calls have I made?
-    # @return Integer
+    # @param {Symbol} scope [:shop|:global]
+    # @return {Integer}
+    #
     def call_count(scope=:shop)
       api_call_limit_param(scope).shift.to_i
     end
-    
+  
+    ##
+    # @return {HTTPResonse}
+    #
     def response
       Shop.current unless ActiveResource::Base.connection.response
       ActiveResource::Base.connection.response
     end
-    
+  
     private
-    
+  
+    ##
+    # @return {Array}
+    #
     def api_call_limit_param(scope)    
       response[CALL_LIMIT_HEADER_PARAM[scope]].split('/')      
     end    
-  end  
+  end
 end

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

@@ -1,5 +1,5 @@
 module ShopifyAPI
   module Limits
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/shopify_api.yml.example

@@ -1 +1 @@
-site: [insert your ActiveResource::Base.site url here]
+site: <insert your ActiveResource::Base.site url here>

metadata

@@ -2,7 +2,7 @@
 name: shopify-api-limits
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Chris Scott
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-15 00:00:00 -04:00
+date: 2011-05-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency