rack-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/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - rbx
+notifications:
+  recipients:
+    - drnicwilliams@gmail.com
+    - isombra@engineyard.com
+    - jhansen@engineyard.com
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-idempotent.gemspec
+gemspec
+
+group(:test) do
+  gem 'rake'
+  gem 'rack-client', :require => 'rack/client'
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ines Sombra
+
+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,62 @@
+# Rack::Idempotent
+
+This rack middleware intends to handle retry logic for rack-client.
+
+Rack::Idempotent rescues and retries low-level errors and 'safe to retry' http response codes.
+
+Default retry limit is currently set to 5.
+
+Handled low-level Net::HTTP exceptions include:
+
+* `Errno::ETIMEDOUT`
+* `Errno::ECONNREFUSED`
+* `Errno::EHOSTUNREACH`
+
+Response status codes that are retried:
+
+* 408: Request Timeout
+* 502: Bad Gateway
+* 503: Service Unavailable
+* 504: Gateway Timeout
+
+If the retry limit is exceeded, Rack::Idemptotent will raise `Rack::Idempotent::RetryLimitExceeded`.
+
+The exceptions raised are stored as an array available via `Rack::Idempotent::RetryLimitExceeded#idempotent_exceptions`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-idempotent'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-idempotent
+
+## Usage
+
+Add Rack::Idempotent as a Rack::Client middleware as close to the handler as possible:
+
+```ruby
+client = Rack::Client.new do
+  use EY::ApiHMAC::ApiAuth::Client, *ServiceClient.hmac_keys
+  use Rack::Idempotent
+  run Rack::Client::Handler::NetHTTP
+end
+```
+
+## Running Tests
+
+    $ bundle exec rake
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w[--color]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+task :test => :spec
+task :default => :spec

data/lib/rack-idempotent.rb

@@ -0,0 +1,52 @@
+require "rack-idempotent/version"
+
+module Rack
+  class Idempotent
+    RETRY_LIMIT = 5
+    IDEMPOTENT_HTTP_CODES = [502, 503, 504, 408]
+    IDEMPOTENT_ERROR_CLASSES = [Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTUNREACH]
+
+    class RetryLimitExceeded < Exception
+      attr_reader :idempotent_exceptions
+      def initialize(idempotent_exceptions)
+        @idempotent_exceptions = idempotent_exceptions
+      end
+    end
+
+    class HTTPException < Exception
+      attr_reader :status, :headers, :body
+      def initialize(status, headers, body)
+        @status, @headers, @body = status, headers, body
+      end
+
+      def to_s
+        @status.to_s
+      end
+    end
+
+    def initialize(app)
+      @app= app
+    end
+
+    def call(env)
+      env['client.retries'] = 0
+      status, headers, body = nil
+      idempotent_exceptions = []
+      begin
+        dup_env = env.dup
+        status, headers, body = @app.call(dup_env)
+        raise HTTPException.new(status, headers, body) if IDEMPOTENT_HTTP_CODES.include?(status)
+        env.merge!(dup_env)
+        [status, headers, body]
+      rescue *IDEMPOTENT_ERROR_CLASSES, HTTPException => ie
+        idempotent_exceptions << ie
+        if env['client.retries'] > RETRY_LIMIT - 1
+          raise(RetryLimitExceeded.new(idempotent_exceptions))
+        else
+          env['client.retries'] += 1
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/rack-idempotent/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Idempotent
+    VERSION = "0.0.1"
+  end
+end

data/rack-idempotent.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack-idempotent/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ines Sombra"]
+  gem.email         = ["isombra@engineyard.com"]
+  gem.description   = %q{Retry logic for rack-client}
+  gem.summary       = %q{Retry logic for rack-client}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rack-idempotent"
+  gem.require_paths = ["lib"]
+  gem.version       = Rack::Idempotent::VERSION
+end

data/spec/rack-idempotent_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Rack::Idempotent do
+  class CaptureEnv
+    class << self; attr_accessor :env; end
+    def initialize(app); @app=app; end
+    def call(env)
+      @app.call(env)
+    ensure
+      self.class.env = env
+    end
+  end
+  class RaiseUp
+    class << self; attr_accessor :errors; end
+    def self.call(env)
+      error = self.errors.shift
+      raise error if error.is_a?(Class)
+      status_code = error || 200
+      [status_code, {}, []]
+    end
+  end
+
+  before(:each){ CaptureEnv.env = nil }
+  let(:client) do
+    Rack::Client.new do
+      use CaptureEnv
+      use Rack::Idempotent
+      run RaiseUp
+    end
+  end
+
+  it "should retry Errno::ETIMEDOUT" do
+    RaiseUp.errors = [Errno::ETIMEDOUT, Errno::ETIMEDOUT]
+    client.get("/doesntmatter")
+
+    env = CaptureEnv.env
+    env['client.retries'].should == 2
+  end
+
+  it "should raise Rack::Idempotent::RetryLimitExceeded when retry limit is reached" do
+    RaiseUp.errors = (Rack::Idempotent::RETRY_LIMIT + 1).times.map{|i| Errno::ETIMEDOUT}
+
+    lambda { client.get("/doesntmatter") }.should raise_exception(Rack::Idempotent::RetryLimitExceeded)
+
+    env = CaptureEnv.env
+    env['client.retries'].should == Rack::Idempotent::RETRY_LIMIT
+  end
+
+  [502, 503, 504, 408].each do |code|
+    it "retries #{code}" do
+      RaiseUp.errors = [code]
+      client.get("/something")
+      env = CaptureEnv.env
+      env['client.retries'].should == 1
+    end
+  end
+
+  it "should store exceptions raised" do
+    RaiseUp.errors = [502, Errno::ECONNREFUSED, 408, 504, Errno::EHOSTUNREACH, Errno::ETIMEDOUT]
+    errors = RaiseUp.errors.dup
+    exception = nil
+
+    begin
+      client.get("/doesntmatter")
+    rescue Rack::Idempotent::RetryLimitExceeded => e
+      exception = e
+    end
+
+    exception.should_not be_nil
+    exception.idempotent_exceptions.size.should == 6
+    exception.idempotent_exceptions.map{|ie| ie.is_a?(Rack::Idempotent::HTTPException) ? ie.status : ie.class}.should == errors
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+Bundler.require(:test)
+
+require File.expand_path("../../lib/rack-idempotent", __FILE__)

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rack-idempotent
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ines Sombra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-17 00:00:00.000000000 Z
+dependencies: []
+description: Retry logic for rack-client
+email:
+- isombra@engineyard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-idempotent.rb
+- lib/rack-idempotent/version.rb
+- rack-idempotent.gemspec
+- spec/rack-idempotent_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.10
+signing_key: 
+specification_version: 3
+summary: Retry logic for rack-client
+test_files:
+- spec/rack-idempotent_spec.rb
+- spec/spec_helper.rb