faraday 0.6.0 → 0.9.0

data/test/middleware_stack_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+require File.expand_path('../helper', __FILE__)
 
 class MiddlewareStackTest < Faraday::TestCase
   # mock handler classes
@@ -12,22 +12,24 @@ class MiddlewareStackTest < Faraday::TestCase
   class Orange < Handler; end
   class Banana < Handler; end
 
+  class Broken < Faraday::Middleware
+    dependency 'zomg/i_dont/exist'
+  end
+
   def setup
     @conn = Faraday::Connection.new
     @builder = @conn.builder
   end
 
   def test_sets_default_adapter_if_none_set
-    default_middleware = Faraday::Request.lookup_module :url_encoded
-    default_adapter_klass = Faraday::Adapter.lookup_module Faraday.default_adapter
+    default_middleware = Faraday::Request.lookup_middleware :url_encoded
+    default_adapter_klass = Faraday::Adapter.lookup_middleware Faraday.default_adapter
     assert @builder[0] == default_middleware
     assert @builder[1] == default_adapter_klass
   end
 
   def test_allows_rebuilding
     build_stack Apple
-    assert_handlers %w[Apple]
-
     build_stack Orange
     assert_handlers %w[Orange]
   end
@@ -67,12 +69,87 @@ class MiddlewareStackTest < Faraday::TestCase
     assert_handlers %w[Orange]
   end
 
+  def test_stack_is_locked_after_making_requests
+    build_stack Apple
+    assert !@builder.locked?
+    @conn.get('/')
+    assert @builder.locked?
+
+    assert_raises Faraday::RackBuilder::StackLocked do
+      @conn.use Orange
+    end
+  end
+
+  def test_duped_stack_is_unlocked
+    build_stack Apple
+    assert !@builder.locked?
+    @builder.lock!
+    assert @builder.locked?
+
+    duped_connection = @conn.dup
+    assert_equal @builder, duped_connection.builder
+    assert !duped_connection.builder.locked?
+  end
+
+  def test_handler_comparison
+    build_stack Apple
+    assert_equal @builder.handlers.first, Apple
+    assert_equal @builder.handlers[0,1], [Apple]
+    assert_equal @builder.handlers.first, Faraday::RackBuilder::Handler.new(Apple)
+  end
+
+  def test_unregistered_symbol
+    err = assert_raises(Faraday::Error){ build_stack :apple }
+    assert_equal ":apple is not registered on Faraday::Middleware", err.message
+  end
+
+  def test_registered_symbol
+    Faraday::Middleware.register_middleware :apple => Apple
+    begin
+      build_stack :apple
+      assert_handlers %w[Apple]
+    ensure
+      unregister_middleware Faraday::Middleware, :apple
+    end
+  end
+
+  def test_registered_symbol_with_proc
+    Faraday::Middleware.register_middleware :apple => lambda { Apple }
+    begin
+      build_stack :apple
+      assert_handlers %w[Apple]
+    ensure
+      unregister_middleware Faraday::Middleware, :apple
+    end
+  end
+
+  def test_registered_symbol_with_array
+    Faraday::Middleware.register_middleware File.expand_path("..", __FILE__),
+      :strawberry => [lambda { Strawberry }, 'strawberry']
+    begin
+      build_stack :strawberry
+      assert_handlers %w[Strawberry]
+    ensure
+      unregister_middleware Faraday::Middleware, :strawberry
+    end
+  end
+
+  def test_missing_dependencies
+    build_stack Broken
+    err = assert_raises RuntimeError do
+      @conn.get('/')
+    end
+    assert_match "missing dependency for MiddlewareStackTest::Broken: ", err.message
+    assert_match "zomg/i_dont/exist", err.message
+  end
+
   private
 
   # make a stack with test adapter that reflects the order of middleware
   def build_stack(*handlers)
     @builder.build do |b|
       handlers.each { |handler| b.use(*handler) }
+      yield(b) if block_given?
 
       b.adapter :test do |stub|
         stub.get '/' do |env|
@@ -88,4 +165,9 @@ class MiddlewareStackTest < Faraday::TestCase
     echoed_list.shift if echoed_list.first == ''
     assert_equal list, echoed_list
   end
+
+  def unregister_middleware(component, key)
+    # TODO: unregister API?
+    component.instance_variable_get('@registered_middleware').delete(key)
+  end
 end

data/test/multibyte.txt

@@ -0,0 +1 @@
+ファイル

