faraday 0.6.0 → 0.9.0

data/test/connection_test.rb

@@ -1,14 +1,29 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+require File.expand_path('../helper', __FILE__)
 
 class TestConnection < Faraday::TestCase
+
+  def with_env(key, proxy)
+    old_value = ENV.fetch(key, false)
+    ENV[key] = proxy
+    begin
+      yield
+    ensure
+      if old_value == false
+        ENV.delete key
+      else
+        ENV[key] = old_value
+      end
+    end
+  end
+
   def test_initialize_parses_host_out_of_given_url
     conn = Faraday::Connection.new "http://sushi.com"
     assert_equal 'sushi.com', conn.host
   end
 
-  def test_initialize_parses_nil_port_out_of_given_url
+  def test_initialize_inherits_default_port_out_of_given_url
     conn = Faraday::Connection.new "http://sushi.com"
-    assert_nil conn.port
+    assert_equal 80, conn.port
   end
 
   def test_initialize_parses_scheme_out_of_given_url
@@ -38,179 +53,295 @@ class TestConnection < Faraday::TestCase
 
   def test_initialize_stores_default_params_from_options
     conn = Faraday::Connection.new :params => {:a => 1}
-    assert_equal 1, conn.params['a']
+    assert_equal({'a' => 1}, conn.params)
   end
 
   def test_initialize_stores_default_params_from_uri
-    conn = Faraday::Connection.new "http://sushi.com/fish?a=1", :params => {'b' => '2'}
-    assert_equal '1', conn.params['a']
-    assert_equal '2', conn.params['b']
+    conn = Faraday::Connection.new "http://sushi.com/fish?a=1"
+    assert_equal({'a' => '1'}, conn.params)
   end
 
-  def test_initialize_stores_default_headers_from_options
-    conn = Faraday::Connection.new :headers => {:a => 1}
-    assert_equal '1', conn.headers['A']
+  def test_initialize_stores_default_params_from_uri_and_options
+    conn = Faraday::Connection.new "http://sushi.com/fish?a=1&b=2", :params => {'a' => 3}
+    assert_equal({'a' => 3, 'b' => '2'}, conn.params)
   end
 
-  def test_basic_auth_sets_authorization_header
-    conn = Faraday::Connection.new
-    conn.basic_auth 'Aladdin', 'open sesame'
-    assert_equal 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==', conn.headers['Authorization']
+  def test_initialize_stores_default_headers_from_options
+    conn = Faraday::Connection.new :headers => {:user_agent => 'Faraday'}
+    assert_equal 'Faraday', conn.headers['User-agent']
   end
 
-  def test_long_basic_auth_sets_authorization_header_without_new_lines
+  def test_basic_auth_sets_header
     conn = Faraday::Connection.new
-    conn.basic_auth "A" * 255, ""
-    assert_equal "Basic #{'QUFB' * 85}Og==", conn.headers['Authorization']
-  end
+    assert_nil conn.headers['Authorization']
 
-  def test_auto_parses_basic_auth_from_url
-    conn = Faraday::Connection.new :url => "http://aladdin:opensesame@sushi.com/fish"
-    assert_equal 'Basic YWxhZGRpbjpvcGVuc2VzYW1l', conn.headers['Authorization']
+    conn.basic_auth 'Aladdin', 'open sesame'
+    assert auth = conn.headers['Authorization']
+    assert_equal 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==', auth
   end
 
-  def test_token_auth_sets_authorization_header
-    conn = Faraday::Connection.new
-    conn.token_auth 'abcdef'
-    assert_equal 'Token token="abcdef"', conn.headers['Authorization']
+  def test_auto_parses_basic_auth_from_url_and_unescapes
+    conn = Faraday::Connection.new :url => "http://foo%40bar.com:pass%20word@sushi.com/fish"
+    assert auth = conn.headers['Authorization']
+    assert_equal Faraday::Request::BasicAuthentication.header("foo@bar.com", "pass word"), auth
   end
 
-  def test_token_auth_with_options_sets_authorization_header
+  def test_token_auth_sets_header
     conn = Faraday::Connection.new
+    assert_nil conn.headers['Authorization']
+
     conn.token_auth 'abcdef', :nonce => 'abc'
-    assert_equal 'Token token="abcdef",
-                     nonce="abc"', conn.headers['Authorization']
+    assert auth = conn.headers['Authorization']
+    assert_match(/^Token /, auth)
+    assert_match(/token="abcdef"/, auth)
+    assert_match(/nonce="abc"/, auth)
   end
 
-  def test_build_url_uses_connection_host_as_default_uri_host
+  def test_build_exclusive_url_uses_connection_host_as_default_uri_host
     conn = Faraday::Connection.new
     conn.host = 'sushi.com'
-    uri = conn.build_url("/sake.html")
+    uri = conn.build_exclusive_url("/sake.html")
     assert_equal 'sushi.com', uri.host
   end
 
-  def test_build_url_uses_connection_port_as_default_uri_port
+  def test_build_exclusive_url_overrides_connection_port_for_absolute_urls
     conn = Faraday::Connection.new
     conn.port = 23
-    uri = conn.build_url("http://sushi.com")
-    assert_equal 23, uri.port
+    uri = conn.build_exclusive_url("http://sushi.com")
+    assert_equal 80, uri.port
   end
 
-  def test_build_url_uses_connection_scheme_as_default_uri_scheme
+  def test_build_exclusive_url_uses_connection_scheme_as_default_uri_scheme
     conn = Faraday::Connection.new 'http://sushi.com'
-    uri = conn.build_url("/sake.html")
+    uri = conn.build_exclusive_url("/sake.html")
     assert_equal 'http', uri.scheme
   end
 
-  def test_build_url_uses_connection_path_prefix_to_customize_path
+  def test_build_exclusive_url_uses_connection_path_prefix_to_customize_path
     conn = Faraday::Connection.new
     conn.path_prefix = '/fish'
-    uri = conn.build_url("sake.html")
+    uri = conn.build_exclusive_url("sake.html")
     assert_equal '/fish/sake.html', uri.path
   end
 
-  def test_build_url_uses_root_connection_path_prefix_to_customize_path
+  def test_build_exclusive_url_uses_root_connection_path_prefix_to_customize_path
     conn = Faraday::Connection.new
     conn.path_prefix = '/'
-    uri = conn.build_url("sake.html")
+    uri = conn.build_exclusive_url("sake.html")
     assert_equal '/sake.html', uri.path
   end
 
-  def test_build_url_forces_connection_path_prefix_to_be_absolute
+  def test_build_exclusive_url_forces_connection_path_prefix_to_be_absolute
     conn = Faraday::Connection.new
     conn.path_prefix = 'fish'
-    uri = conn.build_url("sake.html")
+    uri = conn.build_exclusive_url("sake.html")
     assert_equal '/fish/sake.html', uri.path
   end
 
-  def test_build_url_ignores_connection_path_prefix_trailing_slash
+  def test_build_exclusive_url_ignores_connection_path_prefix_trailing_slash
     conn = Faraday::Connection.new
     conn.path_prefix = '/fish/'
-    uri = conn.build_url("sake.html")
+    uri = conn.build_exclusive_url("sake.html")
     assert_equal '/fish/sake.html', uri.path
   end
 
-  def test_build_url_allows_absolute_uri_to_ignore_connection_path_prefix
+  def test_build_exclusive_url_allows_absolute_uri_to_ignore_connection_path_prefix
     conn = Faraday::Connection.new
     conn.path_prefix = '/fish'
-    uri = conn.build_url("/sake.html")
+    uri = conn.build_exclusive_url("/sake.html")
     assert_equal '/sake.html', uri.path
   end
 
-  def test_build_url_parses_url_params_into_path
+  def test_build_exclusive_url_parses_url_params_into_path
     conn = Faraday::Connection.new
-    uri = conn.build_url("http://sushi.com/sake.html")
+    uri = conn.build_exclusive_url("http://sushi.com/sake.html")
     assert_equal '/sake.html', uri.path
   end
 
