faraday 1.9.0 → 2.4.0

data/lib/faraday/request/json.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Faraday
+  class Request
+    # Request middleware that encodes the body as JSON.
+    #
+    # Processes only requests with matching Content-type or those without a type.
+    # If a request doesn't have a type but has a body, it sets the Content-type
+    # to JSON MIME-type.
+    #
+    # Doesn't try to encode bodies that already are in string form.
+    class Json < Middleware
+      MIME_TYPE = 'application/json'
+      MIME_TYPE_REGEX = %r{^application/(vnd\..+\+)?json$}.freeze
+
+      def on_request(env)
+        match_content_type(env) do |data|
+          env[:body] = encode(data)
+        end
+      end
+
+      private
+
+      def encode(data)
+        ::JSON.generate(data)
+      end
+
+      def match_content_type(env)
+        return unless process_request?(env)
+
+        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+        yield env[:body] unless env[:body].respond_to?(:to_str)
+      end
+
+      def process_request?(env)
+        type = request_type(env)
+        body?(env) && (type.empty? || type.match?(MIME_TYPE_REGEX))
+      end
+
+      def body?(env)
+        (body = env[:body]) && !(body.respond_to?(:to_str) && body.empty?)
+      end
+
+      def request_type(env)
+        type = env[:request_headers][CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware(json: Faraday::Request::Json)

data/lib/faraday/request/url_encoded.rb

@@ -31,7 +31,9 @@ module Faraday
         return unless process_request?(env)
 
         env.request_headers[CONTENT_TYPE] ||= self.class.mime_type
-        yield(env.body) unless env.body.respond_to?(:to_str)
+        return if env.body.respond_to?(:to_str) || env.body.respond_to?(:read)
+
+        yield(env.body)
       end
 
       # @param env [Faraday::Env]
@@ -54,3 +56,5 @@ module Faraday
     end
   end
 end
+
+Faraday::Request.register_middleware(url_encoded: Faraday::Request::UrlEncoded)

data/lib/faraday/request.rb

@@ -26,28 +26,11 @@ module Faraday
   #   @return [RequestOptions] options
   #
   # rubocop:disable Style/StructInheritance
-  class Request < Struct.new(
-    :http_method, :path, :params, :headers, :body, :options
-  )
+  class Request < Struct.new(:http_method, :path, :params, :headers, :body, :options)
     # rubocop:enable Style/StructInheritance
 
     extend MiddlewareRegistry
 
-    register_middleware File.expand_path('request', __dir__),
-                        url_encoded: [:UrlEncoded, 'url_encoded'],
-                        multipart: [:Multipart, 'multipart'],
-                        retry: [:Retry, 'retry'],
-                        authorization: [:Authorization, 'authorization'],
-                        basic_auth: [
-                          :BasicAuthentication,
-                          'basic_authentication'
-                        ],
-                        token_auth: [
-                          :TokenAuthentication,
-                          'token_authentication'
-                        ],
-                        instrumentation: [:Instrumentation, 'instrumentation']
-
     # @param request_method [String]
     # @yield [request] for block customization, if block given
     # @yieldparam request [Request]
@@ -58,14 +41,6 @@ module Faraday
       end
     end
 
-    def method
-      warn <<~TEXT
-        WARNING: `Faraday::Request##{__method__}` is deprecated; use `#http_method` instead. It will be removed in or after version 2.0.
-        `Faraday::Request##{__method__}` called from #{caller_locations(1..1).first}
-      TEXT
-      http_method
-    end
-
     # Replace params, preserving the existing hash type.
     #
     # @param hash [Hash] new params
@@ -140,11 +115,11 @@ module Faraday
     # @param serialised [Hash] the serialised object.
     def marshal_load(serialised)
       self.http_method = serialised[:http_method]
-      self.body        = serialised[:body]
-      self.headers     = serialised[:headers]
-      self.path        = serialised[:path]
-      self.params      = serialised[:params]
-      self.options     = serialised[:options]
+      self.body = serialised[:body]
+      self.headers = serialised[:headers]
+      self.path = serialised[:path]
+      self.params = serialised[:params]
+      self.options = serialised[:options]
     end
 
     # @return [Env] the Env for this Request
@@ -154,3 +129,8 @@ module Faraday
     end
   end
 end
+
+require 'faraday/request/authorization'
+require 'faraday/request/instrumentation'
+require 'faraday/request/json'
+require 'faraday/request/url_encoded'

data/lib/faraday/response/json.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Faraday
+  class Response
+    # Parse response bodies as JSON.
+    class Json < Middleware
+      def initialize(app = nil, parser_options: nil, content_type: /\bjson$/, preserve_raw: false)
+        super(app)
+        @parser_options = parser_options
+        @content_types = Array(content_type)
+        @preserve_raw = preserve_raw
+      end
+
+      def on_complete(env)
+        process_response(env) if parse_response?(env)
+      end
+
+      private
+
+      def process_response(env)
+        env[:raw_body] = env[:body] if @preserve_raw
+        env[:body] = parse(env[:body])
+      rescue StandardError, SyntaxError => e
+        raise Faraday::ParsingError.new(e, env[:response])
+      end
+
+      def parse(body)
+        ::JSON.parse(body, @parser_options || {}) unless body.strip.empty?
+      end
+
+      def parse_response?(env)
+        process_response_type?(env) &&
+          env[:body].respond_to?(:to_str)
+      end
+
+      def process_response_type?(env)
+        type = response_type(env)
+        @content_types.empty? || @content_types.any? do |pattern|
+          pattern.is_a?(Regexp) ? type.match?(pattern) : type == pattern
+        end
+      end
+
+      def response_type(env)
+        type = env[:response_headers][CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(json: Faraday::Response::Json)

data/lib/faraday/response/logger.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require 'logger'
 require 'faraday/logging/formatter'
 
 module Faraday
@@ -11,10 +12,7 @@ module Faraday
     class Logger < Middleware
       def initialize(app, logger = nil, options = {})
         super(app)
-        logger ||= begin
-          require 'logger'
-          ::Logger.new($stdout)
-        end
+        logger ||= ::Logger.new($stdout)
         formatter_class = options.delete(:formatter) || Logging::Formatter
         @formatter = formatter_class.new(logger: logger, options: options)
         yield @formatter if block_given?
@@ -31,3 +29,5 @@ module Faraday
     end
   end
 end
+
+Faraday::Response.register_middleware(logger: Faraday::Response::Logger)

data/lib/faraday/response/raise_error.rb

@@ -44,13 +44,21 @@ module Faraday
           body: env.body,
           request: {
             method: env.method,
+            url: env.url,
             url_path: env.url.path,
-            params: env.params,
+            params: query_params(env),
             headers: env.request_headers,
             body: env.request_body
           }
         }
       end
+
+      def query_params(env)
+        env.request.params_encoder ||= Faraday::Utils.default_params_encoder
+        env.params_encoder.decode(env.url.query)
+      end
     end
   end
 end
+
+Faraday::Response.register_middleware(raise_error: Faraday::Response::RaiseError)

data/lib/faraday/response.rb

@@ -5,25 +5,9 @@ require 'forwardable'
 module Faraday
   # Response represents an HTTP response from making an HTTP request.
   class Response
-    # Used for simple response middleware.
-    class Middleware < Faraday::Middleware
-      # Override this to modify the environment after the response has finished.
-      # Calls the `parse` method if defined
-      # `parse` method can be defined as private, public and protected
-      def on_complete(env)
-        return unless respond_to?(:parse, true) && env.parse_body?
-
-        env.body = parse(env.body)
-      end
-    end
-
     extend Forwardable
     extend MiddlewareRegistry
 
-    register_middleware File.expand_path('response', __dir__),
-                        raise_error: [:RaiseError, 'raise_error'],
-                        logger: [:Logger, 'logger']
-
     def initialize(env = nil)
       @env = Env.from(env) if env
       @on_complete_callbacks = []
@@ -42,6 +26,7 @@ module Faraday
     def headers
       finished? ? env.response_headers : {}
     end
+
     def_delegator :headers, :[]
 
     def body
@@ -53,10 +38,10 @@ module Faraday
     end
 
     def on_complete(&block)
-      if !finished?
-        @on_complete_callbacks << block
-      else
+      if finished?
         yield(env)
+      else
+        @on_complete_callbacks << block
       end
       self
     end
@@ -99,3 +84,7 @@ module Faraday
     end
   end
 end
+
+require 'faraday/response/json'
+require 'faraday/response/logger'
+require 'faraday/response/raise_error'

data/lib/faraday/utils/headers.rb

@@ -111,7 +111,7 @@ module Faraday
       def parse(header_string)
         return unless header_string && !header_string.empty?
 
-        headers = header_string.split(/\r\n/)
+        headers = header_string.split("\r\n")
 
         # Find the last set of response headers.
         start_index = headers.rindex { |x| x.start_with?('HTTP/') } || 0

data/lib/faraday/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'base64'
+require 'uri'
 require 'faraday/utils/headers'
 require 'faraday/utils/params_hash'
 
@@ -51,6 +53,12 @@ module Faraday
       @default_params_encoder ||= NestedParamsEncoder
     end
 
+    def basic_header_from(login, pass)
+      value = Base64.encode64("#{login}:#{pass}")
+      value.delete!("\n")
+      "Basic #{value}"
+    end
+
     class << self
       attr_writer :default_params_encoder
     end
@@ -71,10 +79,7 @@ module Faraday
     end
 
     def default_uri_parser
-      @default_uri_parser ||= begin
-        require 'uri'
-        Kernel.method(:URI)
-      end
+      @default_uri_parser ||= Kernel.method(:URI)
     end
 
     def default_uri_parser=(parser)
@@ -96,7 +101,7 @@ module Faraday
     # Recursive hash update
     def deep_merge!(target, hash)
       hash.each do |key, value|
-        target[key] = if value.is_a?(Hash) && target[key].is_a?(Hash)
+        target[key] = if value.is_a?(Hash) && (target[key].is_a?(Hash) || target[key].is_a?(Options))
                         deep_merge(target[key], value)
                       else
                         value

data/lib/faraday/version.rb

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

data/lib/faraday.rb

@@ -4,16 +4,10 @@ require 'cgi'
 require 'date'
 require 'set'
 require 'forwardable'
-require 'faraday/middleware_registry'
-require 'faraday/dependency_loader'
-
-unless defined?(::Faraday::Timer)
-  require 'timeout'
-  ::Faraday::Timer = Timeout
-end
-
 require 'faraday/version'
 require 'faraday/methods'
+require 'faraday/error'
+require 'faraday/middleware_registry'
 require 'faraday/utils'
 require 'faraday/options'
 require 'faraday/connection'
@@ -23,25 +17,7 @@ require 'faraday/middleware'
 require 'faraday/adapter'
 require 'faraday/request'
 require 'faraday/response'
-require 'faraday/error'
-require 'faraday/request/url_encoded' # needed by multipart
-
-# External Middleware gems
-require 'faraday/multipart'
-require 'faraday/retry'
-
-# External Adapters gems
-unless defined?(JRUBY_VERSION)
-  require 'faraday/em_http'
-  require 'faraday/em_synchrony'
-end
-require 'faraday/excon'
-require 'faraday/httpclient'
 require 'faraday/net_http'
-require 'faraday/net_http_persistent'
-require 'faraday/patron'
-require 'faraday/rack'
-
 # This is the main namespace for Faraday.
 #
 # It provides methods to create {Connection} objects, and HTTP-related
@@ -55,6 +31,8 @@ require 'faraday/rack'
 #   conn.get '/'
 #
 module Faraday
+  CONTENT_TYPE = 'Content-Type'
+
   class << self
     # The root path that Faraday is being loaded from.
     #
@@ -76,6 +54,10 @@ module Faraday
     #   @return [Symbol] the new default_adapter.
     attr_reader :default_adapter
 
+    # Option for the default_adapter
+    #   @return [Hash] default_adapter options
+    attr_accessor :default_adapter_options
+
     # Documented below, see default_connection
     attr_writer :default_connection
 
@@ -112,23 +94,10 @@ module Faraday
     #               params: { page: 1 }
     #   # => Faraday::Connection to http://faraday.com?page=1
     def new(url = nil, options = {}, &block)
-      options = default_connection_options.merge(options)
+      options = Utils.deep_merge(default_connection_options, options)
       Faraday::Connection.new(url, options, &block)
     end
 
-    # @private
-    # Internal: Requires internal Faraday libraries.
-    #
-    # @param libs [Array] one or more relative String names to Faraday classes.
-    # @return [void]
-    def require_libs(*libs)
-      libs.each do |lib|
-        require "#{lib_path}/#{lib}"
-      end
-    end
-
-    alias require_lib require_libs
-
     # Documented elsewhere, see default_adapter reader
     def default_adapter=(adapter)
       @default_connection = nil
@@ -184,6 +153,5 @@ module Faraday
   self.root_path = File.expand_path __dir__
   self.lib_path = File.expand_path 'faraday', __dir__
   self.default_adapter = :net_http
-
-  require_lib 'autoload' unless ENV['FARADAY_NO_AUTOLOAD']
+  self.default_adapter_options = {}
 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