faraday 0.17.6 → 1.0.1

data/spec/faraday/error_spec.rb

@@ -41,62 +41,5 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.message).to eq('["error1", "error2"]') }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: ["error1", "error2"]>>') }
     end
-
-    context 'maintains backward-compatibility until 1.0' do
-      it 'does not raise an error for error-namespaced classes but prints an error message' do
-        error_message, error = with_warn_squelching { Faraday::Error::ClientError.new('foo') }
-
-        expect(error).to be_a Faraday::ClientError
-        expect(error_message).to match(
-          Regexp.new(
-            'NOTE: Faraday::Error::ClientError.new is deprecated; '\
-            'use Faraday::ClientError.new instead. It will be removed in or after version 1.0'
-          )
-        )
-      end
-
-      it 'does not raise an error for inherited error-namespaced classes but prints an error message' do
-        error_message, = with_warn_squelching { Class.new(Faraday::Error::ClientError) }
-
-        expect(error_message).to match(
-          Regexp.new(
-            'NOTE: Inheriting Faraday::Error::ClientError is deprecated; '\
-            'use Faraday::ClientError instead. It will be removed in or after version 1.0'
-          )
-        )
-      end
-
-      it 'allows backward-compatible class to be subclassed' do
-        expect {
-          with_warn_squelching { Class.new(Faraday::Error::ClientError) }
-        }.not_to raise_error
-      end
-
-      it 'allows rescuing of a current error with a deprecated error' do
-        expect { raise Faraday::ClientError, nil }.to raise_error(Faraday::Error::ClientError)
-      end
-
-      it 'allows rescuing of a current error with a current error' do
-        expect { raise Faraday::ClientError, nil }.to raise_error(Faraday::ClientError)
-      end
-
-      it 'allows rescuing of a deprecated error with a deprecated error' do
-        expect { raise Faraday::Error::ClientError, nil }.to raise_error(Faraday::Error::ClientError)
-      end
-
-      it 'allows rescuing of a deprecated error with a current error' do
-        expect { raise Faraday::Error::ClientError, nil }.to raise_error(Faraday::ClientError)
-      end
-    end
-
-    def with_warn_squelching
-      stderr_catcher = StringIO.new
-      original_stderr = $stderr
-      $stderr = stderr_catcher
-      result = yield if block_given?
-      [stderr_catcher.tap(&:rewind).string, result]
-    ensure
-      $stderr = original_stderr
-    end
   end
 end

data/spec/faraday/middleware_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Middleware do
+  subject { described_class.new(app) }
+
+  describe '#close' do
+    context "with app that doesn't support \#close" do
+      let(:app) { double }
+
+      it 'should issue warning' do
+        expect(subject).to receive(:warn)
+        subject.close
+      end
+    end
+
+    context "with app that supports \#close" do
+      let(:app) { double }
+
+      it 'should issue warning' do
+        expect(app).to receive(:close)
+        expect(subject).to_not receive(:warn)
+        subject.close
+      end
+    end
+  end
+end

data/spec/faraday/options/env_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Env do
+  subject(:env) { described_class.new }
+
+  it 'allows to access members' do
+    expect(env.method).to be_nil
+    env.method = :get
+    expect(env.method).to eq(:get)
+  end
+
+  it 'allows to access symbol non members' do
+    expect(env[:custom]).to be_nil
+    env[:custom] = :boom
+    expect(env[:custom]).to eq(:boom)
+  end
+
+  it 'allows to access string non members' do
+    expect(env['custom']).to be_nil
+    env['custom'] = :boom
+    expect(env['custom']).to eq(:boom)
+  end
+
+  it 'ignores false when fetching' do
+    ssl = Faraday::SSLOptions.new
+    ssl.verify = false
+    expect(ssl.fetch(:verify, true)).to be_falsey
+  end
+
+  it 'retains custom members' do
+    env[:foo] = 'custom 1'
+    env[:bar] = :custom_2
+    env2 = Faraday::Env.from(env)
+    env2[:baz] = 'custom 3'
+
+    expect(env2[:foo]).to eq('custom 1')
+    expect(env2[:bar]).to eq(:custom_2)
+    expect(env[:baz]).to be_nil
+  end
+
+  describe '#body' do
+    subject(:env) { described_class.from(body: { foo: 'bar' }) }
+
+    context 'when response is not finished yet' do
+      it 'returns the request body' do
+        expect(env.body).to eq(foo: 'bar')
+      end
+    end
+
+    context 'when response is finished' do
+      before do
+        env.status = 200
+        env.body = { bar: 'foo' }
+        env.response = Faraday::Response.new(env)
+      end
+
+      it 'returns the response body' do
+        expect(env.body).to eq(bar: 'foo')
+      end
+
+      it 'allows to access request_body' do
+        expect(env.request_body).to eq(foo: 'bar')
+      end
+
+      it 'allows to access response_body' do
+        expect(env.response_body).to eq(bar: 'foo')
+      end
+    end
+  end
+end