-  def test_build_url_parses_url_params_into_query
+  def test_build_exclusive_url_doesnt_add_ending_slash_given_nil_url
+    conn = Faraday::Connection.new
+    conn.url_prefix = "http://sushi.com/nigiri"
+    uri = conn.build_exclusive_url
+    assert_equal "/nigiri", uri.path
+  end
+
+  def test_build_exclusive_url_doesnt_add_ending_slash_given_empty_url
     conn = Faraday::Connection.new
-    uri = conn.build_url("http://sushi.com/sake.html", 'a[b]' => '1 + 2')
-    assert_equal "a%5Bb%5D=1%20%2B%202", uri.query
+    conn.url_prefix = "http://sushi.com/nigiri"
+    uri = conn.build_exclusive_url('')
+    assert_equal "/nigiri", uri.path
   end
 
-  def test_build_url_mashes_default_and_given_params_together
-    conn = Faraday::Connection.new 'http://sushi.com/api?token=abc', :params => {'format' => 'json'}
-    url = conn.build_url("nigiri?page=1", :limit => 5)
-    assert_match /limit=5/,      url.query
-    assert_match /page=1/,       url.query
-    assert_match /format=json/,  url.query
-    assert_match /token=abc/,    url.query
+  def test_build_exclusive_url_doesnt_use_connection_params
+    conn = Faraday::Connection.new "http://sushi.com/nigiri"
+    conn.params = {:a => 1}
+    assert_equal "http://sushi.com/nigiri", conn.build_exclusive_url.to_s
   end
 
-  def test_build_url_overrides_default_params_with_given_params
-    conn = Faraday::Connection.new 'http://sushi.com/api?token=abc', :params => {'format' => 'json'}
-    url = conn.build_url("nigiri?page=1", :limit => 5, :token => 'def', :format => 'xml')
-    assert_match /limit=5/,        url.query
-    assert_match /page=1/,         url.query
-    assert_match /format=xml/,     url.query
-    assert_match /token=def/,      url.query
-    assert_no_match /format=json/, url.query
-    assert_no_match /token=abc/,   url.query
+  def test_build_exclusive_url_uses_argument_params
+    conn = Faraday::Connection.new "http://sushi.com/nigiri"
+    conn.params = {:a => 1}
+    params = Faraday::Utils::ParamsHash.new
+    params[:a] = 2
+    url = conn.build_exclusive_url(nil, params)
+    assert_equal "http://sushi.com/nigiri?a=2", url.to_s
+  end
+
+  def test_build_url_uses_params
+    conn = Faraday::Connection.new "http://sushi.com/nigiri"
+    conn.params = {:a => 1, :b => 1}
+    assert_equal "http://sushi.com/nigiri?a=1&b=1", conn.build_url.to_s
+  end
+
+  def test_build_url_merges_params
+    conn = Faraday::Connection.new "http://sushi.com/nigiri"
+    conn.params = {:a => 1, :b => 1}
+    url = conn.build_url(nil, :b => 2, :c => 3)
+    assert_equal "http://sushi.com/nigiri?a=1&b=2&c=3", url.to_s
+  end
+
+  def test_env_url_parses_url_params_into_query
+    uri = env_url("http://sushi.com/sake.html", 'a[b]' => '1 + 2')
+    assert_equal "a%5Bb%5D=1+%2B+2", uri.query
+  end
+
+  def test_env_url_escapes_per_spec
+    uri = env_url('http:/', 'a' => '1+2 foo~bar.-baz')
+    assert_equal "a=1%2B2+foo~bar.-baz", uri.query
+  end
+
+  def test_env_url_bracketizes_nested_params_in_query
+    url = env_url nil, 'a' => {'b' => 'c'}
+    assert_equal "a%5Bb%5D=c", url.query
+  end
+
+  def test_env_url_bracketizes_repeated_params_in_query
+    uri = env_url("http://sushi.com/sake.html", 'a' => [1, 2])
+    assert_equal "a%5B%5D=1&a%5B%5D=2", uri.query
+  end
+
+  def test_env_url_without_braketizing_repeated_params_in_query
+    uri = env_url 'http://sushi.com', 'a' => [1, 2] do |conn|
+      conn.options.params_encoder = Faraday::FlatParamsEncoder
+    end
+    assert_equal "a=1&a=2", uri.query
   end
 
