shopify-api-limits 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in shopify-api-limits.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,53 @@
+= shopify-api-limits
+
+My friend Dave (aka "hunkybill") posted a problem to me one day about ShopifyAPI call limits, offering a case of beer if I could find a solution:
+http://forums.shopify.com/categories/9/posts/49003
+
+So in the HTTP headers, the ShopifyAPI will return to you in each API request how many calls you've made, as well as the maximum number of calls available.
+
+== Problem
+ActiveResource does not make it easy to read the HTTP response headers, since the method #request in ActiveResource::Connection does not save a reference to the HTTP response:
+  
+  # Makes a request to the remote service.
+  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
+    handle_response(result) # <------------------- right here:  handle_response return an instance of HTTPResponse but doesn't save a ref to it
+  rescue Timeout::Error => e
+    raise TimeoutError.new(e.message)
+  rescue OpenSSL::SSL::SSLError => e
+    raise SSLError.new(e.message)
+  end
+  
+== Solution
+Hack ActiveResource::Connection to introduce a new attr_reader :response and saved the returned HTTPResponse instance to it.
+  
+  class ActiveResource
+    class Connection
+      # HACK 1:  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  
+    end
+  end  
+  
+Now it's possible to access the HTTPResponse instance directly from ActiveResource, via:
+  foo = ActiveResource::Base.connection.response['http-header-param-foo']
+  
+  
+== Installation

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/shopify-api-limits.rb

@@ -0,0 +1,8 @@
+require 'active_resource/connection'
+require 'shopify_api/shopify_api'
+
+module ShopifyAPI
+  module Limits
+    
+  end
+end

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

@@ -0,0 +1,20 @@
+class ActiveResource
+  class Connection
+    # HACK 1:  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  
+  end
+end

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

@@ -0,0 +1,46 @@
+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'
+  
+  class << self
+    ##
+    # How many more API calls can I make?
+    #
+    def available_calls    
+      call_limit - call_count
+    end
+
+    ##
+    # Have I reached my API call limit?
+    #
+    def maxed_out?
+      call_limit == call_count
+    end
+
+    ##
+    # How many total API calls can I make?
+    # @return Integer
+    #
+    def call_limit
+      @api_call_limit ||= api_call_limit_param.pop.to_i
+    end
+
+    ##
+    # How many API calls have I made?
+    # @return Integer
+    def call_count
+      api_call_limit_param.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
+  end  
+end

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

@@ -0,0 +1,5 @@
+module ShopifyAPI
+  module Limits
+    VERSION = "0.0.1"
+  end
+end

data/shopify-api-limits.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shopify-api-limits/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shopify-api-limits"
+  s.version     = ShopifyAPI::Limits::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Scott"]
+  s.email       = ["christocracy@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{This gem adds the ability to read shopify API call limits to the ShopifyAPI gem}
+  s.description = %q{This gem adds the ability to read shopify API call limits to the ShopifyAPI gem}
+
+  #s.rubyforge_project = "shopify-api-limits"
+  
+  s.add_dependency "shopify_api", ">= 1.2.3"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: shopify-api-limits
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shopify_api
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+  type: :runtime
+  version_requirements: *id001
+description: This gem adds the ability to read shopify API call limits to the ShopifyAPI gem
+email: 
+- christocracy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- 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/version.rb
+- shopify-api-limits.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+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: []
+