data/spec/faraday/options/options_spec.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Options do
+  SubOptions = Class.new(Faraday::Options.new(:sub_a, :sub_b))
+  class ParentOptions < Faraday::Options.new(:a, :b, :c)
+    options c: SubOptions
+  end
+
+  describe '#merge' do
+    it 'merges options with hashes' do
+      options = ParentOptions.new(1)
+      expect(options.a).to eq(1)
+      expect(options.b).to be_nil
+
+      dup = options.merge a: 2, b: 3
+      expect(dup.a).to eq(2)
+      expect(dup.b).to eq(3)
+      expect(options.a).to eq(1)
+      expect(options.b).to be_nil
+    end
+
+    it 'deeply merges two options' do
+      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)
+      expected          = ParentOptions.from(a: 1, b: 2, c: expected_sub_opts)
+      expect(merged).to eq(expected)
+    end
+
+    it 'deeply merges options with hashes' do
+      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)
+      expected          = ParentOptions.from(a: 1, b: 2, c: expected_sub_opts)
+      expect(merged).to eq(expected)
+    end
+
+    it 'deeply merges options with nil' do
+      sub_opts = SubOptions.new(3, 4)
+      options  = ParentOptions.new(1, 2, sub_opts)
+      expect(options.a).to eq(1)
+      expect(options.b).to eq(2)
+      expect(options.c.sub_a).to eq(3)
+      expect(options.c.sub_b).to eq(4)
+
+      options2 = ParentOptions.from(b: 5, c: nil)
+
+      merged = options.merge(options2)
+
+      expect(merged.b).to eq(5)
+      expect(merged.c).to eq(sub_opts)
+    end
+
+    it 'deeply merges options with options having nil sub-options' do
+      options = ParentOptions.from(a: 1)
+
+      sub_opts = SubOptions.new(3, 4)
+      options2 = ParentOptions.from(b: 2, c: sub_opts)
+
+      expect(options.a).to eq(1)
+      expect(options2.b).to eq(2)
+      expect(options2.c.sub_a).to eq(3)
+      expect(options2.c.sub_b).to eq(4)
+
+      merged = options.merge(options2)
+
+      expect(merged.c).to eq(sub_opts)
+    end
+
+    describe '#dup' do
+      it 'duplicate options but not sub-options' do
+        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
+
+        expect(opts.b).to eq(1)
+        expect(opts.c.sub_a).to eq(4)
+      end
+    end
+
+    describe '#deep_dup' do
+      it 'duplicate options and also suboptions' do
+        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
+
+        expect(opts.b).to eq(1)
+        expect(opts.c.sub_a).to eq(3)
+      end
+    end
+
+    describe '#clear' do
+      it 'clears the options' do
+        options = SubOptions.new(1)
+        expect(options.empty?).not_to be_truthy
+        options.clear
+        expect(options.empty?).to be_truthy
+      end
+    end
+
+    describe '#empty?' do
+      it 'returns true only if all options are nil' do
+        options = SubOptions.new
+        expect(options.empty?).to be_truthy
+        options.sub_a = 1
+        expect(options.empty?).not_to be_truthy
+        options.delete(:sub_a)
+        expect(options.empty?).to be_truthy
+      end
+    end
+
+    describe '#each_key' do
+      it 'allows to iterate through keys' do
+        options = ParentOptions.new(1, 2, 3)
+        enum    = options.each_key
+        expect(enum.next.to_sym).to eq(:a)
+        expect(enum.next.to_sym).to eq(:b)
+        expect(enum.next.to_sym).to eq(:c)
+      end
+    end
+
+    describe '#key?' do
+      it 'returns true if the key exists and is not nil' do
+        options = SubOptions.new
+        expect(options.key?(:sub_a)).not_to be_truthy
+        options.sub_a = 1
+        expect(options.key?(:sub_a)).to be_truthy
+      end
+    end
+
+    describe '#each_value' do
+      it 'allows to iterate through values' do
+        options = ParentOptions.new(1, 2, 3)
+        enum    = options.each_value
+        expect(enum.next).to eq(1)
+        expect(enum.next).to eq(2)
+        expect(enum.next).to eq(3)
+      end
+    end
+
+    describe '#value?' do
+      it 'returns true if any key has that value' do
+        options = SubOptions.new
+        expect(options.value?(1)).not_to be_truthy
+        options.sub_a = 1
+        expect(options.value?(1)).to be_truthy
+      end
+    end
+
+    describe '#update' do
+      it 'updates options from hashes' do
+        options = ParentOptions.new(1)
+        expect(options.a).to eq(1)
+        expect(options.b).to be_nil
+
+        updated = options.update a: 2, b: 3
+        expect(options.a).to eq(2)
+        expect(options.b).to eq(3)
+        expect(updated).to eq(options)
+      end
+    end
+
+    describe '#delete' do
+      it 'allows to remove value for key' do
+        options = ParentOptions.new(1)
+        expect(options.a).to eq(1)
+        expect(options.delete(:a)).to eq(1)
+        expect(options.a).to be_nil
+      end
+    end
+
+    describe '#from' do
+      it { expect { ParentOptions.from invalid: 1 }.to raise_error(NoMethodError) }
+
+      it 'works with options' do
+        options = ParentOptions.new(1)
+
+        value = ParentOptions.from(options)
+        expect(value.a).to eq(1)
+        expect(value.b).to be_nil
+      end
+
+      it 'works with options with sub object' do
+        sub     = SubOptions.new(1)
+        options = ParentOptions.from a: 1, c: sub
+        expect(options).to be_a_kind_of(ParentOptions)
+        expect(options.a).to eq(1)
+        expect(options.b).to be_nil
+        expect(options.c).to be_a_kind_of(SubOptions)
+        expect(options.c.sub_a).to eq(1)
+      end
+
+      it 'works with hash' do
+        options = ParentOptions.from a: 1
+        expect(options).to be_a_kind_of(ParentOptions)
+        expect(options.a).to eq(1)
+        expect(options.b).to be_nil
+      end
+
+      it 'works with hash with sub object' do
+        options = ParentOptions.from a: 1, c: { sub_a: 1 }
+        expect(options).to be_a_kind_of(ParentOptions)
+        expect(options.a).to eq(1)
+        expect(options.b).to be_nil
+        expect(options.c).to be_a_kind_of(SubOptions)
+        expect(options.c.sub_a).to eq(1)
+      end
+
+      it 'works with deep hash' do
+        hash    = { b: 1 }
+        options = ParentOptions.from a: hash
+        expect(options.a[:b]).to eq(1)
+
+        hash[:b] = 2
+        expect(options.a[:b]).to eq(1)
+
+        options.a[:b] = 3
+        expect(hash[:b]).to eq(2)
+        expect(options.a[:b]).to eq(3)
+      end
+
+      it 'works with nil' do
+        options = ParentOptions.from(nil)
+        expect(options).to be_a_kind_of(ParentOptions)
+        expect(options.a).to be_nil
+        expect(options.b).to be_nil
+      end
+
+      it 'respects inheritance' do
+        subclass = Class.new(ParentOptions)
+        options  = subclass.from(c: { sub_a: 'hello' })
+        expect(options.c).to be_a_kind_of(SubOptions)
+        expect(options.c.sub_a).to eq('hello')
+      end
+    end
+
+    describe '#memoized' do
+      subject(:options_class) { Class.new(ParentOptions) }
+      it 'requires block' do
+        expect { options_class.memoized(:a) }.to raise_error(ArgumentError)
+      end
+
+      it 'accepts block' do
+        options_class.memoized(:a) { :foo }
+        expect(options_class.new.a).to eql(:foo)
+      end
+    end
+
+    describe '#fetch' do
+      subject { SubOptions.new }
+
+      context 'when the fetched key has no value' do
+        it 'uses falsey default' do
+          expect(subject.fetch(:sub_a, false) { |_| :blah }).to be_falsey
+        end
+
+        it 'accepts block' do
+          expect(subject.fetch(:sub_a) { |k| "yo #{k.inspect}" }).to eq('yo :sub_a')
+        end
+
+        it 'needs a default if key is missing' do
+          expect { subject.fetch(:sub_a) }.to raise_error(Faraday::Options.fetch_error_class)
+        end
+      end
+
+      context 'when the fetched key has a value' do
+        before do
+          subject.sub_a = 1
+        end
+
+        it 'grabs value' do
+          expect(subject.fetch(:sub_a, false) { |_| :blah }).to eq(1)
+        end
+
+        it 'works with key' do
+          expect(subject.fetch(:sub_a)).to eq(1)
+        end
+      end
+    end
+  end
+end

data/spec/faraday/options/proxy_options_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::ProxyOptions do
+  describe '#from' do
+    it 'works with string' do
+      options = Faraday::ProxyOptions.from 'http://user:pass@example.org'
+      expect(options.user).to eq('user')
+      expect(options.password).to eq('pass')
+      expect(options.uri).to be_a_kind_of(URI)
+      expect(options.path).to eq('')
+      expect(options.port).to eq(80)
+      expect(options.host).to eq('example.org')
+      expect(options.scheme).to eq('http')
+      expect(options.inspect).to match('#<Faraday::ProxyOptions uri=')
+    end
+
+    it 'works with nil' do
+      options = Faraday::ProxyOptions.from nil
+      expect(options).to be_a_kind_of(Faraday::ProxyOptions)
+      expect(options.inspect).to eq('#<Faraday::ProxyOptions (empty)>')
+    end
+
+    it 'works with no auth' do
+      proxy = Faraday::ProxyOptions.from 'http://example.org'
+      expect(proxy.user).to be_nil
+      expect(proxy.password).to be_nil
+    end
+  end
+
+  it 'allows hash access' do
+    proxy = Faraday::ProxyOptions.from 'http://a%40b:pw%20d@example.org'
+    expect(proxy.user).to eq('a@b')
+    expect(proxy[:user]).to eq('a@b')
+    expect(proxy.password).to eq('pw d')
+    expect(proxy[:password]).to eq('pw d')
+  end
+end

