retry-this 1.0

data/README

@@ -0,0 +1,45 @@
+RETRY_THIS
+by Aman King 
+
+http://bitbucket.org/amanking/retry_this/
+
+A module that allows a Ruby block to be tried a specified number of times in case specified types of errors are raised by the block. Especially helpful when dealing with blocks that invoke third-party systems that may be down.
+
+Eg:
+require 'retry_this'
+class Gateway
+    include RetryThis
+    # ...
+    def make_request(url)
+      connection = create_connection
+      retry_this(:times => 3, :error_types => [SocketError, Timeout::Error]) do
+        # this is retried at least 3 times if a SocketError or Timeout::Error occurs
+        connection.start do |http_connection|
+          http_connection.request(Net::HTTP::Get.new(url))
+        end
+      end
+    rescue SocketError, Timeout::Error => e
+      raise Gateway::ConnectionError,  "Connection failed: #{e.message}"
+    rescue StandardError => error
+      raise Gateway::UnexpectedError, "Unexpected error: #{error.message}"
+    end
+    # ...
+end
+
+(see test/retry_this_test.rb for more)
+
+License
+
+   Copyright 2009 Aman King
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/retry-this.rb

@@ -0,0 +1,17 @@
+=begin
+   Copyright 2009 Aman King
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+=end
+
+require 'retry_this'

data/lib/retry_this.rb

@@ -0,0 +1,30 @@
+=begin
+   Copyright 2009 Aman King
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+=end
+
+module RetryThis
+  def retry_this(options = {})
+    number_of_retries = options[:times] || 1
+    error_types = options[:error_types] || [StandardError]
+    (1 + number_of_retries).times do |attempt_number|
+      begin
+        return yield if block_given?
+      rescue *error_types => e
+        raise e unless attempt_number < number_of_retries
+      end
+    end
+  end
+end
+

data/test/retry_this_test.rb

@@ -0,0 +1,70 @@
+=begin
+   Copyright 2009 Aman King
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+=end
+
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '../lib/retry_this')
+
+class RetryThisTest < Test::Unit::TestCase
+  include RetryThis
+  
+  def test_should_retry_block_for_given_number_of_times_for_given_error_types_and_raise_error_if_all_attempts_fail
+    attempts = 0
+    retry_this(:times => 3, :error_types => [TypeError, RuntimeError]) do
+    attempts += 1
+    if attempts % 2 == 0 
+      raise 'some runtime error'
+    else
+      'hi' + 1 # TypeError
+    end
+    end
+  rescue => e
+    assert e.kind_of?(TypeError) || e.kind_of?(RuntimeError)
+    assert_equal(1 + 3, attempts)
+  end
+  
+  def test_should_retry_block_for_default_1_time_for_default_standard_error_and_raise_error_if_all_attempts_fail
+    attempts = 0
+    retry_this do
+    attempts += 1
+    raise StandardError, 'some error'
+    end
+  rescue => e
+    assert_equal('some error', e.message)
+    assert_equal(1 + 1, attempts)
+  end
+  
+  def test_should_pass_on_an_error_that_is_not_among_given_errors
+    attempts = 0
+    retry_this(:error_types => [TypeError]) do
+    attempts += 1
+    raise StandardError, 'some error'
+    end
+  rescue => e
+    assert_equal('some error', e.message)
+    assert_equal(1, attempts)
+  end
+  
+  def test_should_return_value_of_block_if_any_attempt_leads_to_no_error
+    attempts = 0
+    value = retry_this do
+      attempts += 1
+      raise 'some error' if attempts == 1
+      'hi'
+    end
+    assert_equal('hi', value)
+    assert_equal(1 + 1, attempts)
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: retry-this
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Aman King
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-13 00:00:00 +05:30
+default_executable: 
+dependencies: []
+
+description: RetryThis provides a method that takes a block which it will invoke a given number of times before giving up for specified errors
+email: amanking@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/retry-this.rb
+- lib/retry_this.rb
+- test/retry_this_test.rb
+has_rdoc: true
+homepage: http://bitbucket.org/amanking/retry_this/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: RetryThis provides a method that takes a block which it will invoke a given number of times before giving up for specified errors
+test_files: 
+- test/retry_this_test.rb