faraday 1.0.0 → 1.1.0

data/spec/faraday/params_encoders/flat_spec.rb

@@ -31,4 +31,12 @@ RSpec.describe Faraday::FlatParamsEncoder do
     params = { a: [] }
     expect(subject.encode(params)).to eq('a=')
   end
+
+  it 'encodes unsorted when asked' do
+    params = { b: false, a: true }
+    expect(subject.encode(params)).to eq('a=true&b=false')
+    Faraday::FlatParamsEncoder.sort_params = false
+    expect(subject.encode(params)).to eq('b=false&a=true')
+    Faraday::FlatParamsEncoder.sort_params = true
+  end
 end

data/spec/faraday/params_encoders/nested_spec.rb

@@ -94,6 +94,14 @@ RSpec.describe Faraday::NestedParamsEncoder do
     expect(subject.encode(params)).to eq('a%5B%5D=true&a%5B%5D=false')
   end
 
+  it 'encodes unsorted when asked' do
+    params = { b: false, a: true }
+    expect(subject.encode(params)).to eq('a=true&b=false')
+    Faraday::NestedParamsEncoder.sort_params = false
+    expect(subject.encode(params)).to eq('b=false&a=true')
+    Faraday::NestedParamsEncoder.sort_params = true
+  end
+
   shared_examples 'a wrong decoding' do
     it do
       expect { subject.decode(query) }.to raise_error(TypeError) do |e|

data/spec/faraday/rack_builder_spec.rb

@@ -189,8 +189,157 @@ RSpec.describe Faraday::RackBuilder do
 
     it 'raises an error while making a request' do
       expect { conn.get('/') }.to raise_error(RuntimeError) do |err|
-        expect(err.message).to eq('missing dependency for Broken: cannot load such file -- zomg/i_dont/exist')
+        expect(err.message).to match(%r{missing dependency for Broken: .+ -- zomg/i_dont/exist})
       end
     end
   end
+
+  context 'when middleware is added with named arguments' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    let(:dog_middleware) do
+      Class.new(Faraday::Middleware) do
+        attr_accessor :name
+
+        def initialize(app, name:)
+          super(app)
+          @name = name
+        end
+      end
+    end
+    let(:dog) do
+      subject.handlers.find { |handler| handler == dog_middleware }.build
+    end
+
+    it 'adds a handler to construct middleware with options passed to use' do
+      subject.use dog_middleware, name: 'Rex'
+      expect { dog }.to_not output(
+        /warning: Using the last argument as keyword parameters is deprecated/
+      ).to_stderr
+      expect(dog.name).to eq('Rex')
+    end
+  end
+
+  context 'when a request adapter is added with named arguments' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    let(:cat_request) do
+      Class.new(Faraday::Middleware) do
+        attr_accessor :name
+
+        def initialize(app, name:)
+          super(app)
+          @name = name
+        end
+      end
+    end
+    let(:cat) do
+      subject.handlers.find { |handler| handler == cat_request }.build
+    end
+
+    it 'adds a handler to construct request adapter with options passed to request' do
+      Faraday::Request.register_middleware cat_request: cat_request
+      subject.request :cat_request, name: 'Felix'
+      expect { cat }.to_not output(
+        /warning: Using the last argument as keyword parameters is deprecated/
+      ).to_stderr
+      expect(cat.name).to eq('Felix')
+    end
+  end
+
+  context 'when a response adapter is added with named arguments' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    let(:fish_response) do
+      Class.new(Faraday::Response::Middleware) do
+        attr_accessor :name
+
+        def initialize(app, name:)
+          super(app)
+          @name = name
+        end
+      end
+    end
+    let(:fish) do
+      subject.handlers.find { |handler| handler == fish_response }.build
+    end
+
+    it 'adds a handler to construct response adapter with options passed to response' do
+      Faraday::Response.register_middleware fish_response: fish_response
+      subject.response :fish_response, name: 'Bubbles'
+      expect { fish }.to_not output(
+        /warning: Using the last argument as keyword parameters is deprecated/
+      ).to_stderr
+      expect(fish.name).to eq('Bubbles')
+    end
+  end
+
+  context 'when a plain adapter is added with named arguments' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    let(:rabbit_adapter) do
+      Class.new(Faraday::Adapter) do
+        attr_accessor :name
+
+        def initialize(app, name:)
+          super(app)
+          @name = name
+        end
+      end
+    end
+    let(:rabbit) do
+      subject.adapter.build
+    end
+
+    it 'adds a handler to construct adapter with options passed to adapter' do
+      Faraday::Adapter.register_middleware rabbit_adapter: rabbit_adapter
+      subject.adapter :rabbit_adapter, name: 'Thumper'
+      expect { rabbit }.to_not output(
+        /warning: Using the last argument as keyword parameters is deprecated/
+      ).to_stderr
+      expect(rabbit.name).to eq('Thumper')
+    end
+  end
+
+  context 'when handlers are directly added or updated' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    let(:rock_handler) do
+      Class.new do
+        attr_accessor :name
+
+        def initialize(_app, name:)
+          @name = name
+        end
+      end
+    end
+    let(:rock) do
+      subject.handlers.find { |handler| handler == rock_handler }.build
+    end
+
+    it 'adds a handler to construct adapter with options passed to insert' do
+      subject.insert 0, rock_handler, name: 'Stony'
+      expect { rock }.to_not output(
+        /warning: Using the last argument as keyword parameters is deprecated/
+      ).to_stderr
+      expect(rock.name).to eq('Stony')
+    end
+
+    it 'adds a handler with options passed to insert_after' do
+      subject.insert_after 0, rock_handler, name: 'Rocky'
+      expect { rock }.to_not output(
+        /warning: Using the last argument as keyword parameters is deprecated/
+      ).to_stderr
+      expect(rock.name).to eq('Rocky')
+    end
+
+    it 'adds a handler with options passed to swap' do
+      subject.insert 0, rock_handler, name: 'Flint'
+      subject.swap 0, rock_handler, name: 'Chert'
+      expect { rock }.to_not output(
+        /warning: Using the last argument as keyword parameters is deprecated/
+      ).to_stderr
+      expect(rock.name).to eq('Chert')
+    end
+  end
 end

