faraday 0.14.0 → 0.17.6

data/test/options_test.rb

@@ -0,0 +1,333 @@
+require File.expand_path('../helper', __FILE__)
+
+class OptionsTest < Faraday::TestCase
+  SubOptions = Class.new(Faraday::Options.new(:sub_a, :sub_b))
+  class ParentOptions < Faraday::Options.new(:a, :b, :c)
+    options :c => SubOptions
+  end
+
+  def test_deep_merge
+    sub_opts1 = SubOptions.from(sub_a: 3)
+    sub_opts2 = SubOptions.from(sub_b: 4)
+    opt1 = ParentOptions.from(a: 1, c: sub_opts1)
+    opt2 = ParentOptions.from(b: 2, c: sub_opts2)
+
+    merged = opt1.merge(opt2)
+
+    expected_sub_opts = SubOptions.from(sub_a: 3, sub_b: 4)
+    assert_equal merged, ParentOptions.from(a: 1, b: 2, c: expected_sub_opts)
+  end
+
+  def test_deep_merge_with_hash
+    sub_opts1 = SubOptions.from(sub_a: 3)
+    sub_opts2 = { sub_b: 4 }
+    opt1 = ParentOptions.from(a: 1, c: sub_opts1)
+    opt2 = { b: 2, c: sub_opts2 }
+
+    merged = opt1.merge(opt2)
+
+    expected_sub_opts = SubOptions.from(sub_a: 3, sub_b: 4)
+    assert_equal merged, ParentOptions.from(a: 1, b: 2, c: expected_sub_opts)
+  end
+
+  def test_deep_merge_with_nil
+    sub_opts = SubOptions.new(3, 4)
+    options = ParentOptions.new(1, 2, sub_opts)
+    assert_equal options.a, 1
+    assert_equal options.b, 2
+    assert_equal options.c.sub_a, 3
+    assert_equal options.c.sub_b, 4
+
+    options2 = ParentOptions.from(b: 5, c: nil)
+
+    merged = options.merge(options2)
+
+    assert_equal merged.b, 5
+    assert_equal merged.c, sub_opts
+  end
+
+  def test_deep_merge_with_sub_nil
+    options = ParentOptions.from(a: 1)
+
+    sub_opts = SubOptions.new(3, 4)
+    options2 = ParentOptions.from(b: 2, c: sub_opts)
+
+    assert_equal options.a, 1
+    assert_equal options2.b, 2
+    assert_equal options2.c.sub_a, 3
+    assert_equal options2.c.sub_b, 4
+
+    merged = options.merge(options2)
+
+    assert_equal merged.c, sub_opts
+  end
+
+  def test_dup_is_shallow
+    sub_opts = SubOptions.from(sub_a: 3)
+    opts = ParentOptions.from(b: 1, c: sub_opts)
+
+    duped = opts.dup
+    duped.b = 2
+    duped.c.sub_a = 4
+
+    assert_equal opts.b, 1
+    assert_equal opts.c.sub_a, 4
+  end
+
+  def test_deep_dup
+    sub_opts = SubOptions.from(sub_a: 3)
+    opts = ParentOptions.from(b: 1, c: sub_opts)
+
+    duped = opts.deep_dup
+    duped.b = 2
+    duped.c.sub_a = 4
+
+    assert_equal opts.b, 1
+    assert_equal opts.c.sub_a, 3
+  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_a = 1
+    assert !options.empty?
+    options.delete(:sub_a)
+    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_a)
+    options.sub_a = 1
+    assert options.key?(:sub_a)
+  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_a = 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_from_nil
+    options = Faraday::ProxyOptions.from nil
+    assert_kind_of Faraday::ProxyOptions, options
+  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_a
+  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_a => 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_a
+  end
+
+  def test_inheritance
+    subclass = Class.new(ParentOptions)
+    options = subclass.from(:c => {:sub_a => 'hello'})
+    assert_kind_of SubOptions, options.c
+    assert_equal 'hello', options.c.sub_a
+  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/parameters_test.rb

