shopify-api-limits 0.0.5 → 0.0.7

data/README.rdoc

@@ -23,28 +23,23 @@ ActiveResource does not make it easy to read the HTTP response headers, since th
   end
   
 == Solution
-Hack ActiveResource::Connection to introduce a new attr_reader :response and saved the returned HTTPResponse instance to it.
+Hack ActiveResource::Connection to introduce a new attr_reader :response and capture the returned HTTPResponse instance from the #handle_response method.
   
-  class ActiveResource
+  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 an 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  
+  end
+  
   
 Now it's possible to access the HTTPResponse instance directly from ActiveResource, via:
   foo = ActiveResource::Base.connection.response['http-header-param-foo']
@@ -55,23 +50,23 @@ Now it's possible to access the HTTPResponse instance directly from ActiveResour
   gem "shopify-api-limits"
 
 == Usage
-  count_shop = ShopifyAPI.call_count :shop
-  limit_shop = ShopifyAPI.call_limit :shop
+  count_shop = ShopifyAPI.credit_used :shop
+  limit_shop = ShopifyAPI.credit_limit :shop
   
-  count_global = ShopifyAPI.call_count :global
-  limit_global = ShopifyAPI.call_limit :global
+  count_global = ShopifyAPI.credit_used :global
+  limit_global = ShopifyAPI.credit_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.   
+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 (<b>:shop/:global</b>):  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
+  unless ShopifyAPI.credit_maxed?
+    #make a ShopifyAPI call
   end
   
-  until ShopifyAPI.maxed?
+  until ShopifyAPI.credit_maxed? || stop_condition
     # make some ShopifyAPI calls
   end
   
-  while ShopifyAPI.available_calls
+  while ShopifyAPI.credit_left || stop_condition
     # make some ShopifyAPI calls
   end  
 

data/lib/shopify-api-limits.rb

@@ -4,22 +4,16 @@ module ShopifyAPI
   module Limits
     # Connection hack
     require 'shopify-api-limits/active_resource/connection'
+    require 'shopify-api-limits/shopify_api/limits'
     
-    require 'shopify-api-limits/shopify_api/shopify_api'
-    
-    class Error < StandardError
-      def self.status_code(code = nil)
-        return @code unless code
-        @code = code
-      end
-      
-      def status_code
-        self.class.status_code
-      end
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
     end
-
-    class GlobalError < Error; status_code(1) ; end
-    class ShopError < Error; status_code(2) ; end
+    
+    class Error < StandardError; end
+    class GlobalError < Error; end
+    class ShopError < Error; end
+    
   end
 end
 

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

