faraday 0.17.3 → 1.4.1

data/spec/spec_helper.rb

@@ -1,8 +1,5 @@
 # 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
@@ -18,6 +15,29 @@ Faraday::Deprecate.skip = false
 # it.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'simplecov'
+require 'coveralls'
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
+
+SimpleCov.start do
+  add_filter '/spec/'
+  minimum_coverage 84
+  minimum_coverage_by_file 26
+end
+
+# Ensure all /lib files are loaded
+# so they will be included in the test coverage report.
+Dir['./lib/**/*.rb'].sort.each { |file| require file }
+
+require 'faraday'
+require 'pry'
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
@@ -49,57 +69,64 @@ RSpec.configure do |config|
   # 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
+  # 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"
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # 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!
 
   # This setting enables warnings. It's recommended, but in some cases may
   # be too noisy due to issues in dependencies.
-  config.warnings = true
+  # 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
+  # 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
+  # config.profile_examples = 10
+
+  # 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
+
+  config.include Faraday::HelperMethods
+end
+
+# Extends RSpec DocumentationFormatter to hide skipped tests.
+module FormatterOverrides
+  def example_pending(_arg); end
+
+  def dump_pending(_arg); end
+
+  RSpec::Core::Formatters::DocumentationFormatter.prepend self
 end

data/spec/support/disabling_stub.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Allows to disable WebMock stubs
+module DisablingStub
+  def disable
+    @disabled = true
+  end
+
+  def disabled?
+    @disabled
+  end
+
+  WebMock::RequestStub.prepend self
+end

data/spec/support/fake_safe_buffer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# emulates ActiveSupport::SafeBuffer#gsub
+FakeSafeBuffer = Struct.new(:string) do
+  def to_s
+    self
+  end
+
+  def gsub(regex)
+    string.gsub(regex) do
+      match, = $&, '' =~ /a/
+      yield(match)
+    end
+  end
+end

data/spec/support/helper_methods.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'multipart_parser/reader'
+
+module Faraday
+  module HelperMethods
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def features(*features)
+        @features = features
+      end
+
+      def on_feature(name)
+        yield if block_given? && feature?(name)
+      end
+
+      def feature?(name)
+        if @features.nil?
+          superclass.feature?(name) if superclass.respond_to?(:feature?)
+        elsif @features.include?(name)
+          true
+        end
+      end
+
+      def method_with_body?(method)
+        METHODS_WITH_BODY.include?(method.to_s)
+      end
+    end
+
+    def ssl_mode?
+      ENV['SSL'] == 'yes'
+    end
+
+    def normalize(url)
+      Faraday::Utils::URI(url)
+    end
+
+    def with_default_uri_parser(parser)
+      old_parser = Faraday::Utils.default_uri_parser
+      begin
+        Faraday::Utils.default_uri_parser = parser
+        yield
+      ensure
+        Faraday::Utils.default_uri_parser = old_parser
+      end
+    end
+
+    def with_env(new_env)
+      old_env = {}
+
+      new_env.each do |key, value|
+        old_env[key] = ENV.fetch(key, false)
+        ENV[key] = value
+      end
+
+      begin
+        yield
+      ensure
+        old_env.each do |key, value|
+          value == false ? ENV.delete(key) : ENV[key] = value
+        end
+      end
+    end
+
+    def with_env_proxy_disabled
+      Faraday.ignore_env_proxy = true
+
+      begin
+        yield
+      ensure
+        Faraday.ignore_env_proxy = false
+      end
+    end
+
+    def capture_warnings
+      old = $stderr
+      $stderr = StringIO.new
+      begin
+        yield
+        $stderr.string
+      ensure
+        $stderr = old
+      end
+    end
+
+    def multipart_file
+      Faraday::FilePart.new(__FILE__, 'text/x-ruby')
+    end
+
+    # parse boundary out of a Content-Type header like:
+    #   Content-Type: multipart/form-data; boundary=gc0p4Jq0M2Yt08jU534c0p
+    def parse_multipart_boundary(ctype)
+      MultipartParser::Reader.extract_boundary_value(ctype)
+    end
+
+    # parse a multipart MIME message, returning a hash of any multipart errors
+    def parse_multipart(boundary, body)
+      reader = MultipartParser::Reader.new(boundary)
+      result = { errors: [], parts: [] }
+      def result.part(name)
+        hash = self[:parts].detect { |h| h[:part].name == name }
+        [hash[:part], hash[:body].join]
+      end
+
+      reader.on_part do |part|
+        result[:parts] << thispart = {
+          part: part,
+          body: []
+        }
+        part.on_data do |chunk|
+          thispart[:body] << chunk
+        end
+      end
+      reader.on_error do |msg|
+        result[:errors] << msg
+      end
+      reader.write(body)
+      result
+    end
+
+    def method_with_body?(method)
+      self.class.method_with_body?(method)
+    end
+
+    def big_string
+      kb = 1024
+      (32..126).map(&:chr).cycle.take(50 * kb).join
+    end
+  end
+end

