rescue_me 0.1.1 → 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+pkg/*.gem
+coverage
+.bundle
+.rvmrc
+Gemfile.lock
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS (really?)
+*~
+\#*
+.\#*
+
+## VIM
+.*.sw*
+.sw*

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p194

data/Gemfile

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

data/LICENSE

@@ -1,26 +1,22 @@
-Copyright (c) 2010 Arild Shirazi. All rights reserved.
+Copyright (c) 2010 Arild Shirazi
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+MIT License
 
-   1. Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
+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:
 
-   2. Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THIS SOFTWARE IS PROVIDED BY ARILD SHIRAZI ``AS IS'' AND ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
-SHALL ARILD SHIRAZI OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are those
-of the authors and should not be interpreted as representing official policies,
-either expressed or implied, of Arild Shirazi.
+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.rdoc

@@ -19,9 +19,9 @@ following 2 network errors:
   }
 
 Log output:
-  WARN -- : rescue and retry (attempt 1/5): ./mailer.rb:43,  <SMTPServerBusy: 451 4.3.0 Mail server temporarily rejected message.>
-  WARN -- : rescue and retry (attempt 2/5): ./mailer.rb:43,  <SMTPServerBusy: 451 4.3.0 Mail server temporarily rejected message.>
-  WARN -- : rescue and retry (attempt 3/5): ./mailer.rb:43,  <SMTPServerBusy: 451 4.3.0 Mail server temporarily rejected message.>
+  WARN -- : rescue_and_retry(1/5) "SMTPServerBusy: 451 4.3.0 Mail server temporarily rejected message." in ./mailer.rb:43
+  WARN -- : rescue_and_retry(2/5) "SMTPServerBusy: 451 4.3.0 Mail server temporarily rejected message." in ./mailer.rb:43
+  WARN -- : rescue_and_retry(3/5) "SMTPServerBusy: 451 4.3.0 Mail server temporarily rejected message." in ./mailer.rb:43
   # No further output or stacktrace. Block succeeded on 4th attempt.
 
 
@@ -29,27 +29,4 @@ Log output:
 
 Copyright (c) 2010 Arild Shirazi. All rights reserved.
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-   1. Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-
-   2. Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY ARILD SHIRAZI ``AS IS'' AND ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
-SHALL ARILD SHIRAZI OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are those
-of the authors and should not be interpreted as representing official policies,
-either expressed or implied, of Arild Shirazi.
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/rescue_me/version.rb

@@ -1,3 +1,3 @@
 module RescueMe
-  VERSION = '0.1.1' unless defined? RescueMe::VERSION
+  VERSION = '0.1.2' unless defined? RescueMe::VERSION
 end

data/lib/rescue_me.rb

@@ -1,5 +1,6 @@
-module Kernel
+require "rescue_me/version"
 
+module Kernel
   # Reattempts to run code passed in to this block if a temporary exception occurs
   # (e.g. Net::SMTPServerBusy), using an exponential back-off algorithm
   # (e.g. retry immediately, then after 1, 2, 4, 8, 16, 32... sec).
@@ -16,42 +17,13 @@ module Kernel
       yield
     rescue *temporary_exceptions => e
       attempt = (attempt || 0) + 1
-      RescueMe::Logger.warn(attempt, max_attempts, caller, e)
-
+      message = "rescue_and_retry(#{attempt}/#{max_attempts}) " +
+          "\"#{e.class}: #{e.message}\" in #{caller[1].sub(/.*\/(.*):in.*/,'\1')}"
+      (defined? logger) ? logger.warn(message) : STDERR.puts(message)
       raise(e) if attempt >= max_attempts
-
       # Retry immediately before exponential waits (1, 2, 4, 16, ... sec)
       sleep retry_interval**(attempt - 2) if attempt >= 2
       retry
     end
   end
-
-end
-
-module RescueMe
-  require "logger"
-
-  class << self
-    def logger
-      @logger ||= defined?(Rails) && Rails.respond_to?(:logger) ? Rails.logger : ::Logger.new($stdout)
-    end
-  end
-
-  module Logger
-
-    class << self
-      def warn(attempt, max_attempts, kaller, exception)
-        if RescueMe.logger && RescueMe.logger.respond_to?(:warn)
-          RescueMe.logger.warn(rescued_message(attempt, max_attempts, kaller, exception))
-        end
-      end
-
-      def rescued_message(attempt, max_attempts, kaller, exception)
-        "rescue and retry (attempt #{attempt}/#{max_attempts}): " +
-        "#{kaller.first}, <#{exception.class}: #{exception.message}>"
-      end
-    end
-
-  end
-
 end

