faraday 0.6.0 → 0.9.0

data/lib/faraday/adapter/httpclient.rb

@@ -0,0 +1,106 @@
+module Faraday
+  class Adapter
+    class HTTPClient < Faraday::Adapter
+      dependency 'httpclient'
+
+      def client
+        @client ||= ::HTTPClient.new
+      end
+
+      def call(env)
+        super
+
+        if req = env[:request]
+          if proxy = req[:proxy]
+            configure_proxy proxy
+          end
+
+          if bind = req[:bind]
+            configure_socket bind
+          end
+
+          configure_timeouts req
+        end
+
+        if env[:url].scheme == 'https' && ssl = env[:ssl]
+          configure_ssl ssl
+        end
+
+        # TODO Don't stream yet.
+        # https://github.com/nahi/httpclient/pull/90
+        env[:body] = env[:body].read if env[:body].respond_to? :read
+
+        resp = client.request env[:method], env[:url],
+          :body   => env[:body],
+          :header => env[:request_headers]
+
+        save_response env, resp.status, resp.body, resp.headers
+
+        @app.call env
+      rescue ::HTTPClient::TimeoutError
+        raise Faraday::Error::TimeoutError, $!
+      rescue ::HTTPClient::BadResponseError => err
+        if err.message.include?('status 407')
+          raise Faraday::Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
+        else
+          raise Faraday::Error::ClientError, $!
+        end
+      rescue Errno::ECONNREFUSED, EOFError
+        raise Faraday::Error::ConnectionFailed, $!
+      rescue => err
+        if defined?(OpenSSL) && OpenSSL::SSL::SSLError === err
+          raise Faraday::SSLError, err
+        else
+          raise
+        end
+      end
+
+      def configure_socket(bind)
+        client.socket_local.host = bind[:host]
+        client.socket_local.port = bind[:port]
+      end
+
+      def configure_proxy(proxy)
+        client.proxy = proxy[:uri]
+        if proxy[:user] && proxy[:password]
+          client.set_proxy_auth proxy[:user], proxy[:password]
+        end
+      end
+
+      def configure_ssl(ssl)
+        ssl_config = client.ssl_config
+
+        ssl_config.add_trust_ca ssl[:ca_file]        if ssl[:ca_file]
+        ssl_config.add_trust_ca ssl[:ca_path]        if ssl[:ca_path]
+        ssl_config.cert_store   = ssl[:cert_store]   if ssl[:cert_store]
+        ssl_config.client_cert  = ssl[:client_cert]  if ssl[:client_cert]
+        ssl_config.client_key   = ssl[:client_key]   if ssl[:client_key]
+        ssl_config.verify_depth = ssl[:verify_depth] if ssl[:verify_depth]
+        ssl_config.verify_mode  = ssl_verify_mode(ssl)
+      end
+
+      def configure_timeouts(req)
+        if req[:timeout]
+          client.connect_timeout   = req[:timeout]
+          client.receive_timeout   = req[:timeout]
+          client.send_timeout      = req[:timeout]
+        end
+
+        if req[:open_timeout]
+          client.connect_timeout   = req[:open_timeout]
+          client.send_timeout      = req[:open_timeout]
+        end
+      end
+
+      def ssl_verify_mode(ssl)
+        ssl[:verify_mode] || begin
+          if ssl.fetch(:verify, true)
+            OpenSSL::SSL::VERIFY_PEER | OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+          else
+            OpenSSL::SSL::VERIFY_NONE
+          end
+        end
+      end
+    end
+  end
+end

data/lib/faraday/adapter/net_http.rb

@@ -4,68 +4,119 @@ rescue LoadError
   warn "Warning: no such file to load -- net/https. Make sure openssl is installed if you want ssl support"
   require 'net/http'
 end
+require 'zlib'
 
 module Faraday
   class Adapter
     class NetHttp < Faraday::Adapter
-      def call(env)
-        super
-        url = env[:url]
-        req = env[:request]
+      NET_HTTP_EXCEPTIONS = [
+        EOFError,
+        Errno::ECONNABORTED,
+        Errno::ECONNREFUSED,
+        Errno::ECONNRESET,
+        Errno::EHOSTUNREACH,
+        Errno::EINVAL,
+        Errno::ENETUNREACH,
+        Net::HTTPBadResponse,
+        Net::HTTPHeaderSyntaxError,
+        Net::ProtocolError,
+        SocketError,
+        Zlib::GzipFile::Error,
+      ]
 
-        http = net_http_class(env).new(url.host, url.inferred_port)
+      NET_HTTP_EXCEPTIONS << OpenSSL::SSL::SSLError if defined?(OpenSSL)
 
-        if http.use_ssl = (url.scheme == 'https' && env[:ssl])
-          ssl = env[:ssl]
-          http.verify_mode = ssl[:verify_mode] || ssl.fetch(:verify, true) ?
-                               OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
-          http.cert        = ssl[:client_cert] if ssl[:client_cert]
-          http.key         = ssl[:client_key]  if ssl[:client_key]
-          http.ca_file     = ssl[:ca_file]     if ssl[:ca_file]
-          http.cert_store  = ssl[:cert_store]  if ssl[:cert_store]
-        end
+      def call(env)
+        super
+        http = net_http_connection(env)
+        configure_ssl(http, env[:ssl]) if env[:url].scheme == 'https' and env[:ssl]
 
+        req = env[:request]
         http.read_timeout = http.open_timeout = req[:timeout] if req[:timeout]
         http.open_timeout = req[:open_timeout]                if req[:open_timeout]
 
-        if :get != env[:method]
-          http_request = Net::HTTPGenericRequest.new \
-            env[:method].to_s.upcase,    # request method
-            !!env[:body],                # is there data
-            true,                        # does net/http love you, true or false?
-            url.request_uri,             # request uri path
-            env[:request_headers]        # request headers
-
-          if env[:body].respond_to?(:read)
-            http_request.body_stream = env[:body]
-            env[:body] = nil
-          end
-        end
-
         begin
-          http_response = if :get == env[:method]
-            # prefer `get` to `request` because the former handles gzip (ruby 1.9)
-            http.get url.request_uri, env[:request_headers]
+          http_response = perform_request(http, env)
+        rescue *NET_HTTP_EXCEPTIONS => err
+          if defined?(OpenSSL) && OpenSSL::SSL::SSLError === err
+            raise Faraday::SSLError, err
           else
-            http.request http_request, env[:body]
+            raise Error::ConnectionFailed, err
           end
-        rescue Errno::ECONNREFUSED
-          raise Error::ConnectionFailed, $!
         end
 
-        http_response.each_header do |key, value|
-          response_headers(env)[key] = value
+        save_response(env, http_response.code.to_i, http_response.body || '') do |response_headers|
+          http_response.each_header do |key, value|
+            response_headers[key] = value
+          end
         end
-        env.update :status => http_response.code.to_i, :body => http_response.body
 
         @app.call env
+      rescue Timeout::Error => err
+        raise Faraday::Error::TimeoutError, err
+      end
+
+      def create_request(env)
+        request = Net::HTTPGenericRequest.new \
+          env[:method].to_s.upcase,    # request method
+          !!env[:body],                # is there request body
+          :head != env[:method],       # is there response body
+          env[:url].request_uri,       # request uri path
+          env[:request_headers]        # request headers
+
+        if env[:body].respond_to?(:read)
+          request.body_stream = env[:body]
+        else
+          request.body = env[:body]
+        end
+        request
+      end
+
+      def perform_request(http, env)
+        if :get == env[:method] and !env[:body]
+          # prefer `get` to `request` because the former handles gzip (ruby 1.9)
+          http.get env[:url].request_uri, env[:request_headers]
+        else
+          http.request create_request(env)
+        end
       end
 
-      def net_http_class(env)
+      def net_http_connection(env)
         if proxy = env[:request][:proxy]
           Net::HTTP::Proxy(proxy[:uri].host, proxy[:uri].port, proxy[:user], proxy[:password])
         else
           Net::HTTP
+        end.new(env[:url].host, env[:url].port)
+      end
+
+      def configure_ssl(http, ssl)
+        http.use_ssl      = true
+        http.verify_mode  = ssl_verify_mode(ssl)
+        http.cert_store   = ssl_cert_store(ssl)
+
+        http.cert         = ssl[:client_cert]  if ssl[:client_cert]
+        http.key          = ssl[:client_key]   if ssl[:client_key]
+        http.ca_file      = ssl[:ca_file]      if ssl[:ca_file]
+        http.ca_path      = ssl[:ca_path]      if ssl[:ca_path]
+        http.verify_depth = ssl[:verify_depth] if ssl[:verify_depth]
+        http.ssl_version  = ssl[:version]      if ssl[:version]
+      end
+
+      def ssl_cert_store(ssl)
+        return ssl[:cert_store] if ssl[:cert_store]
+        # Use the default cert store by default, i.e. system ca certs
+        cert_store = OpenSSL::X509::Store.new
+        cert_store.set_default_paths
+        cert_store
+      end
+
+      def ssl_verify_mode(ssl)
+        ssl[:verify_mode] || begin
+          if ssl.fetch(:verify, true)
+            OpenSSL::SSL::VERIFY_PEER
+          else
+            OpenSSL::SSL::VERIFY_NONE
+          end
         end
       end
     end

data/lib/faraday/adapter/net_http_persistent.rb

@@ -0,0 +1,47 @@
+# Rely on autoloading instead of explicit require; helps avoid the "already
+# initialized constant" warning on Ruby 1.8.7 when NetHttp is refereced below.
+# require 'faraday/adapter/net_http'
+
+module Faraday
+  class Adapter
+    # Experimental adapter for net-http-persistent
+    class NetHttpPersistent < NetHttp
+      dependency 'net/http/persistent'
+
+      def net_http_connection(env)
+        if proxy = env[:request][:proxy]
+          proxy_uri = ::URI::HTTP === proxy[:uri] ? proxy[:uri].dup : ::URI.parse(proxy[:uri].to_s)
+          proxy_uri.user = proxy_uri.password = nil
+          # awful patch for net-http-persistent 2.8 not unescaping user/password
+          (class << proxy_uri; self; end).class_eval do
+            define_method(:user) { proxy[:user] }
+            define_method(:password) { proxy[:password] }
+          end if proxy[:user]
+        end
+        Net::HTTP::Persistent.new 'Faraday', proxy_uri
+      end
+
+      def perform_request(http, env)
+        http.request env[:url], create_request(env)
+      rescue Net::HTTP::Persistent::Error => error
+        if error.message.include? 'Timeout'
+          raise Faraday::Error::TimeoutError, error
+        elsif error.message.include? 'connection refused'
+          raise Faraday::Error::ConnectionFailed, error
+        else
+          raise
+        end
+      end
+
+      def configure_ssl(http, ssl)
+        http.verify_mode  = ssl_verify_mode(ssl)
+        http.cert_store   = ssl_cert_store(ssl)
+
+        http.certificate  = ssl[:client_cert]  if ssl[:client_cert]
+        http.private_key  = ssl[:client_key]   if ssl[:client_key]
+        http.ca_file      = ssl[:ca_file]      if ssl[:ca_file]
+        http.ssl_version  = ssl[:version]      if ssl[:version]
+      end
+    end
+  end
+end

data/lib/faraday/adapter/patron.rb

@@ -3,28 +3,65 @@ module Faraday
     class Patron < Faraday::Adapter
       dependency 'patron'
 
+      def initialize(app, &block)
+        super(app)
+        @block = block
+      end
+
       def call(env)
         super
 
         # TODO: support streaming requests
         env[:body] = env[:body].read if env[:body].respond_to? :read
 
-        session = ::Patron::Session.new
+        session = @session ||= create_session
 
