faraday 2.14.3 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecc5e9592d7434d7e39bc5cc827be5b62af99e258582468c8b6fd78e0122bf7e
-  data.tar.gz: 4f5728ac524a3456a800c8d0159b4569173b1c841f80fae7d0d2704e261b6588
+  metadata.gz: 1c06dbc8aa2e38f23986579d5521da86fb335aaf0f5aa83db6fefb530e645b9f
+  data.tar.gz: 84db1e0a961b108e53db54277bc22f533a19f1abf3475384e09a396bf98969d1
 SHA512:
-  metadata.gz: 12567175cd7d08a95ccf8203bffcb9bebf8d1b52f279ce034c3f3e17dc5efc81e08259c2992ff792560ed626dd59ae305c163cb43018860b3c0ae833c3f68855
-  data.tar.gz: bb786c688b4629c6bc43e4715715fcd42de120eee3802a3614eca60e17627ff77f40298af500a431158b1f1de8bd0d0bd58817a8793bab92e11bac9aa9b482f2
+  metadata.gz: dd4be1a725b5f287c0812ec1caa909c5338e938b697581d1bf585460fa47332d4dc840581edd726ff73fe2f4380fe65c45ba05fc92c98816954fe9ac356e0b23
+  data.tar.gz: a508f88684b8f60c9655ebec4acfc9e7cebe25982e708fc98be02d46357304c73ef408de7bba4e2c52b12229c76168c51d3cb9cc1e5728901d580bd6e986dca0

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2023 Rick Olson, Zack Hobson
+Copyright (c) 2009-2026 Rick Olson, Zack Hobson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -58,7 +58,7 @@ But before you start coding, please read our [Contributing Guide][contributing]
 
 ## Copyright
 
-© 2009 - 2023, the Faraday Team. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
+© 2009 - 2026, the Faraday Team. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
 
 [awesome]: https://github.com/lostisland/awesome-faraday/#adapters
 [website]: https://lostisland.github.io/faraday

data/lib/faraday/connection.rb

@@ -210,7 +210,7 @@ module Faraday
     #
     # @overload options(url, params = nil, headers = nil)
     #   Makes an OPTIONS HTTP request to the given URL.
-    #   @param url [String, URI, nil] String base URL to sue as a prefix for all requests.
+    #   @param url [String, URI, nil] String base URL to use as a prefix for all requests.
     #   @param params [Hash, nil] Hash of URI query unencoded key/value pairs.
     #   @param headers [Hash, nil] unencoded HTTP header key/value pairs.
     #
@@ -315,13 +315,13 @@ module Faraday
     # @yield a block to execute multiple requests.
     # @return [void]
     def in_parallel(manager = nil, &block)
-      @parallel_manager = manager || default_parallel_manager do
-        warn 'Warning: `in_parallel` called but no parallel-capable adapter ' \
-             'on Faraday stack'
-        warn caller[2, 10].join("\n")
+      previous_manager = @parallel_manager
+      @parallel_manager = manager || previous_manager || default_parallel_manager do
+        warn('Warning: `in_parallel` called but no parallel-capable adapter ' \
+             'on Faraday stack', caller[2, 10].join("\n"))
         nil
       end
-      return yield unless @parallel_manager
+      return yield unless @parallel_manager && !@parallel_manager.equal?(previous_manager)
 
       if @parallel_manager.respond_to?(:execute)
         # Execute is the new method that is responsible for executing the block.
@@ -332,7 +332,7 @@ module Faraday
         @parallel_manager.run
       end
     ensure
-      @parallel_manager = nil
+      @parallel_manager = previous_manager
     end
 
     # Sets the Hash proxy options.
@@ -505,7 +505,7 @@ module Faraday
                      params: params.dup,
                      builder: builder.dup,
                      ssl: ssl.dup,
-                     request: options.dup)
+                     request: options.dup).tap { |copy| copy.proxy = proxy if @manual_proxy }
     end
 
     # Yields username and password extracted from a URI if they both exist.
@@ -519,7 +519,7 @@ module Faraday
     def with_uri_credentials(uri)
       return unless uri.user && uri.password
 
-      yield(Utils.unescape(uri.user), Utils.unescape(uri.password))
+      yield(URI::DEFAULT_PARSER.unescape(uri.user), URI::DEFAULT_PARSER.unescape(uri.password))
     end
 
     def proxy_from_env(url)
@@ -532,7 +532,7 @@ module Faraday
         uri = if uri.host.nil?
                 find_default_proxy
               else
-                URI.parse("#{uri.scheme}://#{uri.host}").find_proxy
+                URI.parse(uri.to_s).find_proxy
               end
       when URI
         uri = url.find_proxy

data/lib/faraday/options/connection_options.rb

@@ -4,6 +4,33 @@ module Faraday
   # @!parse
   #   # ConnectionOptions contains the configurable properties for a Faraday
   #   # connection object.
+  #   #
+  #   # @!attribute request
+  #   #   @return [RequestOptions] default request options for the connection
+  #   #
+  #   # @!attribute proxy
+  #   #   @return [ProxyOptions] proxy options for the connection
+  #   #
+  #   # @!attribute ssl
+  #   #   @return [SSLOptions] SSL options for the connection
+  #   #
+  #   # @!attribute builder
+  #   #   @return [RackBuilder] the middleware stack builder for the connection
+  #   #
+  #   # @!attribute url
+  #   #   @return [String, URI] the base URL for the connection
+  #   #
+  #   # @!attribute parallel_manager
+  #   #   @return [Object] manager used when the connection runs in parallel mode
+  #   #
+  #   # @!attribute params
+  #   #   @return [Hash] default query parameters for the connection
+  #   #
+  #   # @!attribute headers
+  #   #   @return [Hash] default headers for the connection
+  #   #
+  #   # @!attribute builder_class
+  #   #   @return [Class] the class used to build the middleware stack
   #   class ConnectionOptions < Options; end
   ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                   :parallel_manager, :params, :headers,

data/lib/faraday/options/proxy_options.rb

@@ -4,6 +4,15 @@ module Faraday
   # @!parse
   #   # ProxyOptions contains the configurable properties for the proxy
   #   # configuration used when making an HTTP request.
+  #   #
+  #   # @!attribute uri
+  #   #   @return [URI] the proxy server URI
+  #   #
+  #   # @!attribute user
+  #   #   @return [String] the proxy server username
+  #   #
+  #   # @!attribute password
+  #   #   @return [String] the proxy server password
   #   class ProxyOptions < Options; end
   ProxyOptions = Options.new(:uri, :user, :password) do
     extend Forwardable
@@ -33,7 +42,7 @@ module Faraday
       super
     end
 
-    memoized(:user) { uri&.user && Utils.unescape(uri.user) }
-    memoized(:password) { uri&.password && Utils.unescape(uri.password) }
+    memoized(:user) { uri&.user && URI::DEFAULT_PARSER.unescape(uri.user) }
+    memoized(:password) { uri&.password && URI::DEFAULT_PARSER.unescape(uri.password) }
   end
 end

data/lib/faraday/options/request_options.rb

@@ -3,6 +3,41 @@
 module Faraday
   # @!parse
   #   # RequestOptions contains the configurable properties for a Faraday request.
+  #   #
+  #   # @!attribute params_encoder
+  #   #   @return [Object] the params encoder used to serialize the request params
+  #   #
+  #   # @!attribute proxy
+  #   #   @return [ProxyOptions] proxy options for this request
+  #   #
+  #   # @!attribute bind
+  #   #   @return [Hash] the local host and port to bind the connection to
+  #   #
+  #   # @!attribute timeout
+  #   #   @return [Integer] time limit for the entire request (in seconds)
+  #   #
+  #   # @!attribute open_timeout
+  #   #   @return [Integer] time limit for just the connection phase (in seconds)
+  #   #
+  #   # @!attribute read_timeout
+  #   #   @return [Integer] time limit for the first response byte received from
+  #   #           the server (in seconds)
+  #   #
+  #   # @!attribute write_timeout
+  #   #   @return [Integer] time limit for the client to send the request to the
+  #   #           server (in seconds)
+  #   #
+  #   # @!attribute boundary
+  #   #   @return [String] the boundary used for multipart request bodies
+  #   #
+  #   # @!attribute oauth
+  #   #   @return [Hash] OAuth options used by the OAuth middleware
+  #   #
+  #   # @!attribute context
+  #   #   @return [Hash] free-form storage carried alongside the request
+  #   #
+  #   # @!attribute on_data
+  #   #   @return [Proc] callback invoked with each chunk when streaming the response
   #   class RequestOptions < Options; end
   RequestOptions = Options.new(:params_encoder, :proxy, :bind,
                                :timeout, :open_timeout, :read_timeout,

data/lib/faraday/options.rb

@@ -74,7 +74,7 @@ module Faraday
 
     # Public
     def fetch(key, *args)
-      unless symbolized_key_set.include?(key.to_sym)
+      unless members.include?(key.to_sym) && !send(key).nil?
         key_setter = "#{key}="
         if !args.empty?
           send(key_setter, args.first)
@@ -193,7 +193,7 @@ module Faraday
     end
 
     def symbolized_key_set
-      @symbolized_key_set ||= Set.new(keys.map(&:to_sym))
+      Set.new(keys.map(&:to_sym))
     end
 
     def self.inherited(subclass)

data/lib/faraday/rack_builder.rb

@@ -115,6 +115,7 @@ module Faraday
     def adapter(klass = NO_ARGUMENT, *args, **kwargs, &block)
       return @adapter if klass == NO_ARGUMENT || klass.nil?
 
+      raise_if_locked
       klass = Faraday::Adapter.lookup_middleware(klass) if klass.is_a?(Symbol)
       @adapter = self.class::Handler.new(klass, *args, **kwargs, &block)
     end
@@ -230,10 +231,6 @@ module Faraday
       raise MISSING_ADAPTER_ERROR unless @adapter
     end
 
-    def adapter_set?
-      !@adapter.nil?
-    end
-
     def use_symbol(mod, key, ...)
       use(mod.lookup_middleware(key), ...)
     end

data/lib/faraday/response/json.rb

@@ -8,7 +8,7 @@ module Faraday
     class Json < Middleware
       def initialize(app = nil, parser_options: nil, content_type: /\bjson$/, preserve_raw: false)
         super(app)
-        @parser_options = parser_options
+        @parser_options = parser_options&.dup
         @content_types = Array(content_type)
         @preserve_raw = preserve_raw
 
@@ -33,7 +33,7 @@ module Faraday
 
         decoder, method_name = @decoder_options
 
-        decoder.public_send(method_name, body, @parser_options || {})
+        decoder.public_send(method_name, body, **(@parser_options || {}))
       end
 
       def parse_response?(env)

data/lib/faraday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faraday
-  VERSION = '2.14.3'
+  VERSION = '2.15.0'
 end

data/lib/faraday.rb

@@ -137,6 +137,38 @@ module Faraday
       @default_connection_options = ConnectionOptions.from(options)
     end
 
+    # HTTP verb methods, forwarded to {.default_connection}.
+    #
+    # They take the same arguments as their {Faraday::Connection} counterparts,
+    # see {Faraday::Connection#get} and {Faraday::Connection#post}.
+    # Defining them here rather than relying on {method_missing} keeps them
+    # visible to `Faraday.methods`, `pry`'s `ls`, documentation tools and
+    # editor autocomplete.
+
+    # @!visibility private
+    METHODS_WITH_QUERY.each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        # def get(url = nil, params = nil, headers = nil, &block)
+        #   default_connection.get(url, params, headers, &block)
+        # end
+        def #{method}(url = nil, params = nil, headers = nil, &block)
+          default_connection.#{method}(url, params, headers, &block)
+        end
+      RUBY
+    end
+
+    # @!visibility private
+    METHODS_WITH_BODY.each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        # def post(url = nil, body = nil, headers = nil, &block)
+        #   default_connection.post(url, body, headers, &block)
+        # end
+        def #{method}(url = nil, body = nil, headers = nil, &block)
+          default_connection.#{method}(url, body, headers, &block)
+        end
+      RUBY
+    end
+
     private
 
     # Internal: Proxies method calls on the Faraday constant to

data/spec/faraday/connection_spec.rb

@@ -119,6 +119,15 @@ RSpec.describe Faraday::Connection do
       it { expect(subject.headers['Authorization']).to eq('Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==') }
     end
 
+    context 'with basic_auth in url containing literal plus signs' do
+      let(:url) { 'http://Ala+ddin:open+sesame%2B@httpbingo.org/fish' }
+
+      it 'does not decode plus signs as spaces' do
+        expected = Faraday::Utils.basic_header_from('Ala+ddin', 'open+sesame+')
+        expect(subject.headers['Authorization']).to eq(expected)
+      end
+    end
+
     context 'with custom headers' do
       let(:options) { { headers: { user_agent: 'Faraday' } } }
 
@@ -693,6 +702,34 @@ RSpec.describe Faraday::Connection do
       it { expect(subject.options[:timeout]).to eq(5) }
       it { expect(conn.options[:open_timeout]).to be_nil }
     end
+
+    context 'with a manually set proxy' do
+      it 'preserves the proxy over env http_proxy' do
+        with_env 'http_proxy' => 'http://env-proxy.com' do
+          conn.proxy = 'http://manual-proxy.com'
+
+          expect(subject.proxy.host).to eq('manual-proxy.com')
+          expect(subject.proxy_for_request(url).host).to eq('manual-proxy.com')
+        end
+      end
+
+      it 'preserves an explicitly disabled proxy' do
+        with_env 'http_proxy' => 'http://env-proxy.com' do
+          conn.proxy = nil
+
+          expect(subject.proxy).to be_nil
+          expect(subject.proxy_for_request(url)).to be_nil
+        end
+      end
+    end
+
+    context 'without a manually set proxy' do
+      it 'uses env http_proxy' do
+        with_env 'http_proxy' => 'http://env-proxy.com' do
+          expect(subject.proxy_for_request(url).host).to eq('env-proxy.com')
+        end
+      end
+    end
   end
 
   describe '#respond_to?' do

data/spec/faraday/options/options_spec.rb

@@ -277,6 +277,40 @@ RSpec.describe Faraday::Options do
         it 'needs a default if key is missing' do
           expect { subject.fetch(:sub_a) }.to raise_error(Faraday::Options.fetch_error_class)
         end
+
+        it 'keeps the installed default on repeated fetches' do
+          expect(subject.fetch(:sub_a, 1)).to eq(1)
+          expect(subject.fetch(:sub_a, 2)).to eq(1)
+        end
+
+        it 'reads the current value after a default is replaced' do
+          subject.fetch(:sub_a, 1)
+          subject.sub_a = 3
+
+          expect(subject.fetch(:sub_a, 2)).to eq(3)
+        end
+
+        it 'installs a new default after deletion or clearing' do
+          subject.fetch(:sub_a, 1)
+          subject.delete(:sub_a)
+          expect(subject.fetch(:sub_a, 2)).to eq(2)
+
+          subject.clear
+          expect(subject.fetch(:sub_a, 3)).to eq(3)
+        end
+
+        it 'preserves a false value on later fetches' do
+          subject.fetch(:sub_a, false)
+
+          expect(subject.fetch(:sub_a, true) { :unused }).to be(false)
+        end
+
+        it 'uses string keys and evaluates a block only for an empty value' do
+          expect(subject.fetch('sub_a') { |key| "#{key} default" }).to eq('sub_a default')
+          subject.sub_a = 'changed'
+
+          expect(subject.fetch('sub_a') { |key| raise "unexpected default for #{key}" }).to eq('changed')
+        end
       end
 
       context 'when the fetched key has a value' do

data/spec/faraday/options/proxy_options_spec.rb

@@ -76,4 +76,10 @@ RSpec.describe Faraday::ProxyOptions do
     expect(proxy.password).to eq('pw d')
     expect(proxy[:password]).to eq('pw d')
   end
+
+  it 'preserves literal plus signs in userinfo' do
+    proxy = Faraday::ProxyOptions.from 'http://a+b:pw+d%2B@example.org'
+    expect(proxy.user).to eq('a+b')
+    expect(proxy.password).to eq('pw+d+')
+  end
 end

data/spec/faraday/rack_builder_spec.rb

@@ -67,6 +67,12 @@ RSpec.describe Faraday::RackBuilder do
       expect { subject.use(Orange) }.to raise_error(Faraday::RackBuilder::StackLocked)
     end
 
+    it 'rejects adapter changes after locking the stack' do
+      conn.get('/')
+      expect { subject.adapter(:net_http) }.to raise_error(Faraday::RackBuilder::StackLocked)
+      expect(subject.adapter).to eq(Faraday::Adapter.lookup_middleware(:test))
+    end
+
     it 'dup stack is unlocked' do
       expect(subject.locked?).to be_falsey
       subject.lock!

data/spec/faraday_spec.rb

@@ -40,4 +40,30 @@ RSpec.describe Faraday do
       Faraday.default_connection = nil
     end
   end
+
+  context 'HTTP verb methods' do
+    let(:mock_connection) { double('Connection') }
+
+    before do
+      Faraday.default_connection = mock_connection
+    end
+
+    (Faraday::METHODS_WITH_QUERY + Faraday::METHODS_WITH_BODY).each do |http_method|
+      it "defines .#{http_method} and forwards it to the default_connection" do
+        expect(Faraday.singleton_class.instance_methods(false)).to include(http_method.to_sym)
+
+        block = proc { |request| request }
+        expect(mock_connection).to receive(http_method) do |*args, &blk|
+          expect(args).to eq(['/foo', { page: 1 }, { 'X-Custom' => 'yes' }])
+          expect(blk).to be(block)
+        end
+
+        Faraday.public_send(http_method, '/foo', { page: 1 }, { 'X-Custom' => 'yes' }, &block)
+      end
+    end
+
+    after do
+      Faraday.default_connection = nil
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -24,9 +24,18 @@ 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
+
+  # SimpleCov 1.0 first, then older.
+  if SimpleCov.respond_to?(:skip)
+    skip '/spec/'
+    skip '/tmp/'
+    coverage(:line) { minimum 26, per: :file }
+  else
+    add_filter '/spec/'
+    add_filter '/tmp/'
+    minimum_coverage_by_file 26
+  end
 end
 
 require 'faraday'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 2.14.3
+  version: 2.15.0
 platform: ruby
 authors:
 - "@technoweenie"
@@ -20,7 +20,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +144,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.14.3
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.15.0
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
   rubygems_mfa_required: 'true'