shopify_api_retry 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9f6d412f4f64e2d2ac4d7e741008526b7a71b767
-  data.tar.gz: 1db395165fe1466210334c70efb1db523242837b
+SHA256:
+  metadata.gz: 949d65d19ed205d18a64ea886ef817bcd9d8b26895036228dddc3dcf4d91f0ca
+  data.tar.gz: 6b776cf5985be1593e791a81c6f4ce31c88ca4f029c7ba03bd8e24ca5f44f26f
 SHA512:
-  metadata.gz: 871762fa4d151434d30a088cdaad6c2e2da6d5207b3a2671fe0e7ee1076b9f1b7a179e238596841463eb9dbde4023e4d0c542ae350dfd06f7d85cce6b87226c6
-  data.tar.gz: b0d9c33fbf726213a3eba185df8dac8839539a29867c53a15b5730dd535946efbd4f19bac143788c4084f17cec0bcbac9a35edaecf19369edd5ee6f49ebb2e09
+  metadata.gz: 781e898074a0f3b9aaed28f1202087173e42483920375f7921384854437f9ed40ad77a0ef37be5d1221f5e76141c988a35e50368da22e83b5e8722c185558e70
+  data.tar.gz: 243547c486e88cfabed0ea4a2c4fbba9524aa44234c5852110cf4a485f28c551309e78a055222576da2bcc6240232d783706807ebeee31c41956dddd6e130495

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [3.0.0, 2.7.2, 2.6.6, 2.5.8, 2.4.10]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+
+      - run: bundle install
+      - run: bundle exec rake

data/README.md

@@ -1,18 +1,9 @@
 # ShopifyAPIRetry
 
