faraday 0.6.0 → 0.9.0

data/test/adapters/excon_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class ExconTest < Faraday::TestCase
+
+    def adapter() :excon end
+
+    Integration.apply(self, :NonParallel) do
+      # https://github.com/geemus/excon/issues/126 ?
+      undef :test_timeout if ssl_mode?
+
+      # Excon lets OpenSSL::SSL::SSLError be raised without any way to
+      # distinguish whether it happened because of a 407 proxy response
+      undef :test_proxy_auth_fail if ssl_mode?
+
+      # https://github.com/geemus/excon/issues/358
+      undef :test_connection_error if RUBY_VERSION >= '2.1.0'
+    end
+  end
+end

data/test/adapters/httpclient_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class HttpclientTest < Faraday::TestCase
+
+    def adapter() :httpclient end
+
+    Integration.apply(self, :NonParallel) do
+      def setup
+        require 'httpclient' unless defined?(HTTPClient)
+        HTTPClient::NO_PROXY_HOSTS.delete('localhost')
+      end
+
+      def test_binds_local_socket
+        host = '1.2.3.4'
+        conn = create_connection :request => { :bind => { :host => host } }
+        assert_equal host, conn.options[:bind][:host]
+      end
+    end
+  end
+end

data/test/adapters/integration.rb

