faraday 0.6.0 → 0.9.0

data/lib/faraday/adapter/typhoeus.rb

@@ -1,7 +1,7 @@
 module Faraday
   class Adapter
     class Typhoeus < Faraday::Adapter
-      self.supports_parallel_requests = true
+      self.supports_parallel = true
 
       def self.setup_parallel_manager(options = {})
         options.empty? ? ::Typhoeus::Hydra.hydra : ::Typhoeus::Hydra.new(options)
@@ -11,34 +11,112 @@ module Faraday
 
       def call(env)
         super
+        perform_request env
+        @app.call env
+      end
+
+      def perform_request(env)
+        read_body env
 
-        # TODO: support streaming requests
+        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  => env[:method],
+          :method  => method,
           :body    => env[:body],
           :headers => env[:request_headers],
-          :disable_ssl_peer_verification => (env[:ssl] && !env[:ssl].fetch(:verify, true))
+          :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
 
-        env_req = env[:request]
+      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
 
-        is_parallel = !!env[:parallel_manager]
-        req.on_complete do |resp|
-          env.update :status => resp.code, :body => resp.body
-          response_headers(env).parse resp.headers
-          env[:response].finish(env) if is_parallel
+      def configure_socket(req, env)
+        if bind = request_options(env)[:bind]
+          req.interface = bind[:host]
         end
+      end
 
-        hydra = env[:parallel_manager] || self.class.setup_parallel_manager
-        hydra.queue req
-        hydra.run unless is_parallel
+      def request_options(env)
+        env[:request]
+      end
 
-        @app.call env
-      rescue Errno::ECONNREFUSED
-        raise Error::ConnectionFailed, $!
+      def parallel?(env)
+        !!env[:parallel_manager]
       end
     end
   end

data/lib/faraday/adapter.rb

@@ -1,38 +1,46 @@
 module Faraday
+  # Public: This is a base class for all Faraday adapters.  Adapters are
+  # responsible for fulfilling a Faraday request.
   class Adapter < Middleware
     CONTENT_LENGTH = 'Content-Length'.freeze
 
-    extend AutoloadHelper
+    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']
 
-    autoload_all 'faraday/adapter',
-      :ActionDispatch => 'action_dispatch',
-      :NetHttp        => 'net_http',
-      :Typhoeus       => 'typhoeus',
-      :EMSynchrony    => 'em_synchrony',
-      :Patron         => 'patron',
-      :Excon          => 'excon',
-      :Test           => 'test'
+    # Public: This module marks an Adapter as supporting parallel requests.
+    module Parallelism
+      attr_writer :supports_parallel
+      def supports_parallel?() @supports_parallel end
 
-    register_lookup_modules \
-      :action_dispatch => :ActionDispatch,
-      :test            => :Test,
-      :net_http        => :NetHttp,
-      :typhoeus        => :Typhoeus,
-      :patron          => :Patron,
-      :em_synchrony    => :EMSynchrony,
-      :excon           => :Excon
+      def inherited(subclass)
+        super
+        subclass.supports_parallel = self.supports_parallel?
+      end
+    end
+
+    extend Parallelism
+    self.supports_parallel = false
 
     def call(env)
-      if !env[:body] and Connection::METHODS_WITH_BODIES.include? env[:method]
-        # play nice and indicate we're sending an empty body
-        env[:request_headers][CONTENT_LENGTH] = "0"
-        # Typhoeus hangs on PUT requests if body is nil
-        env[:body] = ''
-      end
+      env.clear_body if env.needs_body?
     end
 
-    def response_headers(env)
-      env[:response_headers] ||= Utils::Headers.new
+    def save_response(env, status, body, headers = nil)
+      env.status = status
+      env.body = body
+      env.response_headers = Utils::Headers.new.tap do |response_headers|
+        response_headers.update headers unless headers.nil?
+        yield(response_headers) if block_given?
+      end
     end
   end
 end

data/lib/faraday/autoload.rb

@@ -0,0 +1,85 @@
+module Faraday
+  # Internal: Adds the ability for other modules to manage autoloadable
+  # constants.
+  module AutoloadHelper
+    # Internal: Registers the constants to be auto loaded.
+    #
+    # prefix  - The String require prefix.  If the path is inside Faraday, then
+    #           it will be prefixed with the root path of this loaded Faraday
+    #           version.
+    # options - Hash of Symbol => String library names.
+    #
+    # Examples.
+    #
+    #   Faraday.autoload_all 'faraday/foo',
+    #     :Bar => 'bar'
+    #
+    #   # requires faraday/foo/bar to load Faraday::Bar.
+    #   Faraday::Bar
+    #
+    #
+    # Returns nothing.
+    def autoload_all(prefix, options)
+      if prefix =~ /^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
+
+    # Internal: Loads each autoloaded constant.  If thread safety is a concern,
+    # wrap this in a Mutex.
+    #
+    # Returns nothing.
+    def load_autoloaded_constants
+      constants.each do |const|
+        const_get(const) if autoload?(const)
+      end
+    end
+
+    # Internal: Filters the module's contents with those that have been already
+    # autoloaded.
+    #
+    # Returns an Array of Class/Module objects.
+    def all_loaded_constants
+      constants.map { |c| const_get(c) }.
+        select { |a| a.respond_to?(:loaded?) && a.loaded? }
+    end
+  end
+
+  class Adapter
+    extend AutoloadHelper
+    autoload_all 'faraday/adapter',
+      :NetHttp           => 'net_http',
+      :NetHttpPersistent => 'net_http_persistent',
+      :Typhoeus          => 'typhoeus',
+      :EMSynchrony       => 'em_synchrony',
+      :EMHttp            => 'em_http',
+      :Patron            => 'patron',
+      :Excon             => 'excon',
+      :Test              => 'test',
+      :Rack              => 'rack',
+      :HTTPClient        => 'httpclient'
+  end
+
+  class Request
+    extend AutoloadHelper
+    autoload_all 'faraday/request',
+      :UrlEncoded => 'url_encoded',
+      :Multipart => 'multipart',
+      :Retry => 'retry',
+      :Timeout => 'timeout',
+      :Authorization => 'authorization',
+      :BasicAuthentication => 'basic_authentication',
+      :TokenAuthentication => 'token_authentication',
+      :Instrumentation => 'instrumentation'
+  end
+
+  class Response
+    extend AutoloadHelper
+    autoload_all 'faraday/response',
+      :RaiseError => 'raise_error',
+      :Logger     => 'logger'
+  end
+end