-  def test_build_url_parses_url
+  def test_build_exclusive_url_parses_url
     conn = Faraday::Connection.new
-    uri = conn.build_url("http://sushi.com/sake.html")
-    assert_equal "http",             uri.scheme
-    assert_equal "sushi.com",        uri.host
+    uri = conn.build_exclusive_url("http://sushi.com/sake.html")
+    assert_equal "http",       uri.scheme
+    assert_equal "sushi.com",  uri.host
     assert_equal '/sake.html', uri.path
-    assert_nil uri.port
   end
 
-  def test_build_url_parses_url_and_changes_scheme
+  def test_build_exclusive_url_parses_url_and_changes_scheme
     conn = Faraday::Connection.new :url => "http://sushi.com/sushi"
     conn.scheme = 'https'
-    uri = conn.build_url("sake.html")
+    uri = conn.build_exclusive_url("sake.html")
     assert_equal 'https://sushi.com/sushi/sake.html', uri.to_s
   end
 
-  def test_proxy_accepts_string
+  def test_build_exclusive_url_joins_url_to_base_with_ending_slash
+    conn = Faraday::Connection.new :url => "http://sushi.com/sushi/"
+    uri = conn.build_exclusive_url("sake.html")
+    assert_equal 'http://sushi.com/sushi/sake.html', uri.to_s
+  end
+
+  def test_build_exclusive_url_used_default_base_with_ending_slash
+    conn = Faraday::Connection.new :url => "http://sushi.com/sushi/"
+    uri = conn.build_exclusive_url
+    assert_equal 'http://sushi.com/sushi/', uri.to_s
+  end
+
+  def test_build_exclusive_url_overrides_base
+    conn = Faraday::Connection.new :url => "http://sushi.com/sushi/"
+    uri = conn.build_exclusive_url('/sake/')
+    assert_equal 'http://sushi.com/sake/', uri.to_s
+  end
+
+  def test_build_exclusive_url_handles_uri_instances
     conn = Faraday::Connection.new
-    conn.proxy 'http://proxy.com'
-    assert_equal 'proxy.com', conn.proxy[:uri].host
-    assert_equal [:uri],      conn.proxy.keys
+    uri = conn.build_exclusive_url(URI('/sake.html'))
+    assert_equal '/sake.html', uri.path
+  end
+
+  def test_proxy_accepts_string
+    with_env 'http_proxy', "http://duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      conn.proxy 'http://proxy.com'
+      assert_equal 'proxy.com', conn.proxy.host
+    end
   end
 
   def test_proxy_accepts_uri
-    conn = Faraday::Connection.new
-    conn.proxy Addressable::URI.parse('http://proxy.com')
-    assert_equal 'proxy.com', conn.proxy[:uri].host
-    assert_equal [:uri],      conn.proxy.keys
+    with_env 'http_proxy', "http://duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      conn.proxy URI.parse('http://proxy.com')
+      assert_equal 'proxy.com', conn.proxy.host
+    end
   end
 
   def test_proxy_accepts_hash_with_string_uri
-    conn = Faraday::Connection.new
-    conn.proxy :uri => 'http://proxy.com', :user => 'rick'
-    assert_equal 'proxy.com', conn.proxy[:uri].host
-    assert_equal 'rick',      conn.proxy[:user]
+    with_env 'http_proxy', "http://duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      conn.proxy :uri => 'http://proxy.com', :user => 'rick'
+      assert_equal 'proxy.com', conn.proxy.host
+      assert_equal 'rick',      conn.proxy.user
+    end
   end
 
   def test_proxy_accepts_hash
-    conn = Faraday::Connection.new
-    conn.proxy :uri => Addressable::URI.parse('http://proxy.com'), :user => 'rick'
-    assert_equal 'proxy.com', conn.proxy[:uri].host
-    assert_equal 'rick',      conn.proxy[:user]
+    with_env 'http_proxy', "http://duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      conn.proxy :uri => URI.parse('http://proxy.com'), :user => 'rick'
+      assert_equal 'proxy.com', conn.proxy.host
+      assert_equal 'rick',      conn.proxy.user
+    end
+  end
+
+  def test_proxy_accepts_http_env
+    with_env 'http_proxy', "http://duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      assert_equal 'duncan.proxy.com', conn.proxy.host
+    end
+  end
+
+  def test_proxy_accepts_http_env_with_auth
+    with_env 'http_proxy', "http://a%40b:my%20pass@duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      assert_equal 'a@b',     conn.proxy.user
+      assert_equal 'my pass', conn.proxy.password
+    end
+  end
+
+  def test_proxy_accepts_env_without_scheme
+    with_env 'http_proxy', "localhost:8888" do
+      uri = Faraday::Connection.new.proxy[:uri]
+      assert_equal 'localhost', uri.host
+      assert_equal 8888, uri.port
+    end
+  end
+
+  def test_no_proxy_from_env
+    with_env 'http_proxy', nil do
+      conn = Faraday::Connection.new
+      assert_equal nil, conn.proxy
+    end
+  end
+
+  def test_no_proxy_from_blank_env
+    with_env 'http_proxy', '' do
+      conn = Faraday::Connection.new
+      assert_equal nil, conn.proxy
+    end
+  end
+
+  def test_proxy_doesnt_accept_uppercase_env
+    with_env 'HTTP_PROXY', "http://localhost:8888/" do
+      conn = Faraday::Connection.new
+      assert_nil conn.proxy
+    end
   end
 
   def test_proxy_requires_uri
@@ -220,26 +351,172 @@ class TestConnection < Faraday::TestCase
     end
   end
 
-  def test_params_to_query_converts_hash_of_params_to_uri_escaped_query_string
-    conn = Faraday::Connection.new
-    class << conn
-      public :build_query
+  def test_dups_connection_object
+    conn = Faraday::Connection.new 'http://sushi.com/foo',
+      :ssl => { :verify => :none },
+      :headers => {'content-type' => 'text/plain'},
+      :params => {'a'=>'1'}
+
+    other = conn.dup
+
+    assert_equal conn.build_exclusive_url, other.build_exclusive_url
+    assert_equal 'text/plain', other.headers['content-type']
+    assert_equal '1', other.params['a']
+
+    other.basic_auth('', '')
+    other.headers['content-length'] = 12
+    other.params['b'] = '2'
+
+    assert_equal 2, other.builder.handlers.size
+    assert_equal 2, conn.builder.handlers.size
+    assert !conn.headers.key?('content-length')
+    assert !conn.params.key?('b')
+  end
+
+  def test_initialize_with_false_option
+    conn = Faraday::Connection.new :ssl => {:verify => false}
+    assert !conn.ssl.verify?
+  end
+
+  def test_init_with_block
+    conn = Faraday::Connection.new { }
+    assert_equal 0, conn.builder.handlers.size
+  end
+
+  def test_init_with_block_yields_connection
+    conn = Faraday::Connection.new(:params => {'a'=>'1'}) { |faraday|
+      faraday.adapter :net_http
+      faraday.url_prefix = 'http://sushi.com/omnom'
+      assert_equal '1', faraday.params['a']
+    }
+    assert_equal 1, conn.builder.handlers.size
+    assert_equal '/omnom', conn.path_prefix
+  end
+
+  def env_url(url, params)
+    conn = Faraday::Connection.new(url, :params => params)
+    yield(conn) if block_given?
+    req = conn.build_request(:get)
+    req.to_env(conn).url
+  end
+end
+
+class TestRequestParams < Faraday::TestCase
+  def create_connection(*args)
+    @conn = Faraday::Connection.new(*args) do |conn|
+      yield(conn) if block_given?
+      class << conn.builder
+        undef app
+        def app() lambda { |env| env } end
+      end
     end
-    assert_equal "a%5Bb%5D=1%20%2B%202", conn.build_query('a[b]' => '1 + 2')
   end
 
