reliable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afbd6aaeb9f1d19e3511e537e71193fed673f97b
+  data.tar.gz: 123dd86916e2e6b82d46647494d9aeae7a1baebd
+SHA512:
+  metadata.gz: 0d00ee6c4d11c2ed8cba0653dcbefc10a63f74b82855aa34af241a38ca272a3074da072d93670c84cbf356b82d1a3f4e69ac9237a327f2aa185f194da55ad278
+  data.tar.gz: dd84c008ca7df5ed2015ffaaa46db0b0de988a5410e9ff63646366dbbbde31041f795b17f67b3ab7302e07bbbf117d95c1552cec7d9c9aaa1189297bb52fa45b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yusuke KUOKA
+
+MIT License
+
+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,56 @@
+# Reliable
+
+A ruby gem to reliably retry methods and blocks in a reusable, customizable, clean way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reliable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reliable
+
+## Usage
+
+```ruby
+Reliable::Tryer.after_call = -> value:, error:, tries: {
+  puts "#{tries}: value=#{value}, error=#{error.class.name}(#{error})"
+}
+
+class Test
+  extend Reliable
+
+  class FooError < StandardError; end
+
+  def foo
+    raise FooError, 'message' if rand < 0.8
+    "successful result"
+  end
+
+  retries :foo, up_to: 3.times, on: FooError
+end
+
+# Test.new.foo
+#1: value=, error=Test::FooError(message)
+#Retrying on error: Test::FooError: message
+#2: value=, error=Test::FooError(message)
+#Retrying on error: Test::FooError: message
+#3: value=successful result, error=NilClass()
+#=> "successful result"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/reliable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/reliable.rb

@@ -0,0 +1,78 @@
+module Reliable
+  def retries(method, up_to:, on:, delay: Tryer.delay, before_retry: Tryer.before_retry, after_call: Tryer.after_call)
+    original_method = :"#{method}_without_reliable"
+    alias_method original_method, method
+
+    tryer = Tryer.new(up_to: up_to, on: on, delay: delay, before_retry: before_retry, after_call: after_call)
+    define_method method do |*args|
+      tryer.reliably do
+        __send__ original_method, *args
+      end
+    end
+  end
+
+  class Tryer
+    class << self
+      def delay=(delay)
+        @delay = delay
+      end
+
+      def delay
+        @delay ||= -> x { x ** 2 }
+      end
+
+      def before_retry=(before_retry)
+        @before_retry = before_retry
+      end
+
+      def before_retry
+        @before_retry ||= -> e:, tries: {
+          warn "Retrying on error: #{e.class.name}: #{e}"
+        }
+      end
+
+      def after_call=(after_call)
+        @after_call = after_call
+      end
+
+      def after_call
+        @after_call ||= -> value:, error:, tries: {}
+      end
+    end
+
+    def initialize(up_to:, on:, delay: Tryer.delay, before_retry: Tryer.before_retry, after_call: Tryer.after_call)
+      @enumerable = up_to.respond_to?(:each) ? up_to : up_to.times
+      @before_retry = before_retry
+      @after_call = after_call
+      @delay = delay
+      @retried_errors = [on].flatten
+    end
+
+    def reliably(&block)
+      tries = 0
+      last_value = nil
+      last_error = nil
+
+      @enumerable.each do
+        tries += 1
+
+        begin
+          if tries > 1
+            @before_retry[e: last_error, tries: tries]
+            sleep @delay[tries-1]
+          end
+
+          last_error = nil
+          last_value = block.call
+          return last_value
+        rescue *@retried_errors => e
+          last_error = e
+        ensure
+          @after_call[value: last_value, error: last_error, tries: tries]
+        end
+      end
+
+      raise last_error
+    end
+  end
+end

data/lib/reliable/version.rb

@@ -0,0 +1,3 @@
+module Reliable
+  VERSION = "0.0.1"
+end

data/reliable.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reliable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reliable"
+  spec.version       = Reliable::VERSION
+  spec.authors       = ["Yusuke KUOKA"]
+  spec.email         = ["yusuke.kuoka@crowdworks.co.jp"]
+  spec.summary       = %q{A ruby gem to reliably retry methods and blocks in a reusable, customizable, clean way.}
+  spec.homepage      = "https://github.com/crowdworks/reliable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: reliable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yusuke KUOKA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 
+email:
+- yusuke.kuoka@crowdworks.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/reliable.rb
+- lib/reliable/version.rb
+- reliable.gemspec
+homepage: https://github.com/crowdworks/reliable
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby gem to reliably retry methods and blocks in a reusable, customizable,
+  clean way.
+test_files: []
+has_rdoc: