faraday 0.9.2 → 1.0.0

data/lib/faraday/adapter/test.rb

@@ -1,26 +1,56 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
-    # test = Faraday::Connection.new do
-    #   use Faraday::Adapter::Test do |stub|
-    #     stub.get '/nigiri/sake.json' do
-    #       [200, {}, 'hi world']
+    # @example
+    #   test = Faraday::Connection.new do
+    #     use Faraday::Adapter::Test do |stub|
+    #       # Define matcher to match the request
+    #       stub.get '/resource.json' do
+    #         # return static content
+    #         [200, {'Content-Type' => 'application/json'}, 'hi world']
+    #       end
+    #
+    #       # response with content generated based on request
+    #       stub.get '/showget' do |env|
+    #         [200, {'Content-Type' => 'text/plain'}, env[:method].to_s]
+    #       end
+    #
+    #       # A regular expression can be used as matching filter
+    #       stub.get /\A\/items\/(\d+)\z/ do |env, meta|
+    #         # in case regular expression is used, an instance of MatchData
+    #         # can be received
+    #         [200,
+    #          {'Content-Type' => 'text/plain'},
+    #          "showing item: #{meta[:match_data][1]}"
+    #         ]
+    #       end
     #     end
     #   end
-    # end
     #
-    # resp = test.get '/nigiri/sake.json'
-    # resp.body # => 'hi world'
+    #   resp = test.get '/resource.json'
+    #   resp.body # => 'hi world'
     #
+    #   resp = test.get '/showget'
+    #   resp.body # => 'get'
+    #
+    #   resp = test.get '/items/1'
+    #   resp.body # => 'showing item: 1'
+    #
+    #   resp = test.get '/items/2'
+    #   resp.body # => 'showing item: 2'
     class Test < Faraday::Adapter
       attr_accessor :stubs
 
+      # A stack of Stubs
       class Stubs
         class NotFound < StandardError
         end
 
         def initialize
-          # {:get => [Stub, Stub]}
-          @stack, @consumed = {}, {}
+          # { get: [Stub, Stub] }
+          @stack = {}
+          @consumed = {}
           yield(self) if block_given?
         end
 
@@ -28,17 +58,18 @@ module Faraday
           @stack.empty?
         end
 
-        def match(request_method, path, headers, body)
-          return false if !@stack.key?(request_method)
+        def match(request_method, host, path, headers, body)
+          return false unless @stack.key?(request_method)
+
           stack = @stack[request_method]
           consumed = (@consumed[request_method] ||= [])
 
-          if stub = matches?(stack, path, headers, body)
+          stub, meta = matches?(stack, host, path, headers, body)
+          if stub
             consumed << stack.delete(stub)
-            stub
-          else
-            matches?(consumed, path, headers, body)
+            return stub, meta
           end
+          matches?(consumed, host, path, headers, body)
         end
 
         def get(path, headers = {}, &block)
@@ -49,15 +80,15 @@ module Faraday
           new_stub(:head, path, headers, &block)
         end
 
-        def post(path, body=nil, headers = {}, &block)
+        def post(path, body = nil, headers = {}, &block)
           new_stub(:post, path, headers, body, &block)
         end
 
-        def put(path, body=nil, headers = {}, &block)
+        def put(path, body = nil, headers = {}, &block)
           new_stub(:put, path, headers, body, &block)
         end
 
-        def patch(path, body=nil, headers = {}, &block)
+        def patch(path, body = nil, headers = {}, &block)
           new_stub(:patch, path, headers, body, &block)
         end
 
@@ -73,45 +104,83 @@ module Faraday
         def verify_stubbed_calls
           failed_stubs = []
           @stack.each do |method, stubs|
-            unless stubs.size == 0
-              failed_stubs.concat(stubs.map {|stub|
+            next if stubs.empty?
+
+            failed_stubs.concat(
+              stubs.map do |stub|
                 "Expected #{method} #{stub}."
-              })
-            end
+              end
+            )
           end
-          raise failed_stubs.join(" ") unless failed_stubs.size == 0
+          raise failed_stubs.join(' ') unless failed_stubs.empty?
         end
 
         protected
 
-        def new_stub(request_method, path, headers = {}, body=nil, &block)
-          normalized_path = Faraday::Utils.normalize_path(path)
-          (@stack[request_method] ||= []) << Stub.new(normalized_path, headers, body, block)
+        def new_stub(request_method, path, headers = {}, body = nil, &block)
+          normalized_path, host =
+            if path.is_a?(Regexp)
+              path
+            else
+              [
+                Faraday::Utils.normalize_path(path),
+                Faraday::Utils.URI(path).host
+              ]
+            end
+
+          stub = Stub.new(host, normalized_path, headers, body, block)
+          (@stack[request_method] ||= []) << stub
         end
 