@@ -0,0 +1,254 @@
+require 'forwardable'
+require File.expand_path("../../helper", __FILE__)
+Faraday.require_lib 'autoload'
+
+module Adapters
+  # Adapter integration tests. To use, implement two methods:
+  #
+  # `#adapter` required. returns a symbol for the adapter middleware name
+  # `#adapter_options` optional. extra arguments for building an adapter
+  module Integration
+    def self.apply(base, *extra_features)
+      if base.live_server?
+        features = [:Common]
+        features.concat extra_features
+        features << :SSL if base.ssl_mode?
+        features.each {|name| base.send(:include, self.const_get(name)) }
+        yield if block_given?
+      elsif !defined? @warned
+        warn "Warning: Not running integration tests against a live server."
+        warn "Start the server `ruby test/live_server.rb` and set the LIVE=1 env variable."
+        @warned = true
+      end
+    end
+
+    module Parallel
+      def test_in_parallel
+        resp1, resp2 = nil, nil
+
+        connection = create_connection
+        connection.in_parallel do
+          resp1 = connection.get('echo?a=1')
+          resp2 = connection.get('echo?b=2')
+          assert connection.in_parallel?
+          assert_nil resp1.body
+          assert_nil resp2.body
+        end
+        assert !connection.in_parallel?
+        assert_equal 'get ?{"a"=>"1"}', resp1.body
+        assert_equal 'get ?{"b"=>"2"}', resp2.body
+      end
+    end
+
+    module NonParallel
+      def test_no_parallel_support
+        connection = create_connection
+        response = nil
+
+        err = capture_warnings do
+          connection.in_parallel do
+            response = connection.get('echo').body
+          end
+        end
+        assert response
+        assert_match "no parallel-capable adapter on Faraday stack", err
+        assert_match __FILE__, err
+      end
+    end
+
+    module Compression
+      def test_GET_handles_compression
+        res = get('echo_header', :name => 'accept-encoding')
+        assert_match(/gzip;.+\bdeflate\b/, res.body)
+      end
+    end
+
+    module SSL
+      def test_GET_ssl_fails_with_bad_cert
+        ca_file = 'tmp/faraday-different-ca-cert.crt'
+        conn = create_connection(:ssl => {:ca_file => ca_file})
+        err = assert_raises Faraday::SSLError do
+          conn.get('/ssl')
+        end
+        assert_includes err.message, "certificate"
+      end
+    end
+
+    module Common
+      extend Forwardable
+      def_delegators :create_connection, :get, :head, :put, :post, :patch, :delete, :run_request
+
+      def test_GET_retrieves_the_response_body
+        assert_equal 'get', get('echo').body
+      end
+
+      def test_GET_send_url_encoded_params
+        assert_equal %(get ?{"name"=>"zack"}), get('echo', :name => 'zack').body
+      end
+
+      def test_GET_retrieves_the_response_headers
+        response = get('echo')
+        assert_match(/text\/plain/, response.headers['Content-Type'], 'original case fail')
+        assert_match(/text\/plain/, response.headers['content-type'], 'lowercase fail')
+      end
+
+      def test_GET_handles_headers_with_multiple_values
+        assert_equal 'one, two', get('multi').headers['set-cookie']
+      end
+
+      def test_GET_with_body
+        response = get('echo') do |req|
+          req.body = {'bodyrock' => true}
+        end
+        assert_equal %(get {"bodyrock"=>"true"}), response.body
+      end
+
+      def test_GET_sends_user_agent
+        response = get('echo_header', {:name => 'user-agent'}, :user_agent => 'Agent Faraday')
+        assert_equal 'Agent Faraday', response.body
+      end
+
+      def test_GET_ssl
+        expected = self.class.ssl_mode?.to_s
+        assert_equal expected, get('ssl').body
+      end
+
+      def test_POST_send_url_encoded_params
+        assert_equal %(post {"name"=>"zack"}), post('echo', :name => 'zack').body
+      end
+
+      def test_POST_send_url_encoded_nested_params
+        resp = post('echo', 'name' => {'first' => 'zack'})
+        assert_equal %(post {"name"=>{"first"=>"zack"}}), resp.body
+      end
+
+      def test_POST_retrieves_the_response_headers
+        assert_match(/text\/plain/, post('echo').headers['content-type'])
+      end
+
+      def test_POST_sends_files
+        resp = post('file') do |req|
+          req.body = {'uploaded_file' => Faraday::UploadIO.new(__FILE__, 'text/x-ruby')}
+        end
+        assert_equal "file integration.rb text/x-ruby #{File.size(__FILE__)}", resp.body
+      end
+
+      def test_PUT_send_url_encoded_params
+        assert_equal %(put {"name"=>"zack"}), put('echo', :name => 'zack').body
+      end
+
+      def test_PUT_send_url_encoded_nested_params
+        resp = put('echo', 'name' => {'first' => 'zack'})
+        assert_equal %(put {"name"=>{"first"=>"zack"}}), resp.body
+      end
+
+      def test_PUT_retrieves_the_response_headers
+        assert_match(/text\/plain/, put('echo').headers['content-type'])
+      end
+
+      def test_PATCH_send_url_encoded_params
+        assert_equal %(patch {"name"=>"zack"}), patch('echo', :name => 'zack').body
+      end
+
+      def test_OPTIONS
+        resp = run_request(:options, 'echo', nil, {})
+        assert_equal 'options', resp.body
+      end
+
+      def test_HEAD_retrieves_no_response_body
+        assert_equal '', head('echo').body
+      end
+
+      def test_HEAD_retrieves_the_response_headers
+        assert_match(/text\/plain/, head('echo').headers['content-type'])
+      end
+
+      def test_DELETE_retrieves_the_response_headers
+        assert_match(/text\/plain/, delete('echo').headers['content-type'])
+      end
+
+      def test_DELETE_retrieves_the_body
+        assert_equal %(delete), delete('echo').body
+      end
+
+      def test_timeout
+        conn = create_connection(:request => {:timeout => 1, :open_timeout => 1})
+        assert_raises Faraday::Error::TimeoutError do
+          conn.get '/slow'
+        end
+      end
+
+      def test_connection_error
+        assert_raises Faraday::Error::ConnectionFailed do
+          get 'http://localhost:4'
+        end
+      end
+
+      def test_proxy
+        proxy_uri = URI(ENV['LIVE_PROXY'])
+        conn = create_connection(:proxy => proxy_uri)
+
+        res = conn.get '/echo'
+        assert_equal 'get', res.body
+
+        unless self.class.ssl_mode?
+          # proxy can't append "Via" header for HTTPS responses
+          assert_match(/:#{proxy_uri.port}$/, res['via'])
+        end
+      end
+
+      def test_proxy_auth_fail
+        proxy_uri = URI(ENV['LIVE_PROXY'])
+        proxy_uri.password = 'WRONG'
+        conn = create_connection(:proxy => proxy_uri)
+
+        err = assert_raises Faraday::Error::ConnectionFailed do
+          conn.get '/echo'
+        end
+
+        unless self.class.ssl_mode? && self.class.jruby?
+          # JRuby raises "End of file reached" which cannot be distinguished from a 407
+          assert_equal %{407 "Proxy Authentication Required "}, err.message
+        end
+      end
+
+      def test_empty_body_response_represented_as_blank_string
+        response = get('204')
+        assert_equal '', response.body
+      end
+
+      def adapter
+        raise NotImplementedError.new("Need to override #adapter")
+      end
+
+      # extra options to pass when building the adapter
+      def adapter_options
+        []
+      end
+
+      def create_connection(options = {})
+        if adapter == :default
+          builder_block = nil
+        else
+          builder_block = Proc.new do |b|
+            b.request :multipart
+            b.request :url_encoded
+            b.adapter adapter, *adapter_options
+          end
+        end
+
+        server = self.class.live_server
+        url = '%s://%s:%d' % [server.scheme, server.host, server.port]
+
+        options[:ssl] ||= {}
+        options[:ssl][:ca_file] ||= ENV['SSL_FILE']
+
+        Faraday::Connection.new(url, options, &builder_block).tap do |conn|
+          conn.headers['X-Faraday-Adapter'] = adapter.to_s
+          adapter_handler = conn.builder.handlers.last
+          conn.builder.insert_before adapter_handler, Faraday::Response::RaiseError
+        end
+      end
+    end
+  end
+end

data/test/adapters/logger_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require File.expand_path('../../helper', __FILE__)
 require 'stringio'
 require 'logger'
 
@@ -15,7 +15,7 @@ module Adapters
           stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
         end
       end
-      @resp = @conn.get '/hello', :accept => 'text/html'
+      @resp = @conn.get '/hello', nil, :accept => 'text/html'
     end
 
     def test_still_returns_output
@@ -23,7 +23,7 @@ module Adapters
     end
 
     def test_logs_method_and_url
-      assert_match "get /hello", @io.string
+      assert_match "get http:/hello", @io.string
     end
 
     def test_logs_request_headers

data/test/adapters/net_http_persistent_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class NetHttpPersistentTest < Faraday::TestCase
+
+    def adapter() :net_http_persistent end
+
+    Integration.apply(self, :NonParallel) do
+      def setup
+        if defined?(Net::HTTP::Persistent)
+          # work around problems with mixed SSL certificates
+          # https://github.com/drbrain/net-http-persistent/issues/45
+          http = Net::HTTP::Persistent.new('Faraday')
+          http.ssl_cleanup(4)
+        end
+      end if ssl_mode?
+    end
+
+  end
+end

data/test/adapters/net_http_test.rb

@@ -1,33 +1,14 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require File.expand_path('../integration', __FILE__)
 
 module Adapters
   class NetHttpTest < Faraday::TestCase
-    def setup
-      @connection = Faraday.new('http://disney.com') do |b|
-        b.adapter :net_http
-      end
-    end
 
-    def test_handles_compression_transparently_on_get
-      stub_request(:get, 'disney.com/hello').with { |request|
-        accept_encoding = request.headers['Accept-Encoding']
-        if RUBY_VERSION.index('1.8') == 0
-          # ruby 1.8 doesn't do any gzip/deflate automatically
-          accept_encoding == nil
-        else
-          # test for a value such as "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
-          accept_encoding =~ /gzip;.+\bdeflate\b/
-        end
-      }
-      @connection.get('/hello')
-    end
+    def adapter() :net_http end
 
-    def test_connect_error_gets_wrapped
-      stub_request(:get, 'disney.com/hello').to_raise(Errno::ECONNREFUSED)
+    behaviors = [:NonParallel]
+    behaviors << :Compression if RUBY_VERSION >= '1.9'
+
+    Integration.apply(self, *behaviors)
 
-      assert_raise Faraday::Error::ConnectionFailed do
-        @connection.get('/hello')
-      end
-    end
   end
 end

data/test/adapters/patron_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class Patron < Faraday::TestCase
+
+    def adapter() :patron end
+
+    Integration.apply(self, :NonParallel) do
+      # https://github.com/toland/patron/issues/34
+      undef :test_PATCH_send_url_encoded_params
+
+      # https://github.com/toland/patron/issues/52
+      undef :test_GET_with_body
+
+      # no support for SSL peer verification
+      undef :test_GET_ssl_fails_with_bad_cert if ssl_mode?
+    end unless jruby?
+
+  end
+end

data/test/adapters/rack_test.rb

@@ -0,0 +1,31 @@
+require File.expand_path("../integration", __FILE__)
+require File.expand_path('../../live_server', __FILE__)
+
+module Adapters
+  class RackTest < Faraday::TestCase
+
+    def adapter() :rack end
+
+    def adapter_options
+      [Faraday::LiveServer]
+    end
+
+    # no Integration.apply because this doesn't require a server as a separate process
+    include Integration::Common
+    include Integration::NonParallel
+
+    # not using shared test because error is swallowed by Sinatra
+    def test_timeout
+      conn = create_connection(:request => {:timeout => 1, :open_timeout => 1})
+      begin
+        conn.get '/slow'
+      rescue Faraday::Error::ClientError
+      end
+    end
+
+    # test not applicable
+    undef test_connection_error
+    undef test_proxy
+    undef test_proxy_auth_fail
+  end
+end

data/test/adapters/test_middleware_test.rb

@@ -1,9 +1,10 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+require File.expand_path('../../helper', __FILE__)
 
 module Adapters
   class TestMiddleware < Faraday::TestCase
+    Stubs = Faraday::Adapter.lookup_middleware(:test)::Stubs
     def setup
-      @stubs = Faraday::Adapter::Test::Stubs.new
+      @stubs = Stubs.new
       @conn  = Faraday.new do |builder|
         builder.adapter :test, @stubs
       end
@@ -27,6 +28,27 @@ module Adapters
       assert_equal 'hello', @conn.get("/hello").body
     end
 
+    def test_middleware_with_get_params
+      @stubs.get('/param?a=1') { [200, {}, 'a'] }
+      assert_equal 'a', @conn.get('/param?a=1').body
+    end
+
+    def test_middleware_ignores_unspecified_get_params
+      @stubs.get('/optional?a=1') { [200, {}, 'a'] }
+      assert_equal 'a', @conn.get('/optional?a=1&b=1').body
+      assert_equal 'a', @conn.get('/optional?a=1').body
+      assert_raises Faraday::Adapter::Test::Stubs::NotFound do
+        @conn.get('/optional')
+      end
+    end
+
+    def test_middleware_with_http_headers
+      @stubs.get('/yo', { 'X-HELLO' => 'hello' }) { [200, {}, 'a'] }
+      @stubs.get('/yo') { [200, {}, 'b'] }
+      assert_equal 'a', @conn.get('/yo') { |env| env.headers['X-HELLO'] = 'hello' }.body
+      assert_equal 'b', @conn.get('/yo').body
+    end
+
     def test_middleware_allow_different_outcomes_for_the_same_request
       @stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
       @stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'world'] }
@@ -34,10 +56,59 @@ module Adapters
       assert_equal 'world', @conn.get("/hello").body
     end
 
+    def test_yields_env_to_stubs
+      @stubs.get '/hello' do |env|
+        assert_equal '/hello',     env[:url].path
+        assert_equal 'foo.com',    env[:url].host
+        assert_equal '1',          env[:params]['a']
+        assert_equal 'text/plain', env[:request_headers]['Accept']
+        [200, {}, 'a']
+      end
+
+      @conn.headers['Accept'] = 'text/plain'
+      assert_equal 'a', @conn.get('http://foo.com/hello?a=1').body
+    end
+
+    def test_parses_params_with_default_encoder
+      @stubs.get '/hello' do |env|
+        assert_equal '1', env[:params]['a']['b']
+        [200, {}, 'a']
+      end
+
+      assert_equal 'a', @conn.get('http://foo.com/hello?a[b]=1').body
+    end
+
+    def test_parses_params_with_nested_encoder
+      @stubs.get '/hello' do |env|
+        assert_equal '1', env[:params]['a']['b']
+        [200, {}, 'a']
+      end
+
+      @conn.options.params_encoder = Faraday::NestedParamsEncoder
+      assert_equal 'a', @conn.get('http://foo.com/hello?a[b]=1').body
+    end
+
+    def test_parses_params_with_flat_encoder
+      @stubs.get '/hello' do |env|
+        assert_equal '1', env[:params]['a[b]']
+        [200, {}, 'a']
+      end
+
+      @conn.options.params_encoder = Faraday::FlatParamsEncoder
+      assert_equal 'a', @conn.get('http://foo.com/hello?a[b]=1').body
+    end
+
     def test_raises_an_error_if_no_stub_is_found_for_request
-      assert_raise RuntimeError do
+      assert_raises Stubs::NotFound do
         @conn.get('/invalid'){ [200, {}, []] }
       end
     end
+
+    def test_raises_an_error_if_no_stub_is_found_for_request_without_this_header
+      @stubs.get('/yo', { 'X-HELLO' => 'hello' }) { [200, {}, 'a'] }
+      assert_raises Faraday::Adapter::Test::Stubs::NotFound do
+        @conn.get('/yo')
+      end
+    end
   end
 end

data/test/adapters/typhoeus_test.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../integration', __FILE__)
+
+module Adapters
+  class TyphoeusTest < Faraday::TestCase
+
+    def adapter() :typhoeus end
+
+    Integration.apply(self, :Parallel) do
+      # https://github.com/dbalatero/typhoeus/issues/75
+      undef :test_GET_with_body
+
+      # Not a Typhoeus bug, but WEBrick inability to handle "100-continue"
+      # which libcurl seems to generate for this particular request:
+      undef :test_POST_sends_files
+
+      # inconsistent outcomes ranging from successful response to connection error
+      undef :test_proxy_auth_fail if ssl_mode?
+
+      def test_binds_local_socket
+        host = '1.2.3.4'
+        conn = create_connection :request => { :bind => { :host => host } }
+        assert_equal host, conn.options[:bind][:host]
+      end
+
+    end unless jruby?
+  end
+end
+

