faraday 0.17.3 → 1.0.0

data/spec/support/shared_examples/adapter.rb

@@ -0,0 +1,104 @@
+# 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(: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, 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,234 @@
+# frozen_string_literal: true
+
+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' => 'one, two' })
+    expect(response.headers['set-cookie']).to eq('one, two')
+  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 =~ /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
+
+  it 'handles requests with proxy' do
+    conn_options[:proxy] = 'http://google.co.uk'
+
+    res = conn.public_send(http_method, '/')
+    expect(res.status).to eq(200)
+  end
+
+  it 'handles proxy failures' do
+    conn_options[:proxy] = 'http://google.co.uk'
+    request_stub.to_return(status: 407)
+
+    expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::ProxyAuthError)
+  end
+end

data/spec/support/streaming_response_checker.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Faraday
+  module StreamingResponseChecker
+    def check_streaming_response(streamed, options = {})
+      opts = {
+        prefix: '',
+        streaming?: true
+      }.merge(options)
+
+      expected_response = opts[:prefix] + big_string
+
+      chunks, sizes = streamed.transpose
+
+      # Check that the total size of the chunks (via the last size returned)
+      # is the same size as the expected_response
+      expect(sizes.last).to eq(expected_response.bytesize)
+
+      start_index = 0
+      expected_chunks = []
+      chunks.each do |actual_chunk|
+        expected_chunk = expected_response[start_index..((start_index + actual_chunk.bytesize) - 1)]
+        expected_chunks << expected_chunk
+        start_index += expected_chunk.bytesize
+      end
+
+      # it's easier to read a smaller portion, so we check that first
+      expect(expected_chunks[0][0..255]).to eq(chunks[0][0..255])
+
+      [expected_chunks, chunks].transpose.each do |expected, actual|
+        expect(actual).to eq(expected)
+      end
+    end
+  end
+end

data/spec/support/webmock_rack_app.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Rack app used to test the Rack adapter.
+# Uses Webmock to check if requests are registered, in which case it returns
+# the registered response.
+class WebmockRackApp
+  def call(env)
+    req_signature = WebMock::RequestSignature.new(
+      req_method(env),
+      req_uri(env),
+      body: req_body(env),
+      headers: req_headers(env)
+    )
+
+    WebMock::RequestRegistry
+      .instance
+      .requested_signatures
+      .put(req_signature)
+
+    process_response(req_signature)
+  end
+
+  def req_method(env)
+    env['REQUEST_METHOD'].downcase.to_sym
+  end
+
+  def req_uri(env)
+    scheme = env['rack.url_scheme']
+    host = env['SERVER_NAME']
+    port = env['SERVER_PORT']
+    path = env['PATH_INFO']
+    query = env['QUERY_STRING']
+
+    url = +"#{scheme}://#{host}:#{port}#{path}"
+    url += "?#{query}" if query
+
+    uri = WebMock::Util::URI.heuristic_parse(url)
+    uri.path = uri.normalized_path.gsub('[^:]//', '/')
+    uri
+  end
+
+  def req_headers(env)
+    http_headers = env.select { |k, _| k.start_with?('HTTP_') }
+                      .map { |k, v| [k[5..-1], v] }
+                      .to_h
+
+    special_headers = Faraday::Adapter::Rack::SPECIAL_HEADERS
+    http_headers.merge(env.select { |k, _| special_headers.include?(k) })
+  end
+
+  def req_body(env)
+    env['rack.input'].read
+  end
+
+  def process_response(req_signature)
+    res = WebMock::StubRegistry.instance.response_for_request(req_signature)
+
+    if res.nil? && req_signature.uri.host == 'localhost'
+      raise Faraday::ConnectionFailed, 'Trying to connect to localhost'
+    end
+
+    raise WebMock::NetConnectNotAllowedError, req_signature unless res
+
+    raise Faraday::TimeoutError if res.should_timeout
+
+    [res.status[0], res.headers || {}, [res.body || '']]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 0.17.3
+  version: 1.0.0
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2020-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -42,6 +42,9 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- UPGRADING.md
+- examples/client_spec.rb
+- examples/client_test.rb
 - lib/faraday.rb
 - lib/faraday/adapter.rb
 - lib/faraday/adapter/em_http.rb
@@ -56,12 +59,24 @@ files:
 - lib/faraday/adapter/rack.rb
 - lib/faraday/adapter/test.rb
 - lib/faraday/adapter/typhoeus.rb
+- lib/faraday/adapter_registry.rb
 - lib/faraday/autoload.rb
 - lib/faraday/connection.rb
-- lib/faraday/deprecate.rb
+- lib/faraday/dependency_loader.rb
+- lib/faraday/encoders/flat_params_encoder.rb
+- lib/faraday/encoders/nested_params_encoder.rb
 - lib/faraday/error.rb
