faraday 1.7.0 → 2.0.0.alpha.pre.1

data/spec/faraday/request/multipart_spec.rb

@@ -157,7 +157,7 @@ RSpec.describe Faraday::Request::Multipart do
       {
         a: 1,
         b: {
-          c: Faraday::UploadIO.new(__FILE__, 'text/x-ruby', nil,
+          c: Faraday::FilePart.new(__FILE__, 'text/x-ruby', nil,
                                    'Content-Disposition' => 'form-data; foo=1'),
           d: 2
         }
@@ -207,7 +207,7 @@ RSpec.describe Faraday::Request::Multipart do
     let(:payload) do
       {
         json: Faraday::ParamPart.new(json, 'application/json'),
-        io: Faraday::UploadIO.new(io, 'application/pdf')
+        io: Faraday::FilePart.new(io, 'application/pdf')
       }
     end
 
@@ -239,7 +239,7 @@ RSpec.describe Faraday::Request::Multipart do
       {
         a: 1,
         b: [{
-          c: Faraday::UploadIO.new(__FILE__, 'text/x-ruby'),
+          c: Faraday::FilePart.new(__FILE__, 'text/x-ruby'),
           d: 2
         }]
       }
@@ -284,8 +284,8 @@ RSpec.describe Faraday::Request::Multipart do
       {
         a: 1,
         b: [
-          Faraday::UploadIO.new(io, 'application/pdf'),
-          Faraday::UploadIO.new(io, 'application/pdf')
+          Faraday::FilePart.new(io, 'application/pdf'),
+          Faraday::FilePart.new(io, 'application/pdf')
         ]
       }
     end

data/spec/faraday/request/retry_spec.rb

@@ -32,6 +32,18 @@ RSpec.describe Faraday::Request::Retry do
 
       it { expect(times_called).to eq(3) }
     end
+
+    context 'and this is passed as a string custom exception' do
+      let(:options) { [{ exceptions: 'StandardError' }] }
+
+      it { expect(times_called).to eq(3) }
+    end
+
+    context 'and a non-existent string custom exception is passed' do
+      let(:options) { [{ exceptions: 'WrongStandardErrorNotExisting' }] }
+
+      it { expect(times_called).to eq(1) }
+    end
   end
 
   context 'when an expected error happens' do
@@ -169,7 +181,7 @@ RSpec.describe Faraday::Request::Retry do
 
     it 'UploadIO: should rewind files on retry' do
       io = StringIO.new('Test data')
-      upload_io = Faraday::UploadIO.new(io, 'application/octet/stream')
+      upload_io = Faraday::FilePart.new(io, 'application/octet/stream')
 
       rewound = 0
       rewind = -> { rewound += 1 }

data/spec/faraday/request_spec.rb

@@ -22,17 +22,6 @@ RSpec.describe Faraday::Request do
     it { expect(subject.http_method).to eq(:post) }
   end
 
-  describe 'deprecate method for HTTP method' do
-    let(:http_method) { :post }
-    let(:expected_warning) do
-      %r{WARNING: `Faraday::Request#method` is deprecated; use `#http_method` instead. It will be removed in or after version 2.0.\n`Faraday::Request#method` called from .+/spec/faraday/request_spec.rb:\d+.}
-    end
-
-    it { expect(subject.method).to eq(:post) }
-
-    it { expect { subject.method }.to output(expected_warning).to_stderr }
-  end
-
   context 'when setting the url on setup with a URI' do
     let(:block) { proc { |req| req.url URI.parse('foo.json?a=1') } }
 

data/spec/faraday/response/json_spec.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Response::Json, type: :response do
+  let(:options) { {} }
+  let(:headers) { {} }
+  let(:middleware) do
+    described_class.new(lambda { |env|
+      Faraday::Response.new(env)
+    }, **options)
+  end
+
+  def process(body, content_type = 'application/json', options = {})
+    env = {
+      body: body, request: options,
+      request_headers: Faraday::Utils::Headers.new,
+      response_headers: Faraday::Utils::Headers.new(headers)
+    }
+    env[:response_headers]['content-type'] = content_type if content_type
+    yield(env) if block_given?
+    middleware.call(Faraday::Env.from(env))
+  end
+
+  context 'no type matching' do
+    it "doesn't change nil body" do
+      expect(process(nil).body).to be_nil
+    end
+
+    it 'nullifies empty body' do
+      expect(process('').body).to be_nil
+    end
+
+    it 'parses json body' do
+      response = process('{"a":1}')
+      expect(response.body).to eq('a' => 1)
+      expect(response.env[:raw_body]).to be_nil
+    end
+  end
+
+  context 'with preserving raw' do
+    let(:options) { { preserve_raw: true } }
+
+    it 'parses json body' do
+      response = process('{"a":1}')
+      expect(response.body).to eq('a' => 1)
+      expect(response.env[:raw_body]).to eq('{"a":1}')
+    end
+  end
+
+  context 'with default regexp type matching' do
+    it 'parses json body of correct type' do
+      response = process('{"a":1}', 'application/x-json')
+      expect(response.body).to eq('a' => 1)
+    end
+
+    it 'ignores json body of incorrect type' do
+      response = process('{"a":1}', 'text/json-xml')
+      expect(response.body).to eq('{"a":1}')
+    end
+  end
+
+  context 'with array type matching' do
+    let(:options) { { content_type: %w[a/b c/d] } }
+
+    it 'parses json body of correct type' do
+      expect(process('{"a":1}', 'a/b').body).to be_a(Hash)
+      expect(process('{"a":1}', 'c/d').body).to be_a(Hash)
+    end
+
+    it 'ignores json body of incorrect type' do
+      expect(process('{"a":1}', 'a/d').body).not_to be_a(Hash)
+    end
+  end
+
+  it 'chokes on invalid json' do
+    expect { process('{!') }.to raise_error(Faraday::ParsingError)
+  end
+
+  it 'includes the response on the ParsingError instance' do
+    process('{') { |env| env[:response] = Faraday::Response.new }
+    raise 'Parsing should have failed.'
+  rescue Faraday::ParsingError => e
+    expect(e.response).to be_a(Faraday::Response)
+  end
+
+  context 'HEAD responses' do
+    it "nullifies the body if it's only one space" do
+      response = process(' ')
+      expect(response.body).to be_nil
+    end
+
+    it "nullifies the body if it's two spaces" do
+      response = process(' ')
+      expect(response.body).to be_nil
+    end
+  end
+
+  context 'JSON options' do
+    let(:body) { '{"a": 1}' }
+    let(:result) { { a: 1 } }
+    let(:options) do
+      {
+        parser_options: {
+          symbolize_names: true
+        }
+      }
+    end
+
+    it 'passes relevant options to JSON parse' do
+      expect(::JSON).to receive(:parse)
+        .with(body, options[:parser_options])
+        .and_return(result)
+
+      response = process(body)
+      expect(response.body).to eq(result)
+    end
+  end
+end

data/spec/faraday/response/raise_error_spec.rb

@@ -139,7 +139,7 @@ RSpec.describe Faraday::Response::RaiseError do
       Faraday.new do |b|
         b.response :raise_error
         b.adapter :test do |stub|
-          stub.post('request?full=true', request_body, request_headers) do
+          stub.post(url, request_body, request_headers) do
             [400, { 'X-Reason' => 'because' }, 'keep looking']
           end
         end
@@ -147,11 +147,13 @@ RSpec.describe Faraday::Response::RaiseError do
     end
     let(:request_body) { JSON.generate({ 'item' => 'sth' }) }
     let(:request_headers) { { 'Authorization' => 'Basic 123' } }
+    let(:url_path) { 'request' }
+    let(:query_params) { 'full=true' }
+    let(:url) { "#{url_path}?#{query_params}" }
 
     subject(:perform_request) do
-      conn.post 'request' do |req|
+      conn.post url do |req|
         req.headers['Authorization'] = 'Basic 123'
-        req.params[:full] = true
         req.body = request_body
       end
     end
@@ -159,7 +161,8 @@ RSpec.describe Faraday::Response::RaiseError do
     it 'returns the request info in the exception' do
       expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
         expect(ex.response[:request][:method]).to eq(:post)
-        expect(ex.response[:request][:url_path]).to eq('/request')
+        expect(ex.response[:request][:url]).to eq(URI("http:/#{url}"))
+        expect(ex.response[:request][:url_path]).to eq("/#{url_path}")
         expect(ex.response[:request][:params]).to eq({ 'full' => 'true' })
         expect(ex.response[:request][:headers]).to match(a_hash_including(request_headers))
         expect(ex.response[:request][:body]).to eq(request_body)

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

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/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
 
@@ -199,11 +199,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0.alpha.pre.1
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,120 +10,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-09 00:00:00.000000000 Z
+date: 2021-10-25 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.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-- !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.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-patron
-  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-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:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
@@ -173,11 +61,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/encoders/flat_params_encoder.rb
 - lib/faraday/encoders/nested_params_encoder.rb
 - lib/faraday/error.rb
@@ -197,13 +82,13 @@ 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/multipart.rb
 - lib/faraday/request/retry.rb
-- lib/faraday/request/token_authentication.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
@@ -211,15 +96,7 @@ 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
@@ -235,12 +112,13 @@ files:
 - spec/faraday/rack_builder_spec.rb
 - spec/faraday/request/authorization_spec.rb
 - spec/faraday/request/instrumentation_spec.rb
+- spec/faraday/request/json_spec.rb
 - spec/faraday/request/multipart_spec.rb
 - spec/faraday/request/retry_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
@@ -254,13 +132,12 @@ files:
 - 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.7.0
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.0.0.alpha.pre.1
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: 
@@ -272,14 +149,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: HTTP/REST API client library.

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

data/lib/faraday/autoload.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  # Adds the ability for other modules to manage autoloadable
-  # constants.
-  #
-  # @api private
-  module AutoloadHelper
-    # Registers the constants to be auto loaded.
-    #
-    # @param prefix [String] The require prefix. If the path is inside Faraday,
-    #           then it will be prefixed with the root path of this loaded
-    #           Faraday version.
-    # @param options [{ Symbol => String }] library names.
-    #
-    # @example
-    #
-    #   Faraday.autoload_all 'faraday/foo',
-    #     Bar: 'bar'
-    #
-    #   # requires faraday/foo/bar to load Faraday::Bar.
-    #   Faraday::Bar
-    #
-    # @return [void]
-    def autoload_all(prefix, options)
-      if prefix.match? %r{^faraday(/|$)}i
-        prefix = File.join(Faraday.root_path, prefix)
-      end
-
-      options.each do |const_name, path|
-        autoload const_name, File.join(prefix, path)
-      end
-    end
-
-    # Loads each autoloaded constant.  If thread safety is a concern,
-    # wrap this in a Mutex.
-    #
-    # @return [void]
-    def load_autoloaded_constants
-      constants.each do |const|
-        const_get(const) if autoload?(const)
-      end
-    end
-
-    # Filters the module's contents with those that have been already
-    # autoloaded.
-    #
-    # @return [Array<Class, Module>]
-    def all_loaded_constants
-      constants
-        .map { |c| const_get(c) }
-        .select { |a| a.respond_to?(:loaded?) && a.loaded? }
-    end
-  end
-
-  # Adapter is the base class for all Faraday adapters.
-  # @see lib/faraday/adapter.rb Original class location
-  class Adapter
-    extend AutoloadHelper
-    autoload_all 'faraday/adapter',
-                 Typhoeus: 'typhoeus',
-                 Test: 'test'
-  end
-
-  # Request represents a single HTTP request for a Faraday adapter to make.
-  # @see lib/faraday/request.rb Original class location
-  class Request
-    extend AutoloadHelper
-    autoload_all 'faraday/request',
-                 UrlEncoded: 'url_encoded',
-                 Multipart: 'multipart',
-                 Retry: 'retry',
-                 Authorization: 'authorization',
-                 BasicAuthentication: 'basic_authentication',
-                 TokenAuthentication: 'token_authentication',
-                 Instrumentation: 'instrumentation'
-  end
-
-  # Response represents the returned value of a sent Faraday request.
-  # @see lib/faraday/response.rb Original class location
-  class Response
-    extend AutoloadHelper
-    autoload_all 'faraday/response',
-                 RaiseError: 'raise_error',
-                 Logger: 'logger'
-  end
-end

data/lib/faraday/dependency_loader.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  # DependencyLoader helps Faraday adapters and middleware load dependencies.
-  module DependencyLoader
-    attr_reader :load_error
-
-    # Executes a block which should try to require and reference dependent
-    # libraries
-    def dependency(lib = nil)
-      lib ? require(lib) : yield
-    rescue LoadError, NameError => e
-      self.load_error = e
-    end
-
-    def new(*)
-      unless loaded?
-        raise "missing dependency for #{self}: #{load_error.message}"
-      end
-
-      super
-    end
-
-    def loaded?
-      load_error.nil?
-    end
-
-    def inherited(subclass)
-      super
-      subclass.send(:load_error=, load_error)
-    end
-
-    private
-
-    attr_writer :load_error
-  end
-end

data/lib/faraday/request/basic_authentication.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'base64'
-
-module Faraday
-  class Request
-    # Authorization middleware for Basic Authentication.
-    class BasicAuthentication < load_middleware(:authorization)
-      # @param login [String]
-      # @param pass [String]
-      #
-      # @return [String] a Basic Authentication header line
-      def self.header(login, pass)
-        value = Base64.encode64([login, pass].join(':'))
-        value.delete!("\n")
-        super(:Basic, value)
-      end
-    end
-  end
-end