@@ -0,0 +1,72 @@
+module ShopifyAPI
+  module Limits    
+    module ClassMethods
+
+      # Takes form num_requests_executed/max_requests
+      # Eg: 101/3000
+      CREDIT_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?
+      # @return {Integer}
+      #
+      def credit_left
+        shop = credit_limit(:shop) - credit_used(:shop)
+        global = credit_limit(:global) - credit_used(:global)      
+        shop < global ? shop : global
+      end
+      alias_method :available_calls, :credit_left
+      
+      ##
+      # Have I reached my API call limit?
+      # @return {Boolean}
+      #
+      def credit_maxed?
+        credit_left == 0
+      end
+      alias_method :maxed?, :credit_maxed?
+      
+      ##
+      # How many total API calls can I make?
+      # NOTE: subtracting 1 from credit_limit because I think ShopifyAPI cuts off at 299/2999 or shop/global limits.
+      # @param {Symbol} scope [:shop|:global]
+      # @return {Integer}
+      #
+      def credit_limit(scope=:shop)
+        @api_credit_limit ||= {}
+        @api_credit_limit[scope] ||= api_credit_limit_param(scope).pop.to_i - 1     
+      end
+      alias_method :call_limit, :credit_limit
+
+      ##
+      # How many API calls have I made?
+      # @param {Symbol} scope [:shop|:global]
+      # @return {Integer}
+      #
+      def credit_used(scope=:shop)
+        api_credit_limit_param(scope).shift.to_i
+      end
+      alias_method :call_count, :credit_used
+      
+      ##
+      # @return {HTTPResonse}
+      #
+      def response
+        Shop.current unless ActiveResource::Base.connection.response
+        ActiveResource::Base.connection.response
+      end
+
+      private
+
+      ##
+      # @return {Array}
+      #
+      def api_credit_limit_param(scope)    
+        response[CREDIT_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.5"
+    VERSION = "0.0.7"
   end
 end

data/spec/limits.rb

@@ -3,30 +3,32 @@ require './spec/boot'
 
 describe "Limits" do
   it "Can fetch local limits" do
-    count = ShopifyAPI.call_count :shop
-    limit = ShopifyAPI.call_limit :shop
+    count = ShopifyAPI.credit_used :shop
+    limit = ShopifyAPI.credit_limit :shop
     
-    (count < 300 && count > 0).should be_true
     (count < limit).should be_true
-    ShopifyAPI.maxed?.should be_false
-    (ShopifyAPI.available_calls > 0).should be_true
+    (count > 0).should be_true
+    ShopifyAPI.credit_maxed?.should be_false
+    (ShopifyAPI.credit_left > 0).should be_true
   end
   
   it "Can fetch global limits" do
-    count = ShopifyAPI.call_count :global
-    limit = ShopifyAPI.call_limit :global
+    count = ShopifyAPI.credit_used :global
+    limit = ShopifyAPI.creidt_limit :global
     
     (count < 3000 && count > 0).should be_true
     (count < limit).should be_true
-    ShopifyAPI.maxed?.should be_false
-    (ShopifyAPI.available_calls > 0).should be_true    
+    ShopifyAPI.credit_maxed?.should be_false
+    (ShopifyAPI.credit_left > 0).should be_true    
   end
   
   it "Can execute up to local max" do
-    until ShopifyAPI.maxed?
+    until ShopifyAPI.credit_maxed?
       ShopifyAPI::Shop.current
-      puts "avail: #{ShopifyAPI.available_calls}, maxed: #{ShopifyAPI.maxed?}"
+      puts "avail: #{ShopifyAPI.credit_left}, maxed: #{ShopifyAPI.credit_maxed?}"
     end
+    ShopifyAPI.credit_maxed?.should be_true
+    (ShopifyAPI.credit_left == 0).should be_true
   end
     
 end

metadata

@@ -2,7 +2,7 @@
 name: shopify-api-limits
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors: 
 - Chris Scott
@@ -62,7 +62,7 @@ files:
 - Rakefile
 - lib/shopify-api-limits.rb
 - lib/shopify-api-limits/active_resource/connection.rb
-- lib/shopify-api-limits/shopify_api/shopify_api.rb
+- lib/shopify-api-limits/shopify_api/limits.rb
 - lib/shopify-api-limits/version.rb
 - shopify-api-limits.gemspec
 - spec/boot.rb

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

@@ -1,72 +0,0 @@
-module ShopifyAPI
-  module Limits            
-    def self.included(klass)
-      klass.send(:extend, ClassMethods)
-    end
-  end
-  
-  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?
-    # @return {Integer}
-    #
-    def available_calls
-      shop = call_limit(:shop) - call_count(:shop)
-      global = call_limit(:global) - call_count(:global)      
-      shop < global ? shop : global
-    end
-
-    ##
-    # Have I reached my API call limit?
-    # @return {Boolean}
-    #
-    def maxed?
-      available_calls == 0
-    end
-
-    ##
-    # 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.
-    # @param {Symbol} scope [:shop|:global]
-    # @return {Integer}
-    #
-    def call_limit(scope=:shop)
-      @api_call_limit ||= {}
-      @api_call_limit[scope] ||= api_call_limit_param(scope).pop.to_i - 1     
-    end
-
-    ##
-    # How many API calls have I made?
-    # @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