-Simple module to retry a [ShopifyAPI](https://github.com/Shopify/shopify_api) request if an HTTP 429 (too many requests) is returned. No monkey patching.
+![CI](https://github.com/ScreenStaring/shopify_api_retry/workflows/CI/badge.svg)
 
-## Usage
-
-```rb
-ShopifyAPIRetry.retry { customer.update_attribute(:tags, "foo")  }
-ShopifyAPIRetry.retry(30) { customer.update_attribute(:tags, "foo") }  # Retry after 30 seconds on HTTP 429
-customer = ShopifyAPIRetry.retry { ShopifyAPI::Customer.find(id) }
-```
-
-If no retry time is provided the value of the HTTP header `Retry-After` is used. If it's not given (it always is) `2` is used.
-
-If the retry fails the original error is raised (`ActiveResource::ClientError` or subclass).
+Simple Ruby module to retry a [Shopify API request](https://github.com/Shopify/shopify_api) if rate limited (HTTP 429) or other errors
+occur.
 
 ## Installation
 
@@ -28,6 +19,54 @@ Gem:
 gem install shopify_api_retry
 ```
 
+## Usage
+
+By default requests are retried when a Shopify rate limit error is returned. The retry happens once after waiting for
+[the seconds given by the HTTP `Retry-After` header](https://shopify.dev/concepts/about-apis/rate-limits):
+```rb
+require "shopify_api_retry" # requires "shopify_api" for you
+
+ShopifyAPIRetry.retry { customer.update_attribute(:tags, "foo") }
+customer = ShopifyAPIRetry.retry { ShopifyAPI::Customer.find(id) }
+```
+
+You can override this:
+```rb
+ShopifyAPIRetry.retry(:wait => 3, :tries => 5) { customer.update_attribute(:tags, "foo")  }
+```
+This will try the request 5 times, waiting 3 seconds between each attempt. If a retry fails after the given number
+of `:tries` the original error will be raised.
+
+You can also retry requests when other errors occur:
+```rb
+ShopifyAPIRetry.retry "5XX" => { :wait => 10, :tries => 2 } do
+  customer.update_attribute(:tags, "foo")
+end
+```
+This still retries rate limit requests, but also all HTTP 5XX errors.
+
+Classes can be specified too:
+```rb
+ShopifyAPIRetry.retry SocketError => { :wait => 1, :tries => 5 } do
+  customer.update_attribute(:tags, "foo")
+end
+```
+
+Global defaults can be set as well:
+```rb
+ShopifyAPIRetry.configure do |config|
+  config.default_wait  = 2.5
+  config.default_tries = 10
+
+  # Use defaults for these
+  config.on ["5XX", Net::TimeoutError]
+
+  config.on SocketError, :tries => 2, :wait => 1
+end
+
+ShopifyAPIRetry.retry { customer.update_attribute(:tags, "foo")  }
+```
+
 ## License
 
 Released under the MIT License: www.opensource.org/licenses/MIT

data/Rakefile

@@ -1 +1,8 @@
+require "rake"
+require "rake/testtask"
 require "bundler/gem_tasks"
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end

data/lib/shopify_api_retry.rb

@@ -1,35 +1,99 @@
+# frozen_string_literal: true
+
 require "shopify_api"
 
 module ShopifyAPIRetry
-  VERSION = "0.0.1".freeze
-  HTTP_RETRY_AFTER = "Retry-After".freeze
+  VERSION = "0.1.0"
+
+  HTTP_RETRY_AFTER = "Retry-After"
+  HTTP_RETRY_STATUS = "429"
+
+  class Config
+    attr_writer :default_wait
+    attr_writer :default_tries
+
+    def initialize
+      @settings = {}
+    end
+
+    def default_wait
+      @default_wait ||= nil
+    end
+
+    def default_tries
+      @default_tries ||= 2
+    end
+
+    def on(errors, options = nil)
+      options = (options || {}).dup
+      options[:wait] ||= default_wait
+      options[:tries] ||= default_tries
+
+      Array(errors).each do |status_or_class|
+        @settings[status_or_class] = options
+      end
+    end
+
+    def clear
+      @settings.clear
+      @default_wait = nil
+      @default_tries = nil
+    end
+
+    def to_h
+      settings = { HTTP_RETRY_STATUS => { :tries => default_tries, :wait => default_wait } }
+      @settings.each_with_object(settings) { |(k, v), o| o[k.to_s] = v.dup }
+    end
+  end
+
+  @config = Config.new
 
+  def self.configure
+    return @config unless block_given?
+    yield @config
+    nil
+  end
+
+  def self.config
+    @config
+  end
+
+  #
+  # Execute the provided block. If an HTTP 429 response is returned try
+  # it again. If any errors are provided try them according to their wait/return spec.
   #
-  # Execute the provided block. If an HTTP 429 response is return try
-  # it again.  If no retry time is provided the value of the HTTP header <code>Retry-After</code>
-  # is used. If it's not given (it always is) +2+ is used.
+  # If no spec is provided the value of the HTTP header <code>Retry-After</code>
+  # is waited for before retrying. If it's not given (it always is) +2+ is used.
   #
-  # If retry fails the original error is raised (`ActiveResource::ClientError` or subclass).
+  # If retry fails the original error is raised.
   #
   # Returns the value of the block.
   #
-  def retry(seconds_to_wait = nil)
+  def retry(cfg = nil)
     raise ArgumentError, "block required" unless block_given?
-    raise ArgumentError, "seconds to wait must be > 0" unless seconds_to_wait.nil? || seconds_to_wait > 0
 
-    result = nil
-    retried = false
+    attempts = build_config(cfg)
 
     begin
       result = yield
-    rescue ActiveResource::ClientError => e
-      # Not 100% if we need to check for code method, I think I saw a NoMethodError...
-      raise unless !retried && e.response.respond_to?(:code) && e.response.code.to_i == 429
+    rescue => e
+      handler = attempts[e.class.name]
+      raise if handler.nil? && (!e.is_a?(ActiveResource::ClientError) || !e.response.respond_to?(:code))
 
-      seconds_to_wait = (e.response[HTTP_RETRY_AFTER] || 2).to_i unless seconds_to_wait
-      sleep seconds_to_wait
+      handler ||= attempts[e.response.code] || attempts["#{e.response.code[0]}XX"]
+      handler[:wait] ||= e.response[HTTP_RETRY_AFTER] || config.default_wait if e.response.code == HTTP_RETRY_STATUS
+
+      handler[:attempts] ||= 1
+      raise if handler[:attempts] == handler[:tries]
+
+      snooze = handler[:wait].to_i
+      waited = sleep snooze
+      snooze -= waited
+      # Worth looping?
+      sleep snooze if snooze > 0
+
+      handler[:attempts] += 1
 
-      retried = true
       retry
     end
 
@@ -37,4 +101,32 @@ module ShopifyAPIRetry
   end
 
   module_function :retry
+
+  def self.build_config(userconfig)
+    config = ShopifyAPIRetry.config.to_h
+    return config unless userconfig
+
+    if userconfig.is_a?(Integer)
+      userconfig = { :wait => cfg }
+      warn "passing an Integer to retry is deprecated and will be removed, use an :wait => #{cfg} instead"
+    elsif !userconfig.is_a?(Hash)
+      raise ArgumentError, "config must be a Hash"
+    end
+
+    userconfig.each do |k, v|
+      if v.is_a?(Hash)
+        config[k.to_s] = v.dup
+      else
+        config[HTTP_RETRY_STATUS][k] = v
+      end
+    end
+
+    config.values.each do |cfg|
+      raise ArgumentError, "seconds to wait must be >= 0" if cfg[:wait] && cfg[:wait] < 0
+    end
+
+    config
+  end
+
+  private_class_method :build_config
 end

data/shopify_api_retry.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "shopify_api_retry"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.authors       = ["Skye Shaw"]
   spec.email         = ["skye.shaw@gmail.com"]
 
@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "shopify_api", ">= 4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api_retry
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shopify_api
@@ -25,33 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 description: Simple module to retry a ShopifyAPI request if an HTTP 429 (too many
   requests) is returned. No monkey patching.
 email:
@@ -60,6 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -88,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Retry a ShopifyAPI request if an HTTP 429 (too many requests) is returned