data/pkg/.gitignore

@@ -0,0 +1 @@
+*.gem

data/rescue_me.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rescue_me/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'rescue_me'
+  spec.version     = RescueMe::VERSION
+  spec.authors     = ['Arild Shirazi']
+  spec.email       = ['as4@eshirazi.com']
+  spec.description = 'Provides a convenience method to retry blocks of code that might fail due to temporary errors, e.g. a network service that becomes temporarily unavailable. The retries are timed to back-off exponentially (2^n seconds), hopefully giving time for the remote server to recover.'
+  spec.summary     = 'Retry a block of code that might fail due to temporary errors.'
+  spec.homepage    = 'https://github.com/ashirazi/rescue_me'
+  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'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'shoulda'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/rescue_me_spec.rb

@@ -0,0 +1,85 @@
+require_relative 'spec_helper'
+
+# TODO AS: Replace this class with a mock
+class ExceptionCounter
+
+  require 'net/smtp'
+  attr_reader :method_called_count
+
+  def initialize
+    @method_called_count = 0
+  end
+
+  def exception_free
+    @method_called_count += 1
+    "This method does not raise exceptions"
+  end
+
+  def raise_zero_division_error
+    @method_called_count += 1
+    12/0
+  end
+
+  # Will raise SMTPServerBusy the first x times this method is called,
+  # after which this method does nothing.
+  def raise_smtp_exception_until_call(times)
+    @method_called_count += 1
+    @smtp_exception_count = (@smtp_exception_count ||= 0) + 1
+    raise Net::SMTPServerBusy if times > @smtp_exception_count
+  end
+
+end # ExceptionCounter
+
+describe 'rescue_me' do
+
+  before(:each) do
+    @exception_counter = ExceptionCounter.new
+  end
+
+  it "runs an exception-free block of code once" do
+    rescue_and_retry {
+      @exception_counter.exception_free
+    }
+    @exception_counter.method_called_count.should == 1
+  end
+
+  it "attempts to run a block that raises an unexpected exception only once" do
+    expect do
+      rescue_and_retry(5, IOError) {
+        @exception_counter.raise_zero_division_error
+      }
+    end.to raise_error ZeroDivisionError
+    @exception_counter.method_called_count.should == 1
+  end
+
+  it "re-runs the block of code for exactly max_attempt number of times" do
+    begin
+      rescue_and_retry(3, ZeroDivisionError) {
+        @exception_counter.raise_zero_division_error
+      }
+    rescue
+    end
+    @exception_counter.method_called_count.should == 3
+  end
+
+  it "re-runs the block of code for exactly a single time when specified" do
+    @exception_counter = ExceptionCounter.new
+    begin
+      rescue_and_retry(1, ZeroDivisionError) {
+        @exception_counter.raise_zero_division_error
+      }
+    rescue
+    end
+    @exception_counter.method_called_count.should == 1
+  end
+
+  it "does not re-run the block of code after it has run successfully" do
+    expect do
+      rescue_and_retry(5, Net::SMTPServerBusy) {
+        @exception_counter.raise_smtp_exception_until_call(3)
+      }
+    end.to_not raise_error
+    @exception_counter.method_called_count.should == 3
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+
+require_relative '../lib/rescue_me'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rescue_me
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-04 00:00:00.000000000 Z
+date: 2013-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -69,12 +101,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rescue_me/version.rb
-- lib/rescue_me.rb
+- .document
+- .gitignore
+- .ruby-version
+- Gemfile
 - LICENSE
 - README.rdoc
+- Rakefile
+- lib/rescue_me.rb
+- lib/rescue_me/version.rb
+- pkg/.gitignore
+- rescue_me.gemspec
+- spec/rescue_me_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/ashirazi/rescue_me
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -90,12 +132,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubyforge_project: rescue_me
+rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Retry a block of code that might fail due to temporary errors.
-test_files: []
+test_files:
+- spec/rescue_me_spec.rb
+- spec/spec_helper.rb
 has_rdoc: