faraday 2.0.0.alpha.pre.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f77dd46610919ce71119fc9b51f01a0b8d2e5294c279ca4849088d642c72e1d8
-  data.tar.gz: 8f6f37724b2f1d730b11f3c9bf2e3440e952e682c7728f9b5adef86a917cd1dc
+  metadata.gz: 367d509be94da297eac6ece76f5561772218a5982696eba047ef8599d0ff05e1
+  data.tar.gz: 779c66227b778b17661428c17ab65567e23f13ea2824b92251eba67cd32c6280
 SHA512:
-  metadata.gz: 95ed69ec1d3ba8582309cf314c65f3718ee3feff7d15f7e7b75593e23c992c30df5243547618be0ff1bc17da1a346feb72ae5ce7460f10ec086061426270476d
-  data.tar.gz: 8d511875d592606eaab5aef9de57c86f083136ab022cb7cc6db56e4676ea9c6fde624378bca18db294f9dd6a0025fd96228baf5c92d93c539fbd7b6a5d2978d9
+  metadata.gz: 73d405ce87ac4a0917806b16ab11693b68966334656689a95bc06764501c44965832b08fa7bf36beeb71c2144a6661775df4f22b18e8281f664a0605fc2ece49
+  data.tar.gz: 22701db3eb1bb1668aaf6429e711acad05099577b39ccc792d32c42a82043f628483973a993c5ce91acd4207a9f0a01f47a51d6bffc4212047e4150fbb63e1e1

data/examples/client_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe Client do
 
   it 'handles exception' do
     stubs.get('/ebi') do
-      raise Faraday::ConnectionFailed, nil
+      raise Faraday::ConnectionFailed
     end
 
     expect { client.sushi('ebi') }.to raise_error(Faraday::ConnectionFailed)

data/examples/client_test.rb

@@ -60,7 +60,7 @@ class ClientTest < Test::Unit::TestCase
   def test_sushi_exception
     stubs = Faraday::Adapter::Test::Stubs.new
     stubs.get('/ebi') do
-      raise Faraday::ConnectionFailed, nil
+      raise Faraday::ConnectionFailed
     end
 
     cli = client(stubs)

data/lib/faraday/connection.rb

@@ -117,7 +117,7 @@ module Faraday
 
     extend Forwardable
 
-    def_delegators :builder, :build, :use, :request, :response, :adapter, :app
+    def_delegators :builder, :use, :request, :response, :adapter, :app
 
     # Closes the underlying resources and/or connections. In the case of
     # persistent connections, this closes all currently open connections

data/lib/faraday/error.rb

@@ -6,7 +6,7 @@ module Faraday
   class Error < StandardError
     attr_reader :response, :wrapped_exception
 
-    def initialize(exc, response = nil)
+    def initialize(exc = nil, response = nil)
       @wrapped_exception = nil unless defined?(@wrapped_exception)
       @response = nil unless defined?(@response)
       super(exc_msg_and_response!(exc, response))
@@ -141,13 +141,7 @@ module Faraday
   class SSLError < Error
   end
 
-  # Raised by FaradayMiddleware::ResponseMiddleware
+  # Raised by middlewares that parse the response, like the JSON response middleware.
   class ParsingError < Error
   end
-
-  # Exception used to control the Retry middleware.
-  #
-  # @see Faraday::Request::Retry
-  class RetriableResponse < Error
-  end
 end

data/lib/faraday/rack_builder.rb

@@ -58,22 +58,21 @@ module Faraday
       end
     end
 
-    def initialize(handlers = [], adapter = nil, &block)
-      @adapter = adapter
-      @handlers = handlers
-      if block
-        build(&block)
-      elsif @handlers.empty?
-        # default stack, if nothing else is configured
-        request :url_encoded
-        self.adapter Faraday.default_adapter
-      end
+    def initialize(&block)
+      @adapter = nil
+      @handlers = []
+      build(&block)
+    end
+
+    def initialize_dup(original)
+      super
+      @adapter = original.adapter
+      @handlers = original.handlers.dup
     end
 
-    def build(options = {})
+    def build
       raise_if_locked
-      @handlers.clear unless options[:keep]
-      yield(self) if block_given?
+      block_given? ? yield(self) : request(:url_encoded)
       adapter(Faraday.default_adapter) unless @adapter
     end
 
@@ -109,7 +108,7 @@ module Faraday
     end
 
     ruby2_keywords def adapter(klass = NO_ARGUMENT, *args, &block)
