excon-middleware-aws-exponential_backoff 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79088f6ebcd87310329c1c8ce66dc3c3aa7184c9
-  data.tar.gz: 19f90d70c7292dd6f9d902260dec0297dcd744b1
+  metadata.gz: 2f924a60b2a1e3a03602c89a3129db0cda2e1551
+  data.tar.gz: 9a5086a9e03df332d549f8867ce86efdde285cf2
 SHA512:
-  metadata.gz: 165f925409e1d286e97aa3a43aefe56214ed16f22e36aedf58af75f17f7f2bad8725d4c485d47f2ce9ceca22ba53262a1e605ae11d965fe527793428a576fc6a
-  data.tar.gz: fb60aa48496cbb24c24d38bd2b156e2c0caae1c6f576a90b4bda775f5a241801cc5ee6ddfc18e28d9b9868dbf46daed75763e6b30f05f56a00754b29c91492b6
+  metadata.gz: 38b0e9021987f793758bac30bec08c3ad17873476930f385fc2ceffda2916784a0dd2f6c364b6f63ec634d366733cdbaf6c506213693bace823e5d6d4a176c8c
+  data.tar.gz: 7c2d1a1a72a86a761a054d9919cca21f81d7603f2d7792169d0f97f562673b18d6d3b777d6106ff736b1c69517de4e8eb6c060ec258d545ad9aa76fdd71cc78f

data/README.md

@@ -36,3 +36,8 @@ end
 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
+
+## Inspiration
+
+* http://docs.aws.amazon.com/general/latest/gr/api-retries.html
+* https://github.com/aws/aws-sdk-ruby/blob/master/lib/aws/core/client.rb

data/excon-middleware-aws-exponential_backoff.gemspec

@@ -20,5 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "open4"
+  spec.add_development_dependency "sinatra"
   spec.add_dependency "excon"
 end

data/lib/excon/middleware/aws/exponential_backoff.rb

@@ -29,8 +29,8 @@ module Excon
         def error_call(datum)
           datum[:backoff] ||= {}
           datum[:backoff][:max_retries] ||= 0
-          datum[:backoff][:max_delay] ||= 30
-          datum[:backoff][:retry_count] = 0
+          datum[:backoff][:max_delay]   ||= 30
+          datum[:backoff][:retry_count] ||= 0
 
           if (throttle?(datum) || server_error?(datum)) && should_retry?(datum)
             do_backoff(datum)

data/lib/excon/middleware/aws/exponential_backoff/version.rb

@@ -4,7 +4,7 @@ module Excon
   module Middleware
     module AWS
       class ExponentialBackoff < Excon::Middleware::Base
-        VERSION = "0.0.1"
+        VERSION = "0.0.2"
       end
     end
   end

data/spec/exponential_backoff_spec.rb

@@ -6,6 +6,13 @@ class Stack
   def response_call(datum); end
 end
 
+class Instrumentor
+  def instrument(name, datum, &block)
+    return unless block
+    block.call
+  end
+end
+
 RSpec.describe Excon::Middleware::AWS::ExponentialBackoff do
   let(:stack) { Stack.new }
   subject { Excon::Middleware::AWS::ExponentialBackoff.new(stack) }
@@ -70,6 +77,23 @@ RSpec.describe Excon::Middleware::AWS::ExponentialBackoff do
     subject.do_handoff(datum)
   end
 
