faraday-conductivity 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 37144ee9e787b4eba24b366cff58a3d437e5670c
-  data.tar.gz: 577ec27bee6892d8a73382eb1018e726236ce2a4
+SHA256:
+  metadata.gz: 4b7daa7d2c2b8b16dc880bfb8ac956542d2db10f299a2821f1d1df8323c88e96
+  data.tar.gz: fa99a8e801b0cab12612be567d7558612e6da81a7c849a5cfd0a0a77358b4f42
 SHA512:
-  metadata.gz: dce521f65e52e0fa0cfc168d4bd3fe5fded12ecbc5267a9c8632772c19f9e75713f9a84a7013d2bb2e1979e8c8f79eed7b1293da78b751dc64757a8fbf277e56
-  data.tar.gz: c65886c49d1ccaf753bdeeca1133aa002070c9b9354499fcb82ab9b619cb8a5944a86db4511866cb63f7f260a9325111f33e129797c1505d20981439189b8188
+  metadata.gz: 26827ab33d953a9bd4ea2212cdaf9c2ffb3f7537f79c6143496976c38a5c4d55bb3a55e9315f6f169e802aba5165acd54c2a7ffee56a65bdb3c4254405749fae
+  data.tar.gz: f16d6d9307c8747ef3510fa447c07fdb5ed89040fad92fc7ff5bdbb87e0d8b199aa9d2979d7030cb54183bbae9cbe03fcdb9f70d82b9edb0494fc87c43010f30

data/.travis.yml

@@ -1,8 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.3.0
+  - 2.7.0
 gemfile:
-  - gemfiles/faraday_0.8.gemfile
-  - gemfiles/faraday_0.9.gemfile
+  - gemfiles/faraday_1.0.0.gemfile

data/Appraisals

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

data/README.md

