faraday 2.13.4 → 2.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12dedb476a26ae00e5f902e4e10f5327a790290d2d7647711aac09e8661af959
-  data.tar.gz: f43c7bb1127b0a57bb7aa0727a096e0b66cfeead93445631dacf151c354efbdb
+  metadata.gz: 05f10cf15f3eb3f35b39edc67e14c374306d286f7b282ce86e131cab66ef9726
+  data.tar.gz: 17df5c4c9c054080f80038a1d8c6e1eaf88fd5d319c5ca1f04b10bc7bc0fe350
 SHA512:
-  metadata.gz: b3cb808ea984cc306ad71fc502bf79541d5e79fb9ca066784e0674dc71a2dc22ac20b6968065cceaa3fe5ccb909124aeef9513a37bf83bbcb4a63e116dbd6afe
-  data.tar.gz: 1540d3fe594b1d0a025caede980b99419de50d4ea148b53bf5cf7a3082307982c0917fd739621805252f8016e427ffdbfba59da5a679b529380adf0100cf10ef
+  metadata.gz: 511bc21e7d0e4c4ecf866f84b434e6f38d6c4eada9d17148f25db9c6cf3194c4fe6fe600cc1b41d288e611e8dbfcbbbb5e2d711051a4340239741bb9dae54b73
+  data.tar.gz: e527f43b558124d58d4c4826dc46d0716a6689fec48dea4daf47a3943e1cae5c3612b2e490c956811d0d2ba501290548e85f2b0879bd924fd026566a2dc6056e

data/examples/client_test.rb

@@ -26,7 +26,7 @@ class Client
 end
 
 # Example API client test
-class ClientTest < Test::Unit::TestCase
+class ClientTest < Test::Unit::TestCase # rubocop:disable Style/OneClassPerFile
   def test_httpbingo_name
     stubs = Faraday::Adapter::Test::Stubs.new
     stubs.get('/api') do |env|

data/lib/faraday/adapter.rb

@@ -8,6 +8,12 @@ module Faraday
 
     CONTENT_LENGTH = 'Content-Length'
 
+    TIMEOUT_KEYS = {
+      read: :read_timeout,
+      open: :open_timeout,
+      write: :write_timeout
+    }.freeze
+
     # This module marks an Adapter as supporting parallel requests.
     module Parallelism
       attr_writer :supports_parallel
@@ -23,6 +29,7 @@ module Faraday
     end
 
     extend Parallelism
+
     self.supports_parallel = false
 
     def initialize(_app = nil, opts = {}, &block)
@@ -89,12 +96,6 @@ module Faraday
       end
       options[key] || options[:timeout]
     end
-
-    TIMEOUT_KEYS = {
-      read: :read_timeout,
-      open: :open_timeout,
-      write: :write_timeout
-    }.freeze
   end
 end
 

data/lib/faraday/connection.rb

@@ -481,8 +481,11 @@ module Faraday
       if url && !base.path.end_with?('/')
         base.path = "#{base.path}/" # ensure trailing slash
       end
-      # Ensure relative url will be parsed correctly (such as `service:search` )
-      url = "./#{url}" if url.respond_to?(:start_with?) && !url.start_with?('http://', 'https://', '/', './', '../')
+      url = url.to_s if url.respond_to?(:host)
+      # Ensure relative url will be parsed correctly (such as `service:search` or `//evil.com`)
+      url = "./#{url}" if url.respond_to?(:start_with?) &&
+                          (url.start_with?('//') ||
+                           !url.start_with?('http://', 'https://', '/', './', '../'))
       uri = url ? base + url : base
       if params
         uri.query = params.to_query(params_encoder || options.params_encoder)

data/lib/faraday/encoders/flat_params_encoder.rb

@@ -6,6 +6,7 @@ module Faraday
   module FlatParamsEncoder
     class << self
       extend Forwardable
+
       def_delegators :'Faraday::Utils', :escape, :unescape
     end
 
@@ -76,9 +77,9 @@ module Faraday
 
       empty_accumulator = {}
 
-      split_query = (query.split('&').map do |pair|
+      split_query = query.split('&').filter_map do |pair|
         pair.split('=', 2) if pair && !pair.empty?
-      end).compact
+      end
       split_query.each_with_object(empty_accumulator.dup) do |pair, accu|
         pair[0] = unescape(pair[0])
         pair[1] = true if pair[1].nil?

data/lib/faraday/encoders/nested_params_encoder.rb

@@ -170,6 +170,7 @@ module Faraday
       attr_accessor :sort_params, :array_indices
 
       extend Forwardable
+
       def_delegators :'Faraday::Utils', :escape, :unescape
     end
 

data/lib/faraday/error.rb

@@ -155,9 +155,12 @@ module Faraday
   end
 
   # Raised by Faraday::Response::RaiseError in case of a 422 response.
-  class UnprocessableEntityError < ClientError
+  class UnprocessableContentError < ClientError
   end
 
+  # Used to provide compatibility with legacy error name.
+  UnprocessableEntityError = UnprocessableContentError
+
   # Raised by Faraday::Response::RaiseError in case of a 429 response.
   class TooManyRequestsError < ClientError
   end
@@ -169,7 +172,7 @@ module Faraday
   # A unified client error for timeouts.
   class TimeoutError < ServerError
     def initialize(exc = 'timeout', response = nil)
-      super(exc, response)
+      super
     end
   end
 

data/lib/faraday/logging/formatter.rb

@@ -63,7 +63,7 @@ module Faraday
 
       def dump_body(body)
         if body.respond_to?(:to_str)
-          body.to_str
+          body.to_str.encode(::Encoding::UTF_8, undef: :replace, invalid: :replace)
         else
           pretty_inspect(body)
         end

data/lib/faraday/middleware.rb

@@ -65,7 +65,7 @@ module Faraday
       if app.respond_to?(:close)
         app.close
       else
-        warn "#{app} does not implement \#close!"
+        warn "#{app} does not implement #close!"
       end
     end
   end

data/lib/faraday/options/env.rb

@@ -78,7 +78,7 @@ module Faraday
     # @param value [Object] a value fitting Option.from(v).
     # @return [Env] from given value
     def self.from(value)
-      env = super(value)
+      env = super
       if value.respond_to?(:custom_members)
         env.custom_members.update(value.custom_members)
       end
@@ -90,7 +90,7 @@ module Faraday
       return self[current_body] if key == :body
 
       if in_member_set?(key)
-        super(key)
+        super
       else
         custom_members[key]
       end
@@ -105,7 +105,7 @@ module Faraday
       end
 
       if in_member_set?(key)
-        super(key, value)
+        super
       else
         custom_members[key] = value
       end

data/lib/faraday/options/proxy_options.rb

@@ -7,6 +7,7 @@ module Faraday
   #   class ProxyOptions < Options; end
   ProxyOptions = Options.new(:uri, :user, :password) do
     extend Forwardable
+
     def_delegators :uri, :scheme, :scheme=, :host, :host=, :port, :port=,
                    :path, :path=
 
@@ -29,7 +30,7 @@ module Faraday
         end
       end
 
-      super(value)
+      super
     end
 
     memoized(:user) { uri&.user && Utils.unescape(uri.user) }

data/lib/faraday/options/request_options.rb

@@ -12,7 +12,7 @@ module Faraday
       if key && key.to_sym == :proxy
         super(key, value ? ProxyOptions.from(value) : nil)
       else
-        super(key, value)
+        super
       end
     end
 

data/lib/faraday/options.rb

@@ -186,7 +186,7 @@ module Faraday
     def [](key)
       key = key.to_sym
       if (method = self.class.memoized_attributes[key])
-        super(key) || (self[key] = instance_eval(&method))
+        super || (self[key] = instance_eval(&method))
       else
         super
       end

data/lib/faraday/rack_builder.rb

@@ -15,6 +15,11 @@ module Faraday
     # Used to detect missing arguments
     NO_ARGUMENT = Object.new
 
+    LOCK_ERR = "can't modify middleware stack after making a request"
+    MISSING_ADAPTER_ERROR = "An attempt to run a request with a Faraday::Connection without adapter has been made.\n" \
+                            "Please set Faraday.default_adapter or provide one when initializing the connection.\n" \
+                            'For more info, check https://lostisland.github.io/faraday/usage/.'
+
     attr_accessor :handlers
 
     # Error raised when trying to modify the stack after calling `lock!`
@@ -211,11 +216,6 @@ module Faraday
 
     private
 
-    LOCK_ERR = "can't modify middleware stack after making a request"
-    MISSING_ADAPTER_ERROR = "An attempt to run a request with a Faraday::Connection without adapter has been made.\n" \
-                            "Please set Faraday.default_adapter or provide one when initializing the connection.\n" \
-                            'For more info, check https://lostisland.github.io/faraday/usage/.'
-
     def raise_if_locked
       raise StackLocked, LOCK_ERR if locked?
     end

data/lib/faraday/response/raise_error.rb

@@ -15,7 +15,7 @@ module Faraday
         404 => Faraday::ResourceNotFound,
         408 => Faraday::RequestTimeoutError,
         409 => Faraday::ConflictError,
-        422 => Faraday::UnprocessableEntityError,
+        422 => Faraday::UnprocessableContentError,
         429 => Faraday::TooManyRequestsError
       }.freeze
       # rubocop:enable Naming/ConstantName

data/lib/faraday/response.rb

@@ -33,6 +33,10 @@ module Faraday
       finished? ? env.body : nil
     end
 
+    def url
+      finished? ? env.url : nil
+    end
+
     def finished?
       !!env
     end
@@ -60,9 +64,9 @@ module Faraday
 
     def to_hash
       {
-        status: env.status, body: env.body,
-        response_headers: env.response_headers,
-        url: env.url
+        status: status, body: body,
+        response_headers: headers,
+        url: url
       }
     end
 

data/lib/faraday/utils/headers.rb

@@ -51,7 +51,7 @@ module Faraday
 
       def [](key)
         key = KeyMap[key]
-        super(key) || super(@names[key.downcase])
+        super || super(@names[key.downcase])
       end
 
       def []=(key, val)
@@ -59,13 +59,13 @@ module Faraday
         key = (@names[key.downcase] ||= key)
         # join multiple values with a comma
         val = val.to_ary.join(', ') if val.respond_to?(:to_ary)
-        super(key, val)
+        super
       end
 
       def fetch(key, ...)
         key = KeyMap[key]
         key = @names.fetch(key.downcase, key)
-        super(key, ...)
+        super
       end
 
       def delete(key)
@@ -74,13 +74,13 @@ module Faraday
         return unless key
 
         @names.delete key.downcase
-        super(key)
+        super
       end
 
       def dig(key, *rest)
         key = KeyMap[key]
         key = @names.fetch(key.downcase, key)
-        super(key, *rest)
+        super
       end
 
       def include?(key)

data/lib/faraday/version.rb

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

data/spec/faraday/connection_spec.rb

@@ -311,6 +311,46 @@ RSpec.describe Faraday::Connection do
       end
     end
 
