retry_it 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3133fcf53875f5554c5fbdbb62f7e0cd413efd2db0ad11e30afa99e06be263b3
+  data.tar.gz: 4bb4e6ce29a77b4f3b3bd816bf0766b58540641894b4298ee86b2534f3867771
+SHA512:
+  metadata.gz: a7f5dd9a4ffa9728d2ff13b6f2f898ebe9762c9a2f9801c140025b3a8f52363a3e966298bded772382cd1756941908917362ec1aa2f54ab5901299456a90016d
+  data.tar.gz: 98571c88ef2f8758d45f71965d1c2607eeeb00e4f0f8775509207d97129edbc74608042d7c65cea4f642530df6adf9544040d10e86bd271c82228280f3521a27

data/.gitignore

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

data/.travis.yml

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

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

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    retryable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  retryable!
+
+BUNDLED WITH
+   1.16.5

data/README.md

@@ -0,0 +1,110 @@
+# RetryIt
+
+Easily retry a code block a set amount of times, before giving up. Useful for unreliable external I/O, such as accessing
+HTTP servers that periodically throw errors, but are expected to work most of the time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'retry_it'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install retry_it
+
+## Usage
+
+Include RetryIt in your class:
+
+```
+class APIClient
+  include RetryIt
+end
+```
+
+You can then call `retry_it` when running code that fails intermittently:
+
+```
+class APIClient
+  include RetryIt
+
+  def get_data
+    retry_it(errors: [Timeout::Error]) do
+      HTTP.get('http://foo.com')
+    end
+  end
+end
+```
+
+If `HTTP.get` throws an error, `retry_it` will wait a few seconds, and then try
+again. It will repeat this a few times before eventually giving up, and raising
+the last error it received.
+
+`retry_it` accepts these arguments:
+
+* `max_runs`: controls the maximum number of times the block should be fun.
+              Defaults to RetryIt::MAX_RUNS
+* `errors`: an Array of subclasses of Exception, which indicate which Exceptions
+            are considered retryable.
+* `timeout`: how many seconds we will wait between retries. Defaults to
+             RetryIt::DEFAULT_TIMEOUT_S
+* `logger`: A Logger object. If provided, when a retry occurs, an info-level
+            message will be logged.
+* `should_retry_proc`: A Proc that can be used to more finely control when a
+                       retry occurs. The Proc is given one parameter: the
+                       Exception object. The Proc must return a boolean value.
+                       A true indicates that a retry should occur. Useful for
+                       when it is sometimes desired to retry from an error, but
+                       not always (For instance, an HTTP error with code 504 is
+                       retryable, but a 404 probably isn't)
+
+Examples:
+
+```
+# Retry only on HTTPErrors with code 504. All other errors will not trigger a
+# retry.
+retry_it(timeout: 60, errors: [HTTPError], should_retry_proc: Proc.new { |e| e.code == 504 }) do
+  some_api_request
+end
+
+
+# Use a logger to be notified when a retry occurs:
+require 'logger'
+
+logger = Logger.new STDOUT
+retry_it(max_runs: 100, timeout: 60, errors: [Error], logger: logger) do
+  some_api_request
+end
+```
+
+Keep in mind that you can pass methods as parameters using `method`:
+
+```
+class APIClient
+  include RetryIt
+
+  def download_data
+    retry_it(should_retry_proc: method(:is_retryable), errors: [HTTPError]) do
+      api.get("foo.com")
+    end
+  end
+
+  def is_retryable(error)
+    error.code == 504
+  end
+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).

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,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "retry_it"
+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_it.rb

@@ -0,0 +1,32 @@
+require "retry_it/version"
+
+module RetryIt
+  MAX_RUNS = 10
+  DEFAULT_TIMEOUT_S = 10 # seconds
+  DEFAULT_EXCEPTIONS = []
+
+  def retry_it(max_runs: MAX_RUNS,
+               errors: DEFAULT_EXCEPTIONS,
+               timeout: DEFAULT_TIMEOUT_S,
+               should_retry_proc: nil,
+               logger: nil)
+    retries = 0
+    begin
+      yield
+    rescue *errors => e
+      retries += 1
+      if retries < max_runs && (!should_retry_proc.is_a?(Proc) || should_retry_proc.call(e))
+        if logger
+          logger.info "Error (#{e.class}), retrying ##{retries} of #{max_runs}. Sleeping for #{timeout}"
+        end
+        if timeout > 0
+          sleep timeout
+        end
+        retry
+      else
+        raise
+      end
+    end
+  end
+
+end

data/lib/retry_it/version.rb

@@ -0,0 +1,3 @@
+module RetryIt
+  VERSION = "0.1.0"
+end

data/retry_it.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "retry_it/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "retry_it"
+  spec.version       = RetryIt::VERSION
+  spec.authors       = ["rgould"]
+  spec.email         = ["richard.gould@daliaresearch.com"]
+
+  spec.summary       = %q{Easily retry code that fails intermittently}
+  spec.description   = %q{Easily retry code that fails intermittently. Perfect for interacting with that flakey HTTP API.}
+  spec.homepage      = "https://github.com/DaliaResearch/retry_it"
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: retry_it
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rgould
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-26 00:00:00.000000000 Z
+dependencies:
+- !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: Easily retry code that fails intermittently. Perfect for interacting
+  with that flakey HTTP API.
+email:
+- richard.gould@daliaresearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/retry_it.rb
+- lib/retry_it/version.rb
+- retry_it.gemspec
+homepage: https://github.com/DaliaResearch/retry_it
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Easily retry code that fails intermittently
+test_files: []