faraday-conductivity 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6881981ef0909be7b9068c7b807507a5a06ff9af
-  data.tar.gz: b4839cd37451314cc0f82049300ec3fe3a3899f1
+  metadata.gz: 81337bd02893a9e0365427e2f498fc299c9bfd91
+  data.tar.gz: b35b5bf0cf8e97c222b7a08d2425f6ffc47210d7
 SHA512:
-  metadata.gz: e0d512fbf02229c25e38d1d8306e3853d07a36ba5a095ed1df5470a31a9c87661a7116b842c49477316eadbc303232fe743d45d91329a60ebcb8081b15d7a4c4
-  data.tar.gz: 701bc930076a97d3dafe8cc11abc3a37a7f77441b3ba101d755cca1d1f85dc3eea5aac1802f6685689cc6a56cce4a97b632ee93a2d26f31af956696b720d75a8
+  metadata.gz: ff06c7a6e23d062a62cf24bc02867c9ec23243afcf284dec10bdf4737d97bb2cbfa23befd52907d4b2e590b41205a24398e78572513da26491f8c47d6027e9ed
+  data.tar.gz: 88b20bf120f272d9c2e16908bd2bcbc650befac32e64ba6570d3cc103ac3244af517d2c7cd90d33883c6a697f24a174c5da87bd2ebd437b577de2f55e3510069

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 log/
+gemfiles/*.lock

data/.travis.yml

@@ -2,3 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.1
+gemfile:
+  - gemfiles/faraday_0.8.gemfile
+  - gemfiles/faraday_0.9.gemfile

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "faraday-0.8" do
+  gem "faraday", "~> 0.8.0"
+end
+
+appraise "faraday-0.9" do
+  gem "faraday", "~> 0.9.0"
+end

data/README.md

@@ -9,7 +9,7 @@ These middlewares are currently included:
 * **extended_logging**, logs *all* the information of the request.
 * **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.
+* **request_headers**, allows you to specify default request headers used in each request.
 * **selective_errors**, raise errors only on the statuses that you specify.
 
 Further information:
@@ -38,7 +38,7 @@ connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
   # provided by this gem
   faraday.request :user_agent, app: "MarketingSite", version: APP_VERSION
   faraday.request :request_id
-  faraday.request :mimetype, accept: "application/vnd.widgets-v2+json"
+  faraday.request :request_headers, accept: "application/vnd.widgets-v2+json"
 
   # provided by this gem
   faraday.use :extended_logging, logger: Rails.logger
@@ -192,7 +192,44 @@ 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`.
+the rest.
+
+If you don't specify the `:on` or `:except` options, it will behave exactly like
+`:raise_error`. The errors are however "enhanced" with extra information about
+the request that normally are lost:
+
+``` ruby
+begin
+  do_failing_request_here
+rescue Faraday::Error::ClientError => error
+  puts error.request[:url]
+  puts error.request[:method]
+  puts error.request[:body]
+  puts error.request[:headers]
+
+  puts error.response[:status]
+  puts error.response[:body]
+  puts error.response[:headers]
+  puts error.response_time
+end
+```
+
+### Request Headers
+
+Allows you to set request headers ahead of time, so you don't have to do this
+each time you make a request. You can override it per request of course.
+
+Usage:
+
+``` ruby
+connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
+  faraday.request :request_headers, accept: "application/json", x_version_number: "10"
+end
+```
+
+### Mimetype
+
+This one is deprecated. Use Request Headers instead.
 
 ## Contributing
 

data/Rakefile

@@ -1,3 +1,4 @@
+require "appraisal"
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)

data/faraday-conductivity.gemspec

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

data/gemfiles/faraday_0.8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.8.0"
+
+gemspec :path=>"../"

data/gemfiles/faraday_0.9.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "faraday", "~> 0.9.0"
+
+gemspec :path=>"../"

data/lib/faraday/conductivity.rb

@@ -9,15 +9,18 @@ require "faraday/conductivity/request_id_filter"
 require "faraday/conductivity/user_agent"
 require "faraday/conductivity/repeater"
 require "faraday/conductivity/selective_errors"
+require "faraday/conductivity/request_headers"
 
 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 :response,    :selective_errors => Faraday::Conductivity::SelectiveErrors
+
+  Faraday::Middleware.register_middleware :extended_logging => Faraday::Conductivity::ExtendedLogging
+  Faraday::Middleware.register_middleware :repeater         => Faraday::Conductivity::Repeater
+  Faraday::Request.register_middleware    :mimetype         => Faraday::Conductivity::Mimetype
+  Faraday::Request.register_middleware    :request_id       => Faraday::Conductivity::RequestId
+  Faraday::Request.register_middleware    :request_headers  => Faraday::Conductivity::RequestHeaders
+  Faraday::Request.register_middleware    :user_agent       => Faraday::Conductivity::UserAgent
+  Faraday::Response.register_middleware   :selective_errors => Faraday::Conductivity::SelectiveErrors
 end
 

data/lib/faraday/conductivity/mimetype.rb

@@ -1,5 +1,6 @@
 module Faraday
   module Conductivity
+    # Deprecated. Use RequestHeaders
     class Mimetype < Faraday::Middleware
 
       def initialize(app, options = {})

data/lib/faraday/conductivity/request_headers.rb

@@ -0,0 +1,19 @@
+module Faraday
+  module Conductivity
+    class RequestHeaders < Faraday::Middleware
+
+      def initialize(app, headers)
+        super(app)
+        @headers = headers
+      end
+
+      def call(env)
+        @headers.each do |header, value|
+          env[:request_headers][header] ||= value
+        end
+        @app.call(env)
+      end
+
+    end
+  end
+end

data/lib/faraday/conductivity/selective_errors.rb

@@ -1,5 +1,57 @@
 module Faraday
   module Conductivity
+
+    module Error
+
+      attr_accessor :request, :response, :response_time
+
+      def initialize(*)
+        @request  = {}
+        @response = {}
+        super
+      end
+
+      def message
+        if @wrapped_exception
+          "#{@wrapped_exception.class}: #{super}"
+        else
+          "#{request[:method].to_s.upcase} #{request[:url]} responded with status #{response[:status]}"
+        end
+      end
+
+      def inspect
+        "<#{self.class}> #{message}"
+      end
+
+    end
+
+    # Use this to raise errors on certain HTTP statuses. These are basically
+    # the same errors as Faraday raises when you use the "raise_error"
+    # middleware, but with added fields to better inspect what went wrong.
+    #
+    # Examples:
+    #
+    #   # specify an array
+    #   faraday.response :selective_errors, on: [422,500]
+    #   # or a range:
+    #   faraday.response :selective_errors, on: 500...600
+    #   # specify errors:
+    #   faraday.response :selective_errors, except: [404,422]
+    #
+    # Rescueing the errors:
+    #
+    #   begin
+    #     do_request
+    #   rescue Faraday::Conductivity::Error => error
+    #     puts error.request[:url]
+    #     puts error.request[:method]
+    #     puts error.request[:body]
+    #     puts error.request[:headers]
+    #
+    #     puts error.response[:status]
+    #     puts error.response[:body]
+    #     puts error.response[:headers]
+    #   end
     class SelectiveErrors < Faraday::Middleware
 
       ClientErrorStatuses = 400...600
@@ -11,12 +63,43 @@ module Faraday
       end
 
       def call(env)
-        # capture request_body because not accessible afterwards
-        request_body = env[:body]
+        # capture request because it will be modified during the request
+        request = {
+          :method  => env[:method],
+          :url     => env[:url],
+          :body    => env[:body],
+          :headers => env[:request_headers],
+        }
+
+        start_time = Time.now
+
         @app.call(env).on_complete do
-          if should_raise_error?(env[:status])
-            raise_error(env, request_body)
+
+          status = env[:status]
+
+          if should_raise_error?(status)
+            response = {
+              :status  => env[:status],
+              :body    => env[:body],
+              :headers => env[:response_headers],
+            }
+            error = case status
+              when 404
+                Faraday::Error::ResourceNotFound.new(response)
+              when 407
+                # mimic the behavior that we get with proxy requests with HTTPS
+                Faraday::Error::ConnectionFailed.new(%{407 "Proxy Authentication Required "})
+              else
+                Faraday::Error::ClientError.new(response)
+              end
+            error.extend Error
+            error.response = response
+            error.request = request
+            error.response_time = Time.now - start_time
+            raise error
+
           end
+
         end
       end
 
@@ -24,29 +107,6 @@ module Faraday
         @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.2.1"
+    VERSION = "0.3.0"
   end
 end

data/spec/middleware/request_headers_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe Faraday::Conductivity::RequestHeaders do
+
+  it "includes the mimetype specified" do
+    connection = create_connection do |faraday|
+      faraday.request :request_headers, :accept => "application/json", :x_version_number => "123"
+    end
+    request_headers = connection.get("/test").env[:request_headers]
+
+    request_headers["Accept"].should eq "application/json"
+    request_headers["X-Version-Number"].should eq "123"
+  end
+
+  it "doesn't override locally specified headers" do
+    connection = create_connection do |faraday|
+      faraday.request :request_headers, :accept => "application/json"
+    end
+    response = connection.get("/test") do |request|
+      request.headers[:accept] = "application/xml"
+    end
+
+    request_headers = response.env[:request_headers]
+
+    request_headers["Accept"].should eq "application/xml"
+  end
+
+end

data/spec/middleware/selective_errors_spec.rb

@@ -34,18 +34,39 @@ describe Faraday::Conductivity::SelectiveErrors do
     expect { response_with_status(407) }.to raise_error Faraday::Error::ConnectionFailed
   end
 
+  it "stores more information about the request and response" do
+    apply_selective_errors on: 403..422, except: [408]
+    error = response_with_status(422) rescue $!
+    expect(error.message).to eq "GET http://widgets.example.org/test responded with status 422"
+
+    expect(error.request[:url].to_s).to eq "http://widgets.example.org/test"
+    expect(error.request[:method]).to eq :get
+
+    expect(error.response[:status]).to eq 422
+
+    expect(error.request[:body]).to eq "the request body"
+    expect(error.response[:body]).to eq "the response body"
+
+    expect(error.request[:headers]).to eq "Accept" => "application/json"
+    expect(error.response[:headers]).to eq "X-Foo-Bar" => "y"
+    expect(error.response_time).to be_a Float
+  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"] }
+      stub.get("/test") { |e| [status, { :x_foo_bar => "y" }, "the response body"] }
     end
     connection = create_connection(stubs) do |faraday|
       faraday.response :selective_errors, @options
     end
-    connection.get("/test")
+    connection.get("/test") do |f|
+      f.body = "the request body"
+      f.headers = { "Accept" => "application/json" }
+    end
   end
 
 end

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: faraday-conductivity
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - iain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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.
@@ -87,18 +101,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - faraday-conductivity.gemspec
+- gemfiles/faraday_0.8.gemfile
+- gemfiles/faraday_0.9.gemfile
 - lib/faraday/conductivity.rb
 - lib/faraday/conductivity/extended_logging.rb
 - lib/faraday/conductivity/mimetype.rb
 - lib/faraday/conductivity/repeater.rb
+- lib/faraday/conductivity/request_headers.rb
 - lib/faraday/conductivity/request_id.rb
 - lib/faraday/conductivity/request_id_filter.rb
 - lib/faraday/conductivity/selective_errors.rb
@@ -108,6 +126,7 @@ files:
 - spec/middleware/extended_logging_spec.rb
 - spec/middleware/mimetype_spec.rb
 - spec/middleware/repeater_spec.rb
+- spec/middleware/request_headers_spec.rb
 - spec/middleware/request_id_spec.rb
 - spec/middleware/selective_errors_spec.rb
 - spec/middleware/user_agent_spec.rb
@@ -122,17 +141,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.1.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Extra Faraday middleware, geared towards a service oriented architecture.
@@ -141,6 +160,7 @@ test_files:
 - spec/middleware/extended_logging_spec.rb
 - spec/middleware/mimetype_spec.rb
 - spec/middleware/repeater_spec.rb
+- spec/middleware/request_headers_spec.rb
 - spec/middleware/request_id_spec.rb
 - spec/middleware/selective_errors_spec.rb
 - spec/middleware/user_agent_spec.rb