pester 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f5c9151d53d657939d6506baf8a27e5da2744b3b
+  data.tar.gz: 251a6215cfe9cd275f37bf7df458561116cb7401
+SHA512:
+  metadata.gz: dd350670630f082f40af4ab8290e7eb5f8a75a2137ca61cacc63c72445c28baad2eda3bc595aec14bb2782bc3ac5778a38c5678661aaec77ab75fe9f1fcb7e9f
+  data.tar.gz: 4bd76629e817aca9981340564ec5426ab8e6c6619bbe222b6b7b0d33143e587f21c9b49a31d2dbfb87d9a06ac1863dcf192d550860cf7686ba56448dc38041e0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 140
+
+Style/Documentation:
+    Enabled: false
+
+Style/RaiseArgs:
+    Enabled: false
+
+Style/SignalException:
+  Enabled: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Marc Bollinger
+
+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,31 @@
+# Pester
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pester'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pester
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pester/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task prep: %w(spec rubocop)
+
+task default: :spec

data/lib/pester/behaviors/sleep.rb

@@ -0,0 +1,9 @@
+module Pester
+  module Behaviors
+    module Sleep
+      Linear = ->(attempt_num, delay_interval) { sleep(attempt_num * delay_interval) }
+
+      Exponential = ->(attempt_num, delay_interval) { sleep((2**attempt_num - 1) * delay_interval) }
+    end
+  end
+end

data/lib/pester/behaviors.rb

@@ -0,0 +1,8 @@
+module Pester
+  module Behaviors
+    WarnAndReraise = lambda do |logger, max_attempts, e|
+      logger.warn("Max # of retriable exceptions (#{max_attempts}) exceeded, re-raising. Context: #{e}. Trace: #{e.backtrace}")
+      raise
+    end
+  end
+end

data/lib/pester/config.rb

@@ -0,0 +1,16 @@
+module Pester
+  class Config
+    class << self
+      attr_writer :logger
+
+      def configure
+        yield self
+      end
+
+      def logger
+        require 'logger' unless defined? Logger
+        @logger ||= Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/pester/version.rb

@@ -0,0 +1,3 @@
+module Pester
+  VERSION = '0.1.0'
+end

data/lib/pester.rb