@@ -1,4 +1,8 @@
-# Faraday::Conductivity [![Build Status](https://travis-ci.org/yourkarma/faraday-conductivity.png?branch=master)](https://travis-ci.org/yourkarma/faraday-conductivity)
+# Faraday::Conductivity [![Build Status](https://travis-ci.org/enova/faraday-conductivity.svg?branch=master)](https://travis-ci.org/enova/faraday-conductivity)
+
+Originally implemented by [yourkarma/faraday-conductivity](https://github.com/yourkarma/faraday-conductivity).
+
+---
 
 Extra Faraday Middleware! Geared towards a service oriented architecture.
 
@@ -144,35 +148,6 @@ 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.
-
 ### Selective Errors
 
 The default `:raise_error` middleware raises errors for every http status above
@@ -189,10 +164,7 @@ connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
 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.
+The errors raised will be the same [as Faraday](https://github.com/lostisland/faraday/blob/019e1a841707718adad2fd05c602eb1a869b42bc/lib/faraday/response/raise_error.rb).
 
 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
@@ -201,7 +173,7 @@ the request that normally are lost:
 ``` ruby
 begin
   do_failing_request_here
-rescue Faraday::Error::ClientError => error
+rescue Faraday::ClientError => error
   puts error.request[:url]
   puts error.request[:method]
   puts error.request[:body]
@@ -227,6 +199,43 @@ connection = Faraday.new(url: "http://widgets.yourapp.com") do |faraday|
 end
 ```
 
+## faraday-conductivity ~> 0.3
+
+The following middlewares have been removed entirely and are no longer
+supported, but were available prior in faraday-conductivity versions <= 0.3.
+
+### Repeater
+
+Suggested to use [Faraday's Retry](https://github.com/lostisland/faraday/blob/master/docs/middleware/request/retry.md)
+instead.
+
+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.
+
 ### Mimetype
 
 This one is deprecated. Use Request Headers instead.

data/faraday-conductivity.gemspec

@@ -6,11 +6,11 @@ require 'faraday/conductivity/version'
 Gem::Specification.new do |gem|
   gem.name          = "faraday-conductivity"
   gem.version       = Faraday::Conductivity::VERSION
-  gem.authors       = ["iain"]
-  gem.email         = ["iain@iain.nl"]
+  gem.authors       = ["iain", "sshao"]
+  gem.email         = ["iain@iain.nl", "ssh.sshao@gmail.com"]
   gem.description   = %q{Extra Faraday middleware, geared towards a service oriented architecture.}
   gem.summary       = %q{Extra Faraday middleware, geared towards a service oriented architecture.}
-  gem.homepage      = "https://github.com/yourkarma/faraday-conductivity"
+  gem.homepage      = "https://github.com/enova/faraday-conductivity"
   gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
@@ -18,10 +18,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "faraday", "~> 0.8"
+  gem.add_dependency "faraday", "~> 1.0"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 3"
   gem.add_development_dependency "pry"
-  gem.add_development_dependency "service_double"
   gem.add_development_dependency "appraisal"
 end

data/gemfiles/{faraday_0.8.gemfile → faraday_1.0.0.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "faraday", "~> 0.8.0"
+gem "faraday", "~> 1.0.0"
 
-gemspec :path=>"../"
+gemspec path: "../"

data/lib/faraday/conductivity.rb

@@ -3,11 +3,9 @@ require "faraday"
 require "faraday/conductivity/version"
 
 require "faraday/conductivity/extended_logging"
-require "faraday/conductivity/mimetype"
 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"
 require "faraday/conductivity/request_headers"
 
@@ -16,8 +14,6 @@ module Faraday
   end
 
   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

data/lib/faraday/conductivity/selective_errors.rb

@@ -54,7 +54,8 @@ module Faraday
     #   end
     class SelectiveErrors < Faraday::Middleware
 
-      ClientErrorStatuses = 400...600
+      ClientErrorStatuses = (400...500).freeze
+      ServerErrorStatuses = (500...600).freeze
 
       def initialize(app, options = {})
         @app    = app
@@ -74,35 +75,49 @@ module Faraday
         start_time = Time.now
 
         @app.call(env).on_complete do
-
           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
+                    when 400
+                      Faraday::BadRequestError.new(response_values(env))
+                    when 401
+                      Faraday::UnauthorizedError.new(response_values(env))
+                    when 403
+                      Faraday::ForbiddenError.new(response_values(env))
+                    when 404
+                      Faraday::ResourceNotFound.new(response_values(env))
+                    when 407
+                      # mimic the behavior that we get with proxy requests with HTTPS
+                      msg = %(407 "Proxy Authentication Required")
+                      Faraday::ProxyAuthError.new(msg, response_values(env))
+                    when 409
+                      Faraday::ConflictError.new(response_values(env))
+                    when 422
+                      Faraday::UnprocessableEntityError.new(response_values(env))
+                    when ClientErrorStatuses
+                      Faraday::ClientError.new(response_values(env))
+                    when ServerErrorStatuses
+                      Faraday::ServerError.new(response_values(env))
+                    when nil
+                      Faraday::NilStatusError.new(response_values(env))
+                    end
+
             error.extend Error
-            error.response = response
+            error.response = response_values(env)
             error.request = request
             error.response_time = Time.now - start_time
-            raise error
 
+            raise error
           end
 
         end
       end
 
+      def response_values(env)
+        { status: env.status, headers: env.response_headers, body: env.body }
+      end
+
       def should_raise_error?(status)
         @on.include?(status) && !@except.include?(status)
       end

data/lib/faraday/conductivity/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module Conductivity
-    VERSION = "0.3.1"
+    VERSION = "1.0.0"
   end
 end

data/spec/middleware/selective_errors_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Faraday::Conductivity::SelectiveErrors do
 
   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
+    expect { response_with_status(408) }.to raise_error Faraday::ClientError
   end
 
   it "won't raise an exception when outside the range" do
@@ -19,17 +19,17 @@ RSpec.describe Faraday::Conductivity::SelectiveErrors do
 
   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
+    expect { response_with_status(409) }.to raise_error Faraday::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
+    expect { response_with_status(404) }.to raise_error Faraday::ResourceNotFound
   end
 
-  it "raises a connection failed on 407" do
+  it "raises proxy auth required on 407" do
     apply_selective_errors on: 403..422, except: [408]
-    expect { response_with_status(407) }.to raise_error Faraday::Error::ConnectionFailed
+    expect { response_with_status(407) }.to raise_error Faraday::ProxyAuthError
   end
 
   it "stores more information about the request and response" do

data/spec/spec_helper.rb

@@ -31,12 +31,3 @@ RSpec.configure do |config|
   config.disable_monkey_patching!
   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,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: faraday-conductivity
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - iain
+- sshao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +67,6 @@ dependencies:
     - - ">="
       - !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
@@ -97,6 +84,7 @@ dependencies:
 description: Extra Faraday middleware, geared towards a service oriented architecture.
 email:
 - iain@iain.nl
+- ssh.sshao@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,28 +98,22 @@ files:
 - README.md
 - Rakefile
 - faraday-conductivity.gemspec
-- gemfiles/faraday_0.8.gemfile
-- gemfiles/faraday_0.9.gemfile
+- gemfiles/faraday_1.0.0.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
 - 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_headers_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
+homepage: https://github.com/enova/faraday-conductivity
 licenses:
 - MIT
 metadata: {}
@@ -150,19 +132,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 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_headers_spec.rb
 - spec/middleware/request_id_spec.rb
 - spec/middleware/selective_errors_spec.rb
 - spec/middleware/user_agent_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/gemfiles/faraday_0.9.gemfile

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

data/lib/faraday/conductivity/mimetype.rb

@@ -1,18 +0,0 @@
-module Faraday
-  module Conductivity
-    # Deprecated. Use RequestHeaders
-    class Mimetype < Faraday::Middleware
-
-      def initialize(app, options = {})
-        super(app)
-        @accept = options.fetch(:accept)
-      end
-
-      def call(env)
-        env[:request_headers]['Accept'] ||= @accept
-        @app.call(env)
-      end
-
-    end
-  end
-end

data/lib/faraday/conductivity/repeater.rb

@@ -1,61 +0,0 @@
-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, SystemCallError
-          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/spec/fake_server.rb

@@ -1,21 +0,0 @@
-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/mimetype_spec.rb

@@ -1,17 +0,0 @@
-RSpec.describe Faraday::Conductivity::Mimetype do
-
-  subject(:request_headers) { response.env[:request_headers] }
-
-  it "includes the mimetype specified" do
-    expect(request_headers["Accept"]).to eq mimetype
-  end
-
-  let(:mimetype) { "application/vnd.users-v2+json" }
-
-  def connection
-    create_connection do |faraday|
-      faraday.request :mimetype, :accept => mimetype
-    end
-  end
-
-end

data/spec/middleware/repeater_spec.rb

@@ -1,61 +0,0 @@
-RSpec.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
-    }
-  }
-
-  it "retries after timeouts" do
-    expect(get_with_max(4).body).to eq "fast"
-  end
-
-  it "gives up after a number of retries" do
-    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 = MyPattern.new
-    expect(Faraday::Conductivity::Repeater::Pattern).to receive(:new).and_return(pattern)
-    get_with_max(6)
-    expect(pattern.waited).to eq pattern.waited.sort
-  end
-
-  it "handles other errors too" do
-    connection = Faraday.new(url: "http://blabla.bla") { |faraday|
-      faraday.use :repeater, mode: :rapid, retries: 2
-      faraday.adapter Faraday.default_adapter
-    }
-
-    pattern = double :pattern
-    expect(Faraday::Conductivity::Repeater::Pattern).to receive(:new).and_return(pattern)
-    expect(pattern).to receive(:wait).with(1).ordered
-    expect(pattern).to receive(:wait).with(2).ordered
-
-    expect { connection.get("/") }.to raise_error(Faraday::Error::ConnectionFailed)
-  end
-
-  def get_with_max(num)
-    connection.get("/unreliable/#{num}") { |req|
-      req.options[:timeout] = 1
-      req.options[:open_timeout] = 1
-    }
-  end
-
-end