shopify_api_retry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f6d412f4f64e2d2ac4d7e741008526b7a71b767
+  data.tar.gz: 1db395165fe1466210334c70efb1db523242837b
+SHA512:
+  metadata.gz: 871762fa4d151434d30a088cdaad6c2e2da6d5207b3a2671fe0e7ee1076b9f1b7a179e238596841463eb9dbde4023e4d0c542ae350dfd06f7d85cce6b87226c6
+  data.tar.gz: b0d9c33fbf726213a3eba185df8dac8839539a29867c53a15b5730dd535946efbd4f19bac143788c4084f17cec0bcbac9a35edaecf19369edd5ee6f49ebb2e09

data/.gitignore

@@ -0,0 +1,59 @@
+
+# Created by https://www.gitignore.io/api/ruby
+# Edit at https://www.gitignore.io/?templates=ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# End of https://www.gitignore.io/api/ruby

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in shopify_api_retry.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2016 - 2019 (c) ScreenStaring
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# 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.
+
+## 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).
+
+## Installation
+
+Bundler:
+
+```rb
+gem "shopify_api_retry"
+```
+
+Gem:
+
+```
+gem install shopify_api_retry
+```
+
+## License
+
+Released under the MIT License: www.opensource.org/licenses/MIT
+
+---
+
+Made by [ScreenStaring](http://screenstaring.com)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/shopify_api_retry.rb

@@ -0,0 +1,40 @@
+require "shopify_api"
+
+module ShopifyAPIRetry
+  VERSION = "0.0.1".freeze
+  HTTP_RETRY_AFTER = "Retry-After".freeze
+
+  #
+  # 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 retry fails the original error is raised (`ActiveResource::ClientError` or subclass).
+  #
+  # Returns the value of the block.
+  #
+  def retry(seconds_to_wait = 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
+
+    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
+
+      seconds_to_wait = (e.response[HTTP_RETRY_AFTER] || 2).to_i unless seconds_to_wait
+      sleep seconds_to_wait
+
+      retried = true
+      retry
+    end
+
+    result
+  end
+
+  module_function :retry
+end

data/shopify_api_retry.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "shopify_api_retry"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Retry a ShopifyAPI request if an HTTP 429 (too many requests) is returned}
+  spec.description   = %q{Simple module to retry a ShopifyAPI request if an HTTP 429 (too many requests) is returned. No monkey patching.}
+  spec.homepage      = "https://github.com/ScreenStaring/shopify_api_retry"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "shopify_api", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: shopify_api_retry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple module to retry a ShopifyAPI request if an HTTP 429 (too many
+  requests) is returned. No monkey patching.
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shopify_api_retry.rb
+- shopify_api_retry.gemspec
+homepage: https://github.com/ScreenStaring/shopify_api_retry
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Retry a ShopifyAPI request if an HTTP 429 (too many requests) is returned
+test_files: []