durable_call 0.0.1

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 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexander Pavlenko
+
+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,52 @@
+# DurableCall
+
+Invoke methods DRY and safely with parameterized retries, timeouts and logging
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'durable_call'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install durable_call
+
+## Usage
+
+Simple usage:
+
+    DurableCall.call(Object.new, :object_id)
+
+Multiple arguments and options:
+
+    DurableCall.call(Something.new, [:method_name, :param, :other_param], options)
+
+Where ```options``` may take:
+
+    {
+      :interval  # 1. lambda, which takes retries number and returns seconds to sleep
+                 # 2. just Float
+                 # 3. Symbol for built-in strategies, defaults to :rand
+      :logger    # Logger object, defaults to nil
+      :retries   # retries number, defaults to 0
+      :timeout   # operation timeout, defaults to nil (no time limits)
+    }
+
+Also, it's possible to perform multiple calls with the same options:
+
+    caller = DurableCall::Caller.new(Something.new, options)
+    caller.call(:method_name, :param, :other_param)
+    caller.call(:faster_faster, :no_instantiation_overhead)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/benchmarks/simple_method.rb

@@ -0,0 +1,19 @@
+require 'benchmark'
+require File.expand_path('../../lib/durable_call.rb', __FILE__)
+
+n = 500000
+Benchmark.bm do |bm|
+  object = Object.new
+
+  bm.report do
+    n.times do
+      object.__send__ :object_id
+    end
+  end
+
+  bm.report do
+    n.times do
+      DurableCall.call(object, :object_id)
+    end
+  end
+end

data/durable_call.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'durable_call/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "durable_call"
+  spec.version       = DurableCall::VERSION
+  spec.authors       = ["Alexander Pavlenko"]
+  spec.email         = ["apavlenko@mirantis.com"]
+  spec.description   = %q{Invoke methods DRY and safely with parameterized retries, timeouts and logging}
+  spec.summary       = %q{Durable methods invocation}
+  spec.homepage      = ""
+  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 "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/durable_call/caller.rb

@@ -0,0 +1,78 @@
+require 'timeout'
+
+module DurableCall
+
+  class RetriesError < RuntimeError; end
+  TimeoutError = Timeout::Error
+
+  class Caller
+
+    INTERVALS = {
+      :rand => lambda{|_| rand },
+      # TODO: progression with the increasing delays between retries
+    }.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",
+    }.freeze
+
+    attr_reader :subject
+
+    def initialize(subject, options={})
+      @subject = subject
+      { # default options
+        :interval => :rand,
+        :logger   => nil,
+        :retries  => 0,
+        :timeout  => nil,
+      }.each do |key, value|
+        instance_variable_set :"@#{key}", options.key?(key) ? options[key] : value
+      end
+    end
+
+    def call(*args)
+      Timeout.timeout(@timeout) do
+        # we want to return as soon as result will be obtained
+        called = false
+        result = nil
+        (0..@retries).each do |retries_counter|
+          begin
+            @logger.info MESSAGES[:new_retry] % retries_counter if retries_counter > 0 if @logger
+            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
+            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
+            end
+          else
+            break
+          end
+        end
+        if called
+          result
+        else
+          raise RetriesError, "Number of retries exceeded: #{@retries}"
+        end
+      end
+    end
+  end
+end

data/lib/durable_call/version.rb

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

data/lib/durable_call.rb

@@ -0,0 +1,8 @@
+require 'durable_call/version'
+require 'durable_call/caller'
+
+module DurableCall
+  def self.call(subject, args, options={})
+    DurableCall::Caller.new(subject, options).call(*Array(args))
+  end
+end

data/spec/durable_call_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+require 'logger'
+
+describe DurableCall do
+
+  before :all do
+    @subject_class = Class.new do
+      def simple_method
+        true
+      end
+      def long_method(seconds)
+        sleep seconds
+        true
+      end
+      def failing_method(condition)
+        raise RuntimeError.new("it happens") if condition.call
+        true
+      end
+      def worse_method(seconds, condition)
+        sleep seconds
+        raise RuntimeError.new("it happens") if condition.call
+        true
+      end
+    end.freeze
+    @subject = @subject_class.new.freeze
+  end
+
+  before do
+    @log = StringIO.new
+    @logger = Logger.new(@log)
+  end
+
+  it 'should have a version number' do
+    DurableCall::VERSION.should_not be_nil
+  end
+
+  it 'has default settings' do
+    @wrapper = DurableCall::Caller.new(@subject)
+    @wrapper.instance_variable_get(:@interval).should == :rand
+    @wrapper.instance_variable_get(:@logger  ).should == nil
+    @wrapper.instance_variable_get(:@retries ).should == 0
+    @wrapper.instance_variable_get(:@timeout ).should == nil
+  end
+
+  it 'has subject reader' do
+    @wrapper = DurableCall::Caller.new(@subject)
+    @wrapper.subject.should === @subject
+  end
+
+  it 'invokes simple methods' do
+    @wrapper = DurableCall::Caller.new(@subject, :logger => @logger)
+    @wrapper.call(:simple_method).should == true
+    @log.string.should == ''
+  end
+
+  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 == ''
+  end
+
+  it 'invokes not so long method' do
+    @wrapper = DurableCall::Caller.new(@subject, :timeout => 0.1, :logger => @logger)
+    @wrapper.call(:long_method, 0.09).should == true
+    @log.string.should == ''
+  end
+
+  it 'invokes failing method' do
+    @wrapper = DurableCall::Caller.new(@subject)
+    (condition = mock).should_receive(:call).once.and_return(true)
+    expect{ @wrapper.call(:failing_method, condition) }.to raise_error(DurableCall::RetriesError)
+  end
+
+  it 'invokes failing method with 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,
+    ]).should == true
+  end
+
+  it 'invokes not so failing method' do
+    @wrapper = DurableCall::Caller.new(@subject, :retries => 2, :interval => 0.0123, :logger => @logger)
+    (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/,
+    ]).should == true
+  end
+
+  it 'invokes worse method' do
+    @wrapper = DurableCall::Caller.new(@subject, :retries => 2, :interval => 0.05, :timeout => 0.1, :logger => @logger)
+    (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/,
+    ]).should == true
+  end
+
+  it 'has shorthand module method' do
+    DurableCall.call(@subject, :simple_method)
+    DurableCall.call(@subject, [:long_method, 0.01], {:logger => @logger, :timeout => 0.1})
+  end
+
+  def valid_log?(log, regexps)
+    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

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'durable_call'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: durable_call
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Pavlenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-22 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: 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'
+description: Invoke methods DRY and safely with parameterized retries, timeouts and
+  logging
+email:
+- apavlenko@mirantis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/simple_method.rb
+- durable_call.gemspec
+- lib/durable_call.rb
+- lib/durable_call/caller.rb
+- lib/durable_call/version.rb
+- spec/durable_call_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.25
+signing_key: 
+specification_version: 3
+summary: Durable methods invocation
+test_files:
+- spec/durable_call_spec.rb
+- spec/spec_helper.rb