reattempt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 066604102e5490b27868c7a4cfd1d3b83a2f87187d5de6cec16a44278e93cb3d
+  data.tar.gz: 3ca36c4e76b52f157e0c87f48f1e3a084c139e23957ef340c3c7b181537124aa
+SHA512:
+  metadata.gz: 0315c05322d5e7967c0a45f6d008169f68457221e643ed6824d1710249c1beb34ff69963aafd048f95504332750eec76c70dcbe3f7e1122e5bde1cf326619d14
+  data.tar.gz: 99725584d39fe74e62ce398697ccec2784a390f17b65aae877c760659ac6196a6c524bc1309e848bd5ecafa91ab9ec54151f8061398a83d05f8b1f890f8f5ccc

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

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 reattempt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Thomas Hurst
+
+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,98 @@
+# Reattempt
+
+Simple `Enumerable` APIs offering retries with exponential backoff and jitter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reattempt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reattempt
+
+## Synopsis
+
+Simplest use with the defaults - 5 attempts, 0.02 to 1 second delay, 0.2 jitter
+(delay is randomised ±10%), catching `StandardError`:
+
+```ruby
+begin
+  Reattempt::Retry.new.each do
+    poke_remote_api
+  end
+rescue Reattempt::RetriesExceeded => e
+  handle_repeated_failure(e.cause)
+end
+```
+
+Instances are thread-safe, and it's suggested that you separate their creation
+from usage: inject them as dependencies, configure them in class attributes,
+store them in constants, etc.
+
+## Usage
+
+Reattempt consists of two main classes:
+
+### Backoff
+
+`Backoff` implements a simple jittered exponential backoff calculator as an
+`Enumerable`:
+
+```ruby
+# Start delay 0.075-0.125 seconds, increasing to 0.75-1.25 seconds
+bo = Reattempt::Backoff.new(min_delay: 0.1, max_delay: 1.0, jitter: 0.5)
+
+bo.take(4).map { |x| x.round(4) } # => [0.1138, 0.2029, 0.4227, 0.646]
+bo.take(2).each { |delay| sleep delay }
+bo.delay_for_attempt(4) # => 1.0403524624141058
+bo[4] # => 0.8328055668923606
+
+bo.each do |delay|
+  printf("Sleeping for about %.2f seconds\n", delay)
+  sleep delay
+end
+```
+
+Note `Backoff` is strictly a *calculator*, it does *not* implement sleep itself.
+
+The iterator is unbounded and you're expected to `take` however many you need,
+or manually exit the loop.
+
+### Retry
+
+`Retry` implements a retrying iterator, catching the given `Exception` types and
+sleeping as per a configured `Backoff` instance.
+
+```ruby
+bo = Reattempt::Backoff.new(min_delay: 0.1, max_delay: 1.0, jitter: 0.5)
+try = Reattempt::Retry.new(tries: 5, rescue: TempError, backoff: bo)
+begin
+  try.each do |attempt|
+    raise TempError, "Failed in attempt #{attempt}"
+  end
+rescue Reattempt::RetriesExceeded => e
+  p e.cause # => #<TempError: "Failed in attempt 5">
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Freaky/ruby-reattempt.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "reattempt"
+
+# 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/reattempt.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'reattempt/version'
+
+require 'dry-initializer'
+require 'dry-types'
+
+module Reattempt
+  # Exception raised by +Retry.each+, with the error from the loop available
+  # in +RetriesExceeded#cause+.
+  RetriesExceeded = Class.new(StandardError)
+
+  # Calculate exponential backoff times between +min_delay+ and +max_delay+,
+  # with +jitter+ of between 0 and 1 and +factor+ of, by default, 2.
+  #
+  # Minimum delay is min_delay * jitter / 2, maximum is max_delay * jitter / 2.
+  #
+  # Instances are +Enumerable+.
+  #
+  # Example:
+  #
+  # ```ruby
+  # # Start delay 0.075-0.125 seconds, doubling to a limit of 0.75-1.25
+  # bo = Reattempt::Backoff.new(min_delay: 0.1, max_delay: 1.0, jitter: 0.5)
+  # bo.take(4).map { |x| x.round(4) } # => [0.1151, 0.1853, 0.4972, 0.9316]
+  # ```
+  class Backoff
+    include Enumerable
+    extend Dry::Initializer[undefined: false]
+
+    option :min_delay,
+           default: -> { 0.02 },
+           type: Dry::Types['coercible.float'].constrained(gteq: 0)
+
+    option :max_delay,
+           default: -> { 1.0 },
+           type: Dry::Types['coercible.float'].constrained(gteq: 0)
+
+    option :jitter,
+           default: -> { 0.2 },
+           type: Dry::Types['coercible.float'].constrained(lt: 1, gteq: 0)
+
+    option :factor,
+           default: -> { 2 },
+           type: Dry::Types['coercible.float'].constrained(gt: 0)
+
+    # Iterate over calls to +delay_for_attempt+ with a counter.  If no block
+    # given, return an +Enumerator+.
+    def each
+      return enum_for(:each) unless block_given?
+
+      0.upto(Float::INFINITY) do |try|
+        yield delay_for_attempt(try)
+      end
+    end
+
+    # Calculate a randomised delay for attempt number +try+, starting from 0.
+    #
+    # Aliased to +[]+
+    def delay_for_attempt(try)
+      delay = (min_delay * (factor ** try)).clamp(min_delay, max_delay)
+      delay * Random.rand(jitter_range)
+    end
+
+    alias [] delay_for_attempt
+
+    private
+
+    def jitter_range
+      @jitter_range ||= Range.new(1 - (jitter / 2), 1 + jitter / 2)
+    end
+  end
+
+  # Retry the loop iterator if configured caught exceptions are raised and retry
+  # count is not exceeded, sleeping as per a given backoff configuration.
+  #
+  # Example:
+  # ```ruby
+  # bo = Reattempt::Backoff.new(min_delay: 0.1, max_delay: 1.0, jitter: 0.5)
+  # try = Reattempt::Retry.new(tries: 5, rescue: TempError, backoff: bo)
+  # begin
+  #   try.each do |attempt|
+  #     raise TempError, "Failed in attempt #{attempt}"
+  #   end
+  # rescue Reattempt::RetriesExceeded => e
+  #   p e.cause # => #<TempError: "Failed in attempt 5">
+  # end
+  # ```
+  class Retry
+    include Enumerable
+    extend Dry::Initializer[undefined: false]
+
+    option :tries,
+           default: -> { 5 },
+           type: Dry::Types['strict.integer'].constrained(gteq: 0)
+
+    option :rescue,
+           default: -> { StandardError },
+           type: Dry::Types['coercible.array'].constrained(min_size: 1)
+                           .of(Dry::Types::Any.constrained(attr: :===))
+
+    option :backoff,
+           default: -> { Backoff.new },
+           type: Dry::Types::Definition.new(Backoff).constrained(type: Backoff)
+
+    option :sleep_proc,
+           default: -> { Kernel.method(:sleep) },
+           type: Dry::Types::Any.constrained(attr: :call)
+
+    option :rescue_proc,
+           default: -> { ->(_ex) {} },
+           type: Dry::Types::Any.constrained(attr: :call)
+
+    # Yield the block with the current attempt number, starting from 1, for up
+    # to +tries+ times.  Setting +tries+ to zero will result in an instant
+    # +RetriesExceeded+, which may be useful for testing.
+    #
+    # If any of the configured +rescue+ exceptions are raised (as matched by
+    # +===+), call +rescue_proc+ with the exception, call +sleep_proc+ with the
+    # delay as configured by +backoff+, and try again up to +retries+ times.
+    #
+    # +rescue_proc+ defaults to a no-op.
+    #
+    # +sleep_proc+ defaults to +Kernel#sleep+.
+    #
+    # Raise +RetriesExceeded+ when the count is exceeded, setting +cause+ to
+    # the previous exception.
+    def each
+      return enum_for(:each) unless block_given?
+
+      ex = nil
+
+      backoff.lazy.take(tries).each_with_index do |delay, try|
+        return yield(try + 1)
+      rescue Exception => ex
+        raise unless self.rescue.any? { |r| r === ex }
+        rescue_proc.call ex
+        sleep_proc.call delay
+      end
+
+      raise RetriesExceeded, cause: ex
+    end
+  end
+end

data/lib/reattempt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Reattempt
+  VERSION = '0.1.0'
+end

data/reattempt.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "reattempt/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "reattempt"
+  spec.version       = Reattempt::VERSION
+  spec.authors       = ["Thomas Hurst"]
+  spec.email         = ["tom@hur.st"]
+
+  spec.summary       = %q{Enumerable retries with exponential backoff}
+  spec.description   = %q{Enumerable APIs for retries and exponential backoff with jitter}
+  spec.homepage      = "https://github.com/Freaky/ruby-reattempt/"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.5"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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 "dry-initializer"
+  spec.add_dependency "dry-types"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: reattempt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Hurst
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Enumerable APIs for retries and exponential backoff with jitter
+email:
+- tom@hur.st
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reattempt.rb
+- lib/reattempt/version.rb
+- reattempt.gemspec
+homepage: https://github.com/Freaky/ruby-reattempt/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Enumerable retries with exponential backoff
+test_files: []