faraday 0.8.11 → 0.9.0

data/test/connection_test.rb

@@ -1,5 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
-require 'uri'
+require File.expand_path('../helper', __FILE__)
 
 class TestConnection < Faraday::TestCase
 
@@ -98,140 +97,180 @@ class TestConnection < Faraday::TestCase
     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_overrides_connection_port_for_absolute_urls
+  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")
+    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_doesnt_add_ending_slash_given_nil_url
+  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_url(nil)
+    uri = conn.build_exclusive_url
     assert_equal "/nigiri", uri.path
   end
 
-  def test_build_url_doesnt_add_ending_slash_given_empty_url
+  def test_build_exclusive_url_doesnt_add_ending_slash_given_empty_url
     conn = Faraday::Connection.new
     conn.url_prefix = "http://sushi.com/nigiri"
-    uri = conn.build_url('')
+    uri = conn.build_exclusive_url('')
     assert_equal "/nigiri", uri.path
   end
 
-  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')
+  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_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_build_url_escapes_per_spec
-    conn = Faraday::Connection.new
-    uri = conn.build_url('http:/', 'a' => '1+2 foo~bar.-baz')
+  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_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
+  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_build_url_parses_url
+  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_exclusive_url_parses_url
     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 "http",       uri.scheme
     assert_equal "sushi.com",  uri.host
     assert_equal '/sake.html', uri.path
   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_build_url_handles_uri_instances
-    conn = Faraday::Connection.new
-    uri = conn.build_url(URI('/sake.html'))
-    assert_equal '/sake.html', uri.path
+  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_request_header_change_does_not_modify_connection_header
-    connection = Faraday.new(:url => "https://asushi.com/sake.html")
-    connection.headers = { "Authorization"=>"token abc123" }
-
-    request = connection.build_request(:get)
-    request.headers.delete("Authorization")
+  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
 
-    assert_equal connection.headers.keys.sort, ["Authorization"]
-    assert connection.headers.include?("Authorization")
+  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
 
-    assert_equal request.headers.keys.sort, []
-    assert !request.headers.include?("Authorization")
+  def test_build_exclusive_url_handles_uri_instances
+    conn = Faraday::Connection.new
+    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[:uri].host
-      assert_equal [:uri],      conn.proxy.keys
+      assert_equal 'proxy.com', conn.proxy.host
     end
   end
 
@@ -239,8 +278,7 @@ class TestConnection < Faraday::TestCase
     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[:uri].host
-      assert_equal [:uri],      conn.proxy.keys
+      assert_equal 'proxy.com', conn.proxy.host
     end
   end
 
@@ -248,8 +286,8 @@ class TestConnection < Faraday::TestCase
     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[:uri].host
-      assert_equal 'rick',      conn.proxy[:user]
+      assert_equal 'proxy.com', conn.proxy.host
+      assert_equal 'rick',      conn.proxy.user
     end
   end
 
@@ -257,23 +295,23 @@ class TestConnection < Faraday::TestCase
     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[:uri].host
-      assert_equal 'rick',      conn.proxy[:user]
+      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[:uri].host
+      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]
+      assert_equal 'a@b',     conn.proxy.user
+      assert_equal 'my pass', conn.proxy.password
     end
   end
 
@@ -317,26 +355,27 @@ class TestConnection < Faraday::TestCase
     conn = Faraday::Connection.new 'http://sushi.com/foo',
       :ssl => { :verify => :none },
       :headers => {'content-type' => 'text/plain'},
-      :params => {'a'=>'1'},
-      :request => {:timeout => 5}
+      :params => {'a'=>'1'}
 
     other = conn.dup
 
-    assert_equal conn.build_url(''), other.build_url('')
+    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'
-    other.options[:open_timeout] = 10
 
     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')
-    assert_equal 5, other.options[:timeout]
-    assert_nil conn.options[:open_timeout]
+  end
+
+  def test_initialize_with_false_option
+    conn = Faraday::Connection.new :ssl => {:verify => false}
+    assert !conn.ssl.verify?
   end
 
   def test_init_with_block
@@ -353,30 +392,40 @@ class TestConnection < Faraday::TestCase
     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
+      yield(conn) if block_given?
+      class << conn.builder
         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
-    env[:url].query
-  end
-
   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
+  end
+
   def test_merges_connection_and_request_params
     create_connection 'http://a.co/?token=abc', :params => {'format' => 'json'}
     query = get '?page=1', :limit => 5
@@ -433,14 +482,41 @@ class TestRequestParams < Faraday::TestCase
   end
 
   def test_array_params_in_url
-    create_connection 'http://a.co/page1?color[]=red&color[]=blue'
-    query = get
-    assert_equal "color%5B%5D=red&color%5B%5D=blue", query
+    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
-    create_connection 'http://a.co/page1', :params => {:color => ['red', 'blue']}
-    query = get
-    assert_equal "color%5B%5D=red&color%5B%5D=blue", query
+    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
+
+  def get(*args)
+    env = @conn.get(*args) do |req|
+      yield(req) if block_given?
+    end
+    env[:url].query
   end
 end

data/test/env_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+require File.expand_path('../helper', __FILE__)
 
 class EnvTest < Faraday::TestCase
   def setup
@@ -6,29 +6,29 @@ class EnvTest < Faraday::TestCase
       :headers => {'Mime-Version' => '1.0'},
       :request => {:oauth => {:consumer_key => 'anonymous'}}
 
-    @conn.options[:timeout]      = 3
-    @conn.options[:open_timeout] = 5
-    @conn.ssl[:verify]           = false
+    @conn.options.timeout      = 3
+    @conn.options.open_timeout = 5
+    @conn.ssl.verify           = false
     @conn.proxy 'http://proxy.com'
   end
 
   def test_request_create_stores_method
     env = make_env(:get)
-    assert_equal :get, env[:method]
+    assert_equal :get, env.method
   end
 
   def test_request_create_stores_uri
     env = make_env do |req|
       req.url 'foo.json', 'a' => 1
     end
-    assert_equal 'http://sushi.com/api/foo.json?a=1', env[:url].to_s
+    assert_equal 'http://sushi.com/api/foo.json?a=1', env.url.to_s
   end
 
   def test_request_create_stores_headers
     env = make_env do |req|
       req['Server'] = 'Faraday'
     end
-    headers = env[:request_headers]
+    headers = env.request_headers
     assert_equal '1.0', headers['mime-version']
     assert_equal 'Faraday', headers['server']
   end
@@ -37,37 +37,37 @@ class EnvTest < Faraday::TestCase
     env = make_env do |req|
       req.body = 'hi'
     end
-    assert_equal 'hi', env[:body]
+    assert_equal 'hi', env.body
   end
 
   def test_global_request_options
     env = make_env
-    assert_equal 3, env[:request][:timeout]
-    assert_equal 5, env[:request][:open_timeout]
+    assert_equal 3, env.request.timeout
+    assert_equal 5, env.request.open_timeout
   end
 
   def test_per_request_options
     env = make_env do |req|
-      req.options[:timeout] = 10
-      req.options[:custom] = true
-      req.options[:oauth][:consumer_secret] = 'xyz'
+      req.options.timeout = 10
+      req.options.boundary = 'boo'
+      req.options.oauth[:consumer_secret] = 'xyz'
     end
-    assert_equal 10, env[:request][:timeout]
-    assert_equal 5, env[:request][:open_timeout]
-    assert_equal true, env[:request][:custom]
+    assert_equal 10, env.request.timeout
+    assert_equal 5, env.request.open_timeout
+    assert_equal 'boo', env.request.boundary
 
     oauth_expected = {:consumer_secret => 'xyz', :consumer_key => 'anonymous'}
-    assert_equal oauth_expected, env[:request][:oauth]
+    assert_equal oauth_expected, env.request.oauth
   end
 
   def test_request_create_stores_ssl_options
     env = make_env
-    assert_equal false, env[:ssl][:verify]
+    assert_equal false, env.ssl.verify
   end
 
   def test_request_create_stores_proxy_options
     env = make_env
-    assert_equal 'proxy.com', env[:request][:proxy][:uri].host
+    assert_equal 'proxy.com', env.request.proxy.host
   end
 
   private