@@ -0,0 +1,92 @@
+require 'pester/behaviors'
+require 'pester/behaviors/sleep'
+require 'pester/config'
+require 'pester/version'
+
+module Pester
+  def self.configure(&block)
+    Config.configure(&block)
+  end
+
+  def self.retry(options = {}, &block)
+    retry_action(options.merge(on_retry: ->(_, delay_interval) { sleep(delay_interval) }), &block)
+  end
+
+  def self.retry_with_backoff(options = {}, &block)
+    retry_action(options.merge(on_retry: Behaviors::Sleep::Linear), &block)
+  end
+
+  def self.retry_with_exponential_backoff(options = {}, &block)
+    retry_action({ delay_interval: 1 }.merge(options).merge(on_retry: Behaviors::Sleep::Exponential), &block)
+  end
+
+  # This function executes a block and retries the block depending on
+  # which errors were thrown. Retries 4 times by default.
+  #
+  # Options:
+  #   retry_error_classes       - A single or array of exceptions to retry on. Thrown exceptions not in this list
+  #                               (including parent/sub-classes) will be reraised
+  #   reraise_error_classes     - A single or array of exceptions to always re-raiseon. Thrown exceptions not in
+  #                               this list (including parent/sub-classes) will be retried
+  #   max_attempts              - Max number of attempts to retry
+  #   delay_interval            - Second interval by which successive attempts will be incremented. A value of 2
+  #                               passed to retry_with_backoff will retry first after 2 seconds, then 4, then 6, et al.
+  #   on_retry                  - A Proc to be called on each successive failure, before the next retry
+  #   on_max_attempts_exceeded  - A Proc to be called when attempt_num >= max_attempts - 1
+  #   message                   - String or regex to look for in thrown exception messages. Matches will trigger retry
+  #                               logic, non-matches will cause the exception to be reraised
+  #
+  # Usage:
+  #   retry_action do
+  #     puts 'trying to remove a directory'
+  #     FileUtils.rm_r(directory)
+  #   end
+  #
+  #  retryable(error_classes: Mysql2::Error, message: /^Lost connection to MySQL server/, max_attempts: 2) do
+  #    ActiveRecord::Base.connection.execute("LONG MYSQL STATEMENT")
+  #  end
+  def self.retry_action(opts = {}, &block)
+    merge_defaults(opts)
+    if opts[:retry_error_classes] && opts[:reraise_error_classes]
+      fail 'You can only have one of retry_error_classes or reraise_error_classes'
+    end
+
+    opts[:max_attempts].times do |attempt_num|
+      begin
+        result = yield block
+        return result
+      rescue => e
+        class_reraise = opts[:retry_error_classes] && !opts[:retry_error_classes].include?(e.class)
+        reraise_error = opts[:reraise_error_classes] && opts[:reraise_error_classes].include?(e.class)
+        message_reraise = opts[:message] && !e.message[opts[:message]]
+
+        if class_reraise || message_reraise || reraise_error
+          match_type = class_reraise ? 'class' : 'message'
+          opts[:logger].warn("Reraising exception from inside retry_action because provided #{match_type} was not matched.")
+          raise
+        end
+
+        if opts[:max_attempts] - 1 > attempt_num
+          attempts_left = opts[:max_attempts] - attempt_num - 1
+          trace = e.backtrace
+          opts[:logger].warn("Failure encountered: #{e}, backing off and trying again #{attempts_left} more times. Trace: #{trace}")
+          opts[:on_retry].call(attempt_num, opts[:delay_interval])
+        else
+          return opts[:on_max_attempts_exceeded].call(opts[:logger], opts[:max_attempts], e)
+        end
+      end
+    end
+  end
+
+  private
+
+  def self.merge_defaults(opts)
+    opts[:retry_error_classes]      = opts[:retry_error_classes] ? Array(opts[:retry_error_classes]) : nil
+    opts[:reraise_error_classes]    = opts[:reraise_error_classes] ? Array(opts[:reraise_error_classes]) : nil
+    opts[:max_attempts]             ||= 4
+    opts[:delay_interval]           ||= 30
+    opts[:on_retry]                 ||= ->(_, _) {}
+    opts[:on_max_attempts_exceeded] ||= Behaviors::WarnAndReraise
+    opts[:logger]                   ||= Config.logger
+  end
+end

data/pester.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pester/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pester'
+  spec.version       = Pester::VERSION
+  spec.authors       = ['Marc Bollinger']
+  spec.email         = ['marc@lumoslabs.com']
+  spec.summary       = 'Common block-based retry for external calls.'
+  spec.description   = <<-EOD
+                       |We found ourselves constantly wrapping network-facing calls with all kinds of bespoke,
+                       | copied, and rewritten retry logic. This gem is an attempt to unify common behaviors,
+                       | like simple retry, retry with linear backoff, and retry with exponential backoff.
+EOD
+  spec.homepage      = 'https://github.com/lumoslabs/pester'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+end

data/spec/helpers/null_logger.rb

@@ -0,0 +1,9 @@
+require 'logger' unless defined? Logger
+
+class NullLogger < Logger
+  def initialize(*_args)
+  end
+
+  def add(*_args, &_block)
+  end
+end

data/spec/helpers/scripted_failer.rb

@@ -0,0 +1,18 @@
+class ScriptedFailer
+  attr_accessor :fails, :result, :successes
+
+  def initialize(num_fails = 2, intended_result = 2)
+    @fails = num_fails
+    @result = intended_result
+    @successes = 0
+  end
+
+  def fail(error_class, msg)
+    if @fails > 0
+      @fails -= 1
+      raise error_class.new(msg)
+    end
+    @successes += 1
+    @result
+  end
+end