+    context 'with protocol-relative URL (GHSA-33mh-2634-fwr2)' do
+      it 'does not allow host override with //evil.com/path' do
+        conn.url_prefix = 'http://httpbingo.org/api'
+        uri = conn.build_exclusive_url('//evil.com/path')
+        expect(uri.host).to eq('httpbingo.org')
+      end
+
+      it 'does not allow host override with URI("//evil.com/path")' do
+        conn.url_prefix = 'http://httpbingo.org/api'
+        uri = conn.build_exclusive_url(URI('//evil.com/path?token=1'))
+        expect(uri.host).to eq('httpbingo.org')
+        expect(uri.query).to eq('token=1')
+      end
+
+      it 'does not allow host override with //evil.com:8080/path' do
+        conn.url_prefix = 'http://httpbingo.org/api'
+        uri = conn.build_exclusive_url('//evil.com:8080/path')
+        expect(uri.host).to eq('httpbingo.org')
+      end
+
+      it 'does not allow host override with //user:pass@evil.com/path' do
+        conn.url_prefix = 'http://httpbingo.org/api'
+        uri = conn.build_exclusive_url('//user:pass@evil.com/path')
+        expect(uri.host).to eq('httpbingo.org')
+      end
+
+      it 'does not allow host override with ///evil.com' do
+        conn.url_prefix = 'http://httpbingo.org/api'
+        uri = conn.build_exclusive_url('///evil.com')
+        expect(uri.host).to eq('httpbingo.org')
+      end
+
+      it 'still allows single-slash absolute paths' do
+        conn.url_prefix = 'http://httpbingo.org/api'
+        uri = conn.build_exclusive_url('/safe/path')
+        expect(uri.host).to eq('httpbingo.org')
+        expect(uri.path).to eq('/safe/path')
+      end
+    end
+
     context 'with a custom `default_uri_parser`' do
       let(:url) { 'http://httpbingo.org' }
       let(:parser) { Addressable::URI }

data/spec/faraday/middleware_spec.rb

@@ -52,14 +52,14 @@ RSpec.describe Faraday::Middleware do
   end
 
   describe '#close' do
-    context "with app that doesn't support \#close" do
+    context "with app that doesn't support #close" do
       it 'should issue warning' do
         is_expected.to receive(:warn)
         subject.close
       end
     end
 
-    context "with app that supports \#close" do
+    context 'with app that supports #close' do
       it 'should issue warning' do
         expect(app).to receive(:close)
         is_expected.to_not receive(:warn)

data/spec/faraday/request_spec.rb

@@ -31,6 +31,15 @@ RSpec.describe Faraday::Request do
     it { expect(subject.to_env(conn).url.to_s).to eq('http://httpbingo.org/api/foo.json?a=1') }
   end
 
+  context 'when setting the url on setup with a protocol-relative URI' do
+    let(:block) { proc { |req| req.url URI.parse('//evil.com/path?token=1') } }
+    let(:url) { subject.to_env(conn).url }
+
+    it { expect(url.host).to eq('httpbingo.org') }
+    it { expect(url.path).to eq('/api///evil.com/path') }
+    it { expect(url.query).to eq('token=1') }
+  end
+
   context 'when setting the url on setup with a string path and params' do
     let(:block) { proc { |req| req.url 'foo.json', 'a' => 1 } }
 

data/spec/faraday/response/json_spec.rb

@@ -106,7 +106,7 @@ RSpec.describe Faraday::Response::Json, type: :response do
     end
 
     it 'passes relevant options to JSON parse' do
-      expect(::JSON).to receive(:parse)
+      expect(JSON).to receive(:parse)
         .with(body, options[:parser_options])
         .and_return(result)
 

data/spec/faraday/response/logger_spec.rb

@@ -21,6 +21,7 @@ RSpec.describe Faraday::Response::Logger do
         stubs.post('/ohai') { [200, { 'Content-Type' => 'text/html' }, 'fred'] }
         stubs.post('/ohyes') { [200, { 'Content-Type' => 'text/html' }, 'pebbles'] }
         stubs.get('/rubbles') { [200, { 'Content-Type' => 'application/json' }, rubbles] }
+        stubs.get('/8bit') { [200, { 'Content-Type' => 'text/html' }, (+'café!').force_encoding(Encoding::ASCII_8BIT)] }
         stubs.get('/filtered_body') { [200, { 'Content-Type' => 'text/html' }, 'soylent green is people'] }
         stubs.get('/filtered_headers') { [200, { 'Content-Type' => 'text/html' }, 'headers response'] }
         stubs.get('/filtered_params') { [200, { 'Content-Type' => 'text/html' }, 'params response'] }