@@ -98,6 +98,25 @@ class HeadersTest < Faraday::TestCase
     assert_equal 'application/xml', @headers['content-type']
   end
 
+  def test_fetch_key
+    @headers['Content-Type'] = 'application/json'
+    block_called = false
+    assert_equal 'application/json', @headers.fetch('content-type') { block_called = true }
+    assert_equal 'application/json', @headers.fetch('Content-Type')
+    assert_equal 'application/json', @headers.fetch('CONTENT-TYPE')
+    assert_equal 'application/json', @headers.fetch(:content_type)
+    assert_equal false, block_called
+
+    assert_equal 'default', @headers.fetch('invalid', 'default')
+    assert_equal false, @headers.fetch('invalid', false)
+    assert_nil   @headers.fetch('invalid', nil)
+
+    assert_equal 'Invalid key', @headers.fetch('Invalid') { |key| "#{key} key" }
+
+    expected_error = defined?(KeyError) ? KeyError : IndexError
+    assert_raises(expected_error) { @headers.fetch('invalid') }
+  end
+
   def test_delete_key
     @headers['Content-Type'] = 'application/json'
     assert_equal 1, @headers.size
@@ -131,10 +150,9 @@ end
 
 class ResponseTest < Faraday::TestCase
   def setup
-    @env = {
+    @env = Faraday::Env.from \
       :status => 404, :body => 'yikes',
-      :response_headers => Faraday::Utils::Headers.new('Content-Type' => 'text/plain')
-    }
+      :response_headers => {'Content-Type' => 'text/plain'}
     @response = Faraday::Response.new @env
   end
 
@@ -174,10 +192,19 @@ class ResponseTest < Faraday::TestCase
   def test_marshal
     @response = Faraday::Response.new
     @response.on_complete { }
-    @response.finish @env.merge(:custom => 'moo')
+    @response.finish @env.merge(:params => 'moo')
 
     loaded = Marshal.load Marshal.dump(@response)
-    assert_nil loaded.env[:custom]
+    assert_nil loaded.env[:params]
     assert_equal %w[body response_headers status], loaded.env.keys.map { |k| k.to_s }.sort
   end
+
+  def test_hash
+    hash = @response.to_hash
+    assert_kind_of Hash, hash
+    assert_equal @env.to_hash, hash
+    assert_equal hash[:status], @response.status
+    assert_equal hash[:response_headers], @response.headers
+    assert_equal hash[:body], @response.body
+  end
 end

data/test/helper.rb

@@ -1,14 +1,18 @@
-if RUBY_VERSION >= '1.9'
-  require 'simplecov'
+require 'rubygems'         # rubygems/version doesn't work by itself
+require 'rubygems/version' # for simplecov-html
+require 'simplecov'
+require 'coveralls'
 
-  SimpleCov.start do
-    add_filter '/bundle/'
-    add_filter '/test/'
-    minimum_coverage(88.74)
-  end
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/bundle/'
 end
 
-require 'test/unit'
+gem 'minitest' if defined? Bundler
+require 'minitest/autorun'
 
 if ENV['LEFTRIGHT']
   begin
@@ -44,7 +48,7 @@ module Faraday
     end
   end
 
-  class TestCase < Test::Unit::TestCase
+  class TestCase < MiniTest::Test
     extend LiveServerConfig
     self.live_server = ENV['LIVE']
 
@@ -70,10 +74,6 @@ module Faraday
       defined? RUBY_ENGINE and 'rbx' == RUBY_ENGINE
     end
 
-    def self.ruby_22_plus?
-      RUBY_VERSION > '2.2'
-    end
-
     def self.ssl_mode?
       ENV['SSL'] == 'yes'
     end

data/test/live_server.rb

@@ -39,11 +39,19 @@ class LiveServer < Sinatra::Base
     [200, { 'Set-Cookie' => 'one, two' }, '']
   end
 
+  get '/who-am-i' do
+    request.env['REMOTE_ADDR']
+  end
+
   get '/slow' do
     sleep 10
     [200, {}, 'ok']
   end
 
+  get '/204' do
+    status 204 # no content
+  end
+
   get '/ssl' do
     request.secure?.to_s
   end