faraday 1.10.4 → 2.13.1

data/spec/faraday/utils/headers_spec.rb

@@ -56,27 +56,54 @@ RSpec.describe Faraday::Utils::Headers do
     it { expect(subject.delete('content-type')).to be_nil }
   end
 
-  describe '#parse' do
-    before { subject.parse(headers) }
+  describe '#dig' do
+    before { subject['Content-Type'] = 'application/json' }
+
+    it { expect(subject&.dig('Content-Type')).to eq('application/json') }
+    it { expect(subject&.dig('CONTENT-TYPE')).to eq('application/json') }
+    it { expect(subject&.dig(:content_type)).to eq('application/json') }
+    it { expect(subject&.dig('invalid')).to be_nil }
+  end
 
+  describe '#parse' do
     context 'when response headers leave http status line out' do
       let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n" }
 
+      before { subject.parse(headers) }
+
       it { expect(subject.keys).to eq(%w[Content-Type]) }
       it { expect(subject['Content-Type']).to eq('text/html') }
       it { expect(subject['content-type']).to eq('text/html') }
     end
 
     context 'when response headers values include a colon' do
-      let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nLocation: http://sushi.com/\r\n\r\n" }
+      let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nLocation: http://httpbingo.org/\r\n\r\n" }
 
-      it { expect(subject['location']).to eq('http://sushi.com/') }
+      before { subject.parse(headers) }
+
+      it { expect(subject['location']).to eq('http://httpbingo.org/') }
     end
 
     context 'when response headers include a blank line' do
       let(:headers) { "HTTP/1.1 200 OK\r\n\r\nContent-Type: text/html\r\n\r\n" }
 
+      before { subject.parse(headers) }
+
       it { expect(subject['content-type']).to eq('text/html') }
     end
+
+    context 'when response headers include already stored keys' do
+      let(:headers) { "HTTP/1.1 200 OK\r\nX-Numbers: 123\r\n\r\n" }
+
+      before do
+        h = subject
+        h[:x_numbers] = 8
+        h.parse(headers)
+      end
+
+      it do
+        expect(subject[:x_numbers]).to eq('8, 123')
+      end
+    end
   end
 end

data/spec/faraday/utils_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Faraday::Utils do
   describe 'headers parsing' do
     let(:multi_response_headers) do
       "HTTP/1.x 500 OK\r\nContent-Type: text/html; charset=UTF-8\r\n" \
-      "HTTP/1.x 200 OK\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n"
+        "HTTP/1.x 200 OK\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n"
     end
 
     it 'parse headers for aggregated responses' do
@@ -53,4 +53,68 @@ RSpec.describe Faraday::Utils do
       expect(headers).not_to have_key('authorization')
     end
   end
+
+  describe '.deep_merge!' do
+    let(:connection_options) { Faraday::ConnectionOptions.new }
+    let(:url) do
+      {
+        url: 'http://example.com/abc',
+        headers: { 'Mime-Version' => '1.0' },
+        request: { oauth: { consumer_key: 'anonymous' } },
+        ssl: { version: '2' }
+      }
+    end
+
+    it 'recursively merges the headers' do
+      connection_options.headers = { user_agent: 'My Agent 1.0' }
+      deep_merge = Faraday::Utils.deep_merge!(connection_options, url)
+
+      expect(deep_merge.headers).to eq('Mime-Version' => '1.0', user_agent: 'My Agent 1.0')
+    end
+
+    context 'when a target hash has an Options Struct value' do
+      let(:request) do
+        {
+          params_encoder: nil,
+          proxy: nil,
+          bind: nil,
+          timeout: nil,
+          open_timeout: nil,
+          read_timeout: nil,
+          write_timeout: nil,
+          boundary: nil,
+          oauth: { consumer_key: 'anonymous' },
+          context: nil,
+          on_data: nil
+        }
+      end
+      let(:ssl) do
+        {
+          verify: nil,
+          ca_file: nil,
+          ca_path: nil,
+          verify_mode: nil,
+          cert_store: nil,
+          client_cert: nil,
+          client_key: nil,
+          certificate: nil,
+          private_key: nil,
+          verify_depth: nil,
+          version: '2',
+          min_version: nil,
+          max_version: nil,
+          verify_hostname: nil,
+          hostname: nil,
+          ciphers: nil
+        }
+      end
+
+      it 'does not overwrite an Options Struct value' do
+        deep_merge = Faraday::Utils.deep_merge!(connection_options, url)
+
+        expect(deep_merge.request.to_h).to eq(request)
+        expect(deep_merge.ssl.to_h).to eq(ssl)
+      end
+    end
+  end
 end

data/spec/faraday_spec.rb

