undertaker-rails 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89bb816806ea0dbd56b5483f3c931677f4ba4242
+  data.tar.gz: 10a1c9e62a33a4ac37e524c1714978d205af5392
+SHA512:
+  metadata.gz: ea99e7436faf32584467c23fa0ea68cf97598eff22439581dcd9196822c7779a9c030bb628a857a3904f353eb77fc46f18be5fe6c7e7b371cea2097eef7d068a
+  data.tar.gz: 49a67ef0dc1b8f6c85694967a3881fe600f3cdccfb38346869ace8580a53b1b4f60f5a4dd13d412b9bcfd3dca39dc66b0e4b78a380bb3c9fb86dd20aa89d6c4f

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian LaMattina
+
+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 @@
+# Undertaker
+
+Easy exponential back off.
+
+Undertaker will run a block of code and if it raises an exception it will
+retry.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'undertaker-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install undertaker
+
+## Usage
+
+### Retry any StandardError
+
+```ruby
+undertaker = Undertaker.new(limit: 5, logger: Rails.logger)
+
+undertaker.execute do
+  something...
+end
+```
+
+### With a custom retry condition
+
+```ruby
+undertaker = Undertaker.new
+
+undertaker.retry_when { |exception| exception == SomeError }
+
+undertaker.execute do
+  something...
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/undertaker/fork )
+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 @@
+require "bundler/gem_tasks"

data/lib/undertaker.rb

@@ -0,0 +1,73 @@
+require "undertaker/version"
+require "active_support/logger"
+
+module Undertaker
+
+  def self.new(*args)
+    Undertaker.new(*args)
+  end
+
+  class Undertaker
+    attr_accessor :attempts, :retry_condition
+    attr_reader :limit
+
+    def initialize(options = {})
+      @exceptions = []
+      @attempts = 0
+      @limit = options[:limit] || 10
+      @logger = options[:logger] || ActiveSupport::Logger.new(STDOUT)
+    end
+
+    def execute
+      setup_execution
+      yield
+    rescue StandardError => exception
+      add_exception exception
+      if should_retry?
+        setup_retry
+        retry
+      end
+      raise exception
+    end
+
+    def retry_when(&block)
+      self.retry_condition = block
+    end
+
+    private
+
+    def setup_execution
+      self.attempts += 1
+    end
+
+    def setup_retry
+      log_retry
+      sleep exponential_backoff
+    end
+
+    def add_exception(exception)
+      @exceptions << exception
+    end
+
+    def last_exception
+      @exceptions.last
+    end
+
+    def should_retry?
+      attempts < limit && retry_condition?
+    end
+
+    def retry_condition?
+      retry_condition.nil? || retry_condition.call(last_exception)
+    end
+
+    def exponential_backoff
+      (1.0 / 2.0 * (2.0**attempts - 1.0)).ceil
+    end
+
+    def log_retry
+      @logger.warn "Undertaker: #{last_exception} raised retring..."
+      @logger.warn last_exception.backtrace[0..5].join("\n")
+    end
+  end
+end

data/lib/undertaker/version.rb

@@ -0,0 +1,3 @@
+module Undertaker
+  VERSION = "0.0.2"
+end

data/spec/lib/undertaker_spec.rb

@@ -0,0 +1,67 @@
+require 'pry'
+require 'benchmark'
+require 'undertaker'
+
+describe Undertaker, 'configuration' do
+
+  it 'allows the limit and logger to be configured' do
+    undertaker = Undertaker.new(limit: 1, logger: "Logger")
+
+    expect(undertaker.instance_variable_get(:@limit)).to eq 1
+    expect(undertaker.instance_variable_get(:@logger)).to eq "Logger"
+  end
+
+  it 'allows configuration of the retry configuration' do
+    undertaker = Undertaker.new(limit: 2)
+    test_attempts = 0
+    undertaker.retry_when do |exception|
+      exception == NameError
+    end
+
+    expect do
+      undertaker.execute do
+        test_attempts += 1
+        raise RangeError
+      end
+    end.to raise_error(RangeError)
+
+    expect(test_attempts).to eq 1
+  end
+end
+
+describe Undertaker, '#execute' do
+  it 'executes a block' do
+    x = 5
+
+    Undertaker.new.execute do
+      x = 10
+    end
+
+    expect(x).to be 10
+  end
+
+  it 'retries on failure until the limit is hit' do
+    test_attempts = 0
+
+    expect do
+      Undertaker.new(limit: 3).execute do
+        test_attempts += 1
+        raise NameError
+      end
+    end.to raise_error(NameError)
+
+    expect(test_attempts).to eq 3
+  end
+
+  it 'backs off exponentially on failure' do
+    duration = Benchmark.measure do
+      begin
+        Undertaker.new(limit: 3).execute do
+          raise StandardError
+        end
+      rescue StandardError => e
+      end
+    end
+    expect(duration.real).to be >= 2
+  end
+end

data/undertaker-rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'undertaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "undertaker-rails"
+  spec.version       = Undertaker::VERSION
+  spec.authors       = ["Brian LaMattina"]
+  spec.email         = ["brianlamattina@gmail.com"]
+  spec.summary       = %q{Easy exponential back off}
+  spec.description   = %q{Easy exponential back off}
+  spec.homepage      = "https://github.com/blamattina/undertaker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
+
+  spec.add_dependency("activesupport", ">= 4.0.0")
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.0"
+  spec.add_development_dependency "pry", "~> 0.9.12"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: undertaker-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Brian LaMattina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+description: Easy exponential back off
+email:
+- brianlamattina@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/undertaker.rb
+- lib/undertaker/version.rb
+- spec/lib/undertaker_spec.rb
+- undertaker-rails.gemspec
+homepage: https://github.com/blamattina/undertaker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Easy exponential back off
+test_files:
+- spec/lib/undertaker_spec.rb