-        response = begin
-          if Connection::METHODS_WITH_BODIES.include? env[:method]
-            session.send(env[:method], env[:url].to_s, env[:body].to_s, env[:request_headers])
-          else
-            session.send(env[:method], env[:url].to_s, env[:request_headers])
+        if req = env[:request]
+          session.timeout = session.connect_timeout = req[:timeout] if req[:timeout]
+          session.connect_timeout = req[:open_timeout]              if req[:open_timeout]
+
+          if proxy = req[:proxy]
+            proxy_uri = proxy[:uri].dup
+            proxy_uri.user = proxy[:user] && Utils.escape(proxy[:user]).gsub('+', '%20')
+            proxy_uri.password = proxy[:password] && Utils.escape(proxy[:password]).gsub('+', '%20')
+            session.proxy = proxy_uri.to_s
           end
-        rescue Errno::ECONNREFUSED
+        end
+
+        response = begin
+          data = env[:body] ? env[:body].to_s : nil
+          session.request(env[:method], env[:url].to_s, env[:request_headers], :data => data)
+        rescue Errno::ECONNREFUSED, ::Patron::ConnectionFailed
           raise Error::ConnectionFailed, $!
         end
 
-        env.update :status => response.status, :body => response.body
-        response_headers(env).update response.headers
+        save_response(env, response.status, response.body, response.headers)
 
         @app.call env
+      rescue ::Patron::TimeoutError => err
+        raise Faraday::Error::TimeoutError, err
+      rescue ::Patron::Error => err
+        if err.message.include?("code 407")
+          raise Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
+        else
+          raise Error::ConnectionFailed, err
+        end
+      end
+
+      if loaded? && defined?(::Patron::Request::VALID_ACTIONS)
+        # HAX: helps but doesn't work completely
+        # https://github.com/toland/patron/issues/34
+        ::Patron::Request::VALID_ACTIONS.tap do |actions|
+          actions << :patch unless actions.include? :patch
+          actions << :options unless actions.include? :options
+        end
+      end
+
+      def create_session
+        session = ::Patron::Session.new
+        session.insecure = true
+        @block.call(session) if @block
+        session
       end
     end
   end

data/lib/faraday/adapter/rack.rb

@@ -0,0 +1,58 @@
+module Faraday
+  class Adapter
+    # Sends requests to a Rack app.
+    #
+    # Examples
+    #
+    #   class MyRackApp
+    #     def call(env)
+    #       [200, {'Content-Type' => 'text/html'}, ["hello world"]]
+    #     end
+    #   end
+    #
+    #   Faraday.new do |conn|
+    #     conn.adapter :rack, MyRackApp.new
+    #   end
+    class Rack < Faraday::Adapter
+      dependency 'rack/test'
+
+      # not prefixed with "HTTP_"
+      SPECIAL_HEADERS = %w[ CONTENT_LENGTH CONTENT_TYPE ]
+
+      def initialize(faraday_app, rack_app)
+        super(faraday_app)
+        mock_session = ::Rack::MockSession.new(rack_app)
+        @session     = ::Rack::Test::Session.new(mock_session)
+      end
+
+      def call(env)
+        super
+        rack_env = {
+          :method => env[:method],
+          :input  => env[:body].respond_to?(:read) ? env[:body].read : env[:body],
+          'rack.url_scheme' => env[:url].scheme
+        }
+
+        env[:request_headers].each do |name, value|
+          name = name.upcase.tr('-', '_')
+          name = "HTTP_#{name}" unless SPECIAL_HEADERS.include? name
+          rack_env[name] = value
+        end if env[:request_headers]
+
+        timeout  = env[:request][:timeout] || env[:request][:open_timeout]
+        response = if timeout
+          Timer.timeout(timeout, Faraday::Error::TimeoutError) { execute_request(env, rack_env) }
+        else
+          execute_request(env, rack_env)
+        end
+
+        save_response(env, response.status, response.body, response.headers)
+        @app.call env
+      end
+
+      def execute_request(env, rack_env)
+        @session.request(env[:url].to_s, rack_env)
+      end
+    end
+  end
+end

data/lib/faraday/adapter/test.rb