data/test/options_test.rb

@@ -0,0 +1,252 @@
+require File.expand_path('../helper', __FILE__)
+
+class OptionsTest < Faraday::TestCase
+  class SubOptions < Faraday::Options.new(:sub); end
+  class ParentOptions < Faraday::Options.new(:a, :b, :c)
+    options :c => SubOptions
+  end
+
+  def test_clear
+    options = SubOptions.new(1)
+    assert !options.empty?
+    assert options.clear
+    assert options.empty?
+  end
+
+  def test_empty
+    options = SubOptions.new
+    assert options.empty?
+    options.sub = 1
+    assert !options.empty?
+    options.delete(:sub)
+    assert options.empty?
+  end
+
+  def test_each_key
+    options = ParentOptions.new(1, 2, 3)
+    enum = options.each_key
+    assert_equal enum.next.to_sym, :a
+    assert_equal enum.next.to_sym, :b
+    assert_equal enum.next.to_sym, :c
+  end
+
+  def test_key?
+    options = SubOptions.new
+    assert !options.key?(:sub)
+    options.sub = 1
+    if RUBY_VERSION >= '1.9'
+      assert options.key?(:sub)
+    else
+      assert options.key?("sub")
+    end
+  end
+
+  def test_each_value
+    options = ParentOptions.new(1, 2, 3)
+    enum = options.each_value
+    assert_equal enum.next, 1
+    assert_equal enum.next, 2
+    assert_equal enum.next, 3
+  end
+
+  def test_value?
+    options = SubOptions.new
+    assert !options.value?(1)
+    options.sub = 1
+    assert options.value?(1)
+  end
+
+  def test_request_proxy_setter
+    options = Faraday::RequestOptions.new
+    assert_nil options.proxy
+
+    assert_raises NoMethodError do
+      options[:proxy] = {:booya => 1}
+    end
+
+    options[:proxy] = {:user => 'user'}
+    assert_kind_of Faraday::ProxyOptions, options.proxy
+    assert_equal 'user', options.proxy.user
+
+    options.proxy = nil
+    assert_nil options.proxy
+  end
+
+  def test_proxy_options_from_string
+    options = Faraday::ProxyOptions.from 'http://user:pass@example.org'
+    assert_equal 'user', options.user
+    assert_equal 'pass', options.password
+    assert_kind_of URI, options.uri
+    assert_equal '', options.path
+    assert_equal 80, options.port
+    assert_equal 'example.org', options.host
+    assert_equal 'http', options.scheme
+  end
+
+  def test_proxy_options_hash_access
+    proxy = Faraday::ProxyOptions.from 'http://a%40b:pw%20d@example.org'
+    assert_equal 'a@b', proxy[:user]
+    assert_equal 'a@b', proxy.user
+    assert_equal 'pw d', proxy[:password]
+    assert_equal 'pw d', proxy.password
+  end
+
+  def test_proxy_options_no_auth
+    proxy = Faraday::ProxyOptions.from 'http://example.org'
+    assert_nil proxy.user
+    assert_nil proxy.password
+  end
+
+  def test_from_options
+    options = ParentOptions.new(1)
+
+    value = ParentOptions.from(options)
+    assert_equal 1, value.a
+    assert_nil value.b
+  end
+
+  def test_from_options_with_sub_object
+    sub = SubOptions.new(1)
+    options = ParentOptions.from :a => 1, :c => sub
+    assert_kind_of ParentOptions, options
+    assert_equal 1, options.a
+    assert_nil options.b
+    assert_kind_of SubOptions, options.c
+    assert_equal 1, options.c.sub
+  end
+
+  def test_from_hash
+    options = ParentOptions.from :a => 1
+    assert_kind_of ParentOptions, options
+    assert_equal 1, options.a
+    assert_nil options.b
+  end
+
+  def test_from_hash_with_sub_object
+    options = ParentOptions.from :a => 1, :c => {:sub => 1}
+    assert_kind_of ParentOptions, options
+    assert_equal 1, options.a
+    assert_nil options.b
+    assert_kind_of SubOptions, options.c
+    assert_equal 1, options.c.sub
+  end
+
+  def test_inheritance
+    subclass = Class.new(ParentOptions)
+    options = subclass.from(:c => {:sub => 'hello'})
+    assert_kind_of SubOptions, options.c
+    assert_equal 'hello', options.c.sub
+  end
+
+  def test_from_deep_hash
+    hash = {:b => 1}
+    options = ParentOptions.from :a => hash
+    assert_equal 1, options.a[:b]
+
+    hash[:b] = 2
+    assert_equal 1, options.a[:b]
+
+    options.a[:b] = 3
+    assert_equal 2, hash[:b]
+    assert_equal 3, options.a[:b]
+  end
+
+  def test_from_nil
+    options = ParentOptions.from(nil)
+    assert_kind_of ParentOptions, options
+    assert_nil options.a
+    assert_nil options.b
+  end
+
+  def test_invalid_key
+    assert_raises NoMethodError do
+      ParentOptions.from :invalid => 1
+    end
+  end
+
+  def test_update
+    options = ParentOptions.new(1)
+    assert_equal 1, options.a
+    assert_nil options.b
+
+    updated = options.update :a => 2, :b => 3
+    assert_equal 2, options.a
+    assert_equal 3, options.b
+    assert_equal options, updated
+  end
+
+  def test_delete
+    options = ParentOptions.new(1)
+    assert_equal 1, options.a
+    assert_equal 1, options.delete(:a)
+    assert_nil options.a
+  end
+
+  def test_merge
+    options = ParentOptions.new(1)
+    assert_equal 1, options.a
+    assert_nil options.b
+
+    dup = options.merge :a => 2, :b => 3
+    assert_equal 2, dup.a
+    assert_equal 3, dup.b
+    assert_equal 1, options.a
+    assert_nil options.b
+  end
+
+  def test_env_access_member
+    e = Faraday::Env.new
+    assert_nil e.method
+    e.method = :get
+    assert_equal :get, e.method
+  end
+
+  def test_env_access_symbol_non_member
+    e = Faraday::Env.new
+    assert_nil e[:custom]
+    e[:custom] = :boom
+    assert_equal :boom, e[:custom]
+  end
+
+  def test_env_access_string_non_member
+    e = Faraday::Env.new
+    assert_nil e["custom"]
+    e["custom"] = :boom
+    assert_equal :boom, e["custom"]
+  end
+
+  def test_env_fetch_ignores_false
+    ssl = Faraday::SSLOptions.new
+    ssl.verify = false
+    assert !ssl.fetch(:verify, true)
+  end
+
+  def test_fetch_grabs_value
+    opt = Faraday::SSLOptions.new
+    opt.verify = 1
+    assert_equal 1, opt.fetch(:verify, false) { |k| :blah }
+  end
+
+  def test_fetch_uses_falsey_default
+    opt = Faraday::SSLOptions.new
+    assert_equal false, opt.fetch(:verify, false) { |k| :blah }
+  end
+
+  def test_fetch_accepts_block
+    opt = Faraday::SSLOptions.new
+    assert_equal "yo :verify", opt.fetch(:verify) { |k| "yo #{k.inspect}"}
+  end
+
+  def test_fetch_needs_a_default_if_key_is_missing
+    opt = Faraday::SSLOptions.new
+    assert_raises Faraday::Options.fetch_error_class do
+      opt.fetch :verify
+    end
+  end
+
+  def test_fetch_works_with_key
+    opt = Faraday::SSLOptions.new
+    opt.verify = 1
+    assert_equal 1, opt.fetch(:verify)
+  end
+end