data/spec/faraday/options/request_options_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::RequestOptions do
+  subject(:options) { Faraday::RequestOptions.new }
+
+  it 'allows to set the request proxy' do
+    expect(options.proxy).to be_nil
+
+    expect { options[:proxy] = { booya: 1 } }.to raise_error(NoMethodError)
+
+    options[:proxy] = { user: 'user' }
+    expect(options.proxy).to be_a_kind_of(Faraday::ProxyOptions)
+    expect(options.proxy.user).to eq('user')
+
+    options.proxy = nil
+    expect(options.proxy).to be_nil
+    expect(options.inspect).to eq('#<Faraday::RequestOptions (empty)>')
+  end
+end

data/spec/faraday/params_encoders/flat_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rack/utils'
+
+RSpec.describe Faraday::FlatParamsEncoder do
+  it_behaves_like 'a params encoder'
+
+  it 'decodes arrays' do
+    query = 'a=one&a=two&a=three'
+    expected = { 'a' => %w[one two three] }
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes boolean values' do
+    query = 'a=true&b=false'
+    expected = { 'a' => 'true', 'b' => 'false' }
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'encodes boolean values' do
+    params = { a: true, b: false }
+    expect(subject.encode(params)).to eq('a=true&b=false')
+  end
+
+  it 'encodes boolean values in array' do
+    params = { a: [true, false] }
+    expect(subject.encode(params)).to eq('a=true&a=false')
+  end
+
+  it 'encodes empty array in hash' do
+    params = { a: [] }
+    expect(subject.encode(params)).to eq('a=')
+  end
+end