@@ -14,50 +14,59 @@ module Faraday
     class Test < Faraday::Adapter
       attr_accessor :stubs
 
-      def self.loaded?() false end
-
       class Stubs
+        class NotFound < StandardError
+        end
+
         def initialize
           # {:get => [Stub, Stub]}
           @stack, @consumed = {}, {}
-          yield self if block_given?
+          yield(self) if block_given?
         end
 
         def empty?
           @stack.empty?
         end
 
-        def match(request_method, path, body)
+        def match(request_method, path, headers, body)
           return false if !@stack.key?(request_method)
           stack = @stack[request_method]
           consumed = (@consumed[request_method] ||= [])
 
-          if stub = matches?(stack, path, body)
+          if stub = matches?(stack, path, headers, body)
             consumed << stack.delete(stub)
             stub
           else
-            matches?(consumed, path, body)
+            matches?(consumed, path, headers, body)
           end
         end
 
-        def get(path, &block)
-          new_stub(:get, path, &block)
+        def get(path, headers = {}, &block)
+          new_stub(:get, path, headers, &block)
+        end
+
+        def head(path, headers = {}, &block)
+          new_stub(:head, path, headers, &block)
+        end
+
+        def post(path, body=nil, headers = {}, &block)
+          new_stub(:post, path, headers, body, &block)
         end
 
-        def head(path, &block)
-          new_stub(:head, path, &block)
+        def put(path, body=nil, headers = {}, &block)
+          new_stub(:put, path, headers, body, &block)
         end
 
-        def post(path, body=nil, &block)
-          new_stub(:post, path, body, &block)
+        def patch(path, body=nil, headers = {}, &block)
+          new_stub(:patch, path, headers, body, &block)
         end
 
-        def put(path, body=nil, &block)
-          new_stub(:put, path, body, &block)
+        def delete(path, headers = {}, &block)
+          new_stub(:delete, path, headers, &block)
         end
 
-        def delete(path, &block)
-          new_stub(:delete, path, &block)
+        def options(path, headers = {}, &block)
+          new_stub(:options, path, headers, &block)
         end
 
         # Raises an error if any of the stubbed calls have not been made.
@@ -75,18 +84,46 @@ module Faraday
 
         protected
 
-        def new_stub(request_method, path, body=nil, &block)
-          (@stack[request_method] ||= []) << Stub.new(path, body, block)
+        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)
         end
 
-        def matches?(stack, path, body)
-          stack.detect { |stub| stub.matches?(path, body) }
+        def matches?(stack, path, headers, body)
+          stack.detect { |stub| stub.matches?(path, headers, body) }
         end
       end
 
-      class Stub < Struct.new(:path, :body, :block)
-        def matches?(request_path, request_body)
-          request_path == path && (body.to_s.size.zero? || request_body == body)
+      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)
+        end
+
+        def matches?(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 &&
+            params_match?(request_params) &&
+            (body.to_s.size.zero? || request_body == body) &&
+            headers_match?(request_headers)
+        end
+
+        def params_match?(request_params)
+          params.keys.all? do |key|
+            request_params[key] == params[key]
+          end
+        end
+
+        def headers_match?(request_headers)
+          headers.keys.all? do |key|
+            request_headers[key] == headers[key]
+          end
         end
 
         def to_s
@@ -101,19 +138,22 @@ module Faraday
       end
 
       def configure
-        yield stubs
+        yield(stubs)
       end
 
       def call(env)
         super
         normalized_path = Faraday::Utils.normalize_path(env[:url])
+        params_encoder = env.request.params_encoder || Faraday::Utils.default_params_encoder
 
-        if stub = stubs.match(env[:method], normalized_path, env[:body])
+        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)
-          env.update :status => status, :body => body
-          response_headers(env).update headers
+          save_response(env, status, body, headers)
         else
-          raise "no stubbed request for #{env[:method]} #{normalized_path} #{env[:body]}"
+          raise Stubs::NotFound, "no stubbed request for #{env[:method]} #{normalized_path} #{env[:body]}"
         end
         @app.call(env)
       end