rescue-retry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a8b1fc794a6e2af2f1f49306d53a4c78dfef9e1
+  data.tar.gz: 21799f0fea3fb29a50cc4a4bdd4eb06da5d2588e
+SHA512:
+  metadata.gz: 46b16c7045ac1eaa166bf10c6b8fcff1bab2a50a15f3e6c6f1ddea676709ac60f37cecdebcb3efa5ded07b158e212ed2dc84af642a91e79f2e2605a6eaf033db
+  data.tar.gz: 95018b6100071aff5798470fed71815fcdcab1508a0a903338ca61efdd17f243f90dc9f6eb33786feb97f1b87e9f9dead7d9f679a5967c5471343cea91029137

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rescue-retry.gemspec
+gemspec

data/README.md

@@ -0,0 +1,56 @@
+# Rescue::Retry
+
+Wraps a instance method in a configurable retry handler with additional/optional delay logic as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rescue-retry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rescue-retry
+
+## Usage
+
+```ruby
+require 'rescue/retry'
+
+class StateCache
+    extend Rescue::Retry
+
+    # Simple
+    rescue_retry :retrieve, Redis::CannotConnectError
+
+    # Verbose
+    rescue_retry :update, [Redis::CannotConnectError, ArgumentError],
+                  max_attempts: 5, # optional
+                  delay: :exponential # optional: :linear, :random
+
+    def retrieve
+      redis.get(key)
+    end
+
+    def update(data)
+      redis.set(key, data)
+    end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[robert2d]/rescue-retry.
+

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rescue/retry"
+
+# 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

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/rescue/handler.rb

@@ -0,0 +1,43 @@
+require 'logger'
+
+module Rescue
+  class Handler
+    attr_reader :errors, :logger, :attempt, :max_attempts, :delay
+
+    def initialize(options = {})
+      @errors = options[:errors] || []
+      @max_attempts = options[:max_attempts] || 3
+      @delay = options[:delay] || :none
+      @logger = options[:logger] || ::Logger.new($stdout)
+      @attempt = 1
+    end
+
+    def call(&block)
+      block.call
+    rescue *errors => e
+      logger.warn "Failed attempt (#{attempt} of #{max_attempts}) #<#{e.class.name}.#{e.message}>"
+      re_raise(e) if max_attempts?
+      @attempt += 1
+      sleep delay_retry(attempt) unless delay == :none
+      retry
+    end
+
+    private
+
+    def delay_retry(attempt)
+      return attempt ** 2 if delay == :exponential
+      return attempt * 2 if delay == :linear
+      return (rand + 1) * 0.5 * attempt if delay == :random
+      raise ArgumentError, "unknown delay \"#{delay}\". accepts: :exponential, :linear and :random"
+    end
+
+    def re_raise(error)
+      logger.error "maximum attempts (#{max_attempts}) reached"
+      raise error.class, error.message
+    end
+
+    def max_attempts?
+      attempt == max_attempts
+    end
+  end
+end

data/lib/rescue/retry.rb

@@ -0,0 +1,22 @@
+require 'rescue/version'
+require 'rescue/handler'
+
+module Rescue
+  module Retry
+    def rescue_retry(method, errors, options = {})
+      proxy = Module.new do
+        define_method(method) do |*args|
+          Handler.new(
+            {
+              errors: Array(errors),
+              logger: respond_to?(:logger) ? logger : nil
+            }.merge(options)
+          ).call do
+            super *args
+          end
+        end
+      end
+      self.prepend proxy
+    end
+  end
+end

data/lib/rescue/version.rb

@@ -0,0 +1,5 @@
+module Rescue
+  module Retry
+    VERSION = "0.1.0"
+  end
+end

data/rescue-retry.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rescue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rescue-retry"
+  spec.version       = Rescue::Retry::VERSION
+  spec.authors       = ["robert2d"]
+  spec.email         = ["david.robertson@crichq.com"]
+
+  spec.summary       = %q{Rescue and Retry a instance method, whilst keeping a method free from rescue's}
+  spec.description   = %q{Wraps an instance method with retry and error capture without adding logic directly to the method}
+  spec.homepage      = "https://github.com/robert2d/rescue-retry"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rescue-retry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- robert2d
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Wraps an instance method with retry and error capture without adding
+  logic directly to the method
+email:
+- david.robertson@crichq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rescue/handler.rb
+- lib/rescue/retry.rb
+- lib/rescue/version.rb
+- rescue-retry.gemspec
+homepage: https://github.com/robert2d/rescue-retry
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rescue and Retry a instance method, whilst keeping a method free from rescue's
+test_files: []