+  it "can be instrumented" do
+    instrumentor = Instrumentor.new
+    datum = {
+             instrumentor: instrumentor,
+             instrumentor_name: "test"
+            }
+
+    expect(instrumentor).to receive(:instrument).with("test.backoff", datum).and_call_original
+    expect_any_instance_of(Kernel).to receive(:sleep)
+    subject.do_sleep(0, datum)
+  end
+
+  it "works when not instrumented" do
+    expect_any_instance_of(Kernel).to receive(:sleep)
+    subject.do_sleep(0, {})
+  end
+
   context :do_backoff do
     let(:connection) { double("connection") }
     let(:datum) {
@@ -103,4 +127,25 @@ RSpec.describe Excon::Middleware::AWS::ExponentialBackoff do
       subject.do_backoff(datum)
     end
   end
+
+  it "should work against a real server" do
+    Excon.defaults[:mock] = false
+    Excon.defaults[:middlewares] << Excon::Middleware::AWS::ExponentialBackoff
+
+    datum = {
+             instrumentor: Instrumentor.new,
+             instrumentor_name: "test",
+             expects: [200],
+             backoff: {
+                       max_retries: 3,
+                       max_delay: 0
+                      }
+            }
+
+    allow(Excon).to receive(:display_warning) # keep rspec output tidy even with unsupported request key :backoff
+
+    ServerHelper.with_server("aws") do
+      expect(Excon.get('http://127.0.0.1:9292/throttle/3', datum).body).to eq "OK"
+    end
+  end
 end

data/spec/servers/aws.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require "sinatra/base"
+
+class PathRequestCounter
+  def initialize(app)
+    @app = app
+    @counter = {}
+  end
+
+  def call(env)
+    path_info = env['PATH_INFO']
+    @counter[path_info] ||= 1
+    env['path_info.request.counter'] = @counter[path_info]
+
+    @app.call(env).tap do
+      @counter[path_info] += 1
+    end
+  end
+end
+
+class AWS < Sinatra::Base
+  configure do
+    set :port, 9292
+  end
+
+  use PathRequestCounter
+
+  get '/throttle/:count' do
+    count = request.env['path_info.request.counter']
+     if count <= Integer(params[:count] || 0)
+      [400, {}, ["<Code>Throttling</Code>"]]
+    else
+      [200, {}, "OK"]
+    end
+  end
+
+  if app_file == $0
+    start! do
+      $stderr.puts "ready"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,34 +1,6 @@
 require "excon/middleware/aws/exponential_backoff"
 
-module AWSErrorHelper
-  def throttling_response
-    body = %(
-      <ErrorResponse xmlns="http://some-service.amazonaws.com/doc/2010-05-15/">
-        <Error>
-          <Type>Sender</Type>
-          <Code>Throttling</Code>
-          <Message>Rate exceeded</Message>
-        </Error>
-      </ErrorResponse>
-    )
-
-    Excon::Response.new(status: 400, body: body)
-  end
-
-  def request_time_too_skewed_response
-    body = %(
-      <Error>
-        <Code>RequestTimeTooSkewed</Code>
-        <Message>The difference between the request time and the current time is too large.</Message>
-        <ServerTime>2006-11-10T13:43:55Z</ServerTime>
-        <MaxAllowedSkewMilliseconds>900000</MaxAllowedSkewMilliseconds>
-        <RequestTime>Fri, 10 Nov 2006 13:28:46 GMT</RequestTime>
-      </Error>
-    )
-
-    Excon::Response.new(status: 400, body: body)
-  end
-end
+Dir[File.join(File.expand_path("../support", __FILE__), "**/*.rb")].each {|f| require f}
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
@@ -46,4 +18,18 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 
   config.include AWSErrorHelper
+
+  config.around(:each) do |example|
+    excon_defaults = Excon.defaults
+    Excon.defaults[:mock] = true
+
+    example.run
+
+    Excon.defaults = excon_defaults
+    Excon.stubs.clear
+  end
+
+  config.before(:all) do
+    Excon.stub({}, {:body => 'Fallback', :status => 200})
+  end
 end

data/spec/support/aws_error_helper.rb

@@ -0,0 +1,29 @@
+module AWSErrorHelper
+  def throttling_response
+    body = %(
+      <ErrorResponse xmlns="http://some-service.amazonaws.com/doc/2010-05-15/">
+        <Error>
+          <Type>Sender</Type>
+          <Code>Throttling</Code>
+          <Message>Rate exceeded</Message>
+        </Error>
+      </ErrorResponse>
+    )
+
+    Excon::Response.new(status: 400, body: body)
+  end
+
+  def request_time_too_skewed_response
+    body = %(
+      <Error>
+        <Code>RequestTimeTooSkewed</Code>
+        <Message>The difference between the request time and the current time is too large.</Message>
+        <ServerTime>2006-11-10T13:43:55Z</ServerTime>
+        <MaxAllowedSkewMilliseconds>900000</MaxAllowedSkewMilliseconds>
+        <RequestTime>Fri, 10 Nov 2006 13:28:46 GMT</RequestTime>
+      </Error>
+    )
+
+    Excon::Response.new(status: 400, body: body)
+  end
+end

data/spec/support/server_helper.rb

@@ -0,0 +1,23 @@
+# Adapted from excon's tests/test_helper.rb
+module ServerHelper
+
+  extend self
+
+  def server_path(*parts)
+    File.expand_path(File.join(File.dirname(__FILE__), "..", "servers", *parts))
+  end
+
+  def with_server(name)
+    require "open4"
+    pid, w, r, e = Open4.popen4(server_path("#{name}.rb"))
+
+    until val = e.gets; val =~ /ready/ || val.nil?
+      puts val
+    end
+
+    yield
+  ensure
+    Process.kill(9, pid)
+    Process.wait(pid)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excon-middleware-aws-exponential_backoff
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Hale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: open4
+  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: sinatra
+  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: excon
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +112,10 @@ files:
 - lib/excon/middleware/aws/exponential_backoff/include.rb
 - lib/excon/middleware/aws/exponential_backoff/version.rb
 - spec/exponential_backoff_spec.rb
+- spec/servers/aws.rb
 - spec/spec_helper.rb
+- spec/support/aws_error_helper.rb
+- spec/support/server_helper.rb
 homepage: https://github.com/mikehale/excon-middleware-aws-exponential_backoff
 licenses:
 - MIT
@@ -112,4 +143,7 @@ summary: Excon middleware to exponentially backoff calling AWS APIs when throttl
   or experiencing errors.
 test_files:
 - spec/exponential_backoff_spec.rb
+- spec/servers/aws.rb
 - spec/spec_helper.rb
+- spec/support/aws_error_helper.rb
+- spec/support/server_helper.rb