data/spec/pester_spec.rb

@@ -0,0 +1,204 @@
+require 'logger'
+require 'spec_helper'
+
+class MatchedError < RuntimeError; end
+class UnmatchedError < RuntimeError; end
+
+shared_examples 'raises an error' do
+  it 'raises an error and succeeds 0 times' do
+    expect { Pester.retry_action(options) { action } }.to raise_error
+    expect(failer.successes).to eq(0)
+  end
+end
+
+shared_examples "doesn't raise an error" do
+  it "doesn't raise an error" do
+    expect { Pester.retry_action(options) { action } }.to_not raise_error
+  end
+end
+
+shared_examples 'returns and succeeds' do
+  it 'returns the intended result' do
+    expect(Pester.retry_action(options) { action }).to eq(intended_result)
+  end
+
+  it 'succeeds exactly once' do
+    Pester.retry_action(options) { action }
+    expect(failer.successes).to eq(1)
+  end
+end
+
+shared_examples 'raises an error only in the correct cases with a retry class' do
+  context 'when neither the class is in the retry list, nor is the message matched' do
+    let(:actual_error_class) { non_matching_error_class }
+    let(:actual_error_message) { non_matching_error_message }
+
+    it_has_behavior 'raises an error'
+  end
+
+  context 'when the class is in the retry list, but the message is not matched' do
+    let(:actual_error_class) { matching_error_class }
+    let(:actual_error_message) { non_matching_error_message }
+
+    it_has_behavior 'raises an error'
+  end
+
+  context 'when the class is not in the retry list, but the message is matched' do
+    let(:actual_error_class) { non_matching_error_class }
+    let(:actual_error_message) { matching_error_message }
+
+    it_has_behavior 'raises an error'
+  end
+
+  context 'when the class is in the list, and the message is matched' do
+    let(:actual_error_class) { matching_error_class }
+    let(:actual_error_message) { matching_error_message }
+
+    it_has_behavior "doesn't raise an error"
+
+    it_has_behavior 'returns and succeeds'
+  end
+end
+
+shared_examples 'raises an error only in the correct cases with a reraise class' do
+  context 'when the class is not in the reraise list' do
+    let(:actual_error_class) { non_matching_error_class }
+    let(:actual_error_message) { non_matching_error_message }
+
+    it_has_behavior "doesn't raise an error"
+
+    it_has_behavior 'returns and succeeds'
+  end
+
+  context 'when the class is in the reraise list' do
+    let(:actual_error_class) { matching_error_class }
+    let(:actual_error_message) { matching_error_message }
+
+    it_has_behavior 'raises an error'
+  end
+end
+
+describe 'retry_action' do
+  let(:intended_result) { 1000 }
+  let(:action) { failer.fail(UnmatchedError, 'Dying') }
+  let(:null_logger) { NullLogger.new }
+
+  context 'for non-failing block' do
+    let(:failer) { ScriptedFailer.new(0, intended_result) }
+    let(:options) { { delay_interval: 0, logger: null_logger } }
+
+    it_has_behavior "doesn't raise an error"
+
+    it_has_behavior 'returns and succeeds'
+  end
+
+  context 'for block that fails less than threshold' do
+    let(:failer) { ScriptedFailer.new(2, intended_result) }
+    let(:options) { { max_attempts: 3, logger: null_logger } }
+
+    it_has_behavior "doesn't raise an error"
+
+    it_has_behavior 'returns and succeeds'
+  end
+
+  context 'for block that fails more than threshold' do
+    let(:failer) { ScriptedFailer.new(6) }
+    let(:max_attempts) { 1 }
+
+    context 'without on_max_attempts_exceeded specified' do
+      let(:options) { { max_attempts: max_attempts, logger: null_logger } }
+
+      it_has_behavior 'raises an error'
+    end
+
+    context 'with on_max_attempts_exceeded specified (which does not raise)' do
+      let(:do_nothing_proc) { proc {} }
+      let(:options) do
+        {
+          max_attempts: max_attempts,
+          on_max_attempts_exceeded: do_nothing_proc,
+          logger: null_logger
+        }
+      end
+
+      it_has_behavior "doesn't raise an error"
+    end
+  end
+
+  context 'for retry_action calls with provided retry classes and message strings' do
+    let(:intended_result) { 1000 }
+    let(:failer) { ScriptedFailer.new(2, intended_result) }
+    let(:action) { failer.fail(actual_error_class, actual_error_message) }
+    let(:matching_error_class) { MatchedError }
+    let(:non_matching_error_class) { UnmatchedError }
+    let(:matching_error_message) { 'Lost connection to MySQL server' }
+    let(:non_matching_error_message) { 'You have an error in your SQL syntax' }
+
+    context 'Using retry error classes' do
+      let(:options) do
+        {
+          retry_error_classes: expected_error_classes,
+          message: /^Lost connection to MySQL server/,
+          max_attempts: 10,
+          logger: null_logger
+        }
+      end
+
+      context 'when error_classes is a single error class' do
+        let(:expected_error_classes) { matching_error_class }
+
+        it_has_behavior 'raises an error only in the correct cases with a retry class'
+      end
+
+      context 'when error_classes is a list of error classes' do
+        let(:expected_error_classes) { [ArgumentError, matching_error_class] }
+
+        it_has_behavior 'raises an error only in the correct cases with a retry class'
+      end
+    end
+
+    context 'Using reraise error classes' do
+      let(:options) do
+        {
+          reraise_error_classes: expected_error_classes,
+          max_attempts: 10,
+          logger: null_logger
+        }
+      end
+
+      context 'when error_classes is a single error class' do
+        let(:expected_error_classes) { matching_error_class }
+
+        it_has_behavior 'raises an error only in the correct cases with a reraise class'
+      end
+
+      context 'when error_classes is a list of error classes' do
+        let(:expected_error_classes) { [ArgumentError, matching_error_class] }
+
+        it_has_behavior 'raises an error only in the correct cases with a reraise class'
+      end
+    end
+  end
+end
+
+describe 'logger' do
+  context 'when not otherwise configured' do
+    it 'defaults to the ruby logger' do
+      Pester.configure do |config|
+        config.logger = nil
+      end
+      expect(Pester::Config.logger).to_not be_nil
+      expect(Pester::Config.logger).to be_kind_of(Logger)
+    end
+  end
+
+  context 'when configured to use a particular class' do
+    it 'users that class' do
+      Pester.configure do |config|
+        config.logger = NullLogger.new
+      end
+      expect(Pester::Config.logger).to_not be_nil
+      expect(Pester::Config.logger).to be_kind_of(NullLogger)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+require 'pester'
+
+Dir.glob('./spec/helpers/**/*.rb').each { |f| require f }
+
+RSpec.configure do |c|
+  c.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: pester
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc Bollinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: |2
+                         |We found ourselves constantly wrapping network-facing calls with all kinds of bespoke,
+                         | copied, and rewritten retry logic. This gem is an attempt to unify common behaviors,
+                         | like simple retry, retry with linear backoff, and retry with exponential backoff.
+email:
+- marc@lumoslabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pester.rb
+- lib/pester/behaviors.rb
+- lib/pester/behaviors/sleep.rb
+- lib/pester/config.rb
+- lib/pester/version.rb
+- pester.gemspec
+- spec/helpers/null_logger.rb
+- spec/helpers/scripted_failer.rb
+- spec/pester_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lumoslabs/pester
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Common block-based retry for external calls.
+test_files:
+- spec/helpers/null_logger.rb
+- spec/helpers/scripted_failer.rb
+- spec/pester_spec.rb
+- spec/spec_helper.rb
+has_rdoc: