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

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'guard-rspec'
+  gem 'rspec'
+end
+
+group :faraday do
+  gem 'faraday'
+end
+
+group :rack do
+  gem 'rack-client'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh Lane
+
+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,29 @@
+# Idempotent
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'idempotent'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install idempotent
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/idempotent.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'idempotent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "idempotent"
+  spec.version       = Idempotent::VERSION
+  spec.authors       = ["Josh Lane"]
+  spec.email         = ["me@joshualane.com"]
+  spec.description   = %q{Idempotency middleware for Rack::Client and Faraday}
+  spec.summary       = %q{Make your client's less sensitive}
+  spec.homepage      = "http://joshualane.com/idempotent"
+  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"
+end

data/lib/idempotent.rb

@@ -0,0 +1,21 @@
+require "idempotent/version"
+
+module Idempotent
+  DEFAULT_RETRY_LIMIT = 5
+
+  # Handlers
+  autoload :Handler, 'idempotent/handler'
+  autoload :Rack, 'idempotent/rack'
+  autoload :Faraday, 'idempotent/faraday'
+
+  # Retry policies
+  autoload :ImmediateRetry, 'idempotent/immediate_retry'
+  autoload :ExponentialBackoff, 'idempotent/exponential_backoff'
+
+  # Rescue policies
+  autoload :DefaultRescue, 'idempotent/default_rescue'
+
+  # Exceptions
+  autoload :RetryLimitExceeded, 'idempotent/retry_limit_exceeded'
+  autoload :Retryable, 'idempotent/retryable'
+end

data/lib/idempotent/default_rescue.rb

@@ -0,0 +1,27 @@
+class Idempotent::DefaultRescue
+  GET_RETRY_HTTP_CODES     = [408, 502, 503, 504]
+  POST_RETRY_HTTP_CODES    = [502, 503, 504]
+  IDEMPOTENT_ERROR_CLASSES = [Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTUNREACH]
+
+  def call(request, response, exception)
+    status = nil
+    method = nil
+
+    if exception
+      return IDEMPOTENT_ERROR_CLASSES.include?(exception.class)
+    end
+
+    unless status && method
+      status = response.status
+      method = request.env["REQUEST_METHOD"]
+    end
+
+    if method == "GET"
+      GET_RETRY_HTTP_CODES.include?(status)
+    elsif method == "POST"
+      POST_RETRY_HTTP_CODES.include?(status)
+    else
+      false
+    end
+  end
+end

data/lib/idempotent/exponential_backoff.rb

@@ -0,0 +1,30 @@
+class Idempotent::ExponentialBackoff
+  attr_reader :max_retries, :max_retry_interval, :min_retry_interval
+
+  def initialize(options={})
+    @max_retries = options[:max_retries] || Idempotent::DEFAULT_RETRY_LIMIT
+    @min_retry_interval = options[:min_retry_interval] || 0.5
+    @max_retry_interval = options[:max_retry_interval] || 1800
+  end
+
+  def call(request, response, exception)
+    request.env["idempotent.requests.count"] ||= 0
+    request.env["idempotent.requests.count"] += 1
+    request.env["idempotent.requests.sleep"] ||= (@min_retry_interval / 2)
+    request.env["idempotent.requests.sleep"] *= 2
+
+    if request.env["idempotent.requests.sleep"] > @max_retry_interval
+      request.env["idempotent.requests.sleep"] = @max_retry_interval
+    end
+    if request.env["idempotent.requests.count"] >= @max_retries
+      raise Idempotent::RetryLimitExceeded.new(
+        request.env["idempotent.requests.exceptions"]
+      )
+    end
+    delay(request.env["idempotent.requests.sleep"])
+  end
+
+  def delay(secs)
+    sleep(secs)
+  end
+end

data/lib/idempotent/handler.rb

@@ -0,0 +1,14 @@
+class Idempotent::Handler
+
+  attr_reader :retry_policy, :rescue_policy
+
+  def initialize(app, options={})
+    @app           = app
+    @retry_policy  = options[:retry] || Idempotent::ImmediateRetry.new
+    @rescue_policy = options[:rescue] || Idempotent::DefaultRescue.new
+  end
+
+  # @api
+  def store_exception(exception, request)
+  end
+end

data/lib/idempotent/immediate_retry.rb

@@ -0,0 +1,18 @@
+class Idempotent::ImmediateRetry
+  attr_reader :max_retries
+
+  def initialize(options={})
+    @max_retries = options[:max_retries] || Idempotent::DEFAULT_RETRY_LIMIT
+  end
+
+  def call(request, response, exception)
+    request.env["idempotent.requests.count"] ||= 0
+    request.env["idempotent.requests.count"] += 1
+
+    if request.env["idempotent.requests.count"] >= max_retries
+      raise Idempotent::RetryLimitExceeded.new(
+        request.env["idempotent.requests.exceptions"]
+      )
+    end
+  end
+end

data/lib/idempotent/rack.rb

@@ -0,0 +1,41 @@
+require 'rack/response'
+require 'rack/request'
+
+module Idempotent
+  class Rack < Handler
+
+    def call(env)
+      request   = ::Rack::Request.new(env)
+      response  = nil
+      exception = nil
+
+      while true
+        retry_policy.call(request, response, exception) if response || exception
+        response, exception = nil
+
+        begin
+          status, headers, body = @app.call(env.dup)
+          response = ::Rack::Response.new(body, status, headers)
+
+          next if rescue_policy.call(request, response, exception)
+
+          return [status, headers, body]
+        rescue Idempotent::Retryable => exception
+          store_exception(exception, request)
+          next
+        rescue => exception
+          if rescue_policy.call(request, response, exception)
+            store_exception(exception, request)
+            next
+          end
+          raise
+        end
+      end
+    end
+
+    def store_exception(exception, request)
+      request.env["idempotent.requests.exceptions"] ||= []
+      request.env["idempotent.requests.exceptions"] << exception
+    end
+  end
+end

data/lib/idempotent/retry_limit_exceeded.rb

@@ -0,0 +1,7 @@
+class Idempotent::RetryLimitExceeded < StandardError
+  attr_reader :idempotent_exceptions
+
+  def initialize(idempotent_exceptions)
+    @idempotent_exceptions = idempotent_exceptions
+  end
+end

data/lib/idempotent/retryable.rb

@@ -0,0 +1,2 @@
+class Idempotent::Retryable < StandardError
+end

data/lib/idempotent/version.rb

@@ -0,0 +1,3 @@
+module Idempotent
+  VERSION = "0.0.1"
+end

data/spec/rack/default_spec.rb

@@ -0,0 +1,213 @@
+require 'spec_helper'
+
+Bundler.require(:rack)
+
+describe 'rack/default' do
+  let(:client) do
+    Rack::Client.new do
+      use Rack::Lint
+      use Idempotent::Rack
+      use Rack::Lint
+      use RecordRequests
+      run ChaosMonkey
+    end
+  end
+
+  describe "with defaults" do
+    it "should not retry if succesful response" do
+      client.get("http://example.org/")
+      RecordRequests.requests.count.should == 1
+    end
+
+    it "should retry if it gets one unsuccesful response" do
+      ChaosMonkey.errors = [503]
+      client.get("http://example.org/")
+
+      RecordRequests.requests.count.should == 2
+
+      RecordRequests.responses.count.should == 2
+      RecordRequests.responses[0][0].should == 503
+      RecordRequests.responses[1][0].should == 200
+    end
+
+    it "should retry if it gets more than one unsuccesful response" do
+      ChaosMonkey.errors = [503, 504]
+      client.get("http://example.org/")
+
+      RecordRequests.requests.count.should == 3
+
+      RecordRequests.responses.count.should == 3
+      RecordRequests.responses[0][0].should == 503
+      RecordRequests.responses[1][0].should == 504
+      RecordRequests.responses[2][0].should == 200
+    end
+
+    it "should raise RetryLimitExceeded when the request fails too many times" do
+      retry_limit = Idempotent::DEFAULT_RETRY_LIMIT
+      ChaosMonkey.errors = (retry_limit + 1).times.map {|i| 503}
+      lambda {
+        client.get("http://example.org/")
+      }.should raise_exception Idempotent::RetryLimitExceeded
+      RecordRequests.requests.count.should == retry_limit
+      RecordRequests.responses.count.should == retry_limit
+    end
+
+    it "should retry if the connection times out once" do
+      ChaosMonkey.errors = [Errno::ETIMEDOUT]
+      client.get("http://example.org/")
+
+      RecordRequests.requests.count.should == 2
+      exceptions = RecordRequests.requests.last["idempotent.requests.exceptions"]
+      exceptions.count.should == 1
+      exceptions.first.class.should == Errno::ETIMEDOUT
+
+      RecordRequests.responses.count.should == 2
+      RecordRequests.responses.last[0].should == 200
+    end
+
+    it "should retry if the connection times out more than once" do
+      ChaosMonkey.errors = [Errno::ETIMEDOUT, Errno::ETIMEDOUT]
+      client.get("http://example.org/")
+
+      RecordRequests.requests.count.should == 3
+      exceptions = RecordRequests.requests.last["idempotent.requests.exceptions"]
+      exceptions.count.should == 2
+      exceptions.first.class.should == Errno::ETIMEDOUT
+
+      RecordRequests.responses.count.should == 3
+      RecordRequests.responses.last[0].should == 200
+    end
+
+    it "should raise RetryLimitExceeded when the connection times out too many times" do
+      retry_limit = Idempotent::DEFAULT_RETRY_LIMIT
+      ChaosMonkey.errors = (retry_limit + 1).times.map {|i| Errno::ETIMEDOUT}
+      lambda {
+        client.get("http://example.org/")
+      }.should raise_exception Idempotent::RetryLimitExceeded
+      RecordRequests.requests.count.should == retry_limit
+      RecordRequests.responses.count.should == retry_limit
+    end
+
+    describe "does what the README says it does and" do
+      it 'has a retry limit of 5' do
+        Idempotent::DEFAULT_RETRY_LIMIT.should == 5
+      end
+
+      [Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTUNREACH].each do |e|
+        it "retries on #{e}" do
+          ChaosMonkey.errors = [e]
+          client.get("http://example.org/")
+
+          RecordRequests.requests.count.should == 2
+          exceptions = RecordRequests.requests.last["idempotent.requests.exceptions"]
+          exceptions.count.should == 1
+          exceptions.first.class.should == e
+
+          RecordRequests.responses.count.should == 2
+          RecordRequests.responses.last[0].should == 200
+        end
+      end
+
+      [408, 502, 503, 504].each do |status|
+        it "retries on #{status}" do
+          ChaosMonkey.errors = [status]
+          client.get("http://example.org/")
+
+          RecordRequests.requests.count.should == 2
+
+          RecordRequests.responses.count.should == 2
+          RecordRequests.responses[0][0].should == status
+          RecordRequests.responses[1][0].should == 200
+        end
+      end
+
+      it 'raises RetryLimitExceeded if the retry limit is exceeded' do
+        retry_limit = Idempotent::DEFAULT_RETRY_LIMIT
+        ChaosMonkey.errors = (retry_limit + 1).times.map {|i| 408}
+        lambda {
+          client.get("http://example.org/")
+        }.should raise_exception Idempotent::RetryLimitExceeded
+        RecordRequests.requests.count.should == retry_limit
+        RecordRequests.responses.count.should == retry_limit
+      end
+
+      it 'stores any exceptions raised in RetryLimitExceeded.idempotent_exceptions' do
+        retry_limit = Idempotent::DEFAULT_RETRY_LIMIT
+        ChaosMonkey.errors = (retry_limit + 1).times.map {|i| Errno::ETIMEDOUT}
+        lambda {
+          begin
+            client.get("http://example.org/")
+          rescue Idempotent::RetryLimitExceeded => e
+            e.idempotent_exceptions.should_not be_nil
+            exceptions = e.idempotent_exceptions
+            exceptions.count.should == retry_limit
+            exceptions.each do |ex|
+              ex.class.should == Errno::ETIMEDOUT
+            end
+            raise
+          end
+        }.should raise_exception Idempotent::RetryLimitExceeded
+
+        RecordRequests.requests.count.should == retry_limit
+        RecordRequests.responses.count.should == retry_limit
+      end
+    end
+
+    describe "does what v0.0.3 does and" do
+      [502, 503, 504].each do |status|
+        it "retries POST requests if the status is #{status}" do
+          ChaosMonkey.errors = [status]
+          client.post("http://example.org/")
+
+          RecordRequests.requests.count.should == 2
+
+          RecordRequests.responses.count.should == 2
+          RecordRequests.responses[0][0].should == status
+          RecordRequests.responses[1][0].should == 200
+        end
+      end
+
+      it 'does not retry a POST if the status is 408' do
+        ChaosMonkey.errors = [408]
+        client.post("http://example.org/")
+
+        RecordRequests.requests.count.should == 1
+
+        RecordRequests.responses.count.should == 1
+        RecordRequests.responses[0][0].should == 408
+      end
+
+      it 'retries if a Idempotent::Retryable exception is thrown' do
+        ChaosMonkey.errors = [Idempotent::Retryable]
+        client.get("http://example.org/")
+
+        RecordRequests.requests.count.should == 2
+        exceptions = RecordRequests.requests.last["idempotent.requests.exceptions"]
+        exceptions.count.should == 1
+        exceptions.first.class.should == Idempotent::Retryable
+
+        RecordRequests.responses.count.should == 2
+        RecordRequests.responses.last[0].should == 200
+      end
+
+      it 'is able to rescue http exception via standard error' do
+        ChaosMonkey.errors = [400]
+        begin
+          client.post("http://example.org/")
+        rescue => e
+          e.class.should == Idempotent::HTTPException
+        end
+      end
+
+      it 'is able to rescue retry limit exceeded via standard error' do
+        retry_limit = Idempotent::DEFAULT_RETRY_LIMIT
+        ChaosMonkey.errors = (retry_limit + 1).times.map {|i| Errno::ETIMEDOUT}
+        begin
+          client.post("http://example.org/")
+        rescue => e
+          e.class.should == Idempotent::RetryLimitExceeded
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require File.expand_path("../../lib/idempotent", __FILE__)
+
+Bundler.require(:test)
+
+Dir[File.expand_path("../{support,shared,matchers}/*.rb", __FILE__)].each{|f| require(f)}
+
+RSpec.configure do |config|
+  config.before(:each) do
+    ChaosMonkey.errors = []
+    RecordRequests.reset
+  end
+end

data/spec/support/chaos_monkey.rb

@@ -0,0 +1,15 @@
+class ChaosMonkey
+  class << self
+    attr_accessor :errors
+  end
+
+  def self.call(env)
+    error = nil
+    if self.errors
+      error = self.errors.shift
+      raise error if error.is_a?(Class)
+    end
+    status_code = error || 200
+    [status_code, {"Content-Type" => "text/plain"}, []]
+  end
+end

data/spec/support/record_requests.rb

@@ -0,0 +1,22 @@
+class RecordRequests
+  class << self
+    attr_accessor :requests
+    attr_accessor :responses
+
+    def reset
+      self.requests = []
+      self.responses = []
+    end
+  end
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    response = @app.call(env)
+  ensure
+    self.class.requests << env
+    self.class.responses << response
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: idempotent
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Lane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+description: Idempotency middleware for Rack::Client and Faraday
+email:
+- me@joshualane.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- idempotent.gemspec
+- lib/idempotent.rb
+- lib/idempotent/default_rescue.rb
+- lib/idempotent/exponential_backoff.rb
+- lib/idempotent/handler.rb
+- lib/idempotent/immediate_retry.rb
+- lib/idempotent/rack.rb
+- lib/idempotent/retry_limit_exceeded.rb
+- lib/idempotent/retryable.rb
+- lib/idempotent/version.rb
+- spec/rack/default_spec.rb
+- spec/spec_helper.rb
+- spec/support/chaos_monkey.rb
+- spec/support/record_requests.rb
+homepage: http://joshualane.com/idempotent
+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: Make your client's less sensitive
+test_files:
+- spec/rack/default_spec.rb
+- spec/spec_helper.rb
+- spec/support/chaos_monkey.rb
+- spec/support/record_requests.rb