data/spec/faraday/request/authorization_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe Faraday::Request::Authorization do
     end
 
     context 'when other values are provided' do
-      let(:auth_config) { ['baz', foo: 42] }
+      let(:auth_config) { ['baz', { foo: 42 }] }
 
       it { expect(response.body).to match(/^Token /) }
       it { expect(response.body).to match(/token="baz"/) }
@@ -78,7 +78,7 @@ RSpec.describe Faraday::Request::Authorization do
     end
 
     context 'when passed a string and a hash' do
-      let(:auth_config) { ['baz', foo: 42] }
+      let(:auth_config) { ['baz', { foo: 42 }] }
 
       it { expect(response.body).to eq('baz foo="42"') }
 

data/spec/faraday/request/multipart_spec.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 RSpec.describe Faraday::Request::Multipart do
+  let(:options) { {} }
   let(:conn) do
     Faraday.new do |b|
-      b.request :multipart
+      b.request :multipart, options
       b.request :url_encoded
       b.adapter :test do |stub|
         stub.post('/echo') do |env|
@@ -54,9 +55,10 @@ RSpec.describe Faraday::Request::Multipart do
       part_bc, body_bc = result.part('b[c]')
       expect(part_bc).to_not be_nil
       expect(part_bc.filename).to eq('multipart_spec.rb')
-      expect(part_bc.headers['content-disposition']).to eq(
-        'form-data; foo=1; name="b[c]"; filename="multipart_spec.rb"'
-      )
+      expect(part_bc.headers['content-disposition'])
+        .to eq(
+          'form-data; foo=1; name="b[c]"; filename="multipart_spec.rb"'
+        )
       expect(part_bc.headers['content-type']).to eq('text/x-ruby')
       expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
       expect(body_bc).to eq(File.read(__FILE__))
@@ -135,9 +137,10 @@ RSpec.describe Faraday::Request::Multipart do
       part_bc, body_bc = result.part('b[][c]')
       expect(part_bc).to_not be_nil
       expect(part_bc.filename).to eq('multipart_spec.rb')
-      expect(part_bc.headers['content-disposition']).to eq(
-        'form-data; name="b[][c]"; filename="multipart_spec.rb"'
-      )
+      expect(part_bc.headers['content-disposition'])
+        .to eq(
+          'form-data; name="b[][c]"; filename="multipart_spec.rb"'
+        )
       expect(part_bc.headers['content-type']).to eq('text/x-ruby')
       expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
       expect(body_bc).to eq(File.read(__FILE__))
