faraday 0.16.0 → 0.17.4

data/spec/faraday/deprecate_spec.rb

@@ -0,0 +1,147 @@
+# 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

@@ -0,0 +1,102 @@
+# 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

data/spec/faraday/response/raise_error_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Response::RaiseError do
+  let(:conn) do
+    Faraday.new do |b|
+      b.response :raise_error
+      b.adapter :test do |stub|
+        stub.get('ok') { [200, { 'Content-Type' => 'text/html' }, '<body></body>'] }
+        stub.get('bad-request') { [400, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('unauthorized') { [401, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('forbidden') { [403, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('not-found') { [404, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('proxy-error') { [407, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('conflict') { [409, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('unprocessable-entity') { [422, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('4xx') { [499, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('nil-status') { [nil, { 'X-Reason' => 'nil' }, 'fail'] }
+        stub.get('server-error') { [500, { 'X-Error' => 'bailout' }, 'fail'] }
+      end
+    end
+  end
+
+  it 'raises no exception for 200 responses' do
+    expect { conn.get('ok') }.not_to raise_error
+  end
+
+  it 'raises Faraday::ClientError for 400 responses' do
+    expect { conn.get('bad-request') }.to raise_error(Faraday::ClientError) do |ex|
+      expect(ex.message).to eq('the server responded with status 400')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(400)
+    end
+  end
+
+  it 'raises Faraday::ClientError for 401 responses' do
+    expect { conn.get('unauthorized') }.to raise_error(Faraday::ClientError) do |ex|
+      expect(ex.message).to eq('the server responded with status 401')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(401)
+    end
+  end
+
+  it 'raises Faraday::ClientError for 403 responses' do
+    expect { conn.get('forbidden') }.to raise_error(Faraday::ClientError) do |ex|
+      expect(ex.message).to eq('the server responded with status 403')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(403)
+    end
+  end
+
+  it 'raises Faraday::ResourceNotFound for 404 responses' do
+    expect { conn.get('not-found') }.to raise_error(Faraday::ResourceNotFound) do |ex|
+      expect(ex.message).to eq('the server responded with status 404')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(404)
+    end
+  end
+
+  it 'raises Faraday::ConnectionFailed for 407 responses' do
+    expect { conn.get('proxy-error') }.to raise_error(Faraday::ConnectionFailed) do |ex|
+      expect(ex.message).to eq('407 "Proxy Authentication Required "')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(407)
+    end
+  end
+
+  it 'raises Faraday::ClientError for 409 responses' do
+    expect { conn.get('conflict') }.to raise_error(Faraday::ClientError) do |ex|
+      expect(ex.message).to eq('the server responded with status 409')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(409)
+    end
+  end
+
+  it 'raises Faraday::ClientError for 422 responses' do
+    expect { conn.get('unprocessable-entity') }.to raise_error(Faraday::ClientError) do |ex|
+      expect(ex.message).to eq('the server responded with status 422')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(422)
+    end
+  end
+
+  it 'raises Faraday::NilStatusError for nil status in response' do
+    expect { conn.get('nil-status') }.to raise_error(Faraday::NilStatusError) do |ex|
+      expect(ex.message).to eq('http status could not be derived from the server response')
+      expect(ex.response[:headers]['X-Reason']).to eq('nil')
+      expect(ex.response[:status]).to be_nil
+    end
+  end
+
+  it 'raises Faraday::ClientError for other 4xx responses' do
+    expect { conn.get('4xx') }.to raise_error(Faraday::ClientError) do |ex|
+      expect(ex.message).to eq('the server responded with status 499')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(499)
+    end
+  end
+
+  it 'raises Faraday::ClientError for 500 responses' do
+    expect { conn.get('server-error') }.to raise_error(Faraday::ClientError) do |ex|
+      expect(ex.message).to eq('the server responded with status 500')
+      expect(ex.response[:headers]['X-Error']).to eq('bailout')
+      expect(ex.response[:status]).to eq(500)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'faraday'
+Faraday::Deprecate.skip = false
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+=end
+end

data/test/adapters/default_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class DefaultTest < Faraday::TestCase
+
+    def adapter() :default end
+
+    Integration.apply(self, :NonParallel) do
+      # default stack is not configured with Multipart
+      undef :test_POST_sends_files
+    end
+
+  end
+end

data/test/adapters/em_http_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class EMHttpTest < Faraday::TestCase
+
+    def adapter() :em_http end
+
+    Integration.apply(self, :Parallel) do
+      # https://github.com/eventmachine/eventmachine/pull/289
+      undef :test_timeout
+
+      def test_binds_local_socket
+        host = '1.2.3.4'
+        conn = create_connection :request => { :bind => { :host => host } }
+        assert_equal host, conn.options[:bind][:host]
+      end
+    end unless jruby? and ssl_mode?
+    # https://github.com/eventmachine/eventmachine/issues/180
+
+    def test_custom_adapter_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::EMHttp.new nil, inactivity_timeout: 20
+
+      req = adapter.create_request(url: url, request: {})
+
+      assert_equal 20, req.connopts.inactivity_timeout
+    end
+  end
+end

data/test/adapters/em_synchrony_test.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class EMSynchronyTest < Faraday::TestCase
+
+    def adapter() :em_synchrony end
+
+    unless jruby?
+      Integration.apply(self, :Parallel) do
+        # https://github.com/eventmachine/eventmachine/pull/289
+        undef :test_timeout
+
+        def test_binds_local_socket
+          host = '1.2.3.4'
+          conn = create_connection :request => { :bind => { :host => host } }
+          #put conn.get('/who-am-i').body
+          assert_equal host, conn.options[:bind][:host]
+        end
+      end
+    end
+
+    def test_custom_adapter_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::EMSynchrony.new nil, inactivity_timeout: 20
+
+      req = adapter.create_request(url: url, request: {})
+
+      assert_equal 20, req.connopts.inactivity_timeout
+    end
+  end
+end

data/test/adapters/excon_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class ExconTest < Faraday::TestCase
+
+    def adapter() :excon end
+
+    Integration.apply(self, :NonParallel) do
+      # https://github.com/geemus/excon/issues/126 ?
+      undef :test_timeout if ssl_mode?
+
+      # Excon lets OpenSSL::SSL::SSLError be raised without any way to
+      # distinguish whether it happened because of a 407 proxy response
+      undef :test_proxy_auth_fail if ssl_mode?
+
+      # https://github.com/geemus/excon/issues/358
+      undef :test_connection_error if RUBY_VERSION >= '2.1.0'
+    end
+
+    def test_custom_adapter_config
+      url = URI('https://example.com:1234')
+
+      adapter = Faraday::Adapter::Excon.new nil, debug_request: true
+
+      conn = adapter.create_connection({url: url}, {})
+
+      assert_equal true, conn.data[:debug_request]
+    end
+  end
+end

data/test/adapters/httpclient_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class HttpclientTest < Faraday::TestCase
+
+    def adapter() :httpclient end
+
+    Integration.apply(self, :NonParallel, :Compression) do
+      def setup
+        require 'httpclient' unless defined?(HTTPClient)
+        HTTPClient::NO_PROXY_HOSTS.delete('localhost')
+      end
+
+      def test_binds_local_socket
+        host = '1.2.3.4'
+        conn = create_connection :request => { :bind => { :host => host } }
+        assert_equal host, conn.options[:bind][:host]
+      end
+
+      def test_custom_adapter_config
+        adapter = Faraday::Adapter::HTTPClient.new do |client|
+          client.keep_alive_timeout = 20
+          client.ssl_config.timeout = 25
+        end
+
+        client = adapter.client
+        adapter.configure_client
+
+        assert_equal 20, client.keep_alive_timeout
+        assert_equal 25, client.ssl_config.timeout
+      end
+    end
+  end
+end