faraday 0.7.6 → 0.8.0.rc2

data/test/adapters/logger_test.rb

@@ -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/typhoeus_test.rb

@@ -13,7 +13,7 @@ module Adapters
       stub_request(:get, 'disney.com/world').with(:headers => {'User-Agent'=>'Faraday Agent'}){ |request|
         request.headers["User-Agent"] == 'Faraday Agent'
       }
-      @connection.get('/world', :user_agent => 'Faraday Agent')
+      @connection.get('/world', nil, :user_agent => 'Faraday Agent')
     end
 
   end if defined? ::Typhoeus

data/test/authentication_middleware_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+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_equal "Token token=\"baz\",\n                     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
+end

data/test/connection_test.rb

@@ -2,14 +2,25 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
 require 'uri'
 
 class TestConnection < Faraday::TestCase
+
+  def with_proxy_env(proxy)
+    old_proxy = ENV['http_proxy']
+    ENV['http_proxy'] = proxy
+    begin
+      yield
+    ensure
+      ENV['http_proxy'] = old_proxy
+    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
@@ -57,39 +68,24 @@ class TestConnection < Faraday::TestCase
     assert_equal 'Faraday', conn.headers['User-agent']
   end
 
-  def test_basic_auth_sets_authorization_header
+  def test_basic_auth_prepends_basic_auth_middleware
     conn = Faraday::Connection.new
     conn.basic_auth 'Aladdin', 'open sesame'
-    assert_equal 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==', conn.headers['Authorization']
-  end
-
-  def test_long_basic_auth_sets_authorization_header_without_new_lines
-    conn = Faraday::Connection.new
-    conn.basic_auth "A" * 255, ""
-    assert_equal "Basic #{'QUFB' * 85}Og==", conn.headers['Authorization']
-  end
-
-  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']
+    assert_equal Faraday::Request::BasicAuthentication, conn.builder[0].klass
+    assert_equal ['Aladdin', 'open sesame'], conn.builder[0].instance_eval { @args }
   end
 
   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_equal 'Basic Zm9vQGJhci5jb206cGFzcyB3b3Jk', conn.headers['Authorization']
-  end
-
-  def test_token_auth_sets_authorization_header
-    conn = Faraday::Connection.new
-    conn.token_auth 'abcdef'
-    assert_equal 'Token token="abcdef"', conn.headers['Authorization']
+    assert_equal Faraday::Request::BasicAuthentication, conn.builder[0].klass
+    assert_equal ['foo@bar.com', 'pass word'], conn.builder[0].instance_eval { @args }
   end
 
-  def test_token_auth_with_options_sets_authorization_header
+  def test_token_auth_prepends_token_auth_middleware
     conn = Faraday::Connection.new
     conn.token_auth 'abcdef', :nonce => 'abc'
-    assert_equal 'Token token="abcdef",
-                     nonce="abc"', conn.headers['Authorization']
+    assert_equal Faraday::Request::TokenAuthentication, conn.builder[0].klass
+    assert_equal ['abcdef', { :nonce => 'abc' }], conn.builder[0].instance_eval { @args }
   end
 
   def test_build_url_uses_connection_host_as_default_uri_host
@@ -99,11 +95,11 @@ class TestConnection < Faraday::TestCase
     assert_equal 'sushi.com', uri.host
   end
 
-  def test_build_url_uses_connection_port_as_default_uri_port
+  def test_build_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
+    assert_equal 80, uri.port
   end
 
   def test_build_url_uses_connection_scheme_as_default_uri_scheme
@@ -170,36 +166,21 @@ class TestConnection < Faraday::TestCase
   def test_build_url_parses_url_params_into_query
     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
-  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_equal %w[format=json limit=5 page=1 token=abc], url.query.split('&').sort
-  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_equal %w[format=xml limit=5 page=1 token=def], url.query.split('&').sort
+    assert_equal "a%5Bb%5D=1+%2B+2", uri.query
   end
 
-  def test_default_params_hash_has_indifferent_access
-    conn = Faraday::Connection.new :params => {'format' => 'json'}
-    assert conn.params.has_key?(:format)
-    conn.params[:format] = 'xml'
-    url = conn.build_url("")
-    assert_equal %w[format=xml], url.query.split('&').sort
+  def test_build_url_bracketizes_nested_params_in_query
+    conn = Faraday::Connection.new
+    uri = conn.build_url("http://sushi.com/sake.html", 'a' => {'b' => 'c'})
+    assert_equal "a%5Bb%5D=c", uri.query
   end
 
   def test_build_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
+    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
@@ -216,38 +197,46 @@ class TestConnection < Faraday::TestCase
   end
 
   def test_proxy_accepts_string
-    conn = Faraday::Connection.new
-    conn.proxy 'http://proxy.com'
-    assert_equal 'proxy.com', conn.proxy[:uri].host
-    assert_equal [:uri],      conn.proxy.keys
-  end
-
-  def test_proxy_accepts_addressable_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_proxy_env "http://duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      conn.proxy 'http://proxy.com'
+      assert_equal 'proxy.com', conn.proxy[:uri].host
+      assert_equal [:uri],      conn.proxy.keys
+    end
   end
 
-  def test_proxy_accepts_stdlib_uri
-    conn = Faraday::Connection.new
-    conn.proxy URI('http://proxy.com')
-    assert_equal 'proxy.com', conn.proxy[:uri].host
-    assert_equal [:uri],      conn.proxy.keys
+  def test_proxy_accepts_uri
+    with_proxy_env "http://duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      conn.proxy URI.parse('http://proxy.com')
+      assert_equal 'proxy.com', conn.proxy[:uri].host
+      assert_equal [:uri],      conn.proxy.keys
+    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_proxy_env "http://duncan.proxy.com:80" do
+      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]
+    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_proxy_env "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[:uri].host
+      assert_equal 'rick',      conn.proxy[:user]
+    end
+  end
+
+  def test_proxy_accepts_http_env
+    with_proxy_env "http://duncan.proxy.com:80" do
+      conn = Faraday::Connection.new
+      assert_equal 'duncan.proxy.com', conn.proxy[:uri].host
+    end
   end
 
   def test_proxy_requires_uri
@@ -260,22 +249,121 @@ class TestConnection < Faraday::TestCase
   def test_params_to_query_converts_hash_of_params_to_uri_escaped_query_string
     conn = Faraday::Connection.new
     url = conn.build_url('', 'a[b]' => '1 + 2')
-    assert_equal "a%5Bb%5D=1%20%2B%202", url.query
+    assert_equal "a%5Bb%5D=1+%2B+2", url.query
   end
 
   def test_dups_connection_object
-    conn = Faraday::Connection.new 'http://sushi.com/foo', :ssl => { :verify => :none } do |b|
-      b.adapter :net_http
+    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_url(''), other.build_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 3, 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_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
+end
+
+class TestRequestParams < Faraday::TestCase
+  def create_connection(*args)
+    @conn = Faraday::Connection.new(*args) do |conn|
+      yield conn if block_given?
+      class << conn
+        undef app
+        def app() lambda { |env| env } end
+      end
+    end
+  end
+
+  def get(*args)
+    env = @conn.get(*args) do |req|
+      yield req if block_given?
     end
-    conn.headers['content-type'] = 'text/plain'
-    conn.params['a'] = '1'
+    env[:url].query
+  end
+
+  def assert_query_equal(expected, query)
+    assert_equal expected, query.split('&').sort
+  end
 
-    duped = conn.dup
+  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
 
-    assert_equal conn.build_url(''), duped.build_url('')
-    [:headers, :params, :builder, :ssl].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 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
 end

data/test/env_test.rb

@@ -17,7 +17,7 @@ class EnvTest < Faraday::TestCase
     assert_equal :get, env[:method]
   end
 
-  def test_request_create_stores_addressable_uri
+  def test_request_create_stores_uri
     env = make_env do |req|
       req.url 'foo.json', 'a' => 1
     end
@@ -50,7 +50,7 @@ class EnvTest < Faraday::TestCase
     env = make_env do |req|
       req.options[:timeout] = 10
       req.options[:custom] = true
-      req.options[:oauth] = {:consumer_secret => 'xyz'}
+      req.options[:oauth][:consumer_secret] = 'xyz'
     end
     assert_equal 10, env[:request][:timeout]
     assert_equal 5, env[:request][:open_timeout]
@@ -73,7 +73,7 @@ class EnvTest < Faraday::TestCase
   private
 
   def make_env(method = :get, connection = @conn, &block)
-    request = Faraday::Request.create(method, &block)
+    request = connection.build_request(method, &block)
     request.to_env(connection)
   end
 end
@@ -83,6 +83,31 @@ class HeadersTest < Faraday::TestCase
     @headers = Faraday::Utils::Headers.new
   end
 
+  def test_normalizes_different_capitalizations
+    @headers['Content-Type'] = 'application/json'
+    assert_equal ['Content-Type'], @headers.keys
+    assert_equal 'application/json', @headers['Content-Type']
+    assert_equal 'application/json', @headers['CONTENT-TYPE']
+    assert_equal 'application/json', @headers['content-type']
+    assert @headers.include?('content-type')
+
+    @headers['content-type'] = 'application/xml'
+    assert_equal ['Content-Type'], @headers.keys
+    assert_equal 'application/xml', @headers['Content-Type']
+    assert_equal 'application/xml', @headers['CONTENT-TYPE']
+    assert_equal 'application/xml', @headers['content-type']
+  end
+
+  def test_delete_key
+    @headers['Content-Type'] = 'application/json'
+    assert_equal 1, @headers.size
+    assert @headers.include?('content-type')
+    assert_equal 'application/json', @headers.delete('content-type')
+    assert_equal 0, @headers.size
+    assert !@headers.include?('content-type')
+    assert_equal nil, @headers.delete('content-type')
+  end
+
   def test_parse_response_headers_leaves_http_status_line_out
     @headers.parse("HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n")
     assert_equal %w(Content-Type), @headers.keys