@@ -177,9 +180,10 @@ RSpec.describe Faraday::Request::Multipart do
       part_bc, body_bc = result.part('b[c]')
       expect(part_bc).to_not be_nil
       expect(part_bc.filename).to eq('multipart_spec.rb')
-      expect(part_bc.headers['content-disposition']).to eq(
-        'form-data; foo=1; name="b[c]"; filename="multipart_spec.rb"'
-      )
+      expect(part_bc.headers['content-disposition'])
+        .to eq(
+          'form-data; foo=1; name="b[c]"; filename="multipart_spec.rb"'
+        )
       expect(part_bc.headers['content-type']).to eq('text/x-ruby')
       expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
       expect(body_bc).to eq(File.read(__FILE__))
@@ -258,9 +262,10 @@ RSpec.describe Faraday::Request::Multipart do
       part_bc, body_bc = result.part('b[][c]')
       expect(part_bc).to_not be_nil
       expect(part_bc.filename).to eq('multipart_spec.rb')
-      expect(part_bc.headers['content-disposition']).to eq(
-        'form-data; name="b[][c]"; filename="multipart_spec.rb"'
-      )
+      expect(part_bc.headers['content-disposition'])
+        .to eq(
+          'form-data; name="b[][c]"; filename="multipart_spec.rb"'
+        )
       expect(part_bc.headers['content-type']).to eq('text/x-ruby')
       expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
       expect(body_bc).to eq(File.read(__FILE__))
@@ -271,4 +276,27 @@ RSpec.describe Faraday::Request::Multipart do
       expect(body_bd).to eq('2')
     end
   end
+
+  context 'when passing flat_encode=true option' do
+    let(:options) { { flat_encode: true } }
+    let(:io) { StringIO.new('io-content') }
+    let(:payload) do
+      {
+        a: 1,
+        b: [
+          Faraday::UploadIO.new(io, 'application/pdf'),
+          Faraday::UploadIO.new(io, 'application/pdf')
+        ]
+      }
+    end
+
+    it_behaves_like 'a multipart request'
+
+    it 'encode params using flat encoder' do
+      response = conn.post('/echo', payload)
+
+      expect(response.body).to include('name="b"')
+      expect(response.body).not_to include('name="b[]"')
+    end
+  end
 end

data/spec/faraday/request/url_encoded_spec.rb

@@ -67,4 +67,17 @@ RSpec.describe Faraday::Request::UrlEncoded do
     response = conn.post('/echo', 'a' => { 'b' => { 'c' => ['d'] } })
     expect(response.body).to eq('a%5Bb%5D%5Bc%5D%5B%5D=d')
   end
+
+  context 'customising default_space_encoding' do
+    around do |example|
+      Faraday::Utils.default_space_encoding = '%20'
+      example.run
+      Faraday::Utils.default_space_encoding = nil
+    end
+
+    it 'uses the custom character to encode spaces' do
+      response = conn.post('/echo', str: 'apple banana')
+      expect(response.body).to eq('str=apple%20banana')
+    end
+  end
 end

data/spec/faraday/request_spec.rb

@@ -6,20 +6,31 @@ RSpec.describe Faraday::Request do
                 headers: { 'Mime-Version' => '1.0' },
                 request: { oauth: { consumer_key: 'anonymous' } })
   end
-  let(:method) { :get }
+  let(:http_method) { :get }
   let(:block) { nil }
 
-  subject { conn.build_request(method, &block) }
+  subject { conn.build_request(http_method, &block) }
 
   context 'when nothing particular is configured' do
-    it { expect(subject.method).to eq(:get) }
+    it { expect(subject.http_method).to eq(:get) }
     it { expect(subject.to_env(conn).ssl.verify).to be_falsey }
   end
 
-  context 'when method is post' do
-    let(:method) { :post }
+  context 'when HTTP method is post' do
+    let(:http_method) { :post }
+
+    it { expect(subject.http_method).to eq(:post) }
+  end
+
+  describe 'deprecate method for HTTP method' do
+    let(:http_method) { :post }
+    let(:expected_warning) do
+      %r{WARNING: `Faraday::Request#method` is deprecated; use `#http_method` instead. It will be removed in or after version 2.0.\n`Faraday::Request#method` called from .+/spec/faraday/request_spec.rb:\d+.}
+    end
 
     it { expect(subject.method).to eq(:post) }
+
+    it { expect { subject.method }.to output(expected_warning).to_stderr }
   end
 
   context 'when setting the url on setup with a URI' do

data/spec/faraday/response/middleware_spec.rb

@@ -26,6 +26,22 @@ RSpec.describe Faraday::Response::Middleware do
     end
   end
 
+  context 'with a custom ResponseMiddleware and private parse' do
+    let(:custom_middleware) do
+      Class.new(Faraday::Response::Middleware) do
+        private
+
+        def parse(body)
+          body.upcase
+        end
+      end
+    end
+
+    it 'parses the response' do
+      expect(conn.get('ok').body).to eq('<BODY></BODY>')
+    end
+  end
+
   context 'with a custom ResponseMiddleware but empty response' do
     let(:custom_middleware) do
       Class.new(Faraday::Response::Middleware) do

data/spec/faraday/response/raise_error_spec.rb

@@ -103,4 +103,37 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.response[:status]).to eq(500)
     end
   end
+
+  describe 'request info' do
+    let(:conn) do
+      Faraday.new do |b|
+        b.response :raise_error
+        b.adapter :test do |stub|
+          stub.post('request?full=true', request_body, request_headers) do
+            [400, { 'X-Reason' => 'because' }, 'keep looking']
+          end
+        end
+      end
+    end
+    let(:request_body) { JSON.generate({ 'item' => 'sth' }) }
+    let(:request_headers) { { 'Authorization' => 'Basic 123' } }
+
+    subject(:perform_request) do
+      conn.post 'request' do |req|
+        req.headers['Authorization'] = 'Basic 123'
+        req.params[:full] = true
+        req.body = request_body
+      end
+    end
+
+    it 'returns the request info in the exception' do
+      expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
+        expect(ex.response[:request][:method]).to eq(:post)
+        expect(ex.response[:request][:url_path]).to eq('/request')
+        expect(ex.response[:request][:params]).to eq({ 'full' => 'true' })
+        expect(ex.response[:request][:headers]).to match(a_hash_including(request_headers))
+        expect(ex.response[:request][:body]).to eq(request_body)
+      end
+    end
+  end
 end

data/spec/support/shared_examples/request_method.rb

@@ -13,8 +13,8 @@ shared_examples 'a request method' do |http_method|
   end
 
   it 'handles headers with multiple values' do
-    request_stub.to_return(headers: { 'Set-Cookie' => 'one, two' })
-    expect(response.headers['set-cookie']).to eq('one, two')
+    request_stub.to_return(headers: { 'Set-Cookie' => 'name=value' })
+    expect(response.headers['set-cookie']).to eq('name=value')
   end
 
   it 'retrieves the response headers' do
@@ -119,7 +119,7 @@ shared_examples 'a request method' do |http_method|
       request_stub.with(headers: { 'Content-Type' => %r{\Amultipart/form-data} }) do |request|
         # WebMock does not support matching body for multipart/form-data requests yet :(
         # https://github.com/bblimke/webmock/issues/623
-        request.body =~ /RubyMultipartPost/
+        request.body.include?('RubyMultipartPost')
       end
       conn.public_send(http_method, '/', payload)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - "@technoweenie"
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -32,6 +32,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: technoweenie@gmail.com
 executables: []
@@ -42,7 +56,6 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- UPGRADING.md
 - examples/client_spec.rb
 - examples/client_test.rb
 - lib/faraday.rb
@@ -102,6 +115,7 @@ files:
 - spec/faraday/adapter/net_http_spec.rb
 - spec/faraday/adapter/patron_spec.rb
 - spec/faraday/adapter/rack_spec.rb
+- spec/faraday/adapter/test_spec.rb
 - spec/faraday/adapter/typhoeus_spec.rb
 - spec/faraday/adapter_registry_spec.rb
 - spec/faraday/adapter_spec.rb
@@ -143,25 +157,26 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.0.0
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v1.1.0
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
+- spec/external_adapters
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: HTTP/REST API client library.