data/spec/support/shared_examples/adapter.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+shared_examples 'an adapter' do |**options|
+  before { skip } if options[:skip]
+
+  context 'with SSL enabled' do
+    before { ENV['SSL'] = 'yes' }
+    include_examples 'adapter examples', options
+  end
+
+  context 'with SSL disabled' do
+    before { ENV['SSL'] = 'no' }
+    include_examples 'adapter examples', options
+  end
+end
+
+shared_examples 'adapter examples' do |**options|
+  include Faraday::StreamingResponseChecker
+
+  let(:adapter) { described_class.name.split('::').last }
+
+  let(:conn_options) { { headers: { 'X-Faraday-Adapter' => adapter } }.merge(options[:conn_options] || {}) }
+
+  let(:adapter_options) do
+    return [] unless options[:adapter_options]
+
+    if options[:adapter_options].is_a?(Array)
+      options[:adapter_options]
+    else
+      [options[:adapter_options]]
+    end
+  end
+
+  let(:protocol) { ssl_mode? ? 'https' : 'http' }
+  let(:remote) { "#{protocol}://example.com" }
+  let(:stub_remote) { remote }
+
+  let(:conn) do
+    conn_options[:ssl] ||= {}
+    conn_options[:ssl][:ca_file] ||= ENV['SSL_FILE']
+
+    Faraday.new(remote, conn_options) do |conn|
+      conn.request :multipart
+      conn.request :url_encoded
+      conn.response :raise_error
+      conn.adapter described_class, *adapter_options
+    end
+  end
+
+  let!(:request_stub) { stub_request(http_method, stub_remote) }
+
+  after do
+    expect(request_stub).to have_been_requested unless request_stub.disabled?
+  end
+
+  describe '#delete' do
+    let(:http_method) { :delete }
+
+    it_behaves_like 'a request method', :delete
+  end
+
+  describe '#get' do
+    let(:http_method) { :get }
+
+    it_behaves_like 'a request method', :get
+  end
+
+  describe '#head' do
+    let(:http_method) { :head }
+
+    it_behaves_like 'a request method', :head
+  end
+
+  describe '#options' do
+    let(:http_method) { :options }
+
+    it_behaves_like 'a request method', :options
+  end
+
+  describe '#patch' do
+    let(:http_method) { :patch }
+
+    it_behaves_like 'a request method', :patch
+  end
+
+  describe '#post' do
+    let(:http_method) { :post }
+
+    it_behaves_like 'a request method', :post
+  end
+
+  describe '#put' do
+    let(:http_method) { :put }
+
+    it_behaves_like 'a request method', :put
+  end
+
+  on_feature :trace_method do
+    describe '#trace' do
+      let(:http_method) { :trace }
+
+      it_behaves_like 'a request method', :trace
+    end
+  end
+end

data/spec/support/shared_examples/params_encoder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+shared_examples 'a params encoder' do
+  it 'escapes safe buffer' do
+    monies = FakeSafeBuffer.new('$32,000.00')
+    expect(subject.encode('a' => monies)).to eq('a=%2432%2C000.00')
+  end
+
+  it 'raises type error for empty string' do
+    expect { subject.encode('') }.to raise_error(TypeError) do |error|
+      expect(error.message).to eq("Can't convert String into Hash.")
+    end
+  end
+
+  it 'encodes nil' do
+    expect(subject.encode('a' => nil)).to eq('a')
+  end
+end

data/spec/support/shared_examples/request_method.rb

