faraday-conductivity 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzFiZDYzNzFhODliZjNjNTQ3YTlmMWE0MzY5YTkzYzFiYTEyOTJmMg==
-  data.tar.gz: !binary |-
-    MDMzZTJkODg4ZDEzNjk1OTEzMjkxMDA5YTRlYzQ4Y2FhNGE1N2VkZQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NGQ5MzA4NmUzYjZlZWU4OTlkZmNlOGM0ODMyMmNlZjE0ZDk3ZDQ4MzM5Yjk3
-    MWFjNzE4ZTliYjNmZGNiMDdmYjgyYjUwZmE3YjI3ZDdiNWVhMGM4NzZiZDYz
-    NzY4OTZhOWE4ZDEwN2VjYzQ0NzliMGU2MzRmYjJjM2ViMTgxZDM=
-  data.tar.gz: !binary |-
-    Mzc2YjZjODg1NDNmOWIxODc1MjQ2ODMwZjc4YWNlODRkNWJhNzljMWMxMGI5
-    MjQ1NTBlZmY3ZWIwODc4YmJiMDNhZDE3MGZjMWE2NWQwZGE4MDQ0ZDUxODRj
-    YzFkNDQwZGEyYWNmMDAzMWQ4NDljYjFiODllZDRjNGM5YjMzYTI=
+SHA1:
+  metadata.gz: c0e0b4ab8e7ebe14c7b3ac66223ac8249e457555
+  data.tar.gz: 9de5e1b2b2cb788589612ffdb35b656c538bdda8
+SHA512:
+  metadata.gz: 72d31c8c4ccb84c8ed76bbe98db9e94dff8c2e39c412ebac07a305cb16d232c3c233faf070e09de23868ad7b8295bb77afbd30c2dc1220c96da9f4f551980e92
+  data.tar.gz: 0b47e2a12d797d83d873c60ef4c0fe45b872a442b40343bc64e9a17ded073ac642e84e470277cf32d2dc465517270254a2beca32f459ae4149a4d6ae4776d371

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/README.md

@@ -1,4 +1,4 @@
-# Faraday::Conductivity
+# Faraday::Conductivity [![Build Status](https://travis-ci.org/yourkarma/faraday-conductivity.png?branch=master)](https://travis-ci.org/yourkarma/faraday-conductivity)
 
 Extra Faraday Middleware! Geared towards a service oriented architecture.
 
@@ -10,6 +10,7 @@ These middlewares are currently included:
 * **request_id**, passes along the `X-Request-Id` header to track API request
   back to the source.
 * **mimetype**, allows you to specify the `Accept` header for API versioning.
+* **selective_errors**, raise errors only on the statuses that you specify.
 
 Further information:
 
@@ -45,6 +46,9 @@ connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
   # provided by faraday_middleware
   faraday.response :json, content_type: /\bjson$/
 
+  # provided by this gem
+  faraday.response :selective_errors, on: 425..599, except: 402..499
+
   faraday.adapter Faraday.default_adapter
 
 end
@@ -169,6 +173,26 @@ 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.
 
+### Selective Errors
+
+The default `:raise_error` middleware raises errors for every http status above
+400. However, status codes like 404 or 422 might not be an actual exceptional
+condition. This middleware allows you to specify which status codes you do and
+do not want to raise an error for.
+
+You can pass in an array or a range to the `:on` argument. This will default to
+400...600. You can specify exceptions with the `:except` argument.
+
+``` ruby
+connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
+  faraday.response :selective_errors, on: (400...600), except: [404, 409, 410, 412, 422]
+end
+```
+
+The errors raised will be the same as Faraday, namely
+`Faraday::Error::ResourceNotFound` for 404 errors,
+`Faraday::Error::ConnectionFailed` for 407 and `Faraday::Error::ClientError` for
+the rest. These all inherit from `Faraday::Error`.
 
 ## Contributing
 

data/lib/faraday/conductivity.rb

@@ -8,14 +8,16 @@ require "faraday/conductivity/request_id"
 require "faraday/conductivity/request_id_filter"
 require "faraday/conductivity/user_agent"
 require "faraday/conductivity/repeater"
+require "faraday/conductivity/selective_errors"
 
 module Faraday
   module Conductivity
   end
-  register_middleware :middleware, :extended_logging => Faraday::Conductivity::ExtendedLogging
-  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
+  register_middleware :middleware,  :extended_logging => Faraday::Conductivity::ExtendedLogging
+  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
+  register_middleware :response,    :selective_errors => Faraday::Conductivity::SelectiveErrors
 end
 

data/lib/faraday/conductivity/selective_errors.rb

@@ -0,0 +1,52 @@
+module Faraday
+  module Conductivity
+    class SelectiveErrors < Faraday::Middleware
+
+      ClientErrorStatuses = 400...600
+
+      def initialize(app, options = {})
+        @app    = app
+        @on     = options.fetch(:on) { ClientErrorStatuses }
+        @except = options.fetch(:except) { [] }
+      end
+
+      def call(env)
+        # capture request_body because not accessible afterwards
+        request_body = env[:body]
+        @app.call(env).on_complete do
+          if should_raise_error?(env[:status])
+            raise_error(env, request_body)
+          end
+        end
+      end
+
+      def should_raise_error?(status)
+        @on.include?(status) && !@except.include?(status)
+      end
+
+      def raise_error(env, request_body)
+        case env[:status]
+        when 404
+          raise Faraday::Error::ResourceNotFound, response_values(env, request_body)
+        when 407
+          # mimic the behavior that we get with proxy requests with HTTPS
+          raise Faraday::Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
+        else
+          raise Faraday::Error::ClientError, response_values(env, request_body)
+        end
+      end
+
+      def response_values(env, request_body)
+        {
+          :url              => env[:url],
+          :status           => env[:status],
+          :request_body     => request_body,
+          :request_headers  => env[:request_headers],
+          :response_headers => env[:response_headers],
+          :response_body    => env[:body],
+        }
+      end
+
+    end
+  end
+end