@@ -0,0 +1,157 @@
+require File.expand_path("../helper", __FILE__)
+require "rack/utils"
+
+class TestParameters < Faraday::TestCase
+  # 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_nested
+    monies = FakeSafeBuffer.new("$32,000.00")
+    assert_equal "a=%2432%2C000.00", Faraday::NestedParamsEncoder.encode("a" => monies)
+  end
+
+  def test_escaping_safe_buffer_flat
+    monies = FakeSafeBuffer.new("$32,000.00")
+    assert_equal "a=%2432%2C000.00", Faraday::FlatParamsEncoder.encode("a" => monies)
+  end
+
+  def test_raises_typeerror_nested
+    error = assert_raises TypeError do
+      Faraday::NestedParamsEncoder.encode("")
+    end
+    assert_equal "Can't convert String into Hash.", error.message
+  end
+
+  def test_raises_typeerror_flat
+    error = assert_raises TypeError do
+      Faraday::FlatParamsEncoder.encode("")
+    end
+    assert_equal "Can't convert String into Hash.", error.message
+  end
+
+  def test_decode_array_nested
+    query = "a[1]=one&a[2]=two&a[3]=three"
+    expected = {"a" => ["one", "two", "three"]}
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_decode_array_flat
+    query = "a=one&a=two&a=three"
+    expected = {"a" => ["one", "two", "three"]}
+    assert_equal expected, Faraday::FlatParamsEncoder.decode(query)
+  end
+
+  def test_nested_decode_hash
+    query = "a[b1]=one&a[b2]=two&a[b][c]=foo"
+    expected = {"a" => {"b1" => "one", "b2" => "two", "b" => {"c" => "foo"}}}
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_encode_nil_nested
+    assert_equal "a", Faraday::NestedParamsEncoder.encode("a" => nil)
+  end
+
+  def test_encode_nil_flat
+    assert_equal "a", Faraday::FlatParamsEncoder.encode("a" => nil)
+  end
+
+  def test_decode_nested_array_rack_compat
+    query = "a[][one]=1&a[][two]=2&a[][one]=3&a[][two]=4"
+    expected = Rack::Utils.parse_nested_query(query)
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_decode_nested_array_mixed_types
+    query = "a[][one]=1&a[]=2&a[]=&a[]"
+    expected = Rack::Utils.parse_nested_query(query)
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_decode_nested_ignores_invalid_array
+    query = "[][a]=1&b=2"
+    expected = {"a" => "1", "b" => "2"}
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_decode_nested_ignores_repeated_array_notation
+    query = "a[][][]=1"
+    expected = {"a" => ["1"]}
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_decode_nested_ignores_malformed_keys
+    query = "=1&[]=2"
+    expected = {}
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_decode_nested_subkeys_dont_have_to_be_in_brackets
+    query = "a[b]c[d]e=1"
+    expected = {"a" => {"b" => {"c" => {"d" => {"e" => "1"}}}}}
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_decode_nested_raises_error_when_expecting_hash
+    error = assert_raises TypeError do
+      Faraday::NestedParamsEncoder.decode("a=1&a[b]=2")
+    end
+    assert_equal "expected Hash (got String) for param `a'", error.message
+
+    error = assert_raises TypeError do
+      Faraday::NestedParamsEncoder.decode("a[]=1&a[b]=2")
+    end
+    assert_equal "expected Hash (got Array) for param `a'", error.message
+
+    error = assert_raises TypeError do
+      Faraday::NestedParamsEncoder.decode("a[b]=1&a[]=2")
+    end
+    assert_equal "expected Array (got Hash) for param `a'", error.message
+
+    error = assert_raises TypeError do
+      Faraday::NestedParamsEncoder.decode("a=1&a[]=2")
+    end
+    assert_equal "expected Array (got String) for param `a'", error.message
+
+    error = assert_raises TypeError do
+      Faraday::NestedParamsEncoder.decode("a[b]=1&a[b][c]=2")
+    end
+    assert_equal "expected Hash (got String) for param `b'", error.message
+  end
+
+  def test_decode_nested_final_value_overrides_any_type
+    query = "a[b][c]=1&a[b]=2"
+    expected = {"a" => {"b" => "2"}}
+    assert_equal expected, Faraday::NestedParamsEncoder.decode(query)
+  end
+
+  def test_encode_rack_compat_nested
+    params = { :a => [{:one => "1", :two => "2"}, "3", ""] }
+    expected = Rack::Utils.build_nested_query(params)
+    assert_equal expected.split("&").sort,
+      Faraday::Utils.unescape(Faraday::NestedParamsEncoder.encode(params)).split("&").sort
+  end
+
+  def test_encode_empty_string_array_value
+    expected = 'baz=&foo%5Bbar%5D='
+    assert_equal expected, Faraday::NestedParamsEncoder.encode(foo: {bar: ''}, baz: '')
+  end
+
+  def test_encode_nil_array_value
+    expected = 'baz&foo%5Bbar%5D'
+    assert_equal expected, Faraday::NestedParamsEncoder.encode(foo: {bar: nil}, baz: nil)
+  end
+
+  def test_encode_empty_array_value
+    expected = 'baz%5B%5D&foo%5Bbar%5D%5B%5D'
+    Faraday::NestedParamsEncoder.encode(foo: { bar: [] }, baz: [])
+    assert_equal expected, Faraday::NestedParamsEncoder.encode(foo: { bar: [] }, baz: [])
+  end
+end

data/test/request_middleware_test.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+require File.expand_path('../helper', __FILE__)
+
+Faraday::CompositeReadIO.class_eval { attr_reader :ios }
+
+class RequestMiddlewareTest < Faraday::TestCase
+  def conn
+    Faraday.new do |b|
+      b.request :multipart
+      b.request :url_encoded
+      b.adapter :test do |stub|
+        stub.post('/echo') do |env|
+          posted_as = env[:request_headers]['Content-Type']
+          [200, {'Content-Type' => posted_as}, env[:body]]
+        end
+      end
+    end
+  end
+
+  def test_does_nothing_without_payload
+    response = conn.post('/echo')
+    assert_nil response.headers['Content-Type']
+    assert response.body.empty?
+  end
+
+  def test_ignores_custom_content_type
+    response = conn.post('/echo', { :some => 'data' }, 'content-type' => 'application/x-foo')
+    assert_equal 'application/x-foo', response.headers['Content-Type']
+    assert_equal({ :some => 'data' }, 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%5B%5D=apples&fruit%5B%5D=oranges', response.body
+  end
+
+  def test_url_encoded_with_header
+    response = conn.post('/echo', {'a'=>123}, 'content-type' => 'application/x-www-form-urlencoded')
+    assert_equal 'application/x-www-form-urlencoded', response.headers['Content-Type']
+    assert_equal 'a=123', response.body
+  end
+
+  def test_url_encoded_nested
+    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, 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_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
+    # 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 response.headers['Content-Type'].start_with?(
+      "multipart/form-data; boundary=%s" % Faraday::Request::Multipart::DEFAULT_BOUNDARY_PREFIX,
+    )
+
+    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 response.headers['Content-Type'].start_with?(
+      "multipart/form-data; boundary=%s" % Faraday::Request::Multipart::DEFAULT_BOUNDARY_PREFIX,
+    )
+
+    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_unique_boundary
+    payload = {:a => 1, :b =>[{:c => Faraday::UploadIO.new(__FILE__, 'text/x-ruby'), :d => 2}]}
+    response1 = conn.post('/echo', payload)
+    response2 = conn.post('/echo', payload)
+    assert response1.headers['Content-Type'] != response2.headers['Content-Type']
+  end
+end

data/test/response_middleware_test.rb

@@ -0,0 +1,72 @@
+require File.expand_path('../helper', __FILE__)
+
+class ResponseMiddlewareTest < Faraday::TestCase
+  def setup
+    @conn = Faraday.new do |b|
+      b.response :raise_error
+      b.adapter :test do |stub|
+        stub.get('ok')        { [200, {'Content-Type' => 'text/html'}, '<body></body>'] }
+        stub.get('not-found') { [404, {'X-Reason' => 'because'}, 'keep looking'] }
+        stub.get('error')     { [500, {'X-Error' => 'bailout'}, 'fail'] }
+      end
+    end
+  end
+
+  class ResponseUpcaser < Faraday::Response::Middleware
+    def parse(body)
+      body.upcase
+    end
+  end
+
+  def test_success
+    assert @conn.get('ok')
+  end
+
+  def test_raises_not_found
+    error = assert_raises Faraday::ResourceNotFound do
+      @conn.get('not-found')
+    end
+    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::ClientError do
+      @conn.get('error')
+    end
+    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_nil @conn.get('no_content').body
+  end
+
+  def test_304
+    assert_nil @conn.get('not_modified').body
+  end
+end

data/test/strawberry.rb

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