+- lib/faraday/file_part.rb
+- lib/faraday/logging/formatter.rb
 - lib/faraday/middleware.rb
+- lib/faraday/middleware_registry.rb
 - lib/faraday/options.rb
+- lib/faraday/options/connection_options.rb
+- lib/faraday/options/env.rb
+- lib/faraday/options/proxy_options.rb
+- lib/faraday/options/request_options.rb
+- lib/faraday/options/ssl_options.rb
+- lib/faraday/param_part.rb
 - lib/faraday/parameters.rb
 - lib/faraday/rack_builder.rb
 - lib/faraday/request.rb
@@ -75,48 +90,61 @@ files:
 - lib/faraday/response.rb
 - lib/faraday/response/logger.rb
 - lib/faraday/response/raise_error.rb
-- lib/faraday/upload_io.rb
 - lib/faraday/utils.rb
-- spec/faraday/deprecate_spec.rb
+- lib/faraday/utils/headers.rb
+- lib/faraday/utils/params_hash.rb
+- spec/external_adapters/faraday_specs_setup.rb
+- spec/faraday/adapter/em_http_spec.rb
+- spec/faraday/adapter/em_synchrony_spec.rb
+- spec/faraday/adapter/excon_spec.rb
+- spec/faraday/adapter/httpclient_spec.rb
+- spec/faraday/adapter/net_http_persistent_spec.rb
+- spec/faraday/adapter/net_http_spec.rb
+- spec/faraday/adapter/patron_spec.rb
+- spec/faraday/adapter/rack_spec.rb
+- spec/faraday/adapter/typhoeus_spec.rb
+- spec/faraday/adapter_registry_spec.rb
+- spec/faraday/adapter_spec.rb
+- spec/faraday/composite_read_io_spec.rb
+- spec/faraday/connection_spec.rb
 - spec/faraday/error_spec.rb
+- spec/faraday/middleware_spec.rb
+- spec/faraday/options/env_spec.rb
+- spec/faraday/options/options_spec.rb
+- spec/faraday/options/proxy_options_spec.rb
+- spec/faraday/options/request_options_spec.rb
+- spec/faraday/params_encoders/flat_spec.rb
+- spec/faraday/params_encoders/nested_spec.rb
+- spec/faraday/rack_builder_spec.rb
+- spec/faraday/request/authorization_spec.rb
+- spec/faraday/request/instrumentation_spec.rb
+- spec/faraday/request/multipart_spec.rb
+- spec/faraday/request/retry_spec.rb
+- spec/faraday/request/url_encoded_spec.rb
+- spec/faraday/request_spec.rb
+- spec/faraday/response/logger_spec.rb
+- spec/faraday/response/middleware_spec.rb
 - spec/faraday/response/raise_error_spec.rb
+- spec/faraday/response_spec.rb
+- spec/faraday/utils/headers_spec.rb
+- spec/faraday/utils_spec.rb
+- spec/faraday_spec.rb
 - spec/spec_helper.rb
-- test/adapters/default_test.rb
-- test/adapters/em_http_test.rb
-- test/adapters/em_synchrony_test.rb
-- test/adapters/excon_test.rb
-- test/adapters/httpclient_test.rb
-- test/adapters/integration.rb
-- test/adapters/logger_test.rb
-- test/adapters/net_http_persistent_test.rb
-- test/adapters/net_http_test.rb
-- test/adapters/patron_test.rb
-- test/adapters/rack_test.rb
-- test/adapters/test_middleware_test.rb
-- test/adapters/typhoeus_test.rb
-- test/authentication_middleware_test.rb
-- test/composite_read_io_test.rb
-- test/connection_test.rb
-- test/env_test.rb
-- test/helper.rb
-- test/live_server.rb
-- test/middleware/instrumentation_test.rb
-- test/middleware/retry_test.rb
-- test/middleware_stack_test.rb
-- test/multibyte.txt
-- test/options_test.rb
-- test/parameters_test.rb
-- test/request_middleware_test.rb
-- test/response_middleware_test.rb
-- test/strawberry.rb
-- test/utils_test.rb
+- spec/support/disabling_stub.rb
+- spec/support/fake_safe_buffer.rb
+- spec/support/helper_methods.rb
+- spec/support/shared_examples/adapter.rb
+- spec/support/shared_examples/params_encoder.rb
+- spec/support/shared_examples/request_method.rb
+- spec/support/streaming_response_checker.rb
+- spec/support/webmock_rack_app.rb
 homepage: https://lostisland.github.io/faraday
 licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/lostisland/faraday/
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.0.0
+  source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: 
 rdoc_options: []
@@ -126,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="