retrier 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7a979e1dba5b5a2fc42472e7b3bda3237249dff
+  data.tar.gz: d2e25de2e347612d5309baff7c756e407a1054c3
+SHA512:
+  metadata.gz: 1749e26444a75b2a35a41a5f5659a75f7cef65b12d1c659d5fb80c09ee12bd2ed11efd9b3e0f97e2884091d4f418a72897af834bb76a230c8b504f049f1b3af9
+  data.tar.gz: 0162115d3dd12f5f6722fecfa8236ff4b1455568c83a5397340c2cc9e8a8254a742cadb156609540d0077752ee57bb0636232c23862bd7e7660d5a7e69663ac3

data/README.md

@@ -0,0 +1,26 @@
+#Retrier
+
+Retry a code block the given number of times.
+
+##Usage
+
+###Basic usage
+```ruby
+Retrier.new(max_tries: 5) do
+  do_something_which_may_fail
+end
+```
+
+###Exception handlers
+If supplied with a list of handler functions, `Retrier` will call the handler method. If there isn't a registered handler for the raised exception it will retry the block.
+```ruby
+handlers = {
+  StandardError: (exception) -> {
+    do_something_if_standard_error_has_beenraised
+  }
+}
+
+Retrier.new(handlers: handlers) do
+  risky_operation
+end
+```

data/Rakefile

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

data/lib/retrier.rb

@@ -0,0 +1,25 @@
+class Retrier
+  def initialize(options={}, &block)
+    max_tries = options.fetch(:max_tries, 10)
+    rescuable = Array(options.fetch(:rescue, StandardError))
+    handlers = options[:handlers]
+
+    attempts = 0
+
+    begin
+      attempts += 1
+      return block.call(attempts)
+    rescue *rescuable => exception
+      if handlers
+        handlers.each do |ex,handler|
+          handler.call(exception) if Kernel.const_get(ex) == exception.class
+        end
+      elsif attempts >= max_tries
+        raise exception
+      else
+        retry
+      end
+    end
+
+  end
+end

data/retrier.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "retrier"
+  gem.version       = "1.0.0"
+  gem.authors       = ["Boris Filipov"]
+  gem.email         = ["bfilipov+rubygems@gmail.com"]
+  gem.description   = %q{ Retries a code block the given number of times }
+  gem.homepage      = "https://github.com/borfd/retrier"
+  gem.license       = "MIT"
+  gem.summary       = %q{Execute any code block an arbitrary number of times. Optionally supply exception handlers.}
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+end

data/spec/retrier_spec.rb

@@ -0,0 +1,66 @@
+require 'retrier'
+
+class MyCustomTestException < RuntimeError; end
+class MyCustomTestExceptionB < RuntimeError; end
+
+describe Retrier do
+
+  let(:max_tries) { 4 }
+
+  it "runs only once if there is no exception" do
+    dbl = double
+    dbl.should_receive(:test_this).exactly(1).times
+
+    Retrier.new do
+      dbl.test_this
+    end
+  end
+
+  it "retries the given number of times" do
+    tries = 0
+    dbl = double
+    dbl.should_receive(:test_this).exactly(max_tries).times
+
+    Retrier.new(max_tries: max_tries) do |attempts|
+      tries += 1
+      dbl.test_this
+      fail StandardError unless tries == max_tries
+    end
+
+  end
+
+  it "doesn't catch an exception which isn't passed" do
+    expect {
+      Retrier.new(rescue: MyCustomTestException) do
+        fail MyCustomTestExceptionB
+      end
+    }.to raise_error(MyCustomTestExceptionB)
+  end
+
+  context "with registered exception handlers" do
+    let(:dbl) { double }
+    let(:handlers) do
+      {
+        MyCustomTestException: -> (ex) {
+          dbl.my_custom_exception_raised
+        },
+        MyCustomTestExceptionB: -> (ex) {
+          dbl.this_should_not_happen
+        },
+        StandardError: -> (ex) {
+          dbl.this_should_not_happen
+        }
+      }
+    end
+
+    it "rescues exception and calls appropriate handler" do
+      dbl.should_receive(:my_custom_exception_raised)
+      dbl.should_not_receive(:this_should_not_happen)
+
+      Retrier.new(handlers: handlers) do
+        raise MyCustomTestException
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: retrier
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Boris Filipov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: ' Retries a code block the given number of times '
+email:
+- bfilipov+rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/retrier.rb
+- retrier.gemspec
+- spec/retrier_spec.rb
+homepage: https://github.com/borfd/retrier
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Execute any code block an arbitrary number of times. Optionally supply exception
+  handlers.
+test_files:
+- spec/retrier_spec.rb