faraday 2.3.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51764b6108e230dfff244e6e6e9f275f92f5fc1bcd1bf8e43d36058d35442e14
-  data.tar.gz: 2cdf2edfd3e3c0386f501c0c2609db4f5c879a2a1807869a7b7e690e4a22a77a
+  metadata.gz: 503ea26e785d93ce2e71fa46a1be6deea7c562d96659401b99e4ada7527e7f9b
+  data.tar.gz: 37f707014c1dafb00caf9856c0f5a4386f0f7826e1809e2a6fe03221fca9f936
 SHA512:
-  metadata.gz: 94ce1d0df0639d8e7a8472085331796a787236989e07943a47e463f6d5c68d83bf180b55636e87d37ac654400fe11660ee10898c9b43122c29a211310682b621
-  data.tar.gz: 14af6c0c348cf3ca8ae7f7f8a95b3eb8b73b8a444d90a75c7eeb46d9edd4c840fa44dd2eda4e76653fd4924e6b20d13f32236e21bd303f90b589df1abc88da3d
+  metadata.gz: 37b3abd53741e0bfb8f92636983c152460dee4790d8ac943ddc8fc81b076da115c2d20622ee190b3489101fce497bf628261ba7684e4163d23fe7e0894d5c407
+  data.tar.gz: 40d69fe13ea02495810d3a968681a668f22b5e6790d3d7a98a59e44decff2ad370f3230c59fc5c30e6aa3f150260d7409c995b5ba1ca2413c36a3ce661f82636

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2020 Rick Olson, Zack Hobson
+Copyright (c) 2009-2022 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

@@ -42,7 +42,7 @@ Open the issues page and check for the `help wanted` label!
 But before you start coding, please read our [Contributing Guide][contributing]
 
 ## Copyright
