retry_on_error 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9efeb9e1c5e971b006e600b5998a48b6a8833fc1c1705930951236e757c7214
+  data.tar.gz: 705af84f35b4c3cdc0b88b8aead5a9680f68445a401697dd9cd745993deafe80
+SHA512:
+  metadata.gz: ce056c2b58db144b6a3ff30eaab5d8af527ccca9c03c8bc928b93e0fe7d9d8307de27f92d29be0df559674872e6015d164bda581cd16cc06ffc9679308b06f36
+  data.tar.gz: 18c7262a8cddf97264dc917499283ce3bd4c697094e491a7803fe8f564bb33e8d6c22ef5372df58fb05aa90b5c2b8bc77d818fdf019e4230f1de396a63a81c9c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,77 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Include:
+    - 'lib/**/*'
+    - 'spec/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: false
+
+Layout/SpaceInsideParens:
+  Enabled: false
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/ArgumentsForwarding:
+  Enabled: false # enable when Ruby 2.7 is min. supported version
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: true
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SwapValues:
+  Enabled: true

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.2

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 1.0
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at adamgsteel@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in retry_on_error.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    retry_on_error (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-doc (1.1.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.2.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  pry-doc
+  rake (~> 12.0)
+  retry_on_error!
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Adam Steel
+
+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,11 @@
+[![Build Status](https://travis-ci.org/truecoach/retry_on_error.svg?branch=main)](https://travis-ci.org/truecoach/retry_on_error)
+
+
+# RetryOnError
+
+In process of open sourcing, don't use just yet
+
+## Usage
+
+```ruby
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "retry_on_error"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/retry_on_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "retry_on_error/version"
+require "retry_on_error/errors"
+require "retry_on_error/retrier"
+
+module RetryOnError
+  def self.call(*args, **opts, &block)
+    Retrier.call(*args, **opts, &block)
+  end
+end

data/lib/retry_on_error/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RetryOnError
+  class InvalidConfigError < StandardError; end
+end

data/lib/retry_on_error/retrier.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module RetryOnError
+  class Retrier
+    def self.call(*error_configs, delay: 0.5, max_wait: 0, &block)
+      new(*error_configs, delay: delay, max_wait: max_wait, &block).call
+    end
+
+    def initialize(*error_configs, delay:, max_wait:, &block)
+      self.error_configs = error_configs
+      self.delay = delay
+      self.max_wait = max_wait
+      self.block = block
+
+      validate_configs!
+    end
+
+    def call(start_time: Time.now)
+      block.call
+    rescue StandardError => e
+      raise unless retryable?(e, start_time: start_time)
+
+      sleep delay
+
+      call(start_time: start_time)
+    end
+
+    private
+
+    attr_accessor :block,
+                  :delay,
+                  :error_configs,
+                  :max_wait
+
+    def retryable?(error, start_time:)
+      return false if Time.now - start_time >= max_wait
+
+      error_configs.any? { |c| config_error_match?(c, error) }
+    end
+
+    def config_error_match?(error_config, error)
+      if error_config.is_a?(Array)
+        error.class <= error_config[0] &&
+          error.message.match(error_config[1])
+      else
+        error.class <= error_config
+      end
+    end
+
+    def validate_configs!
+      invalid_config! unless error_configs.respond_to?(:all?)
+
+      return if error_configs.all? { |config| valid_config?(config) }
+
+      invalid_config!
+    end
+
+    def valid_config?(config)
+      config.is_a?(Array) ? valid_array_config?(config) : valid_single_config?(config)
+    rescue StandardError
+      false
+    end
+
+    def valid_array_config?(config)
+      config[0] <= Exception && config[1].is_a?(Regexp)
+    end
+
+    def valid_single_config?(config)
+      config <= Exception
+    end
+
+    def invalid_config!
+      msg = <<~MSG
+
+        Invalid error config object.
+
+        Expected an array of either error classes OR
+        2 item arrays: [error class, regex]
+
+        Example:
+
+        # [
+        #   [ ActiveModel::ValidationError, /message/ ],
+        #   CustomError
+        # ]
+
+        Instead got:
+
+        # #{error_configs.inspect}
+      MSG
+
+      raise InvalidConfigError, msg
+    end
+  end
+end

data/lib/retry_on_error/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RetryOnError
+  VERSION = "0.1.1"
+end

data/retry_on_error.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/retry_on_error/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "retry_on_error"
+  spec.version       = RetryOnError::VERSION
+  spec.authors       = ["Adam Steel"]
+  spec.email         = ["adamgsteel@gmail.com"]
+
+  spec.summary       = %q{Easily customize retry behavior for an operation}
+  spec.description   = %q{Especially useful for handling cross network calls.}
+  spec.homepage      = "https://github.com/truecoach/retry_on_error"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # 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_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-doc'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: retry_on_error
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Adam Steel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: pry-doc
+  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: rubocop
+  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'
+description: Especially useful for handling cross network calls.
+email:
+- adamgsteel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/retry_on_error.rb
+- lib/retry_on_error/errors.rb
+- lib/retry_on_error/retrier.rb
+- lib/retry_on_error/version.rb
+- retry_on_error-0.1.0.gem
+- retry_on_error.gemspec
+homepage: https://github.com/truecoach/retry_on_error
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/truecoach/retry_on_error
+  source_code_uri: https://github.com/truecoach/retry_on_error
+  changelog_uri: https://github.com/truecoach/retry_on_error/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Easily customize retry behavior for an operation
+test_files: []