retryable 1.2 → 1.2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "rspec", "~> 2.5.0"
+end

data/README.markdown

@@ -0,0 +1,75 @@
+retryable gem
+=====
+
+![travis-ci](http://travis-ci.org/nfedyashev/retryable.png)
+
+Description
+--------
+
+Runs a code block, and retries it when an exception occurs. It's great when
+working with flakey webservices (for example).
+
+It's configured using two optional parameters --`:tries` and `:on`--, and
+runs the passed block. Should an exception occur, it'll retry for (n-1) times.
+
+Should the number of retries be reached without success, the last exception
+will be raised.
+
+
+Examples
+--------
+
+Open an URL, retry up to two times when an `OpenURI::HTTPError` occurs.
+
+``` ruby
+require "retryable"
+require "open-uri"
+
+retryable( :tries => 3, :on => OpenURI::HTTPError ) do
+  xml = open( "http://example.com/test.xml" ).read
+end
+```
+
+Do _something_, retry up to four times for either `ArgumentError` or 
+`TimeoutError` exceptions.
+
+``` ruby
+require "retryable"
+
+retryable( :tries => 5, :on => [ ArgumentError, TimeoutError ] ) do
+  # some crazy code
+end
+```
+
+## Defaults
+
+    :tries => 1, :on => Exception
+    
+  
+Installation
+-------
+
+Install the gem:
+
+``` bash
+$ gem install retryable
+```
+
+Add it to your Gemfile:
+
+``` ruby
+gem 'retryable'
+```
+
+
+## Changelog
+
+*  v1.3: stability -- Thoroughly unit-tested
+*  v1.2: FIX -- block would run twice when `:tries` was set to `0`. (Thanks for the heads-up to [Tuker](http://github.com/tuker).)
+
+
+## Thanks
+
+Many thanks to [Chu Yeow for this nifty piece of code](http://blog.codefront.net/2008/01/14/retrying-code-blocks-in-ruby-on-exceptions-whatever/). Look, I liked it
+enough to enhance it a little bit and build a gem from it! :)
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "retryable"
+  gem.homepage = "http://github.com/nfedyashev/retryable"
+  gem.license = "MIT"
+  gem.summary = %Q{Kernel#retryable, allow for retrying of code blocks.}
+  gem.description = %Q{Kernel#retryable, allow for retrying of code blocks.}
+  gem.email = "loci.master@gmail.com"
+  gem.authors = ["Nikita Fedyashev", "Carlo Zottmann", "Chu Yeow"]
+
+  gem.add_development_dependency 'bundler', ['>= 1.0.0']
+  gem.add_development_dependency 'rspec', '~> 2.5.0'
+
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "retryable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.2.1

data/lib/retryable.rb

@@ -2,18 +2,18 @@
 # http://blog.codefront.net/2008/01/14/retrying-code-blocks-in-ruby-on-exceptions-whatever/
 # Slightly rewritten to allow for passing of more than just type of exception.
 
-def retryable( options = {}, &block )
+def retryable(options = {}, &block)
   opts = { :tries => 1, :on => Exception }.merge(options)
 
   return nil if opts[:tries] == 0
-  
+
   retry_exception, tries = [ opts[:on] ].flatten, opts[:tries]
- 
+
   begin
     return yield
   rescue *retry_exception
     retry if (tries -= 1) > 0
   end
- 
+
   yield
 end

data/retryable.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{retryable}
+  s.version = "1.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nikita Fedyashev", "Carlo Zottmann", "Chu Yeow"]
+  s.date = %q{2011-05-10}
+  s.description = %q{Kernel#retryable, allow for retrying of code blocks.}
+  s.email = %q{loci.master@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "lib/retryable.rb",
+    "retryable.gemspec",
+    "spec/lib/retryable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/nfedyashev/retryable}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.1}
+  s.summary = %q{Kernel#retryable, allow for retrying of code blocks.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+  end
+end
+

data/spec/lib/retryable_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'retryable' do
+
+  before(:each) do
+    @attempt = 0
+  end
+
+  it "should make another try on exception" do
+    retryable(:tries => 1, :on => RuntimeError) do
+      @attempt = @attempt + 1
+      raise RuntimeError unless @attempt == 2
+    end
+  end
+
+  it "should make another try if exception is in whitelist" do
+    retryable(:tries => 1, :on => [StandardError, ArgumentError, RuntimeError]) do
+      @attempt = @attempt + 1
+      raise ArgumentError unless @attempt == 2
+    end
+  end
+
+  it "should not try on unexpected exception" do
+    lambda do
+      retryable(:tries => 1, :on => RuntimeError) do
+        @attempt = @attempt + 1
+        raise StandardError unless @attempt == 2
+      end
+    end.should raise_error StandardError
+  end
+
+  it "should make always retry on default exception" do
+    retryable(:tries => 1) do
+      @attempt = @attempt + 1
+      raise StandardError unless @attempt == 2
+    end
+  end
+
+  it "should retry once unless :tries explicitly set" do
+    retryable do
+      @attempt = @attempt + 1
+      raise StandardError unless @attempt == 2
+    end
+  end
+
+  it "should retry twice" do
+    retryable(:tries => 2, :on => RuntimeError) do
+      @attempt = @attempt + 1
+      raise RuntimeError unless @attempt == 3
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+
+require File.dirname(__FILE__) + '/../lib/retryable'
+require 'rspec'
+
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+end

metadata

@@ -1,57 +1,154 @@
 --- !ruby/object:Gem::Specification 
 name: retryable
 version: !ruby/object:Gem::Version 
-  version: "1.2"
+  hash: 29
+  prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
+- Nikita Fedyashev
 - Carlo Zottmann
 - Chu Yeow
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-11-20 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
+date: 2011-05-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id001
+  name: bundler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  version_requirements: *id002
+  name: jeweler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  version_requirements: *id003
+  name: rspec
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id004
+  name: bundler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  version_requirements: *id005
+  name: rspec
+  prerelease: false
 description: Kernel#retryable, allow for retrying of code blocks.
-email: carlo@zottmann.org
+email: loci.master@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.markdown
 files: 
+- .travis.yml
+- Gemfile
+- README.markdown
+- Rakefile
+- VERSION
 - lib/retryable.rb
-- test/tests.rb
-has_rdoc: true
-homepage: http://github.com/carlo/retryable
-licenses: []
-
+- retryable.gemspec
+- spec/lib/retryable_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nfedyashev/retryable
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.7.1
 signing_key: 
 specification_version: 3
 summary: Kernel#retryable, allow for retrying of code blocks.
-test_files: 
-- test/tests.rb
+test_files: []
+

data/test/tests.rb

@@ -1 +0,0 @@
-# nothing to see here yet, move along