data/spec/faraday/params_encoders/nested_spec.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'rack/utils'
+
+RSpec.describe Faraday::NestedParamsEncoder do
+  it_behaves_like 'a params encoder'
+
+  it 'decodes arrays' do
+    query    = 'a[1]=one&a[2]=two&a[3]=three'
+    expected = { 'a' => %w[one two three] }
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes hashes' do
+    query    = 'a[b1]=one&a[b2]=two&a[b][c]=foo'
+    expected = { 'a' => { 'b1' => 'one', 'b2' => 'two', 'b' => { 'c' => 'foo' } } }
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes nested arrays rack compat' do
+    query    = 'a[][one]=1&a[][two]=2&a[][one]=3&a[][two]=4'
+    expected = Rack::Utils.parse_nested_query(query)
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes nested array mixed types' do
+    query    = 'a[][one]=1&a[]=2&a[]=&a[]'
+    expected = Rack::Utils.parse_nested_query(query)
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes nested ignores invalid array' do
+    query    = '[][a]=1&b=2'
+    expected = { 'a' => '1', 'b' => '2' }
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes nested ignores repeated array notation' do
+    query    = 'a[][][]=1'
+    expected = { 'a' => ['1'] }
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes nested ignores malformed keys' do
+    query    = '=1&[]=2'
+    expected = {}
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes nested subkeys dont have to be in brackets' do
+    query    = 'a[b]c[d]e=1'
+    expected = { 'a' => { 'b' => { 'c' => { 'd' => { 'e' => '1' } } } } }
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'decodes nested final value overrides any type' do
+    query    = 'a[b][c]=1&a[b]=2'
+    expected = { 'a' => { 'b' => '2' } }
+    expect(subject.decode(query)).to eq(expected)
+  end
+
+  it 'encodes rack compat' do
+    params   = { a: [{ one: '1', two: '2' }, '3', ''] }
+    result   = Faraday::Utils.unescape(Faraday::NestedParamsEncoder.encode(params)).split('&')
+    expected = Rack::Utils.build_nested_query(params).split('&')
+    expect(result).to match_array(expected)
+  end
+
+  it 'encodes empty string array value' do
+    expected = 'baz=&foo%5Bbar%5D='
+    result = Faraday::NestedParamsEncoder.encode(foo: { bar: '' }, baz: '')
+    expect(result).to eq(expected)
+  end
+
+  it 'encodes nil array value' do
+    expected = 'baz&foo%5Bbar%5D'
+    result = Faraday::NestedParamsEncoder.encode(foo: { bar: nil }, baz: nil)
+    expect(result).to eq(expected)
+  end
+
+  it 'encodes empty array value' do
+    expected = 'baz%5B%5D&foo%5Bbar%5D%5B%5D'
+    result = Faraday::NestedParamsEncoder.encode(foo: { bar: [] }, baz: [])
+    expect(result).to eq(expected)
+  end
+
+  it 'encodes boolean values' do
+    params = { a: true, b: false }
+    expect(subject.encode(params)).to eq('a=true&b=false')
+  end
+
+  it 'encodes boolean values in array' do
+    params = { a: [true, false] }
+    expect(subject.encode(params)).to eq('a%5B%5D=true&a%5B%5D=false')
+  end
+
+  shared_examples 'a wrong decoding' do
+    it do
+      expect { subject.decode(query) }.to raise_error(TypeError) do |e|
+        expect(e.message).to eq(error_message)
+      end
+    end
+  end
+
+  context 'when expecting hash but getting string' do
+    let(:query) { 'a=1&a[b]=2' }
+    let(:error_message) { "expected Hash (got String) for param `a'" }
+    it_behaves_like 'a wrong decoding'
+  end
+
+  context 'when expecting hash but getting array' do
+    let(:query) { 'a[]=1&a[b]=2' }
+    let(:error_message) { "expected Hash (got Array) for param `a'" }
+    it_behaves_like 'a wrong decoding'
+  end
+
+  context 'when expecting nested hash but getting non nested' do
+    let(:query) { 'a[b]=1&a[b][c]=2' }
+    let(:error_message) { "expected Hash (got String) for param `b'" }
+    it_behaves_like 'a wrong decoding'
+  end
+
+  context 'when expecting array but getting hash' do
+    let(:query) { 'a[b]=1&a[]=2' }
+    let(:error_message) { "expected Array (got Hash) for param `a'" }
+    it_behaves_like 'a wrong decoding'
+  end
+
+  context 'when expecting array but getting string' do
+    let(:query) { 'a=1&a[]=2' }
+    let(:error_message) { "expected Array (got String) for param `a'" }
+    it_behaves_like 'a wrong decoding'
+  end
+end