-      return @adapter if klass == NO_ARGUMENT
+      return @adapter if klass == NO_ARGUMENT || klass.nil?
 
       klass = Faraday::Adapter.lookup_middleware(klass) if klass.is_a?(Symbol)
       @adapter = self.class::Handler.new(klass, *args, &block)
@@ -164,6 +163,7 @@ module Faraday
     def app
       @app ||= begin
         lock!
+        ensure_adapter!
         to_app
       end
     end
@@ -182,10 +182,6 @@ module Faraday
         @adapter == other.adapter
     end
 
-    def dup
-      self.class.new(@handlers.dup, @adapter.dup)
-    end
-
     # ENV Keys
     # :http_method - a symbolized request HTTP method (:get, :post)
     # :body   - the request body that will eventually be converted to a string.
@@ -216,6 +212,9 @@ 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?
@@ -227,6 +226,10 @@ module Faraday
       raise 'Adapter should be set using the `adapter` method, not `use`'
     end
 
+    def ensure_adapter!
+      raise MISSING_ADAPTER_ERROR unless @adapter
+    end
+
     def adapter_set?
       !@adapter.nil?
     end

data/lib/faraday/request.rb

@@ -133,6 +133,4 @@ end
 require 'faraday/request/authorization'
 require 'faraday/request/instrumentation'
 require 'faraday/request/json'
-require 'faraday/request/multipart'
-require 'faraday/request/retry'
 require 'faraday/request/url_encoded'

data/lib/faraday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faraday
-  VERSION = '2.0.0.alpha-4'
+  VERSION = '2.0.0'
 end

data/lib/faraday.rb

@@ -17,8 +17,6 @@ require 'faraday/middleware'
 require 'faraday/adapter'
 require 'faraday/request'
 require 'faraday/response'
-require 'faraday/file_part'
-require 'faraday/param_part'
 
 # This is the main namespace for Faraday.
 #
@@ -150,5 +148,4 @@ module Faraday
   self.ignore_env_proxy = false
   self.root_path = File.expand_path __dir__
   self.lib_path = File.expand_path 'faraday', __dir__
-  self.default_adapter = :test
 end

data/spec/faraday/connection_spec.rb

@@ -151,6 +151,9 @@ RSpec.describe Faraday::Connection do
   end
 
   describe '#close' do
+    before { Faraday.default_adapter = :test }
+    after { Faraday.default_adapter = nil }
+
     it 'can close underlying app' do
       expect(conn.app).to receive(:close)
       conn.close

data/spec/faraday/rack_builder_spec.rb

@@ -20,6 +20,8 @@ RSpec.describe Faraday::RackBuilder do
   end
 
   subject { conn.builder }
+  before { Faraday.default_adapter = :test }
+  after { Faraday.default_adapter = nil }
 
   context 'with default stack' do
     let(:conn) { Faraday::Connection.new }
@@ -86,13 +88,6 @@ RSpec.describe Faraday::RackBuilder do
 
     it { expect(subject.handlers).to eq([Apple]) }
 
-    it 'allows rebuilding' do
-      subject.build do |builder|
-        builder.use(Orange)
-      end
-      expect(subject.handlers).to eq([Orange])
-    end
-
     it 'allows use' do
       subject.use(Orange)
       expect(subject.handlers).to eq([Apple, Orange])

data/spec/faraday/request/url_encoded_spec.rb

@@ -3,7 +3,6 @@
 RSpec.describe Faraday::Request::UrlEncoded do
   let(:conn) do
     Faraday.new do |b|
-      b.request :multipart
       b.request :url_encoded
       b.adapter :test do |stub|
         stub.post('/echo') do |env|

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

@@ -40,7 +40,6 @@ shared_examples 'adapter examples' do |**options|
     conn_options[:ssl][:ca_file] ||= ENV['SSL_FILE']
 
     Faraday.new(remote, conn_options) do |conn|
-      conn.request :multipart
       conn.request :url_encoded
       conn.response :raise_error
       conn.adapter described_class, *adapter_options

data/spec/support/shared_examples/request_method.rb

@@ -126,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.include?('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'])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha.pre.4
+  version: 2.0.0
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,28 +10,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: multipart-post
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +46,6 @@ files:
 - 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
@@ -77,15 +56,12 @@ 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/instrumentation.rb
 - lib/faraday/request/json.rb
