shopify-api-limits 0.0.3 → 0.0.4

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/shopify_api.yml

data/lib/shopify-api-limits.rb

@@ -1,10 +1,24 @@
 $:.unshift File.dirname(__FILE__)
 
-require 'shopify-api-limits/active_resource/connection'
-require 'shopify-api-limits/shopify_api/shopify_api'
-
 module ShopifyAPI
   module Limits
+    # Connection hack
+    require 'shopify-api-limits/active_resource/connection'
+    
+    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
+    end
+
+    class GlobalError < Error; status_code(1) ; end
+    class ShopError < Error; status_code(2) ; end
   end
 end

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

@@ -1,9 +1,11 @@
+require 'active_resource'
+
 module ActiveResource
   class Connection
     # HACK 1:  Add an attr_reader for response
     attr_reader :response
   
-    def request(method, path, *arguments)
+    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}"

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

@@ -1,46 +1,56 @@
 module ShopifyAPI
   # Takes form num_requests_executed/max_requests
   # Eg: 101/3000
-  CALL_LIMIT_HEADER_GLOBAL  = 'http_x_shopify_api_call_limit'
-  CALL_LIMIT_HEADER_LOCAL   = 'http_x_shopify_shop_api_call_limit'
+  CALL_LIMIT_HEADER_PARAM = {
+    :global => 'http_x_shopify_api_call_limit',
+    :shop => 'http_x_shopify_shop_api_call_limit'
+  }
   
   class << self
     ##
     # How many more API calls can I make?
+    # GLOBAL: 10/3000   2999/3000
+    # SHOP:   250/300     60/300
     #
-    def available_calls    
-      call_limit - call_count
+    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?
     #
-    def maxed_out?
-      call_limit == call_count
+    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.
     # @return Integer
     #
-    def call_limit
-      @api_call_limit ||= api_call_limit_param.pop.to_i
+    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?
     # @return Integer
-    def call_count
-      api_call_limit_param.shift.to_i
+    def call_count(scope=:shop)
+      api_call_limit_param(scope).shift.to_i
     end
-
-    def api_call_limit_param
-      response[CALL_LIMIT_HEADER_GLOBAL].split('/')
-    end
-
+    
     def response
       Shop.current unless ActiveResource::Base.connection.response
       ActiveResource::Base.connection.response
     end
+    
+    private
+    
+    def api_call_limit_param(scope)    
+      response[CALL_LIMIT_HEADER_PARAM[scope]].split('/')      
+    end    
   end  
 end

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

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

data/shopify-api-limits.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |s|
   #s.rubyforge_project = "shopify-api-limits"
   
   s.add_dependency "shopify_api", ">= 1.2.2"
+  s.add_development_dependency "rspec", ">=2.6.0"
+  s.add_development_dependency "shopify_api", ">= 1.2.2"
   
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/boot.rb

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler.require(:default, :development)
+
+# Load shopify config
+config = YAML.load_file(File.join(File.dirname(__FILE__), "shopify_api.yml"))
+
+ActiveResource::Base.site = config["site"]

data/spec/limits.rb

@@ -0,0 +1,32 @@
+
+require './spec/boot'
+
+describe "Limits" do
+  it "Can fetch local limits" do
+    count = ShopifyAPI.call_count :shop
+    limit = ShopifyAPI.call_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
+  end
+  
+  it "Can fetch global limits" do
+    count = ShopifyAPI.call_count :global
+    limit = ShopifyAPI.call_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    
+  end
+  
+  it "Can execute up to local max" do
+    until ShopifyAPI.maxed?
+      ShopifyAPI::Shop.current
+      puts "avail: #{ShopifyAPI.available_calls}, maxed: #{ShopifyAPI.maxed?}"
+    end
+  end
+    
+end

data/spec/shopify_api.yml.example

@@ -0,0 +1 @@
+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.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Chris Scott
@@ -24,6 +24,28 @@ dependencies:
         version: 1.2.2
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shopify_api
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+  type: :development
+  version_requirements: *id003
 description: This gem adds the ability to read shopify API call limits to the ShopifyAPI gem
 email: 
 - christocracy@gmail.com
@@ -43,6 +65,9 @@ files:
 - lib/shopify-api-limits/shopify_api/shopify_api.rb
 - lib/shopify-api-limits/version.rb
 - shopify-api-limits.gemspec
+- spec/boot.rb
+- spec/limits.rb
+- spec/shopify_api.yml.example
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -71,5 +96,7 @@ rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: This gem adds the ability to read shopify API call limits to the ShopifyAPI gem
-test_files: []
-
+test_files: 
+- spec/boot.rb
+- spec/limits.rb
+- spec/shopify_api.yml.example