@@ -18,10 +18,16 @@ RSpec.describe Faraday do
     end
 
     it 'uses method_missing on Faraday if there is no proxyable method' do
-      expect { Faraday.this_method_does_not_exist }.to raise_error(
-        NoMethodError,
-        "undefined method `this_method_does_not_exist' for Faraday:Module"
-      )
+      expected_message =
+        if RUBY_VERSION >= '3.4'
+          "undefined method 'this_method_does_not_exist' for module Faraday"
+        elsif RUBY_VERSION >= '3.3'
+          "undefined method `this_method_does_not_exist' for module Faraday"
+        else
+          "undefined method `this_method_does_not_exist' for Faraday:Module"
+        end
+
+      expect { Faraday.this_method_does_not_exist }.to raise_error(NoMethodError, expected_message)
     end
 
     it 'proxied methods can be accessed' do

data/spec/spec_helper.rb

@@ -29,16 +29,15 @@ SimpleCov.start do
   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 }
+# Ensure all /lib files are loaded
+# so they will be included in the test coverage report.
+Dir['./lib/**/*.rb'].each { |file| require file }
 
-Faraday::Deprecate.skip = false
+# Load all Rspec support files
+Dir['./spec/support/**/*.rb'].each { |file| require file }
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

data/spec/support/fake_safe_buffer.rb

@@ -8,7 +8,7 @@ FakeSafeBuffer = Struct.new(:string) do
 
   def gsub(regex)
     string.gsub(regex) do
-      match, = $&, '' =~ /a/
+      match, = Regexp.last_match(0), '' =~ /a/ # rubocop:disable Performance/StringInclude
       yield(match)
     end
   end

data/spec/support/faraday_middleware_subclasses.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FaradayMiddlewareSubclasses
+  class SubclassNoOptions < Faraday::Middleware
+  end
+
+  class SubclassOneOption < Faraday::Middleware
+    DEFAULT_OPTIONS = { some_other_option: false }.freeze
+  end
+
+  class SubclassTwoOptions < Faraday::Middleware
+    DEFAULT_OPTIONS = { some_option: true, some_other_option: false }.freeze
+  end
+end
+
+Faraday::Response.register_middleware(no_options: FaradayMiddlewareSubclasses::SubclassNoOptions)
+Faraday::Response.register_middleware(one_option: FaradayMiddlewareSubclasses::SubclassOneOption)
+Faraday::Response.register_middleware(two_options: FaradayMiddlewareSubclasses::SubclassTwoOptions)

data/spec/support/helper_methods.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'multipart_parser/reader'
-
 module Faraday
   module HelperMethods
     def self.included(base)
@@ -86,41 +84,6 @@ module Faraday
       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

data/spec/support/shared_examples/adapter.rb

@@ -37,10 +37,10 @@ shared_examples 'adapter examples' do |**options|
 
   let(:conn) do
     conn_options[:ssl] ||= {}
-    conn_options[:ssl][:ca_file] ||= ENV['SSL_FILE']
+    conn_options[:ssl][:ca_file] ||= ENV.fetch('SSL_FILE', nil)
+    conn_options[:ssl][:verify_hostname] ||= ENV['SSL_VERIFY_HOSTNAME'] == 'yes'
 
     Faraday.new(remote, conn_options) do |conn|
-      conn.request :multipart
       conn.request :url_encoded
       conn.response :raise_error
       conn.adapter described_class, *adapter_options

data/spec/support/shared_examples/request_method.rb

@@ -79,7 +79,7 @@ shared_examples 'a request method' do |http_method|
 
   on_feature :request_body_on_query_methods do
     it 'sends request body' do
-      request_stub.with(Hash[:body, 'test'])
+      request_stub.with({ body: 'test' })
       res = if query_or_body == :body
               conn.public_send(http_method, '/', 'test')
             else
@@ -93,7 +93,7 @@ shared_examples 'a request method' do |http_method|
 
   it 'sends url encoded parameters' do
     payload = { name: 'zack' }
-    request_stub.with(Hash[query_or_body, payload])
+    request_stub.with({ query_or_body => payload })
     res = conn.public_send(http_method, '/', payload)
     if query_or_body == :query
       expect(res.env.request_body).to be_nil
@@ -104,7 +104,7 @@ shared_examples 'a request method' do |http_method|
 
   it 'sends url encoded nested parameters' do
     payload = { name: { first: 'zack' } }
-    request_stub.with(Hash[query_or_body, payload])
+    request_stub.with({ query_or_body => payload })
     conn.public_send(http_method, '/', payload)
   end
 
@@ -126,19 +126,6 @@ shared_examples 'a request method' do |http_method|
     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'])
@@ -166,12 +153,19 @@ shared_examples 'a request method' do |http_method|
       let(:streamed) { [] }
 
       context 'when response is empty' do
