durable_call 0.0.1 → 0.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.coveralls.yml

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in durable_call.gemspec
 gemspec
+
+gem 'coveralls', :require => false
+

data/README.md

@@ -2,6 +2,9 @@
 
 Invoke methods DRY and safely with parameterized retries, timeouts and logging
 
+[![Travis CI](https://secure.travis-ci.org/AlexanderPavlenko/durable_call.png)](https://travis-ci.org/AlexanderPavlenko/durable_call)
+[![Coverage Status](https://coveralls.io/repos/AlexanderPavlenko/durable_call/badge.png?branch=master)](https://coveralls.io/r/AlexanderPavlenko/durable_call)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,7 +32,7 @@ Multiple arguments and options:
 Where ```options``` may take:
 
     {
-      :interval  # 1. lambda, which takes retries number and returns seconds to sleep
+      :interval  # 1. lambda, which takes retry number (min 1) and returns seconds to sleep
                  # 2. just Float
                  # 3. Symbol for built-in strategies, defaults to :rand
       :logger    # Logger object, defaults to nil

data/benchmarks/simple_method.rb

@@ -4,6 +4,7 @@ require File.expand_path('../../lib/durable_call.rb', __FILE__)
 n = 500000
 Benchmark.bm do |bm|
   object = Object.new
+  caller = DurableCall::Caller.new(object)
 
   bm.report do
     n.times do
@@ -11,6 +12,12 @@ Benchmark.bm do |bm|
     end
   end
 
+  bm.report do
+    n.times do
+      caller.call(:object_id)
+    end
+  end
+
   bm.report do
     n.times do
       DurableCall.call(object, :object_id)

data/durable_call.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
 end

data/lib/durable_call/caller.rb

@@ -13,9 +13,11 @@ module DurableCall
     }.freeze
 
     MESSAGES = {
-      :new_retry => "Retry #%1$i",
-      :failed_call => "Failed to call %1$s on %2$s: %3$s",
-      :waiting_before_retry => "Waiting %1$.2f seconds before retry",
+      :new_retry => 'Retry #%1$i',
+      :failed_call => 'Failed to call %1$s on %2$s: %3$s',
+      :waiting_before_retry => 'Waiting %1$.2f seconds before retry',
+      :retries_error => 'Number of retries exceeded: %1$i',
+      :timeout_error => 'Timeout exceeded: %1$.2f',
     }.freeze
 
     attr_reader :subject
@@ -38,30 +40,19 @@ module DurableCall
         called = false
         result = nil
         (0..@retries).each do |retries_counter|
+          # @timeout may be exceeded here and exception will be raised
           begin
-            @logger.info MESSAGES[:new_retry] % retries_counter if retries_counter > 0 if @logger
+            if retries_counter > 0
+              # first try isn't "retry"
+              log :info, :new_retry, retries_counter
+            end
             result = @subject.__send__ *args
             called = true
-          rescue Timeout::Error => ex
-            # just reraise exception if @timeout exceeded
-            raise
           rescue => ex
-            # @timeout may be exceeded here and exception will be raised
-            @logger.warn MESSAGES[:failed_call] % [args.inspect, @subject, ex.inspect] if @logger
+            log :warn, :failed_call, args.inspect, @subject, ex.inspect
             if @interval && retries_counter < @retries
               # interval specified and it's not a last iteration
-              seconds = if @interval.is_a? Symbol
-                INTERVALS[@interval].call(retries_counter)
-              elsif @interval.respond_to?(:call)
-                @interval.call(retries_counter)
-              else
-                @interval
-              end
-              # sleep before next retry if needed
-              if seconds > 0
-                @logger.info MESSAGES[:waiting_before_retry] % seconds if @logger
-                sleep seconds
-              end
+              sleep_before_retry(retries_counter + 1)
             end
           else
             break
@@ -70,9 +61,35 @@ module DurableCall
         if called
           result
         else
-          raise RetriesError, "Number of retries exceeded: #{@retries}"
+          log :error, :retries_error, @retries
+          raise RetriesError
         end
       end
+    rescue TimeoutError
+      log :error, :timeout_error, @timeout
+      raise
+    end
+
+  private
+
+    def sleep_before_retry(retries_counter)
+      seconds = if @interval.is_a? Symbol
+        INTERVALS[@interval].call(retries_counter)
+      elsif @interval.respond_to?(:call)
+        @interval.call(retries_counter)
+      else
+        @interval
+      end
+      # sleep before next retry if needed
+      if seconds > 0
+        log :info, :waiting_before_retry, seconds
+        sleep seconds
+      end
+    end
+
+    def log(level, message, *args)
+      return unless @logger
+      @logger.send level, MESSAGES[message] % args
     end
   end
 end

data/lib/durable_call/version.rb

@@ -1,3 +1,3 @@
 module DurableCall
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/spec/durable_call_spec.rb

@@ -56,7 +56,9 @@ describe DurableCall do
   it 'invokes long method' do
     @wrapper = DurableCall::Caller.new(@subject, :timeout => 0.1, :logger => @logger)
     expect{ @wrapper.call(:long_method, 1) }.to raise_error(DurableCall::TimeoutError)
-    @log.string.should == ''
+    valid_log?(@log.string, [
+      /E.*Timeout exceeded: 0.10/,
+    ]).should == true
   end
 
   it 'invokes not so long method' do
@@ -71,18 +73,48 @@ describe DurableCall do
     expect{ @wrapper.call(:failing_method, condition) }.to raise_error(DurableCall::RetriesError)
   end
 
-  it 'invokes failing method with logging' do
+  it 'invokes failing method with constant intervals and logging' do
     @wrapper = DurableCall::Caller.new(@subject, :retries => 2, :interval => 0.0123, :logger => @logger)
     (condition = mock).should_receive(:call).exactly(3).times.and_return(true)
     expect{ @wrapper.call(:failing_method, condition) }.to raise_error(DurableCall::RetriesError)
     valid_log?(@log.string, [
-        error   = /W.*Failed to call \[\:failing_method, .*RuntimeError\: it happens/,
-        waiting = /I.*Waiting 0\.01 seconds before retry/,
-        /I.*Retry \#1/,
-        error,
-        waiting,
-        /I.*Retry \#2/,
-        error,
+      error   = /W.*Failed to call \[\:failing_method, .*RuntimeError\: it happens/,
+      waiting = /I.*Waiting 0\.01 seconds before retry/,
+      /I.*Retry \#1/,
+      error,
+      waiting,
+      /I.*Retry \#2/,
+      error,
+      /E.*Number of retries exceeded: 2/,
+    ]).should == true
+  end
+
+  it 'invokes failing method with :rand intervals and logging' do
+    @wrapper = DurableCall::Caller.new(@subject, :retries => 1, :logger => @logger)
+    (condition = mock).should_receive(:call).exactly(2).times.and_return(true)
+    expect{ @wrapper.call(:failing_method, condition) }.to raise_error(DurableCall::RetriesError)
+    valid_log?(@log.string, [
+      error = /W.*Failed to call \[\:failing_method, .*RuntimeError\: it happens/,
+      /I.*Waiting [01]\.\d\d seconds before retry/,
+      /I.*Retry \#1/,
+      error,
+      /E.*Number of retries exceeded: 1/,
+    ]).should == true
+  end
+
+  it 'invokes failing method with custom intervals and logging' do
+    @wrapper = DurableCall::Caller.new(@subject, :retries => 2, :interval => lambda{|i| i / 100.0 }, :logger => @logger)
+    (condition = mock).should_receive(:call).exactly(3).times.and_return(true)
+    expect{ @wrapper.call(:failing_method, condition) }.to raise_error(DurableCall::RetriesError)
+    valid_log?(@log.string, [
+      error   = /W.*Failed to call \[\:failing_method, .*RuntimeError\: it happens/,
+      /I.*Waiting 0\.01 seconds before retry/,
+      /I.*Retry \#1/,
+      error,
+      /I.*Waiting 0\.02 seconds before retry/,
+      /I.*Retry \#2/,
+      error,
+      /E.*Number of retries exceeded: 2/,
     ]).should == true
   end
 
@@ -91,9 +123,9 @@ describe DurableCall do
     (condition = mock).should_receive(:call).twice.and_return(true, false)
     @wrapper.call(:failing_method, condition).should == true
     valid_log?(@log.string, [
-        /W.*Failed to call \[\:failing_method, .*RuntimeError\: it happens/,
-        /I.*Waiting 0\.01 seconds before retry/,
-        /I.*Retry \#1/,
+      /W.*Failed to call \[\:failing_method, .*RuntimeError\: it happens/,
+      /I.*Waiting 0\.01 seconds before retry/,
+      /I.*Retry \#1/,
     ]).should == true
   end
 
@@ -102,8 +134,9 @@ describe DurableCall do
     (condition = mock).should_receive(:call).once.and_return(true)
     expect{ @wrapper.call(:worse_method, 0.05, condition) }.to raise_error(DurableCall::TimeoutError)
     valid_log?(@log.string, [
-        /W.*Failed to call \[\:worse_method, .*RuntimeError\: it happens/,
-        /I.*Waiting 0\.05 seconds before retry/,
+      /W.*Failed to call \[\:worse_method, .*RuntimeError\: it happens/,
+      /I.*Waiting 0\.05 seconds before retry/,
+      /E.*Timeout exceeded: 0.10/,
     ]).should == true
   end
 
@@ -113,8 +146,8 @@ describe DurableCall do
   end
 
   def valid_log?(log, regexps)
+    puts "#{'-' * 20}\n", log
     raise ArgumentError if log.lines.count != regexps.size
-    # puts "#{'-' * 20}\n", log
     log.lines.zip(regexps).all?{|(string, regexp)| string =~ regexp }
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,5 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'coveralls'
+Coveralls.wear!
 require 'durable_call'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: durable_call
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Invoke methods DRY and safely with parameterized retries, timeouts and
   logging
 email:
@@ -94,12 +110,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1232904255849708953
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1232904255849708953
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25