@@ -217,7 +218,7 @@ RSpec.describe Faraday::Response::Logger do
 
     it 'logs response body object' do
       conn.get '/rubbles', nil, accept: 'text/html'
-      expect(string_io.string).to match(%([\"Barney\", \"Betty\", \"Bam Bam\"]\n))
+      expect(string_io.string).to match(%(["Barney", "Betty", "Bam Bam"]\n))
     end
 
     it 'logs filter body' do
@@ -238,6 +239,11 @@ RSpec.describe Faraday::Response::Logger do
       expect(string_io.string).to match(%(fred))
     end
 
+    it 'converts to UTF-8' do
+      conn.get '/8bit'
+      expect(string_io.string).to match(%(caf��!))
+    end
+
     after do
       described_class.default_options = { bodies: false }
     end

data/spec/faraday/response/raise_error_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe Faraday::Response::RaiseError do
         stub.get('proxy-error') { [407, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('request-timeout') { [408, { '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('unprocessable-content') { [422, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('too-many-requests') { [429, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('4xx') { [499, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('nil-status') { [nil, { 'X-Reason' => 'nil' }, 'fail'] }
@@ -103,9 +103,20 @@ RSpec.describe Faraday::Response::RaiseError do
     end
   end
 
-  it 'raises Faraday::UnprocessableEntityError for 422 responses' do
-    expect { conn.get('unprocessable-entity') }.to raise_error(Faraday::UnprocessableEntityError) do |ex|
-      expect(ex.message).to eq('the server responded with status 422 for GET http:/unprocessable-entity')
+  it 'raises legacy Faraday::UnprocessableEntityError for 422 responses' do
+    expect { conn.get('unprocessable-content') }.to raise_error(Faraday::UnprocessableEntityError) do |ex|
+      expect(ex.message).to eq('the server responded with status 422 for GET http:/unprocessable-content')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(422)
+      expect(ex.response_status).to eq(422)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+
+  it 'raises Faraday::UnprocessableContentError for 422 responses' do
+    expect { conn.get('unprocessable-content') }.to raise_error(Faraday::UnprocessableContentError) do |ex|
+      expect(ex.message).to eq('the server responded with status 422 for GET http:/unprocessable-content')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(422)
       expect(ex.response_status).to eq(422)

data/spec/faraday/response_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Faraday::Response do
   it { expect(subject.success?).to be_falsey }
   it { expect(subject.status).to eq(404) }
   it { expect(subject.body).to eq('yikes') }
+  it { expect(subject.url).to eq(URI('https://lostisland.github.io/faraday')) }
   it { expect(subject.headers['Content-Type']).to eq('text/plain') }
   it { expect(subject['content-type']).to eq('text/plain') }
 
@@ -31,6 +32,12 @@ RSpec.describe Faraday::Response do
     it { expect(hash[:response_headers]).to eq(subject.headers) }
     it { expect(hash[:body]).to eq(subject.body) }
     it { expect(hash[:url]).to eq(subject.env.url) }
+
+    context 'when response is not finished' do
+      subject { Faraday::Response.new.to_hash }
+
+      it { is_expected.to eq({ status: nil, body: nil, response_headers: {}, url: nil }) }
+    end
   end
 
   describe 'marshal serialization support' do

data/spec/faraday/utils_spec.rb

@@ -33,7 +33,7 @@ RSpec.describe Faraday::Utils do
     end
 
     it 'parses with URI' do
-      with_default_uri_parser(::URI) do
+      with_default_uri_parser(URI) do
         uri = normalize(url)
         expect(uri.host).to eq('example.com')
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 2.13.4
+  version: 2.14.2
 platform: ruby
 authors:
 - "@technoweenie"
@@ -144,7 +144,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.13.4
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.14.2
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
   rubygems_mfa_required: 'true'