data/test/request_middleware_test.rb

@@ -1,14 +1,13 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
-require 'rack/utils'
+# encoding: utf-8
+require File.expand_path('../helper', __FILE__)
 
-Faraday::CompositeReadIO.send :attr_reader, :ios
+Faraday::CompositeReadIO.class_eval { attr_reader :ios }
 
 class RequestMiddlewareTest < Faraday::TestCase
   def setup
     @conn = Faraday.new do |b|
       b.request :multipart
       b.request :url_encoded
-      b.request :json
       b.adapter :test do |stub|
         stub.post('/echo') do |env|
           posted_as = env[:request_headers]['Content-Type']
@@ -18,6 +17,20 @@ class RequestMiddlewareTest < Faraday::TestCase
     end
   end
 
+  def with_utf8
+    if defined?(RUBY_VERSION) && RUBY_VERSION.match(/1.8.\d/)
+      begin
+        previous_kcode = $KCODE
+        $KCODE = "UTF8"
+        yield
+      ensure
+        $KCODE = previous_kcode
+      end
+    else
+      yield
+    end
+  end
+
   def test_does_nothing_without_payload
     response = @conn.post('/echo')
     assert_nil response.headers['Content-Type']
@@ -30,22 +43,10 @@ class RequestMiddlewareTest < Faraday::TestCase
     assert_equal({ :some => 'data' }, response.body)
   end
 
-  def test_json_encodes_hash
-    response = @conn.post('/echo', { :fruit => %w[apples oranges] }, 'content-type' => 'application/json')
-    assert_equal 'application/json', response.headers['Content-Type']
-    assert_equal '{"fruit":["apples","oranges"]}', response.body
-  end
-
-  def test_json_skips_encoding_for_strings
-    response = @conn.post('/echo', '{"a":"b"}', 'content-type' => 'application/json')
-    assert_equal 'application/json', response.headers['Content-Type']
-    assert_equal '{"a":"b"}', response.body
-  end
-
   def test_url_encoded_no_header
     response = @conn.post('/echo', { :fruit => %w[apples oranges] })
     assert_equal 'application/x-www-form-urlencoded', response.headers['Content-Type']
-    assert_equal 'fruit[]=apples&fruit[]=oranges', response.body
+    assert_equal 'fruit%5B%5D=apples&fruit%5B%5D=oranges', response.body
   end
 
   def test_url_encoded_with_header
@@ -58,7 +59,40 @@ class RequestMiddlewareTest < Faraday::TestCase
     response = @conn.post('/echo', { :user => {:name => 'Mislav', :web => 'mislav.net'} })
     assert_equal 'application/x-www-form-urlencoded', response.headers['Content-Type']
     expected = { 'user' => {'name' => 'Mislav', 'web' => 'mislav.net'} }
-    assert_equal expected, Rack::Utils.parse_nested_query(response.body)
+    assert_equal expected, Faraday::Utils.parse_nested_query(response.body)
+  end
+
+  def test_url_encoded_non_nested
+    response = @conn.post('/echo', { :dimensions => ['date', 'location']}) do |req|
+      req.options.params_encoder = Faraday::FlatParamsEncoder
+    end
+    assert_equal 'application/x-www-form-urlencoded', response.headers['Content-Type']
+    expected = { 'dimensions' => ['date', 'location'] }
+    assert_equal expected, Faraday::Utils.parse_query(response.body)
+    assert_equal 'dimensions=date&dimensions=location', response.body
+  end
+
+  def test_url_encoded_unicode
+    err = capture_warnings {
+      response = @conn.post('/echo', {:str => "eé cç aã aâ"})
+      assert_equal "str=e%C3%A9+c%C3%A7+a%C3%A3+a%C3%A2", response.body
+    }
+    assert err.empty?, "stderr did include: #{err}"
+  end
+
+  def test_url_encoded_unicode_with_kcode_set
+    with_utf8 do
+      err = capture_warnings {
+        response = @conn.post('/echo', {:str => "eé cç aã aâ"})
+        assert_equal "str=e%C3%A9+c%C3%A7+a%C3%A3+a%C3%A2", response.body
+      }
+      assert err.empty?, "stderr did include: #{err}"
+    end
+  end
+
+  def test_url_encoded_nested_keys
+    response = @conn.post('/echo', {'a'=>{'b'=>{'c'=>['d']}}})
+    assert_equal "a%5Bb%5D%5Bc%5D%5B%5D=d", response.body
   end
 
   def test_multipart
@@ -72,14 +106,37 @@ class RequestMiddlewareTest < Faraday::TestCase
     response = @conn.post('/echo', payload)
 
     assert_kind_of Faraday::CompositeReadIO, response.body
-    assert_equal "multipart/form-data;boundary=%s" % Faraday::Request::Multipart::DEFAULT_BOUNDARY,
+    assert_equal "multipart/form-data; boundary=%s" % Faraday::Request::Multipart::DEFAULT_BOUNDARY,
       response.headers['Content-Type']