-        def matches?(stack, path, headers, body)
-          stack.detect { |stub| stub.matches?(path, headers, body) }
+        def matches?(stack, host, path, headers, body)
+          stack.each do |stub|
+            match_result, meta = stub.matches?(host, path, headers, body)
+            return stub, meta if match_result
+          end
+          nil
         end
       end
 
-      class Stub < Struct.new(:path, :params, :headers, :body, :block)
-        def initialize(full, headers, body, block)
-          path, query = full.split('?')
-          params = query ?
-            Faraday::Utils.parse_nested_query(query) :
-            {}
-          super(path, params, headers, body, block)
+      # Stub request
+      # rubocop:disable Style/StructInheritance
+      class Stub < Struct.new(:host, :path, :params, :headers, :body, :block)
+        # rubocop:enable Style/StructInheritance
+        def initialize(host, full, headers, body, block)
+          path, query = full.respond_to?(:split) ? full.split('?') : full
+          params =
+            if query
+              Faraday::Utils.parse_nested_query(query)
+            else
+              {}
+            end
+
+          super(host, path, params, headers, body, block)
         end
 
-        def matches?(request_uri, request_headers, request_body)
+        def matches?(request_host, request_uri, request_headers, request_body)
           request_path, request_query = request_uri.split('?')
-          request_params = request_query ?
-            Faraday::Utils.parse_nested_query(request_query) :
-            {}
-          request_path == path &&
+          request_params =
+            if request_query
+              Faraday::Utils.parse_nested_query(request_query)
+            else
+              {}
+            end
+          # meta is a hash used as carrier
+          # that will be yielded to consumer block
+          meta = {}
+          [(host.nil? || host == request_host) &&
+            path_match?(request_path, meta) &&
             params_match?(request_params) &&
             (body.to_s.size.zero? || request_body == body) &&
-            headers_match?(request_headers)
+            headers_match?(request_headers), meta]
+        end
+
+        def path_match?(request_path, meta)
+          if path.is_a?(Regexp)
+            !!(meta[:match_data] = path.match(request_path))
+          else
+            path == request_path
+          end
         end
 
         def params_match?(request_params)
@@ -131,7 +200,7 @@ module Faraday
         end
       end
 
-      def initialize(app, stubs=nil, &block)
+      def initialize(app, stubs = nil, &block)
         super(app)
         @stubs = stubs || Stubs.new
         configure(&block) if block
@@ -143,18 +212,33 @@ module Faraday
 
       def call(env)
         super
+        host = env[:url].host
         normalized_path = Faraday::Utils.normalize_path(env[:url])
-        params_encoder = env.request.params_encoder || Faraday::Utils.default_params_encoder
+        params_encoder = env.request.params_encoder ||
+                         Faraday::Utils.default_params_encoder
+
+        stub, meta = stubs.match(env[:method], host, normalized_path,
+                                 env.request_headers, env[:body])
+
+        unless stub
+          raise Stubs::NotFound, "no stubbed request for #{env[:method]} "\
+                                 "#{normalized_path} #{env[:body]}"
+        end
+
+        env[:params] = if (query = env[:url].query)
+                         params_encoder.decode(query)
+                       else
+                         {}
+                       end
+        block_arity = stub.block.arity
+        status, headers, body =
+          if block_arity >= 0
+            stub.block.call(*[env, meta].take(block_arity))
+          else
+            stub.block.call(env, meta)
+          end
+        save_response(env, status, body, headers)
 
-        if stub = stubs.match(env[:method], normalized_path, env.request_headers, env[:body])
-          env[:params] = (query = env[:url].query) ?
-            params_encoder.decode(query)  :
-            {}
-          status, headers, body = stub.block.call(env)
-          save_response(env, status, body, headers)
-        else
-          raise Stubs::NotFound, "no stubbed request for #{env[:method]} #{normalized_path} #{env[:body]}"
-        end
         @app.call(env)
       end
     end

data/lib/faraday/adapter/typhoeus.rb

@@ -1,123 +1,15 @@
+# frozen_string_literal: true
+
 module Faraday
   class Adapter
+    # Typhoeus adapter. This class is just a stub, the real adapter is in
+    # https://github.com/philsturgeon/typhoeus/blob/master/lib/typhoeus/adapters/faraday.rb
     class Typhoeus < Faraday::Adapter
