retryrb 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 2.0.0
+  - jruby-19mode
+  - ree

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lionel Barrow
+
+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,62 @@
+# Retry
+
+[![Build Status](https://travis-ci.org/lionelbarrow/retry.png)](https://travis-ci.org/lionelbarrow/YOUR_PROJECT_NAME)
+
+A few functions for trying again when things don't go as planned.
+
+### Usage
+
+Suppose you had a function, `some_func`, which might raise `SomeError`. If the function does raise that error, you'd like to try again. In that case, you could say:
+```ruby
+Retry.on_exception(SomeError) do
+  some_func
+end
+```
+
+(Note that if the function raises a different error, no retry will be attempted.)
+
+If you'd like to retry a couple of times (let's say three), you can do that:
+```ruby
+Retry.several_times(SomeError, 3) do
+  some_func
+end
+```
+
+Sometimes you want to wait a bit before retrying. This example will retry twice, with a four second delay between each attempt:
+```ruby
+Retry.with_delay(SomeError, 2, 4) do
+  some_func
+end
+```
+
+Another common pattern is to wait more and more time between each attempt; this is usually called "exponential backoff". This example will retry 3 times, with a delay of 2, 4, and 8 seconds between each attempt:
+```ruby
+Retry.with_exponential_backoff(SomeError, 3, 2) do
+  some_func
+end
+```
+
+### License
+
+The MIT License (MIT)
+
+Copyright (c) 2013 Lionel Barrow
+
+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/Rakefile

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

data/lib/retry/version.rb

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

data/lib/retry.rb

@@ -0,0 +1,29 @@
+module Retry
+  def self.on_exception(exception_class, &block)
+    _with_options(exception_class, 1, 0, false, &block)
+  end
+
+  def self.several_times(exception_class, retries, &block)
+    _with_options(exception_class, retries, 0, false, &block)
+  end
+
+  def self.with_delay(exception_class, retries, seconds_to_wait, &block)
+    _with_options(exception_class, retries, seconds_to_wait, false, &block)
+  end
+
+  def self.with_exponential_backoff(exception_class, retries, base_seconds, &block)
+    _with_options(exception_class, retries, base_seconds, true, &block)
+  end
+
+  def self._with_options(exception_class, retries, base_seconds, exponential_backoff, &block)
+    retries.times do |attempt|
+      begin
+        return yield
+      rescue exception_class
+        sleep(base_seconds ** (attempt + 1)) if exponential_backoff
+        sleep(base_seconds) unless exponential_backoff
+      end
+    end
+    yield
+  end
+end

data/retryrb.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path('../lib/retry/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "retryrb"
+  spec.version       = Retry::VERSION
+  spec.authors       = ["lionelbarrow"]
+  spec.email         = ["lionelbarrow@gmail.com"]
+  spec.description   = "Provides a handful of generic functions for retry strategies."
+  spec.summary       = "Provides generic functions for retry strategies."
+  spec.homepage      = "https://www.github.com/lionelbarrow/retry"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rake"
+end

data/spec/retry/retry_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+describe Retry do
+  describe "_with_options" do
+    it "retries if the correct exception is thrown" do
+      Retry.should_receive(:sleep).once
+
+      count = 0
+      Retry._with_options(DummyError, 1, 1, true) do
+        count += 1
+        raise DummyError if count == 1
+      end
+      count.should == 2
+    end
+
+    it "lets the exception propogate if it does not match" do
+      expect do
+        Retry._with_options(DummyError, 1, 1, true) do
+          raise
+        end
+      end.to raise_error
+    end
+
+    it "sleeps an increasing number of seconds in between attempts" do
+      Retry.should_receive(:sleep).with(2).once
+      Retry.should_receive(:sleep).with(4).once
+
+      count = 0
+      Retry._with_options(DummyError, 2, 2, true) do
+        count += 1
+        raise DummyError unless count == 3
+      end
+    end
+
+    it "tries to retry the number of times specified" do
+      Retry.should_receive(:sleep).exactly(4).times
+
+      count = 0
+      Retry._with_options(DummyError, 4, 1, true) do
+        count += 1
+        raise DummyError if count < 5
+      end
+      count.should == 5
+    end
+
+    it "allows the exception to pass through after the retries have been exhausted" do
+      Retry.should_receive(:sleep).with(1).exactly(2).times
+
+      count = 0
+      expect do
+        Retry._with_options(DummyError, 2, 1, true) do
+          count += 1
+          raise DummyError if count < 4
+        end
+      end.to raise_error(DummyError)
+      count.should == 3
+    end
+
+    it "propagates the block's return value" do
+      Retry._with_options(DummyError, 1, 1, true) do
+        3
+      end.should == 3
+    end
+  end
+
+  describe "with_delay" do
+    it "sleeps a constant amount of time between attempts" do
+      Retry.should_receive(:sleep).with(1).exactly(3).times
+
+      count = 0
+      Retry.with_delay(DummyError, 4, 1) do
+        count += 1
+        raise DummyError unless count == 4
+      end
+      count.should == 4
+    end
+  end
+
+  describe "with_exponential_backoff" do
+    it "sleeps an increasing amount of time between attempts" do
+      Retry.should_receive(:sleep).with(3).once
+      Retry.should_receive(:sleep).with(9).once
+      Retry.should_receive(:sleep).with(27).once
+
+      count = 0
+      Retry.with_exponential_backoff(DummyError, 3, 3) do
+        count += 1
+        raise DummyError unless count == 4
+      end
+    end
+  end
+
+  describe "several_times" do
+    it "retries the specified number of times" do
+      count = 0
+      Retry.several_times(DummyError, 3) do
+        count += 1
+        raise DummyError unless count == 4
+      end
+      count.should == 4
+    end
+  end
+
+  describe "on_exception" do
+    it "retries once" do
+      count = 0
+      Retry.on_exception(DummyError) do
+        count += 1
+        raise DummyError unless count == 2
+      end
+      count.should == 2
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "retry"
+
+class DummyError < StandardError; end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: retryrb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- lionelbarrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a handful of generic functions for retry strategies.
+email:
+- lionelbarrow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/retry.rb
+- lib/retry/version.rb
+- retryrb.gemspec
+- spec/retry/retry_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.github.com/lionelbarrow/retry
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides generic functions for retry strategies.
+test_files:
+- spec/retry/retry_spec.rb
+- spec/spec_helper.rb