-- lib/faraday/request/multipart.rb
-- lib/faraday/request/retry.rb
 - lib/faraday/request/url_encoded.rb
 - lib/faraday/response.rb
 - lib/faraday/response/json.rb
@@ -99,7 +75,6 @@ files:
 - 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_spec.rb
@@ -113,8 +88,6 @@ files:
 - 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
@@ -137,7 +110,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.0.0.alpha.pre.4
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.0.0
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: 
@@ -152,9 +125,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: 

data/lib/faraday/file_part.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-require 'stringio'
-
-# multipart-post gem
-require 'composite_io'
-require 'parts'
-
-module Faraday
-  # Multipart value used to POST a binary data from a file or
-  #
-  # @example
-  #   payload = { file: Faraday::FilePart.new("file_name.ext", "content/type") }
-  #   http.post("/upload", payload)
-  #
-
-  # @!method initialize(filename_or_io, content_type, filename = nil, opts = {})
-  #
-  #   @param filename_or_io [String, IO] Either a String filename to a local
-  #     file or an open IO object.
-  #   @param content_type [String] String content type of the file data.
-  #   @param filename [String] Optional String filename, usually to add context
-  #     to a given IO object.
-  #   @param opts [Hash] Optional Hash of String key/value pairs to describethis
-  #     this uploaded file. Expected Header keys include:
-  #     * Content-Transfer-Encoding - Defaults to "binary"
-  #     * Content-Disposition - Defaults to "form-data"
-  #     * Content-Type - Defaults to the content_type argument.
-  #     * Content-ID - Optional.
-  #
-  # @return [Faraday::FilePart]
-  #
-  # @!attribute [r] content_type
-  # The uploaded binary data's content type.
-  #
-  # @return [String]
-  #
-  # @!attribute [r] original_filename
-  # The base filename, taken either from the filename_or_io or filename
-  # arguments in #initialize.
-  #
-  # @return [String]
-  #
-  # @!attribute [r] opts
-  # Extra String key/value pairs to make up the header for this uploaded file.
-  #
-  # @return [Hash]
-  #
-  # @!attribute [r] io
-  # The open IO object for the uploaded file.
-  #
-  # @return [IO]
-  FilePart = ::UploadIO
-
-  Parts = ::Parts
-
-  # Similar to, but not compatible with CompositeReadIO provided by the
-  # multipart-post gem.
-  # https://github.com/nicksieger/multipart-post/blob/master/lib/composite_io.rb
-  class CompositeReadIO
-    def initialize(*parts)
-      @parts = parts.flatten
-      @ios = @parts.map(&:to_io)
-      @index = 0
-    end
-
-    # @return [Integer] sum of the lengths of all the parts
-    def length
-      @parts.inject(0) { |sum, part| sum + part.length }
-    end
-
-    # Rewind each of the IOs and reset the index to 0.
-    #
-    # @return [void]
-    def rewind
-      @ios.each(&:rewind)
-      @index = 0
-    end
-
-    # Read from IOs in order until `length` bytes have been received.
-    #
-    # @param length [Integer, nil]
-    # @param outbuf [String, nil]
-    def read(length = nil, outbuf = nil)
-      got_result = false
-      outbuf = outbuf ? (+outbuf).replace('') : +''
-
-      while (io = current_io)
-        if (result = io.read(length))
-          got_result ||= !result.nil?
-          result.force_encoding('BINARY') if result.respond_to?(:force_encoding)
-          outbuf << result
-          length -= result.length if length
-          break if length&.zero?
-        end
-        advance_io
-      end
-      !got_result && length ? nil : outbuf
-    end
-
-    # Close each of the IOs.
-    #
-    # @return [void]
-    def close
-      @ios.each(&:close)
-    end
-
-    def ensure_open_and_readable
-      # Rubinius compatibility
-    end
-
-    private
-
-    def current_io
-      @ios[@index]
-    end
-
-    def advance_io
-      @index += 1
-    end
-  end
-end

data/lib/faraday/param_part.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Faraday
-  # Multipart value used to POST data with a content type.
-  class ParamPart
-    # @param value [String] Uploaded content as a String.
-    # @param content_type [String] String content type of the value.
-    # @param content_id [String] Optional String of this value's Content-ID.
-    #
-    # @return [Faraday::ParamPart]
-    def initialize(value, content_type, content_id = nil)
-      @value = value
-      @content_type = content_type
-      @content_id = content_id
-    end
-
-    # Converts this value to a form part.
-    #
-    # @param boundary [String] String multipart boundary that must not exist in
-    #   the content exactly.
-    # @param key [String] String key name for this value.
-    #
-    # @return [Faraday::Parts::Part]
-    def to_part(boundary, key)
-      Faraday::Parts::Part.new(boundary, key, value, headers)
-    end
-
-    # Returns a Hash of String key/value pairs.
-    #
-    # @return [Hash]
-    def headers
-      {
-        'Content-Type' => content_type,
-        'Content-ID' => content_id
-      }
-    end
-
-    # The content to upload.
-    #
-    # @return [String]
-    attr_reader :value
-
-    # The value's content type.
-    #
-    # @return [String]
-    attr_reader :content_type
-
-    # The value's content ID, if given.
-    #
-    # @return [String, nil]
-    attr_reader :content_id
-  end
-end

data/lib/faraday/request/multipart.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path('url_encoded', __dir__)
-require 'securerandom'
-
-module Faraday
-  class Request
-    # Middleware for supporting multi-part requests.
-    class Multipart < UrlEncoded
-      self.mime_type = 'multipart/form-data'
-      unless defined?(::Faraday::Request::Multipart::DEFAULT_BOUNDARY_PREFIX)
-        DEFAULT_BOUNDARY_PREFIX = '-----------RubyMultipartPost'
-      end
-
-      def initialize(app = nil, options = {})
-        super(app)
-        @options = options
-      end
-
-      # Checks for files in the payload, otherwise leaves everything untouched.
-      #
-      # @param env [Faraday::Env]
-      def call(env)
-        match_content_type(env) do |params|
-          env.request.boundary ||= unique_boundary
-          env.request_headers[CONTENT_TYPE] +=
-            "; boundary=#{env.request.boundary}"
-          env.body = create_multipart(env, params)
-        end
-        @app.call env
-      end
-
-      # @param env [Faraday::Env]
-      def process_request?(env)
-        type = request_type(env)
-        env.body.respond_to?(:each_key) && !env.body.empty? && (
-          (type.empty? && has_multipart?(env.body)) ||
-            (type == self.class.mime_type)
-        )
-      end
-
-      # Returns true if obj is an enumerable with values that are multipart.
-      #
-      # @param obj [Object]
-      # @return [Boolean]
-      def has_multipart?(obj) # rubocop:disable Naming/PredicateName
-        if obj.respond_to?(:each)
-          (obj.respond_to?(:values) ? obj.values : obj).each do |val|
-            return true if val.respond_to?(:content_type) || has_multipart?(val)
-          end
-        end
-        false
-      end
-
-      # @param env [Faraday::Env]
-      # @param params [Hash]
-      def create_multipart(env, params)
-        boundary = env.request.boundary
-        parts = process_params(params) do |key, value|
-          part(boundary, key, value)
-        end
-        parts << Faraday::Parts::EpiloguePart.new(boundary)
-
-        body = Faraday::CompositeReadIO.new(parts)
-        env.request_headers[Faraday::Env::ContentLength] = body.length.to_s
-        body
-      end
-
-      def part(boundary, key, value)
-        if value.respond_to?(:to_part)
-          value.to_part(boundary, key)
-        else
-          Faraday::Parts::Part.new(boundary, key, value)
-        end
-      end
-
-      # @return [String]
-      def unique_boundary
-        "#{DEFAULT_BOUNDARY_PREFIX}-#{SecureRandom.hex}"
-      end
-
-      # @param params [Hash]
-      # @param prefix [String]
-      # @param pieces [Array]
-      def process_params(params, prefix = nil, pieces = nil, &block)
-        params.inject(pieces || []) do |all, (key, value)|
-          if prefix
-            key = @options[:flat_encode] ? prefix.to_s : "#{prefix}[#{key}]"
-          end
-
-          case value
-          when Array
-            values = value.inject([]) { |a, v| a << [nil, v] }
-            process_params(values, key, all, &block)
-          when Hash
-            process_params(value, key, all, &block)
-          else
-            # rubocop:disable Performance/RedundantBlockCall
-            all << block.call(key, value)
-            # rubocop:enable Performance/RedundantBlockCall
-          end
-        end
-      end
-    end
-  end
-end
-
-Faraday::Request.register_middleware(multipart: Faraday::Request::Multipart)