@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+shared_examples 'proxy examples' do
+  it 'handles requests with proxy' do
+    res = conn.public_send(http_method, '/')
+
+    expect(res.status).to eq(200)
+  end
+
+  it 'handles proxy failures' do
+    request_stub.to_return(status: 407)
+
+    expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::ProxyAuthError)
+  end
+end
+
+shared_examples 'a request method' do |http_method|
+  let(:query_or_body) { method_with_body?(http_method) ? :body : :query }
+  let(:response) { conn.public_send(http_method, '/') }
+
+  unless http_method == :head && feature?(:skip_response_body_on_head)
+    it 'retrieves the response body' do
+      res_body = 'test'
+      request_stub.to_return(body: res_body)
+      expect(conn.public_send(http_method, '/').body).to eq(res_body)
+    end
+  end
+
+  it 'handles headers with multiple values' do
+    request_stub.to_return(headers: { 'Set-Cookie' => 'name=value' })
+    expect(response.headers['set-cookie']).to eq('name=value')
+  end
+
+  it 'retrieves the response headers' do
+    request_stub.to_return(headers: { 'Content-Type' => 'text/plain' })
+    expect(response.headers['Content-Type']).to match(%r{text/plain})
+    expect(response.headers['content-type']).to match(%r{text/plain})
+  end
+
+  it 'sends user agent' do
+    request_stub.with(headers: { 'User-Agent' => 'Agent Faraday' })
+    conn.public_send(http_method, '/', nil, user_agent: 'Agent Faraday')
+  end
+
+  it 'represents empty body response as blank string' do
+    expect(response.body).to eq('')
+  end
+
+  it 'handles connection error' do
+    request_stub.disable
+    expect { conn.public_send(http_method, 'http://localhost:4') }.to raise_error(Faraday::ConnectionFailed)
+  end
+
+  on_feature :local_socket_binding do
+    it 'binds local socket' do
+      stub_request(http_method, 'http://example.com')
+
+      host = '1.2.3.4'
+      port = 1234
+      conn_options[:request] = { bind: { host: host, port: port } }
+
+      conn.public_send(http_method, '/')
+
+      expect(conn.options[:bind][:host]).to eq(host)
+      expect(conn.options[:bind][:port]).to eq(port)
+    end
+  end
+
+  # context 'when wrong ssl certificate is provided' do
+  #   let(:ca_file_path) { 'tmp/faraday-different-ca-cert.crt' }
+  #   before { conn_options.merge!(ssl: { ca_file: ca_file_path }) }
+  #
+  #   it do
+  #     expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::SSLError) # do |ex|
+  #       expect(ex.message).to include?('certificate')
+  #     end
+  #   end
+  # end
+
+  on_feature :request_body_on_query_methods do
+    it 'sends request body' do
+      request_stub.with(Hash[:body, 'test'])
+      res = if query_or_body == :body
+              conn.public_send(http_method, '/', 'test')
+            else
+              conn.public_send(http_method, '/') do |req|
+                req.body = 'test'
+              end
+            end
+      expect(res.env.request_body).to eq('test')
+    end
+  end
+
+  it 'sends url encoded parameters' do
+    payload = { name: 'zack' }
+    request_stub.with(Hash[query_or_body, payload])
+    res = conn.public_send(http_method, '/', payload)
+    if query_or_body == :query
+      expect(res.env.request_body).to be_nil
+    else
+      expect(res.env.request_body).to eq('name=zack')
+    end
+  end
+
+  it 'sends url encoded nested parameters' do
+    payload = { name: { first: 'zack' } }
+    request_stub.with(Hash[query_or_body, payload])
+    conn.public_send(http_method, '/', payload)
+  end
+
+  # TODO: This needs reimplementation: see https://github.com/lostisland/faraday/issues/718
+  # Should raise Faraday::TimeoutError
+  it 'supports timeout option' do
+    conn_options[:request] = { timeout: 1 }
+    request_stub.to_timeout
+    exc = adapter == 'NetHttp' ? Faraday::ConnectionFailed : Faraday::TimeoutError
+    expect { conn.public_send(http_method, '/') }.to raise_error(exc)
+  end
+
+  # TODO: This needs reimplementation: see https://github.com/lostisland/faraday/issues/718
+  # Should raise Faraday::ConnectionFailed
+  it 'supports open_timeout option' do
+    conn_options[:request] = { open_timeout: 1 }
+    request_stub.to_timeout
+    exc = adapter == 'NetHttp' ? Faraday::ConnectionFailed : Faraday::TimeoutError
+    expect { conn.public_send(http_method, '/') }.to raise_error(exc)
+  end
+
+  # Can't send files on get, head and delete methods
+  if method_with_body?(http_method)
+    it 'sends files' do
+      payload = { uploaded_file: multipart_file }
+      request_stub.with(headers: { 'Content-Type' => %r{\Amultipart/form-data} }) do |request|
+        # WebMock does not support matching body for multipart/form-data requests yet :(
+        # https://github.com/bblimke/webmock/issues/623
+        request.body.include?('RubyMultipartPost')
+      end
+      conn.public_send(http_method, '/', payload)
+    end
+  end
+
+  on_feature :reason_phrase_parse do
+    it 'parses the reason phrase' do
+      request_stub.to_return(status: [200, 'OK'])
+      expect(response.reason_phrase).to eq('OK')
+    end
+  end
+
+  on_feature :compression do
+    # Accept-Encoding header not sent for HEAD requests as body is not expected in the response.
+    unless http_method == :head
+      it 'handles gzip compression' do
+        request_stub.with(headers: { 'Accept-Encoding' => /\bgzip\b/ })
+        conn.public_send(http_method, '/')
+      end
+
+      it 'handles deflate compression' do
+        request_stub.with(headers: { 'Accept-Encoding' => /\bdeflate\b/ })
+        conn.public_send(http_method, '/')
+      end
+    end
+  end
+
+  on_feature :streaming do
+    describe 'streaming' do
+      let(:streamed) { [] }
+
+      context 'when response is empty' do
+        it do
+          conn.public_send(http_method, '/') do |req|
+            req.options.on_data = proc { |*args| streamed << args }
+          end
+
+          expect(streamed).to eq([['', 0]])
+        end
+      end
+
+      context 'when response contains big data' do
+        before { request_stub.to_return(body: big_string) }
+
+        it 'handles streaming' do
+          response = conn.public_send(http_method, '/') do |req|
+            req.options.on_data = proc { |*args| streamed << args }
+          end
+
+          expect(response.body).to eq('')
+          check_streaming_response(streamed, chunk_size: 16 * 1024)
+        end
+      end
+    end
+  end
+
+  on_feature :parallel do
+    context 'with parallel setup' do
+      before do
+        @resp1 = nil
+        @resp2 = nil
+        @payload1 = { a: '1' }
+        @payload2 = { b: '2' }
+
+        request_stub
+          .with(Hash[query_or_body, @payload1])
+          .to_return(body: @payload1.to_json)
+
+        stub_request(http_method, remote)
+          .with(Hash[query_or_body, @payload2])
+          .to_return(body: @payload2.to_json)
+
+        conn.in_parallel do
+          @resp1 = conn.public_send(http_method, '/', @payload1)
+          @resp2 = conn.public_send(http_method, '/', @payload2)
+
+          expect(conn.in_parallel?).to be_truthy
+          expect(@resp1.body).to be_nil
+          expect(@resp2.body).to be_nil
+        end
+
+        expect(conn.in_parallel?).to be_falsey
+      end
+
+      it 'handles parallel requests status' do
+        expect(@resp1&.status).to eq(200)
+        expect(@resp2&.status).to eq(200)
+      end
+
+      unless http_method == :head && feature?(:skip_response_body_on_head)
+        it 'handles parallel requests body' do
+          expect(@resp1&.body).to eq(@payload1.to_json)
+          expect(@resp2&.body).to eq(@payload2.to_json)
+        end
+      end
+    end
+  end
+
+  context 'when a proxy is provided as option' do
+    before do
+      conn_options[:proxy] = 'http://env-proxy.com:80'
+    end
+
+    include_examples 'proxy examples'
+  end
+
+  context 'when http_proxy env variable is set' do
+    let(:proxy_url) { 'http://env-proxy.com:80' }
+
+    around do |example|
+      with_env 'http_proxy' => proxy_url do
+        example.run
+      end
+    end
+
+    include_examples 'proxy examples'
+
+    context 'when the env proxy is ignored' do
+      around do |example|
+        with_env_proxy_disabled(&example)
+      end
+
+      include_examples 'proxy examples'
+    end
+  end
+end