-© 2009 - 2021, the [Faraday Team][faraday_team]. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
+© 2009 - 2022, the [Faraday Team][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/examples/client_spec.rb

@@ -17,6 +17,11 @@ class Client
     data = JSON.parse(res.body)
     data['origin']
   end
+
+  def foo(params)
+    res = @conn.post('/foo', JSON.dump(params))
+    res.status
+  end
 end
 
 RSpec.describe Client do
@@ -94,4 +99,21 @@ RSpec.describe Client do
       stubs.verify_stubbed_calls
     end
   end
+
+  context 'When you want to test the body, you can use a proc as well as string' do
+    it 'tests with a string' do
+      stubs.post('/foo', '{"name":"YK"}') { [200, {}, ''] }
+
+      expect(client.foo(name: 'YK')).to eq 200
+      stubs.verify_stubbed_calls
+    end
+
+    it 'tests with a proc' do
+      check = ->(request_body) { JSON.parse(request_body).slice('name') == { 'name' => 'YK' } }
+      stubs.post('/foo', check) { [200, {}, ''] }
+
+      expect(client.foo(name: 'YK', created_at: Time.now)).to eq 200
+      stubs.verify_stubbed_calls
+    end
+  end
 end

data/examples/client_test.rb

@@ -18,6 +18,11 @@ class Client
     data = JSON.parse(res.body)
     data['origin']
   end
+
+  def foo(params)
+    res = @conn.post('/foo', JSON.dump(params))
+    res.status
+  end
 end
 
 # Example API client test
@@ -109,6 +114,27 @@ class ClientTest < Test::Unit::TestCase
     stubs.verify_stubbed_calls
   end
 
+  def test_with_string_body
+    stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.post('/foo', '{"name":"YK"}') { [200, {}, ''] }
+    end
+    cli = client(stubs)
+    assert_equal 200, cli.foo(name: 'YK')
+
+    stubs.verify_stubbed_calls
+  end
+
+  def test_with_proc_body
+    stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+      check = ->(request_body) { JSON.parse(request_body).slice('name') == { 'name' => 'YK' } }
+      stub.post('/foo', check) { [200, {}, ''] }
+    end
+    cli = client(stubs)
+    assert_equal 200, cli.foo(name: 'YK', created_at: Time.now)
+
+    stubs.verify_stubbed_calls
+  end
+
   def client(stubs)
     conn = Faraday.new do |builder|
       builder.adapter :test, stubs

data/lib/faraday/adapter/test.rb

@@ -26,6 +26,15 @@ module Faraday
     #         ]
     #       end
     #
+    #      # Test the request body is the same as the stubbed body
+    #      stub.post('/bar', 'name=YK&word=call') { [200, {}, ''] }
+    #
+    #      # You can pass a proc as a stubbed body and check the request body in your way.
+    #      # In this case, the proc should return true or false.
+    #      stub.post('/foo', ->(request_body) do
+    #        JSON.parse(request_body).slice('name') == { 'name' => 'YK' } }) { [200, {}, '']
+    #      end
+    #
     #       # You can set strict_mode to exactly match the stubbed requests.
     #       stub.strict_mode = true
     #     end
@@ -42,6 +51,12 @@ module Faraday
     #
     #   resp = test.get '/items/2'
     #   resp.body # => 'showing item: 2'
+    #
+    #   resp = test.post '/bar', 'name=YK&word=call'
+    #   resp.status # => 200
+    #
+    #   resp = test.post '/foo', JSON.dump(name: 'YK', created_at: Time.now)
+    #   resp.status # => 200
     class Test < Faraday::Adapter
       attr_accessor :stubs
 
@@ -181,7 +196,7 @@ module Faraday
           [(host.nil? || host == request_host) &&
             path_match?(request_path, meta) &&
             params_match?(env) &&
-            (body.to_s.size.zero? || request_body == body) &&
+            body_match?(request_body) &&
             headers_match?(request_headers), meta]
         end
 
@@ -222,6 +237,17 @@ module Faraday
           end
         end
 
+        def body_match?(request_body)
+          return true if body.to_s.size.zero?
+
+          case body
+          when Proc
+            body.call(request_body)
+          else
+            request_body == body
+          end
+        end
+
         def to_s
           "#{path} #{body}"
         end

data/lib/faraday/adapter.rb

@@ -59,7 +59,7 @@ module Faraday
 
     private
 
-    def save_response(env, status, body, headers = nil, reason_phrase = nil)
+    def save_response(env, status, body, headers = nil, reason_phrase = nil, finished: true)
       env.status = status
       env.body = body
       env.reason_phrase = reason_phrase&.to_s&.strip
@@ -68,7 +68,7 @@ module Faraday
         yield(response_headers) if block_given?
       end
 
-      env.response.finish(env) unless env.parallel?
+      env.response.finish(env) unless env.parallel? || !finished
       env.response
     end
 

data/lib/faraday/options/env.rb

@@ -157,6 +157,24 @@ module Faraday
       %(#<#{self.class}#{attrs.join(' ')}>)
     end
 
+    def stream_response?
+      request.stream_response?
+    end
+
+    def stream_response(&block)
+      size = 0
+      yielded = false
+      block_result = block.call do |chunk| # rubocop:disable Performance/RedundantBlockCall
+        if chunk.bytesize.positive? || size.positive?
+          yielded = true
+          size += chunk.bytesize
+          request.on_data.call(chunk, size, self)
+        end
+      end
+      request.on_data.call(+'', 0, self) unless yielded
+      block_result
+    end
+
     # @private
     def custom_members
       @custom_members ||= {}

data/lib/faraday/options/ssl_options.rb

@@ -6,6 +6,10 @@ module Faraday
   # @!attribute verify
   #   @return [Boolean] whether to verify SSL certificates or not
   #
+  # @!attribute verify_hostname
+  #   @return [Boolean] whether to enable hostname verification on server certificates
+  #           during the handshake or not (see https://github.com/ruby/openssl/pull/60)
+  #
   # @!attribute ca_file
   #   @return [String] CA file
   #
@@ -41,7 +45,8 @@ module Faraday
   #
   # @!attribute max_version
   #   @return [String, Symbol] maximum SSL version (see https://ruby-doc.org/stdlib-2.5.1/libdoc/openssl/rdoc/OpenSSL/SSL/SSLContext.html#method-i-max_version-3D)
-  class SSLOptions < Options.new(:verify, :ca_file, :ca_path, :verify_mode,
+  class SSLOptions < Options.new(:verify, :verify_hostname,
+                                 :ca_file, :ca_path, :verify_mode,
                                  :cert_store, :client_cert, :client_key,
                                  :certificate, :private_key, :verify_depth,
                                  :version, :min_version, :max_version)
@@ -55,5 +60,10 @@ module Faraday
     def disable?
       !verify?
     end
+
+    # @return [Boolean] true if should verify_hostname
+    def verify_hostname?
+      verify_hostname != false
+    end
   end
 end

data/lib/faraday/version.rb

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

data/spec/faraday/adapter/test_spec.rb

@@ -373,5 +373,41 @@ RSpec.describe Faraday::Adapter::Test do
       it_behaves_like 'does not raise NotFound even when headers do not satisfy the strict check', '/with_user_agent', { authorization: 'Bearer m_ck', user_agent: 'My Agent' }
       it_behaves_like 'does not raise NotFound even when headers do not satisfy the strict check', '/with_user_agent', { authorization: 'Bearer m_ck', user_agent: 'My Agent', x_special: 'special' }
     end
+
+    describe 'body_match?' do
+      let(:stubs) do
+        described_class::Stubs.new do |stubs|
+          stubs.post('/no_check') { [200, {}, 'ok'] }
+          stubs.post('/with_string', 'abc') { [200, {}, 'ok'] }
+          stubs.post(
+            '/with_proc',
+            ->(request_body) { JSON.parse(request_body, symbolize_names: true) == { x: '!', a: [{ m: [{ a: true }], n: 123 }] } },
+            { content_type: 'application/json' }
+          ) do
+            [200, {}, 'ok']
+          end
+        end
+      end
+
+      context 'when trying without any args for body' do
+        subject(:without_body) { connection.post('/no_check') }
+
+        it { expect(without_body.status).to eq 200 }
+      end
+
+      context 'when trying with string body stubs' do
+        subject(:with_string) { connection.post('/with_string', 'abc') }
+
+        it { expect(with_string.status).to eq 200 }
+      end
+
+      context 'when trying with proc body stubs' do
+        subject(:with_proc) do
+          connection.post('/with_proc', JSON.dump(a: [{ n: 123, m: [{ a: true }] }], x: '!'), { 'Content-Type' => 'application/json' })
+        end
+
+        it { expect(with_proc.status).to eq 200 }
+      end
+    end
   end
 end

data/spec/faraday/connection_spec.rb

@@ -131,6 +131,12 @@ RSpec.describe Faraday::Connection do
       it { expect(subject.ssl.verify?).to be_falsey }
     end
 
+    context 'with verify_hostname false' do
+      let(:options) { { ssl: { verify_hostname: false } } }
+
+      it { expect(subject.ssl.verify_hostname?).to be_falsey }
+    end
+
     context 'with empty block' do
       let(:conn) { Faraday::Connection.new {} }
 

data/spec/faraday/options/env_spec.rb

@@ -27,6 +27,12 @@ RSpec.describe Faraday::Env do
     expect(ssl.fetch(:verify, true)).to be_falsey
   end
 
+  it 'handle verify_hostname when fetching' do
+    ssl = Faraday::SSLOptions.new
+    ssl.verify_hostname = true
+    expect(ssl.fetch(:verify_hostname, false)).to be_truthy
+  end
+
   it 'retains custom members' do
     env[:foo] = 'custom 1'
     env[:bar] = :custom2

data/spec/faraday/request_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Faraday::Request do
   context 'when nothing particular is configured' do
     it { expect(subject.http_method).to eq(:get) }
     it { expect(subject.to_env(conn).ssl.verify).to be_falsey }
+    it { expect(subject.to_env(conn).ssl.verify_hostname).to be_falsey }
   end
 
   context 'when HTTP method is post' do

data/spec/faraday/utils_spec.rb

@@ -102,7 +102,8 @@ RSpec.describe Faraday::Utils do
           verify_depth: nil,
           version: '2',
           min_version: nil,
-          max_version: nil
+          max_version: nil,
+          verify_hostname: nil
         }
       end
 

data/spec/support/shared_examples/adapter.rb

@@ -38,6 +38,7 @@ shared_examples 'adapter examples' do |**options|
   let(:conn) do
     conn_options[:ssl] ||= {}
     conn_options[:ssl][:ca_file] ||= ENV['SSL_FILE']
+    conn_options[:ssl][:verify_hostname] ||= ENV['SSL_VERIFY_HOSTNAME'] == 'yes'
 
     Faraday.new(remote, conn_options) do |conn|
       conn.request :url_encoded

data/spec/support/shared_examples/request_method.rb

@@ -153,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
 
@@ -166,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.1
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,22 +10,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday-net_http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +131,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.3.0
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.5.1
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: