shopify_api_rate_limiter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2804a85d4d550041386b466d6afd473490a403d
+  data.tar.gz: 69d21214df61574234c0b413af972a8f69cfadbe
+SHA512:
+  metadata.gz: 9d34ff220e9d9edf3358f30bf369818a8b3e5d52a1061401210fab0dce6d8e7ae8b76bcd1132f790f7de283bb3574e36e46fa25bf16bc957621ff0b8777838f2
+  data.tar.gz: ecab6cadfb5316739f17d8174bcb8147f0f697216cca9695709176654c891df661be1e467a869313f3f903e3c7d38714ee2192970c08a7243e86626f642e06a3

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+coverage
+rdoc
+doc
+pkg
+.ruby-version
+*.lock
+.idea
+.dev/
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,7 @@
+# shopify_api_rate_limiter
+A rate limiter for ActiveResource that adheres to Shopify's API limits. 
+
+## Usage
+```
+gem install shopify_api_rate_limiter
+```

data/Rakefile

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

data/lib/shopify_api_rate_limiter.rb

@@ -0,0 +1,20 @@
+module ShopifyApiRateLimiter
+  class << self
+    attr_accessor :logger
+  end
+
+  class Railties < ::Rails::Railtie
+    initializer 'Rails logger' do
+      ShopifyApiRateLimiter.logger = Rails.logger
+    end
+  end
+
+  if defined?(Rails)
+    require 'shopify_api_rate_limiter/active_resource/connection'
+    require 'shopify_api_rate_limiter/throttled_connection'
+    require 'shopify_api_rate_limiter/engine'
+  else
+    require 'shopify_api_rate_limiter/active_resource/connection'
+    require 'shopify_api_rate_limiter/throttled_connection'
+  end
+end

data/lib/shopify_api_rate_limiter/active_resource/connection.rb

@@ -0,0 +1,7 @@
+require 'shopify_api_rate_limiter/throttled_connection'
+
+module ActiveResource
+  class Connection
+    prepend ShopifyApiRateLimiter::ThrottledConnection
+  end
+end

data/lib/shopify_api_rate_limiter/engine.rb

@@ -0,0 +1,5 @@
+module ShopifyApiRateLimiter
+	class Engine < ::Rails::Engine
+		config.autoload_paths += Dir["#{config.root}/lib/**/"]
+	end
+end

data/lib/shopify_api_rate_limiter/throttled_connection.rb

@@ -0,0 +1,30 @@
+module ShopifyApiRateLimiter
+  module ThrottledConnection
+    SHOPIFY_SLEEP_TIME = 0.5
+
+    def request(method, path, *arguments)
+      if self === ShopifyAPI::Base.connection
+        if ShopifyAPI::Base.connection.response && ShopifyAPI.credit_maxed?
+          ShopifyApiRateLimiter.logger.info "Shopify rate limit credit maxed. Sleeping #{SHOPIFY_SLEEP_TIME}..."
+          sleep(SHOPIFY_SLEEP_TIME)
+        end
+        begin
+          super
+        rescue ActiveResource::ConnectionError => ex
+          if ex.response.code.to_s == '429'
+            ShopifyApiRateLimiter.logger.info "Shopify returned 429 (Rate Limit Exceeded). Sleeping #{SHOPIFY_SLEEP_TIME}..."
+            sleep(SHOPIFY_SLEEP_TIME)
+            retry
+          else
+            raise ex
+          end
+        end
+      else
+        super
+      end
+    rescue ShopifyAPI::Limits::LimitUnavailable => limit_unavailable
+      # Either Shopify API stopped sending the limit header, or we're in a stubby test
+      super
+    end
+  end
+end

data/lib/shopify_api_rate_limiter/version.rb

@@ -0,0 +1,3 @@
+module ShopifyApiRateLimiter
+	VERSION = "0.0.1"
+end

data/shopify_api_rate_limiter.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/shopify_api_rate_limiter/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'shopify_api_rate_limiter'
+  s.version     = ShopifyApiRateLimiter::VERSION 
+  s.date        = '2017-01-11'
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Rate limits API requests to the Shopify API."
+  s.description = "A simple (hacky) solution for rate limiting API requests to the Shopify API."
+  s.authors     = ["Jason Buehler"]
+  s.email       = 'jason.c.buehler@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+
+  s.homepage    = 'http://rubygems.org/gems/shopify_api_rate_limiter'
+  s.license     = 'MIT'
+
+  s.add_runtime_dependency "shopify_api", ">= 1.2.2"
+  s.add_development_dependency "shopify_api", ">= 1.2.2"
+	s.add_development_dependency "bundler", ">= 1.0.0"
+	s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: shopify_api_rate_limiter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Buehler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A simple (hacky) solution for rate limiting API requests to the Shopify
+  API.
+email: jason.c.buehler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/shopify_api_rate_limiter.rb
+- lib/shopify_api_rate_limiter/active_resource/connection.rb
+- lib/shopify_api_rate_limiter/engine.rb
+- lib/shopify_api_rate_limiter/throttled_connection.rb
+- lib/shopify_api_rate_limiter/version.rb
+- shopify_api_rate_limiter.gemspec
+homepage: http://rubygems.org/gems/shopify_api_rate_limiter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Rate limits API requests to the Shopify API.
+test_files: []