-  def test_dups_connection_object
-    conn = Faraday::Connection.new 'http://sushi.com/foo' do |b|
-      b.adapter :net_http
+  def assert_query_equal(expected, query)
+    assert_equal expected, query.split('&').sort
+  end
+
+  def with_default_params_encoder(encoder)
+    old_encoder = Faraday::Utils.default_params_encoder
+    begin
+      Faraday::Utils.default_params_encoder = encoder
+      yield
+    ensure
+      Faraday::Utils.default_params_encoder = old_encoder
     end
-    conn.headers['content-type'] = 'text/plain'
-    conn.params['a'] = '1'
+  end
+
+  def test_merges_connection_and_request_params
+    create_connection 'http://a.co/?token=abc', :params => {'format' => 'json'}
+    query = get '?page=1', :limit => 5
+    assert_query_equal %w[format=json limit=5 page=1 token=abc], query
+  end
+
+  def test_overrides_connection_params
+    create_connection 'http://a.co/?a=a&b=b&c=c', :params => {:a => 'A'} do |conn|
+      conn.params[:b] = 'B'
+      assert_equal 'c', conn.params[:c]
+    end
+    assert_query_equal %w[a=A b=B c=c], get
+  end
+
+  def test_all_overrides_connection_params
+    create_connection 'http://a.co/?a=a', :params => {:c => 'c'} do |conn|
+      conn.params = {'b' => 'b'}
+    end
+    assert_query_equal %w[b=b], get
+  end
+
+  def test_overrides_request_params
+    create_connection
+    query = get '?p=1&a=a', :p => 2
+    assert_query_equal %w[a=a p=2], query
+  end
+
+  def test_overrides_request_params_block
+    create_connection
+    query = get '?p=1&a=a', :p => 2 do |req|
+      req.params[:p] = 3
+    end
+    assert_query_equal %w[a=a p=3], query
+  end
+
+  def test_overrides_request_params_block_url
+    create_connection
+    query = get nil, :p => 2 do |req|
+      req.url '?p=1&a=a', 'p' => 3
+    end
+    assert_query_equal %w[a=a p=3], query
+  end
+
+  def test_overrides_all_request_params
+    create_connection :params => {:c => 'c'}
+    query = get '?p=1&a=a', :p => 2 do |req|
+      assert_equal 'a', req.params[:a]
+      assert_equal 'c', req.params['c']
+      assert_equal 2, req.params['p']
+      req.params = {:b => 'b'}
+      assert_equal 'b', req.params['b']
+    end
+    assert_query_equal %w[b=b], query
+  end
+
+  def test_array_params_in_url
+    with_default_params_encoder(nil) do
+      create_connection 'http://a.co/page1?color[]=red&color[]=blue'
+      query = get
+      assert_equal "color%5B%5D=red&color%5B%5D=blue", query
+    end
+  end
+
+  def test_array_params_in_params
+    with_default_params_encoder(nil) do
+      create_connection 'http://a.co/page1', :params => {:color => ['red', 'blue']}
+      query = get
+      assert_equal "color%5B%5D=red&color%5B%5D=blue", query
+    end
+  end
+
+  def test_array_params_in_url_with_flat_params
+    with_default_params_encoder(Faraday::FlatParamsEncoder) do
+      create_connection 'http://a.co/page1?color=red&color=blue'
+      query = get
+      assert_equal "color=red&color=blue", query
+    end
+  end
+
+  def test_array_params_in_params_with_flat_params
+    with_default_params_encoder(Faraday::FlatParamsEncoder) do
+      create_connection 'http://a.co/page1', :params => {:color => ['red', 'blue']}
+      query = get
+      assert_equal "color=red&color=blue", query
+    end
+  end
 
-    duped = conn.dup
-    assert_equal conn.build_url(''), duped.build_url('')
-    [:headers, :params, :builder].each do |attr|
-      assert_equal     conn.send(attr),           duped.send(attr)
-      assert_not_equal conn.send(attr).object_id, duped.send(attr).object_id
+  def get(*args)
+    env = @conn.get(*args) do |req|
+      yield(req) if block_given?
     end
+    env[:url].query
   end
 end