faraday 1.0.0 → 2.10.0

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,66 @@ 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
+        }
+      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,14 +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 }
+
+# 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

@@ -33,20 +33,21 @@ shared_examples 'adapter examples' do |**options|
 
   let(:protocol) { ssl_mode? ? 'https' : 'http' }
   let(:remote) { "#{protocol}://example.com" }
+  let(:stub_remote) { remote }
 
   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
     end
   end
 
-  let!(:request_stub) { stub_request(http_method, remote) }
+  let!(:request_stub) { stub_request(http_method, stub_remote) }
 
   after do
     expect(request_stub).to have_been_requested unless request_stub.disabled?

data/spec/support/shared_examples/request_method.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+shared_examples 'proxy examples' do
+  it 'handles requests with proxy' do
+    res = conn.public_send(http_method, '/')
+
+    expect(res.status).to eq(200)
+  end
+
+  it 'handles proxy failures' do
+    request_stub.to_return(status: 407)
+
+    expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::ProxyAuthError)
+  end
+end
+
 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, '/') }
@@ -13,8 +27,8 @@ shared_examples 'a request method' do |http_method|
   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')
+    request_stub.to_return(headers: { 'Set-Cookie' => 'name=value' })
+    expect(response.headers['set-cookie']).to eq('name=value')
   end
 
   it 'retrieves the response headers' do
@@ -65,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
@@ -79,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
@@ -90,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
 
@@ -112,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 =~ /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'])
@@ -152,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
 
@@ -165,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
@@ -185,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
@@ -218,17 +233,31 @@ shared_examples 'a request method' do |http_method|
     end
   end
 
-  it 'handles requests with proxy' do
-    conn_options[:proxy] = 'http://google.co.uk'
+  context 'when a proxy is provided as option' do
+    before do
+      conn_options[:proxy] = 'http://env-proxy.com:80'
+    end
 
-    res = conn.public_send(http_method, '/')
-    expect(res.status).to eq(200)
+    include_examples 'proxy examples'
   end
 
-  it 'handles proxy failures' do
-    conn_options[:proxy] = 'http://google.co.uk'
-    request_stub.to_return(status: 407)
+  context 'when http_proxy env variable is set' do
+    let(:proxy_url) { 'http://env-proxy.com:80' }
 
-    expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::ProxyAuthError)
+    around do |example|
+      with_env 'http_proxy' => proxy_url do
+        example.run
+      end
+    end
+
+    include_examples 'proxy examples'
+
+    context 'when the env proxy is ignored' do
+      around do |example|
+        with_env_proxy_disabled(&example)
+      end
+
+      include_examples 'proxy examples'
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.10.0
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,28 +10,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multipart-post
+  name: faraday-net_http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: technoweenie@gmail.com
 executables: []
@@ -42,32 +56,18 @@ 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
-- lib/faraday/adapter/em_http_ssl_patch.rb
-- lib/faraday/adapter/em_synchrony.rb
-- lib/faraday/adapter/em_synchrony/parallel_manager.rb
-- lib/faraday/adapter/excon.rb
-- lib/faraday/adapter/httpclient.rb
-- lib/faraday/adapter/net_http.rb
-- lib/faraday/adapter/net_http_persistent.rb
-- lib/faraday/adapter/patron.rb
-- 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/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/methods.rb
 - lib/faraday/middleware.rb
 - lib/faraday/middleware_registry.rb
 - lib/faraday/options.rb
@@ -76,38 +76,28 @@ files:
 - 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
 - lib/faraday/request/authorization.rb
-- lib/faraday/request/basic_authentication.rb
 - lib/faraday/request/instrumentation.rb
-- lib/faraday/request/multipart.rb
-- lib/faraday/request/retry.rb
-- lib/faraday/request/token_authentication.rb
+- lib/faraday/request/json.rb
 - lib/faraday/request/url_encoded.rb
 - lib/faraday/response.rb
+- lib/faraday/response/json.rb
 - lib/faraday/response/logger.rb
 - lib/faraday/response/raise_error.rb
 - lib/faraday/utils.rb
 - lib/faraday/utils/headers.rb
 - 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_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/test_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_registry_spec.rb
 - spec/faraday/middleware_spec.rb
 - spec/faraday/options/env_spec.rb
 - spec/faraday/options/options_spec.rb
@@ -118,12 +108,11 @@ files:
 - 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/json_spec.rb
 - spec/faraday/request/url_encoded_spec.rb
 - 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
@@ -132,36 +121,37 @@ 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.0.0
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.10.0
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
+- spec/external_adapters
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: HTTP/REST API client library.

data/UPGRADING.md

@@ -1,55 +0,0 @@
-## Faraday 1.0
-
-### Errors
-* Removes sub-class constants definition from `Faraday::Error`. A sub-class (e.g. `ClientError`) was previously accessible
-either through the `Faraday` module (e.g. `Faraday::ClientError`) or through the `Faraday::Error` class (e.g. `Faraday::Error::ClientError`).
-The latter is no longer available and the former should be used instead, so check your `rescue`s.
-* Introduces a new `Faraday::ServerError` (5xx status codes) alongside the existing `Faraday::ClientError` (4xx status codes).
-Please note `Faraday::ClientError` was previously used for both.
-* Introduces new Errors that describe the most common REST status codes:
-  * Faraday::BadRequestError (400)
-  * Faraday::UnauthorizedError (401)
-  * Faraday::ForbiddenError (403)
-  * Faraday::ProxyAuthError (407). Please note this raised a `Faraday::ConnectionFailed` before.
-  * Faraday::ConflictError (409)
-  * Faraday::UnprocessableEntityError (422)
-* The following error classes have changed the hierarchy to better mirror their real-world usage and semantic meaning:
-  * TimeoutError < ServerError (was < ClientError)
-  * ConnectionFailed < Error (was < ClientError)
-  * SSLError < Error (was < ClientError)
-  * ParsingError < Error (was < ClientError)
-  * RetriableResponse < Error (was < ClientError)
-
-### Custom adapters
-If you have written a custom adapter, please be aware that `env.body` is now an alias to the two new properties `request_body` and `response_body`.
-This should work without you noticing if your adapter inherits from `Faraday::Adapter` and calls `save_response`, but if it doesn't, then please ensure you set the `status` BEFORE the `body` while processing the response.
-
-### Others
-* Dropped support for jruby and Rubinius.
-* Officially supports Ruby 2.4+
-* In order to specify the adapter you now MUST use the `#adapter` method on the connection builder. If you don't do so and your adapter inherits from `Faraday::Adapter` then Faraday will raise an exception. Otherwise, Faraday will automatically push the default adapter at the end of the stack causing your request to be executed twice.
-```ruby
-class OfficialAdapter < Faraday::Adapter
-  ...
-end
-
-class MyAdapter
-  ...
-end
-
-# This will raise an exception
-conn = Faraday.new(...) do |f|
-  f.use OfficialAdapter
-end
-
-# This will cause Faraday inserting the default adapter at the end of the stack
-conn = Faraday.new(...) do |f|
-  f.use MyAdapter
-end
-
-# You MUST use `adapter` method
-conn = Faraday.new(...) do |f|
-  f.adapter AnyAdapter
-end
-```
-