-      self.supports_parallel = true
-
-      def self.setup_parallel_manager(options = {})
-        options.empty? ? ::Typhoeus::Hydra.hydra : ::Typhoeus::Hydra.new(options)
-      end
+      # Needs to define this method in order to support Typhoeus <= 1.3.0
+      def call; end
 
       dependency 'typhoeus'
-
-      def call(env)
-        super
-        perform_request env
-        @app.call env
-      end
-
-      def perform_request(env)
-        read_body env
-
-        hydra = env[:parallel_manager] || self.class.setup_parallel_manager
-        hydra.queue request(env)
-        hydra.run unless parallel?(env)
-      rescue Errno::ECONNREFUSED
-        raise Error::ConnectionFailed, $!
-      end
-
-      # TODO: support streaming requests
-      def read_body(env)
-        env[:body] = env[:body].read if env[:body].respond_to? :read
-      end
-
-      def request(env)
-        method = env[:method]
-        # For some reason, prevents Typhoeus from using "100-continue".
-        # We want this because Webrick 1.3.1 can't seem to handle it w/ PUT.
-        method = method.to_s.upcase if method == :put
-
-        req = ::Typhoeus::Request.new env[:url].to_s,
-          :method  => method,
-          :body    => env[:body],
-          :headers => env[:request_headers],
-          :disable_ssl_peer_verification => (env[:ssl] && env[:ssl].disable?)
-
-        configure_ssl     req, env
-        configure_proxy   req, env
-        configure_timeout req, env
-        configure_socket  req, env
-
-        req.on_complete do |resp|
-          if resp.timed_out?
-            if parallel?(env)
-              # TODO: error callback in async mode
-            else
-              raise Faraday::Error::TimeoutError, "request timed out"
-            end
-          end
-
-          case resp.curl_return_code
-          when 0
-            # everything OK
-          when 7
-            raise Error::ConnectionFailed, resp.curl_error_message
-          when 60
-            raise Faraday::SSLError, resp.curl_error_message
-          else
-            raise Error::ClientError, resp.curl_error_message
-          end
-
-          save_response(env, resp.code, resp.body) do |response_headers|
-            response_headers.parse resp.headers
-          end
-          # in async mode, :response is initialized at this point
-          env[:response].finish(env) if parallel?(env)
-        end
-
-        req
-      end
-
-      def configure_ssl(req, env)
-        ssl = env[:ssl]
-
-        req.ssl_version = ssl[:version]          if ssl[:version]
-        req.ssl_cert    = ssl[:client_cert] if ssl[:client_cert]
-        req.ssl_key     = ssl[:client_key]  if ssl[:client_key]
-        req.ssl_cacert  = ssl[:ca_file]          if ssl[:ca_file]
-        req.ssl_capath  = ssl[:ca_path]          if ssl[:ca_path]
-      end
-
-      def configure_proxy(req, env)
-        proxy = request_options(env)[:proxy]
-        return unless proxy
-
-        req.proxy = "#{proxy[:uri].host}:#{proxy[:uri].port}"
-
-        if proxy[:user] && proxy[:password]
-          req.proxy_username = proxy[:user]
-          req.proxy_password = proxy[:password]
-        end
-      end
-
-      def configure_timeout(req, env)
-        env_req = request_options(env)
-        req.timeout = req.connect_timeout = (env_req[:timeout] * 1000) if env_req[:timeout]
-        req.connect_timeout = (env_req[:open_timeout] * 1000)          if env_req[:open_timeout]
-      end
-
-      def configure_socket(req, env)
-        if bind = request_options(env)[:bind]
-          req.interface = bind[:host]
-        end
-      end
-
-      def request_options(env)
-        env[:request]
-      end
-
-      def parallel?(env)
-        !!env[:parallel_manager]
-      end
+      dependency 'typhoeus/adapters/faraday'
     end
   end
 end

data/lib/faraday/adapter.rb

@@ -1,46 +1,115 @@
+# frozen_string_literal: true
+
 module Faraday
-  # Public: This is a base class for all Faraday adapters.  Adapters are
+  # Base class for all Faraday adapters. Adapters are
   # responsible for fulfilling a Faraday request.
-  class Adapter < Middleware
-    CONTENT_LENGTH = 'Content-Length'.freeze
-
-    register_middleware File.expand_path('../adapter', __FILE__),
-      :test => [:Test, 'test'],
-      :net_http => [:NetHttp, 'net_http'],
-      :net_http_persistent => [:NetHttpPersistent, 'net_http_persistent'],
-      :typhoeus => [:Typhoeus, 'typhoeus'],
-      :patron => [:Patron, 'patron'],
-      :em_synchrony => [:EMSynchrony, 'em_synchrony'],
-      :em_http => [:EMHttp, 'em_http'],
-      :excon => [:Excon, 'excon'],
-      :rack => [:Rack, 'rack'],
-      :httpclient => [:HTTPClient, 'httpclient']
-
-    # Public: This module marks an Adapter as supporting parallel requests.
+  class Adapter
+    extend MiddlewareRegistry
+    extend DependencyLoader
+
+    CONTENT_LENGTH = 'Content-Length'
+
+    register_middleware File.expand_path('adapter', __dir__),
+                        test: [:Test, 'test'],
+                        net_http: [:NetHttp, 'net_http'],
+                        net_http_persistent: [
+                          :NetHttpPersistent,
+                          'net_http_persistent'
+                        ],
+                        typhoeus: [:Typhoeus, 'typhoeus'],
+                        patron: [:Patron, 'patron'],
+                        em_synchrony: [:EMSynchrony, 'em_synchrony'],
+                        em_http: [:EMHttp, 'em_http'],
+                        excon: [:Excon, 'excon'],
+                        rack: [:Rack, 'rack'],
+                        httpclient: [:HTTPClient, 'httpclient']
+
+    # This module marks an Adapter as supporting parallel requests.
     module Parallelism
       attr_writer :supports_parallel
-      def supports_parallel?() @supports_parallel end
+      def supports_parallel?
+        @supports_parallel
+      end
 
       def inherited(subclass)
         super
-        subclass.supports_parallel = self.supports_parallel?
+        subclass.supports_parallel = supports_parallel?
       end
     end
 
     extend Parallelism
     self.supports_parallel = false
 
+    def initialize(_app = nil, opts = {}, &block)
+      @app = ->(env) { env.response }
+      @connection_options = opts
+      @config_block = block
+    end
+
+    # Yields or returns an adapter's configured connection. Depends on
+    # #build_connection being defined on this adapter.
+    #
+    # @param env [Faraday::Env, Hash] The env object for a faraday request.
+    #
+    # @return The return value of the given block, or the HTTP connection object
+    #         if no block is given.
+    def connection(env)
+      conn = build_connection(env)
+      return conn unless block_given?
+
+      yield conn
+    end
+
+    # Close any persistent connections. The adapter should still be usable
+    # after calling close.
+    def close
+      # Possible implementation:
+      #   @app.close if @app.respond_to?(:close)
+    end
+
     def call(env)
       env.clear_body if env.needs_body?
+      env.response = Response.new
     end
 
-    def save_response(env, status, body, headers = nil)
+    private
+
+    def save_response(env, status, body, headers = nil, reason_phrase = nil)
       env.status = status
       env.body = body
+      env.reason_phrase = reason_phrase&.to_s&.strip
       env.response_headers = Utils::Headers.new.tap do |response_headers|
         response_headers.update headers unless headers.nil?
         yield(response_headers) if block_given?
       end
+
+      env.response.finish(env) unless env.parallel?
+      env.response
     end
+
+    # Fetches either a read, write, or open timeout setting. Defaults to the
+    # :timeout value if a more specific one is not given.
+    #
+    # @param type [Symbol] Describes which timeout setting to get: :read,
+    #                      :write, or :open.
+    # @param options [Hash] Hash containing Symbol keys like :timeout,
+    #                       :read_timeout, :write_timeout, :open_timeout, or
+    #                       :timeout
+    #
+    # @return [Integer, nil] Timeout duration in seconds, or nil if no timeout
+    #                        has been set.
+    def request_timeout(type, options)
+      key = TIMEOUT_KEYS.fetch(type) do
+        msg = "Expected :read, :write, :open. Got #{type.inspect} :("
+        raise ArgumentError, msg
+      end
+      options[key] || options[:timeout]
+    end
+
+    TIMEOUT_KEYS = {
+      read: :read_timeout,
+      open: :open_timeout,
+      write: :write_timeout
+    }.freeze
   end
 end

data/lib/faraday/adapter_registry.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'monitor'
+
+module Faraday
+  # AdapterRegistry registers adapter class names so they can be looked up by a
+  # String or Symbol name.
+  class AdapterRegistry
+    def initialize
+      @lock = Monitor.new
+      @constants = {}
+    end
+
+    def get(name)
+      klass = @constants[name]
+      return klass if klass
+
+      Object.const_get(name).tap { |c| set(c, name) }
+    end
+
+    def set(klass, name = nil)
+      name ||= klass.to_s
+      @lock.synchronize do
+        @constants[name] = klass
+      end
+    end
+  end
+end