faraday-conductivity 0.0.4 → 0.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+log/

data/README.md

@@ -140,6 +140,36 @@ The User-Agent will looks like this on my machine:
 MarketingSite/1.1 (iain.local; iain; 30360) ruby/1.9.3 (327; x86_64-darwin12.2.0)
 ```
 
+### Repeater
+
+The Repeater will retry your requests until they succeed. This is handy for
+reaching servers that are not too reliable.
+
+``` ruby
+connection = Faraday.new(url: "http://slow.website.com") do |faraday|
+  faraday.use :repeater, retries: 6, mode: :rapid
+end
+```
+
+The `retries` parameter specifies how many times to retry before succeeding.
+
+The `mode` parameter specifies how long to wait before retrying. `:rapid` will
+retry instantly, `:one`, will wait one second between retries, `:linear` and
+`:exponential` will retry longer and longer after every retry.
+
+It's also possible to specify your own pattern by providing a lambda, that
+returns the number of seconds to wait. For example:
+
+``` ruby
+connection = Faraday.new(url: "http://slow.website.com") do |faraday|
+  faraday.use :repeater, retries: 6, pattern: ->(n) { rand < 0.5 ? 10 : 2 }
+end
+```
+
+You can use the repeater together with the `raise_error` middleware to also
+retry after getting 404s and other succeeded requests, but failed statuses.
+
+
 ## Contributing
 
 1. Fork it

data/faraday-conductivity.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "pry"
+  gem.add_development_dependency "service_double"
 end

data/lib/faraday/conductivity.rb

@@ -7,6 +7,7 @@ require "faraday/conductivity/mimetype"
 require "faraday/conductivity/request_id"
 require "faraday/conductivity/request_id_filter"
 require "faraday/conductivity/user_agent"
+require "faraday/conductivity/repeater"
 
 module Faraday
   module Conductivity
@@ -15,5 +16,6 @@ module Faraday
   register_middleware :request, :user_agent => Faraday::Conductivity::UserAgent
   register_middleware :request, :request_id => Faraday::Conductivity::RequestId
   register_middleware :request, :mimetype => Faraday::Conductivity::Mimetype
+  register_middleware :middleware, :repeater => Faraday::Conductivity::Repeater
 end
 

data/lib/faraday/conductivity/repeater.rb

@@ -0,0 +1,61 @@
+module Faraday
+  module Conductivity
+    class Repeater < Faraday::Middleware
+
+      PATTERNS = {
+        :rapid       => lambda { |n| 0 },
+        :one         => lambda { |n| 1 },
+        :linear      => lambda { |n| n },
+        :exponential => lambda { |n| n ** 2 },
+      }
+
+      def initialize(app, options = {})
+        @app = app
+        @retries = options[:retries] || 10
+
+        if mode = options[:mode]
+          @pattern = build_pattern(PATTERNS.fetch(mode))
+        elsif pattern = options[:pattern]
+          @pattern = build_pattern(pattern)
+        else
+          @pattern = build_pattern(PATTERNS.fetch(:exponential))
+        end
+      end
+
+      def call(env)
+        tries = 0
+        begin
+          @app.call(env)
+        rescue Faraday::Error::ClientError
+          if tries < @retries
+            tries += 1
+            @pattern.wait(tries)
+            retry
+          else
+            raise
+          end
+        end
+      end
+
+      def build_pattern(pattern)
+        Pattern.new(pattern)
+      end
+
+      class Pattern
+
+        def initialize(pattern)
+          @pattern = pattern
+        end
+
+        def wait(num)
+          seconds = @pattern.call(num)
+          if seconds != 0
+            sleep num
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/faraday/conductivity/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module Conductivity
-    VERSION = "0.0.4"
+    VERSION = "0.1.0"
   end
 end

data/spec/fake_server.rb

@@ -0,0 +1,21 @@
+count = 0
+
+get "/" do
+  200
+end
+
+delete "/" do
+  count = 0
+  200
+end
+
+get "/unreliable/:max" do |max|
+  max = Integer(max)
+  count += 1
+  if count <= max
+    sleep 5
+    "slow"
+  else
+    "fast"
+  end
+end

data/spec/middleware/repeater_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Faraday::Conductivity::Repeater do
+
+  let(:connection) {
+    Faraday.new(url: $service_double_url) { |faraday|
+      faraday.use :repeater, mode: :rapid, retries: 6
+      faraday.adapter Faraday.default_adapter
+    }
+  }
+
+  it "retries after timeouts" do
+    get_with_max(4).body.should eq "fast"
+  end
+
+  it "gives up after a number of retries" do
+    expect { get_with_max(9) }.to raise_error(Faraday::Error::TimeoutError)
+  end
+
+  it "waits according to a pattern" do
+    pattern = double :pattern
+    Faraday::Conductivity::Repeater::Pattern.should_receive(:new).and_return(pattern)
+    pattern.should_receive(:wait).with(1).ordered
+    pattern.should_receive(:wait).with(2).ordered
+    pattern.should_receive(:wait).with(3).ordered
+    get_with_max(3)
+  end
+
+  def get_with_max(num)
+    connection.get("/unreliable/#{num}") { |req|
+      req.options[:timeout] = 1
+      req.options[:open_timeout] = 1
+    }
+  end
+
+end

data/spec/spec_helper.rb

@@ -34,3 +34,12 @@ RSpec.configure do |config|
   config.order = 'random'
   config.include SpecHelper
 end
+
+require 'service_double'
+
+$service_double_url = "http://localhost:3434"
+
+$service_double = ServiceDouble.hook_into(:rspec) do |config|
+  config.server = File.expand_path('../fake_server.rb', __FILE__)
+  config.url = $service_double_url
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday-conductivity
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: service_double
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Extra Faraday middleware, geared towards a service oriented architecture.
 email:
 - iain@iain.nl
@@ -92,12 +108,15 @@ files:
 - lib/faraday/conductivity.rb
 - lib/faraday/conductivity/extended_logging.rb
 - lib/faraday/conductivity/mimetype.rb
+- lib/faraday/conductivity/repeater.rb
 - lib/faraday/conductivity/request_id.rb
 - lib/faraday/conductivity/request_id_filter.rb
 - lib/faraday/conductivity/user_agent.rb
 - lib/faraday/conductivity/version.rb
+- spec/fake_server.rb
 - spec/middleware/extended_logging_spec.rb
 - spec/middleware/mimetype_spec.rb
+- spec/middleware/repeater_spec.rb
 - spec/middleware/request_id_spec.rb
 - spec/middleware/user_agent_spec.rb
 - spec/spec_helper.rb
@@ -127,8 +146,10 @@ signing_key:
 specification_version: 3
 summary: Extra Faraday middleware, geared towards a service oriented architecture.
 test_files:
+- spec/fake_server.rb
 - spec/middleware/extended_logging_spec.rb
 - spec/middleware/mimetype_spec.rb
+- spec/middleware/repeater_spec.rb
 - spec/middleware/request_id_spec.rb
 - spec/middleware/user_agent_spec.rb
 - spec/spec_helper.rb