-        it do
+        it 'handles streaming' do
+          env = nil
           conn.public_send(http_method, '/') do |req|
-            req.options.on_data = proc { |*args| streamed << args }
+            req.options.on_data = proc do |chunk, size, block_env|
+              streamed << [chunk, size]
+              env ||= block_env
+            end
           end
 
           expect(streamed).to eq([['', 0]])
+          # TODO: enable this after updating all existing adapters to the new streaming API
+          # expect(env).to be_a(Faraday::Env)
+          # expect(env.status).to eq(200)
         end
       end
 
@@ -179,12 +173,19 @@ shared_examples 'a request method' do |http_method|
         before { request_stub.to_return(body: big_string) }
 
         it 'handles streaming' do
+          env = nil
           response = conn.public_send(http_method, '/') do |req|
-            req.options.on_data = proc { |*args| streamed << args }
+            req.options.on_data = proc do |chunk, size, block_env|
+              streamed << [chunk, size]
+              env ||= block_env
+            end
           end
 
           expect(response.body).to eq('')
           check_streaming_response(streamed, chunk_size: 16 * 1024)
+          # TODO: enable this after updating all existing adapters to the new streaming API
+          # expect(env).to be_a(Faraday::Env)
+          # expect(env.status).to eq(200)
         end
       end
     end
@@ -199,11 +200,11 @@ shared_examples 'a request method' do |http_method|
         @payload2 = { b: '2' }
 
         request_stub
-          .with(Hash[query_or_body, @payload1])
+          .with({ query_or_body => @payload1 })
           .to_return(body: @payload1.to_json)
 
         stub_request(http_method, remote)
-          .with(Hash[query_or_body, @payload2])
+          .with({ query_or_body => @payload2 })
           .to_return(body: @payload2.to_json)
 
         conn.in_parallel do

metadata

@@ -1,172 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 1.10.4
+  version: 2.13.1
 platform: ruby
 authors:
 - "@technoweenie"
 - "@iMacTia"
 - "@olleolleolle"
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday-em_http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-em_synchrony
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-excon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: faraday-httpclient
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-multipart
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday-net_http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-net_http_persistent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-patron
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: faraday-retry
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby2_keywords
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
-description: 
+        version: '0'
 email: technoweenie@gmail.com
 executables: []
 extensions: []
@@ -181,12 +73,8 @@ files:
 - lib/faraday.rb
 - lib/faraday/adapter.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/dependency_loader.rb
-- lib/faraday/deprecate.rb
 - lib/faraday/encoders/flat_params_encoder.rb
 - lib/faraday/encoders/nested_params_encoder.rb
 - lib/faraday/error.rb
@@ -204,10 +92,8 @@ files:
 - lib/faraday/rack_builder.rb
 - lib/faraday/request.rb
 - lib/faraday/request/authorization.rb
-- lib/faraday/request/basic_authentication.rb
 - lib/faraday/request/instrumentation.rb
 - lib/faraday/request/json.rb
-- lib/faraday/request/token_authentication.rb
 - lib/faraday/request/url_encoded.rb
 - lib/faraday/response.rb
 - lib/faraday/response/json.rb
@@ -218,21 +104,12 @@ files:
 - lib/faraday/utils/params_hash.rb
 - lib/faraday/version.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_spec.rb
-- spec/faraday/adapter/patron_spec.rb
-- spec/faraday/adapter/rack_spec.rb
 - spec/faraday/adapter/test_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/deprecate_spec.rb
 - spec/faraday/error_spec.rb
+- spec/faraday/middleware_registry_spec.rb
 - spec/faraday/middleware_spec.rb
 - spec/faraday/options/env_spec.rb
 - spec/faraday/options/options_spec.rb
@@ -248,7 +125,6 @@ files:
 - spec/faraday/request_spec.rb
 - spec/faraday/response/json_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
@@ -257,21 +133,21 @@ files:
 - spec/spec_helper.rb
 - spec/support/disabling_stub.rb
 - spec/support/fake_safe_buffer.rb
+- spec/support/faraday_middleware_subclasses.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/releases/tag/v1.10.4
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.13.1
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
-post_install_message: 
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -280,15 +156,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: HTTP/REST API client library.
 test_files: []

data/lib/faraday/adapter/typhoeus.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  class Adapter
-    # Typhoeus adapter. This class is just a stub, the real adapter is in
-    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/adapters/faraday.rb
-    class Typhoeus < Faraday::Adapter
-      # Needs to define this method in order to support Typhoeus <= 1.3.0
-      def call; end
-
-      dependency 'typhoeus'
-      dependency 'typhoeus/adapters/faraday'
-    end
-  end
-end