data/lib/faraday/conductivity/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module Conductivity
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/spec/middleware/repeater_spec.rb

@@ -5,6 +5,7 @@ describe Faraday::Conductivity::Repeater do
   let(:connection) {
     Faraday.new(url: $service_double_url) { |faraday|
       faraday.use :repeater, mode: :rapid, retries: 6
+      faraday.response :raise_error
       faraday.adapter Faraday.default_adapter
     }
   }
@@ -14,16 +15,28 @@ describe Faraday::Conductivity::Repeater do
   end
 
   it "gives up after a number of retries" do
-    expect { get_with_max(9) }.to raise_error(Faraday::Error::TimeoutError)
+    expect { get_with_max(20) }.to raise_error(Faraday::Error::TimeoutError)
+  end
+
+  class MyPattern
+
+    def initialize
+      @waited = []
+    end
+
+    attr_reader :waited
+
+    def wait(x)
+      waited << x
+    end
+
   end
 
   it "waits according to a pattern" do
-    pattern = double :pattern
+    pattern = MyPattern.new
     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)
+    get_with_max(6)
+    pattern.waited.should eq pattern.waited.sort
   end
 
   it "handles other errors too" do

data/spec/middleware/selective_errors_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Faraday::Conductivity::SelectiveErrors do
+
+  subject(:request_headers) { response.env[:request_headers] }
+
+  it "raises an exception if the error is inside the :on argument" do
+    apply_selective_errors on: 407..409
+    expect { response_with_status(408) }.to raise_error Faraday::Error::ClientError
+  end
+
+  it "won't raise an exception when outside the range" do
+    apply_selective_errors on: 407..409
+    expect { response_with_status(410) }.not_to raise_error
+  end
+
+  it "won't raise if included in range, but excluded with :except argument" do
+    apply_selective_errors on: 403..422, except: [408]
+    expect { response_with_status(408) }.not_to raise_error
+  end
+
+  it "raises an exception if included in :on and not included in :except" do
+    apply_selective_errors on: 403..422, except: [408]
+    expect { response_with_status(409) }.to raise_error Faraday::Error::ClientError
+  end
+
+  it "raises a resource not found error when the actual status is 404" do
+    apply_selective_errors on: 403..422, except: [408]
+    expect { response_with_status(404) }.to raise_error Faraday::Error::ResourceNotFound
+  end
+
+  it "raises a connection failed on 407" do
+    apply_selective_errors on: 403..422, except: [408]
+    expect { response_with_status(407) }.to raise_error Faraday::Error::ConnectionFailed
+  end
+
+  def apply_selective_errors(options)
+    @options = options
+  end
+
+  def response_with_status(status)
+    stubs = create_stubs do |stub|
+      stub.get("/test") { |e| [status, {}, "response"] }
+    end
+    connection = create_connection(stubs) do |faraday|
+      faraday.response :selective_errors, @options
+    end
+    connection.get("/test")
+  end
+
+end

data/spec/spec_helper.rb

@@ -6,10 +6,10 @@ module SpecHelper
     connection.get("/test")
   end
 
-  def create_connection
+  def create_connection(the_stubs = stubs)
     Faraday.new(url: "http://widgets.example.org") do |faraday|
       yield faraday
-      faraday.adapter :test, stubs
+      faraday.adapter :test, the_stubs
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-conductivity
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - iain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -28,56 +28,56 @@ dependencies:
   name: rake
   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: rspec
   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: pry
   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: service_double
   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'
 description: Extra Faraday middleware, geared towards a service oriented architecture.
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -100,6 +101,7 @@ files:
 - lib/faraday/conductivity/repeater.rb
 - lib/faraday/conductivity/request_id.rb
 - lib/faraday/conductivity/request_id_filter.rb
+- lib/faraday/conductivity/selective_errors.rb
 - lib/faraday/conductivity/user_agent.rb
 - lib/faraday/conductivity/version.rb
 - spec/fake_server.rb
@@ -107,6 +109,7 @@ files:
 - spec/middleware/mimetype_spec.rb
 - spec/middleware/repeater_spec.rb
 - spec/middleware/request_id_spec.rb
+- spec/middleware/selective_errors_spec.rb
 - spec/middleware/user_agent_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/yourkarma/faraday-conductivity
@@ -119,17 +122,17 @@ 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.0.3
+rubygems_version: 2.1.0
 signing_key: 
 specification_version: 4
 summary: Extra Faraday middleware, geared towards a service oriented architecture.
@@ -139,5 +142,6 @@ test_files:
 - spec/middleware/mimetype_spec.rb
 - spec/middleware/repeater_spec.rb
 - spec/middleware/request_id_spec.rb
+- spec/middleware/selective_errors_spec.rb
 - spec/middleware/user_agent_spec.rb
 - spec/spec_helper.rb