data/test/authentication_middleware_test.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../helper', __FILE__)
+
+class AuthenticationMiddlewareTest < Faraday::TestCase
+  def conn
+    Faraday::Connection.new('http://example.net/') do |builder|
+      yield(builder)
+      builder.adapter :test do |stub|
+        stub.get('/auth-echo') do |env|
+          [200, {}, env[:request_headers]['Authorization']]
+        end
+      end
+    end
+  end
+
+  def test_basic_middleware_adds_basic_header
+    response = conn { |b| b.request :basic_auth, 'aladdin', 'opensesame' }.get('/auth-echo')
+    assert_equal 'Basic YWxhZGRpbjpvcGVuc2VzYW1l', response.body
+  end
+
+  def test_basic_middleware_adds_basic_header_correctly_with_long_values
+    response = conn { |b| b.request :basic_auth, 'A' * 255, '' }.get('/auth-echo')
+    assert_equal "Basic #{'QUFB' * 85}Og==", response.body
+  end
+
+  def test_basic_middleware_does_not_interfere_with_existing_authorization
+    response = conn { |b| b.request :basic_auth, 'aladdin', 'opensesame' }.
+      get('/auth-echo', nil, :authorization => 'Token token="bar"')
+    assert_equal 'Token token="bar"', response.body
+  end
+
+  def test_token_middleware_adds_token_header
+    response = conn { |b| b.request :token_auth, 'quux' }.get('/auth-echo')
+    assert_equal 'Token token="quux"', response.body
+  end
+
+  def test_token_middleware_includes_other_values_if_provided
+    response = conn { |b|
+      b.request :token_auth, 'baz', :foo => 42
+    }.get('/auth-echo')
+    assert_match(/^Token /, response.body)
+    assert_match(/token="baz"/, response.body)
+    assert_match(/foo="42"/, response.body)
+  end
+
+  def test_token_middleware_does_not_interfere_with_existing_authorization
+    response = conn { |b| b.request :token_auth, 'quux' }.
+      get('/auth-echo', nil, :authorization => 'Token token="bar"')
+    assert_equal 'Token token="bar"', response.body
+  end
+
+  def test_authorization_middleware_with_string
+    response = conn { |b|
+      b.request :authorization, 'custom', 'abc def'
+    }.get('/auth-echo')
+    assert_match(/^custom abc def$/, response.body)
+  end
+
+  def test_authorization_middleware_with_hash
+    response = conn { |b|
+      b.request :authorization, 'baz', :foo => 42
+    }.get('/auth-echo')
+    assert_match(/^baz /, response.body)
+    assert_match(/foo="42"/, response.body)
+  end
+end