-    
-    response.body.send(:ios).map(&:read).each do |io|
+
+    response.body.send(:ios).map{|io| io.read}.each do |io|
+      if re = regexes.detect { |r| io =~ r }
+        regexes.delete re
+      end
+    end
+    assert_equal [], regexes
+  end
+
+  def test_multipart_with_arrays
+    # assume params are out of order
+    regexes = [
+      /name\=\"a\"/,
+      /name=\"b\[\]\[c\]\"\; filename\=\"request_middleware_test\.rb\"/,
+      /name=\"b\[\]\[d\]\"/]
+
+    payload = {:a => 1, :b =>[{:c => Faraday::UploadIO.new(__FILE__, 'text/x-ruby'), :d => 2}]}
+    response = @conn.post('/echo', payload)
+
+    assert_kind_of Faraday::CompositeReadIO, response.body
+    assert_equal "multipart/form-data; boundary=%s" % Faraday::Request::Multipart::DEFAULT_BOUNDARY,
+      response.headers['Content-Type']
+
+    response.body.send(:ios).map{|io| io.read}.each do |io|
       if re = regexes.detect { |r| io =~ r }
         regexes.delete re
       end
     end
     assert_equal [], regexes
   end
+
 end

data/test/response_middleware_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+require File.expand_path('../helper', __FILE__)
 
 class ResponseMiddlewareTest < Faraday::TestCase
   def setup
@@ -19,11 +19,9 @@ class ResponseMiddlewareTest < Faraday::TestCase
   end
 
   def test_success
-    assert_nothing_raised do
-      @conn.get('ok')
-    end
+    assert @conn.get('ok')
   end
-  
+
   def test_raises_not_found
     error = assert_raises Faraday::Error::ResourceNotFound do
       @conn.get('not-found')
@@ -31,7 +29,7 @@ class ResponseMiddlewareTest < Faraday::TestCase
     assert_equal 'the server responded with status 404', error.message
     assert_equal 'because', error.response[:headers]['X-Reason']
   end
-  
+
   def test_raises_error
     error = assert_raises Faraday::Error::ClientError do
       @conn.get('error')
@@ -39,9 +37,36 @@ class ResponseMiddlewareTest < Faraday::TestCase
     assert_equal 'the server responded with status 500', error.message
     assert_equal 'bailout', error.response[:headers]['X-Error']
   end
-  
+
   def test_upcase
     @conn.builder.insert(0, ResponseUpcaser)
     assert_equal '<BODY></BODY>', @conn.get('ok').body
   end
 end
+
+class ResponseNoBodyMiddleWareTest < Faraday::TestCase
+  def setup
+    @conn = Faraday.new do |b|
+      b.response :raise_error
+      b.adapter :test do |stub|
+        stub.get('not_modified') { [304, nil, nil] }
+        stub.get('no_content') { [204, nil, nil] }
+      end
+    end
+    @conn.builder.insert(0, NotCalled)
+  end
+
+  class NotCalled < Faraday::Response::Middleware
+    def parse(body)
+      raise "this should not be called"
+    end
+  end
+
+  def test_204
+    assert_equal nil, @conn.get('no_content').body
+  end
+
+  def test_304
+    assert_equal nil, @conn.get('not_modified').body
+  end
+end

data/test/strawberry.rb

@@ -0,0 +1,2 @@
+class MiddlewareStackTest::Strawberry < MiddlewareStackTest::Handler
+end

data/test/utils_test.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestUtils < Faraday::TestCase
+  def setup
+    @url = "http://example.com/abc"
+  end
+
+  # emulates ActiveSupport::SafeBuffer#gsub
+  FakeSafeBuffer = Struct.new(:string) do
+    def to_s() self end
+    def gsub(regex)
+      string.gsub(regex) {
+        match, = $&, '' =~ /a/
+        yield(match)
+      }
+    end
+  end
+
+  def test_escaping_safe_buffer
+    str = FakeSafeBuffer.new('$32,000.00')
+    assert_equal '%2432%2C000.00', Faraday::Utils.escape(str)
+  end
+
+  def test_parses_with_default
+    with_default_uri_parser(nil) do
+      uri = normalize(@url)
+      assert_equal 'example.com', uri.host
+    end
+  end
+
+  def test_parses_with_URI
+    with_default_uri_parser(::URI) do
+      uri = normalize(@url)
+      assert_equal 'example.com', uri.host
+    end
+  end
+
+  def test_parses_with_block
+    with_default_uri_parser(lambda {|u| "booya#{"!" * u.size}" }) do
+      assert_equal 'booya!!!!!!!!!!!!!!!!!!!!!!', normalize(@url)
+    end
+  end
+
+  def normalize(url)
+    Faraday::Utils::URI(url)
+  end
+
+  def with_default_uri_parser(parser)
+    old_parser = Faraday::Utils.default_uri_parser
+    begin
+      Faraday::Utils.default_uri_parser = parser
+      yield
+    ensure
+      Faraday::Utils.default_uri_parser = old_parser
+    end
+  end
+end
+