faraday 0.17.6 → 1.0.0.pre.rc1

data/CHANGELOG.md

@@ -1,232 +0,0 @@
-# Faraday Changelog
-
-## v0.17.3
-
-Fixes:
-
-* Reverts changes in error classes hierarchy. #1092 (@iMacTia)
-* Fix Ruby 1.9 syntax errors and improve Error class testing #1094 (@BanzaiMan,
-  @mrexox, @technoweenie)
-
-Misc:
-
-* Stops using `&Proc.new` for block forwarding. #1083 (@olleolleolle)
-* Update CI to test against ruby 2.0-2.7 #1087, #1099 (@iMacTia, @olleolleolle,
-  @technoweenie)
-* require FARADAY_DEPRECATE=warn to show Faraday v1.0 deprecation warnings
-  #1098 (@technoweenie)
-
-## v0.17.1
-
-Final release before Faraday v1.0, with important fixes for Ruby 2.7.
-
-Fixes:
-
-* RaiseError response middleware raises exception if HTTP client returns a nil
-  status. #1042 (@jonnyom, @BobbyMcWho)
-
-Misc:
-
-* Fix Ruby 2.7 warnings (#1009)
-* Add `Faraday::Deprecate` to warn about upcoming v1.0 changes. (#1054, #1059,
-    #1076, #1077)
-* Add release notes up to current in CHANGELOG.md (#1066)
-* Port minimal rspec suite from main branch to run backported tests. (#1058)
-
-## v0.17.0
-
-This release is the same as v0.15.4. It was pushed to cover up releases
-v0.16.0-v0.16.2.
-
-## v0.15.4
-
-* Expose `pool_size` as a option for the NetHttpPersistent adapter (#834)
-
-## v0.15.3
-
-* Make Faraday::Request serialisable with Marshal. (#803)
-* Add DEFAULT_EXCEPTIONS constant to Request::Retry (#814)
-* Add support for Ruby 2.6 Net::HTTP write_timeout (#824)
-
-## v0.15.2
-
-* Prevents `Net::HTTP` adapters to retry request internally by setting `max_retries` to 0 if available (Ruby 2.5+). (#799)
-* Fixes `NestedParamsEncoder` handling of empty array values (#801)
-
-## v0.15.1
-
-* NetHttpPersistent adapter better reuse of SSL connections (#793)
-* Refactor: inline cached_connection (#797)
-* Logger middleware: use $stdout instead of STDOUT (#794)
-* Fix: do not memoize/reuse Patron session (#796)
-
-Also in this release:
-
-* Allow setting min/max ssl version for Net::HTTP (#792)
-* Allow setting min/max ssl version for Excon (#795)
-
-## v0.15.0
-
-Features:
-
-* Added retry block option to retry middleware. (#770)
-* Retry middleware improvements (honour Retry-After header, retry statuses) (#773)
-* Improve response logger middleware output (#784)
-
-Fixes:
-
-* Remove unused class error (#767)
-* Fix minor typo in README (#760)
-* Reuse persistent connections when using net-http-persistent (#778)
-* Fix Retry middleware documentation (#781)
-* Returns the http response when giving up on retrying by status (#783)
-
-## v0.14.0
-
-Features:
-
-* Allow overriding env proxy (#754)
-* Remove legacy Typhoeus adapter (#715)
-* External Typhoeus Adapter Compatibility (#748)
-* Warn about missing adapter when making a request (#743)
-* Faraday::Adapter::Test stubs now support entire urls (with host) (#741)
-
-Fixes:
-
-* If proxy is manually provided, this takes priority over `find_proxy` (#724)
-* Fixes the behaviour for Excon's open_timeout (not setting write_timeout anymore) (#731)
-* Handle all connection timeout messages in Patron (#687)
-
-## v0.13.1
-
-* Fixes an incompatibility with Addressable::URI being used as uri_parser
-
-## v0.13.0
-
-Features:
-
-* Dynamically reloads the proxy when performing a request on an absolute domain (#701)
-* Adapter support for Net::HTTP::Persistent v3.0.0 (#619)
-
-Fixes:
-
-* Prefer #hostname over #host. (#714)
-* Fixes an edge-case issue with response headers parsing (missing HTTP header) (#719)
-
-## v0.12.2
-
-* Parse headers from aggregated proxy requests/responses (#681)
-* Guard against invalid middleware configuration with warning (#685)
-* Do not use :insecure option by default in Patron (#691)
-* Fixes an issue with HTTPClient not raising a `Faraday::ConnectionFailed` (#702)
-* Fixes YAML serialization/deserialization for `Faraday::Utils::Headers` (#690)
-* Fixes an issue with Options having a nil value (#694)
-* Fixes an issue with Faraday.default_connection not using Faraday.default_connection_options (#698)
-* Fixes an issue with Options.merge! and Faraday instrumentation middleware (#710)
-
-## v0.12.1
-
-* Fix an issue with Patron tests failing on jruby
-* Fix an issue with new `rewind_files` feature that was causing an exception when the body was not an Hash
-* Expose wrapped_exception in all client errors
-* Add Authentication Section to the ReadMe
-
-## v0.12.0.1
-
-* Hotfix release to address an issue with TravisCI deploy on Rubygems
-
-## v0.12.0
-
-Features:
-
-* Proxy feature now relies on Ruby `URI::Generic#find_proxy` and can use `no_proxy` ENV variable (not compatible with ruby < 2.0)
-* Adds support for `context` request option to pass arbitrary information to middlewares
-
-Fixes:
-
-* Fix an issue with options that was causing new options to override defaults ones unexpectedly
-* Rewind `UploadIO`s on retry to fix a compatibility issue
-* Make multipart boundary unique
-* Improvements in `README.md`
-
-## v0.11.0
-
-Features:
-
-* Add `filter` method to Logger middleware
-* Add support for Ruby2.4 and Minitest 6
-* Introduce block syntax to customise the adapter
-
-Fixes:
-
-* Fix an issue that was allowing to override `default_connection_options` from a connection instance
-* Fix a bug that was causing newline escape characters ("\n") to be used when building the Authorization header
-
-## v0.10.1
-
-- Fix an issue with HTTPClient adapter that was causing the SSL to be reset on every request
-- Rescue `IOError` instead of specific subclass
-- `Faraday::Utils::Headers` can now be successfully serialised in YAML
-- Handle `default_connection_options` set with hash
-
-## v0.10.0
-
-Breaking changes:
-- Drop support for Ruby 1.8
-
-Features:
-- Include wrapped exception/reponse in ClientErrors
-- Add `response.reason_phrase`
-- Provide option to selectively skip logging request/response headers
-- Add regex support for pattern matching in `test` adapter
-
-Fixes:
-- Add `Faraday.respond_to?` to find methods managed by `method_missing`
-- em-http: `request.host` instead of `connection.host` should be taken for SSL validations
-- Allow `default_connection_options` to be merged when options are passed as url parameter
-- Improve splitting key-value pairs in raw HTTP headers
-
-## v0.9.2
-
-Adapters:
-- Enable gzip compression for httpclient
-- Fixes default certificate store for httpclient not having default paths.
-- Make excon adapter compatible with 0.44 excon version
-- Add compatibility with Patron 0.4.20
-- Determine default port numbers in Net::HTTP adapters (Addressable compatibility)
-- em-http: wrap "connection closed by server" as ConnectionFailed type
-- Wrap Errno::ETIMEDOUT in Faraday::Error::TimeoutError
-
-Utils:
-- Add Rack-compatible support for parsing `a[][b]=c` nested queries
-- Encode nil values in queries different than empty strings. Before: `a=`; now: `a`.
-- Have `Faraday::Utils::Headers#replace` clear internal key cache
-- Dup the internal key cache when a Headers hash is copied
-
-Env and middleware:
-- Ensure `env` stored on middleware response has reference to the response
-- Ensure that Response properties are initialized during `on_complete` (VCR compatibility)
-- Copy request options in Faraday::Connection#dup
-- Env custom members should be copied by Env.from(env)
-- Honour per-request `request.options.params_encoder`
-- Fix `interval_randomness` data type for Retry middleware
-- Add maximum interval option for Retry middleware
-
-## v0.9.1
-
-* Refactor Net:HTTP adapter so that with_net_http_connection can be overridden to allow pooled connections. (@Ben-M)
-* Add configurable methods that bypass `retry_if` in the Retry request middleware.  (@mike-bourgeous)
-
-## v0.9.0
-
-* Add HTTPClient adapter (@hakanensari)
-* Improve Retry handler (@mislav)
-* Remove autoloading by default (@technoweenie)
-* Improve internal docs (@technoweenie, @mislav)
-* Respect user/password in http proxy string (@mislav)
-* Adapter options are structs.  Reinforces consistent options across adapters
-  (@technoweenie)
-* Stop stripping trailing / off base URLs in a Faraday::Connection. (@technoweenie)
-* Add a configurable URI parser. (@technoweenie)
-* Remove need to manually autoload when using the authorization header helpers on `Faraday::Connection`. (@technoweenie)
-* `Faraday::Adapter::Test` respects the `Faraday::RequestOptions#params_encoder` option. (@technoweenie)

data/Rakefile

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'rake/testtask'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :test
-
-desc "Run all tests"
-task :test => :spec do
-  exec 'script/test'
-end

data/lib/faraday/deprecate.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  # @param new_klass [Class] new Klass to use
-  #
-  # @return [Class] A modified version of new_klass that warns on
-  #   usage about deprecation.
-  # @see Faraday::Deprecate
-  module DeprecatedClass
-    def self.proxy_class(origclass, ver = '1.0')
-      proxy = Class.new(origclass) do
-        const_set("ORIG_CLASS", origclass)
-
-        class << self
-          extend Faraday::Deprecate
-
-          def ===(other)
-            (superclass == const_get("ORIG_CLASS") && other.is_a?(superclass)) || super
-          end
-        end
-      end
-      proxy.singleton_class.send(:deprecate, :new, "#{origclass}.new", ver)
-      proxy.singleton_class.send(:deprecate, :inherited, origclass.name, ver)
-      proxy
-    end
-  end
-
-  # Deprecation using semver instead of date, based on Gem::Deprecate
-  # Provides a single method +deprecate+ to be used to declare when
-  # something is going away.
-  #
-  #     class Legacy
-  #       def self.klass_method
-  #         # ...
-  #       end
-  #
-  #       def instance_method
-  #         # ...
-  #       end
-  #
-  #       extend Faraday::Deprecate
-  #       deprecate :instance_method, "X.z", '1.0'
-  #
-  #       class << self
-  #         extend Faraday::Deprecate
-  #         deprecate :klass_method, :none, '1.0'
-  #       end
-  #     end
-  module Deprecate
-    def self.skip # :nodoc:
-      @skip ||= begin
-        case ENV['FARADAY_DEPRECATE'].to_s.downcase
-        when '1', 'warn' then :warn
-        else :skip
-        end
-      end
-      @skip == :skip
-    end
-
-    def self.skip=(value) # :nodoc:
-      @skip = value ? :skip : :warn
-    end
-
-    # Temporarily turn off warnings. Intended for tests only.
-    def skip_during
-      original = Faraday::Deprecate.skip
-      Faraday::Deprecate.skip, = true
-      yield
-    ensure
-      Faraday::Deprecate.skip = original
-    end
-
-    # Simple deprecation method that deprecates +name+ by wrapping it up
-    # in a dummy method. It warns on each call to the dummy method
-    # telling the user of +repl+ (unless +repl+ is :none) and the
-    # semver that it is planned to go away.
-    # @param name [Symbol] the method symbol to deprecate
-    # @param repl [#to_s, :none] the replacement to use, when `:none` it will
-    #   alert the user that no replacemtent is present.
-    # @param ver [String] the semver the method will be removed.
-    def deprecate(name, repl, ver)
-      class_eval do
-        gem_ver = Gem::Version.new(ver)
-        old = "_deprecated_#{name}"
-        alias_method old, name
-        define_method name do |*args, &block|
-          mod = is_a? Module
-          target = mod ? "#{self}." : "#{self.class}#"
-          target_message = if name == :inherited
-                             "Inheriting #{self}"
-                           else
-                             "#{target}#{name}"
-                           end
-
-          msg = [
-            "NOTE: #{target_message} is deprecated",
-            repl == :none ? ' with no replacement' : "; use #{repl} instead. ",
-            "It will be removed in or after version #{gem_ver}",
-            "\n#{target}#{name} called from #{Gem.location_of_caller.join(':')}"
-          ]
-          warn "#{msg.join}." unless Faraday::Deprecate.skip
-          send old, *args, &block
-        end
-      end
-    end
-
-    module_function :deprecate, :skip_during
-  end
-end

data/spec/faraday/deprecate_spec.rb

@@ -1,147 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Faraday::DeprecatedClass do
-  class SampleClass < StandardError
-    attr_accessor :foo
-
-    def initialize(foo = nil)
-      @foo = foo || :foo
-    end
-  end
-
-  SampleDeprecatedClass = Faraday::DeprecatedClass.proxy_class(SampleClass)
-
-  it 'does not raise error for deprecated classes but prints an error message' do
-    error_message, foobar = with_warn_squelching { SampleDeprecatedClass.new(:foo_bar) }
-    expect(foobar).to be_a(SampleClass)
-    expect(foobar.foo).to eq(:foo_bar)
-    expect(error_message).to match(
-      Regexp.new(
-        'NOTE: SampleDeprecatedClass.new is deprecated; '\
-        'use SampleClass.new instead. It will be removed in or after version 1.0'
-      )
-    )
-  end
-
-  it 'does not raise an error for inherited error-namespaced classes but prints an error message' do
-    error_message, = with_warn_squelching { Class.new(SampleDeprecatedClass) }
-
-    expect(error_message).to match(
-      Regexp.new(
-        'NOTE: Inheriting SampleDeprecatedClass is deprecated; '\
-        'use SampleClass instead. It will be removed in or after version 1.0'
-      )
-    )
-  end
-
-  it 'allows backward-compatible class to be subclassed' do
-    expect {
-      with_warn_squelching { Class.new(SampleDeprecatedClass) }
-    }.not_to raise_error
-  end
-
-  it 'allows rescuing of a current error with a deprecated error' do
-    expect { raise SampleClass, nil }.to raise_error(SampleDeprecatedClass)
-  end
-
-  it 'allows rescuing of a current error with a current error' do
-    expect { raise SampleClass, nil }.to raise_error(SampleClass)
-  end
-
-  it 'allows rescuing of a deprecated error with a deprecated error' do
-    expect { raise SampleDeprecatedClass, nil }.to raise_error(SampleDeprecatedClass)
-  end
-
-  it 'allows rescuing of a deprecated error with a current error' do
-    expect { raise SampleDeprecatedClass, nil }.to raise_error(SampleClass)
-  end
-
-  describe 'match behavior' do
-    class SampleDeprecatedClassA < SampleDeprecatedClass; end
-    class SampleDeprecatedClassB < SampleDeprecatedClass; end
-
-    class SampleDeprecatedClassAX < SampleDeprecatedClassA; end
-
-    class SampleClassA < SampleClass; end
-
-    describe 'undeprecated class' do
-      it 'is === to instance of deprecated class' do
-        expect(SampleClass === SampleDeprecatedClass.new).to be true
-      end
-
-      it 'is === to instance of subclass of deprecated class' do
-        expect(SampleClass === SampleDeprecatedClassA.new).to be true
-      end
-
-      it 'is === to instance of subclass of subclass of deprecated class' do
-        expect(SampleClass === SampleDeprecatedClassAX.new).to be true
-      end
-    end
-
-    describe 'subclass of undeprecated class' do
-      it 'is not === to instance of undeprecated class' do
-        expect(SampleClassA === SampleClass.new).to be false
-      end
-
-      it 'is not === to instance of deprecated class' do
-        expect(SampleClassA === SampleDeprecatedClass.new).to be false
-      end
-    end
-
-    describe 'deprecated class' do
-      it 'is === to instance of undeprecated class' do
-        expect(SampleDeprecatedClass === SampleClass.new).to be true
-      end
-
-      it 'is === to instance of subclass of undeprecated class' do
-        expect(SampleDeprecatedClass === SampleClassA.new).to be true
-      end
-
-      it 'is === to instance of subclass of deprecated class' do
-        expect(SampleDeprecatedClass === SampleDeprecatedClassA.new).to be true
-      end
-
-      it 'is === to instance of subclass of subclass of deprecated class' do
-        expect(SampleDeprecatedClass === SampleDeprecatedClassAX.new).to be true
-      end
-    end
-
-    describe 'subclass of deprecated class' do
-      it 'is not === to instance of subclass of undeprecated class' do
-        expect(SampleDeprecatedClassA === SampleClass.new).to be false
-      end
-
-      it 'is not === to instance of another subclass of deprecated class' do
-        expect(SampleDeprecatedClassA === SampleDeprecatedClassB.new).to be false
-      end
-
-      it 'is === to instance of its subclass' do
-        expect(SampleDeprecatedClassA === SampleDeprecatedClassAX.new).to be true
-      end
-
-      it 'is === to instance of deprecated class' do
-        expect(SampleDeprecatedClass === SampleDeprecatedClassB.new).to be true
-      end
-    end
-
-    describe 'subclass of subclass of deprecated class' do
-      it 'is not === to instance of subclass of another subclass of deprecated class' do
-        expect(SampleDeprecatedClassAX === SampleDeprecatedClassB.new).to be false
-      end
-
-      it 'is not === to instance of its superclass' do
-        expect(SampleDeprecatedClassA === SampleDeprecatedClass.new).to be false
-      end
-    end
-  end
-
-  def with_warn_squelching
-    stderr_catcher = StringIO.new
-    original_stderr = $stderr
-    $stderr = stderr_catcher
-    result = yield if block_given?
-    [stderr_catcher.tap(&:rewind).string, result]
-  ensure
-    $stderr = original_stderr
-  end
-end

data/spec/faraday/error_spec.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Faraday::ClientError do
-  describe '.initialize' do
-    subject { described_class.new(exception, response) }
-    let(:response) { nil }
-
-    context 'with exception only' do
-      let(:exception) { RuntimeError.new('test') }
-
-      it { expect(subject.wrapped_exception).to eq(exception) }
-      it { expect(subject.response).to be_nil }
-      it { expect(subject.message).to eq(exception.message) }
-      it { expect(subject.backtrace).to eq(exception.backtrace) }
-      it { expect(subject.inspect).to eq('#<Faraday::ClientError wrapped=#<RuntimeError: test>>') }
-    end
-
-    context 'with response hash' do
-      let(:exception) { { status: 400 } }
-
-      it { expect(subject.wrapped_exception).to be_nil }
-      it { expect(subject.response).to eq(exception) }
-      it { expect(subject.message).to eq('the server responded with status 400') }
-      it { expect(subject.inspect).to eq('#<Faraday::ClientError response={:status=>400}>') }
-    end
-
-    context 'with string' do
-      let(:exception) { 'custom message' }
-
-      it { expect(subject.wrapped_exception).to be_nil }
-      it { expect(subject.response).to be_nil }
-      it { expect(subject.message).to eq('custom message') }
-      it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: custom message>>') }
-    end
-
-    context 'with anything else #to_s' do
-      let(:exception) { %w[error1 error2] }
-
-      it { expect(subject.wrapped_exception).to be_nil }
-      it { expect(subject.response).to be_nil }
-      it { expect(subject.message).to eq('["error1", "error2"]') }
-      it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: ["error1", "error2"]>>') }
-    end
-
-    context 'maintains backward-compatibility until 1.0' do
-      it 'does not raise an error for error-namespaced classes but prints an error message' do
-        error_message, error = with_warn_squelching { Faraday::Error::ClientError.new('foo') }
-
-        expect(error).to be_a Faraday::ClientError
-        expect(error_message).to match(
-          Regexp.new(
-            'NOTE: Faraday::Error::ClientError.new is deprecated; '\
-            'use Faraday::ClientError.new instead. It will be removed in or after version 1.0'
-          )
-        )
-      end
-
-      it 'does not raise an error for inherited error-namespaced classes but prints an error message' do
-        error_message, = with_warn_squelching { Class.new(Faraday::Error::ClientError) }
-
-        expect(error_message).to match(
-          Regexp.new(
-            'NOTE: Inheriting Faraday::Error::ClientError is deprecated; '\
-            'use Faraday::ClientError instead. It will be removed in or after version 1.0'
-          )
-        )
-      end
-
-      it 'allows backward-compatible class to be subclassed' do
-        expect {
-          with_warn_squelching { Class.new(Faraday::Error::ClientError) }
-        }.not_to raise_error
-      end
-
-      it 'allows rescuing of a current error with a deprecated error' do
-        expect { raise Faraday::ClientError, nil }.to raise_error(Faraday::Error::ClientError)
-      end
-
-      it 'allows rescuing of a current error with a current error' do
-        expect { raise Faraday::ClientError, nil }.to raise_error(Faraday::ClientError)
-      end
-
-      it 'allows rescuing of a deprecated error with a deprecated error' do
-        expect { raise Faraday::Error::ClientError, nil }.to raise_error(Faraday::Error::ClientError)
-      end
-
-      it 'allows rescuing of a deprecated error with a current error' do
-        expect { raise Faraday::Error::ClientError, nil }.to raise_error(Faraday::ClientError)
-      end
-    end
-
-    def with_warn_squelching
-      stderr_catcher = StringIO.new
-      original_stderr = $stderr
-      $stderr = stderr_catcher
-      result = yield if block_given?
-      [stderr_catcher.tap(&:rewind).string, result]
-    ensure
-      $stderr = original_stderr
-    end
-  end
-end