Introduces flat_encode option for multipart adapter. (#1163)

Fixes #1157
This commit is contained in:
Mattia 2020-07-09 10:43:09 +01:00 committed by GitHub
parent e02a8c1009
commit 5acab36239
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 50 additions and 15 deletions

View File

@ -12,6 +12,11 @@ module Faraday
DEFAULT_BOUNDARY_PREFIX = '-----------RubyMultipartPost'
end
def initialize(app = nil, options = {})
@app = app
@options = options
end
# Checks for files in the payload, otherwise leaves everything untouched.
#
# @param env [Faraday::Env]
@ -30,7 +35,7 @@ module Faraday
type = request_type(env)
env.body.respond_to?(:each_key) && !env.body.empty? && (
(type.empty? && has_multipart?(env.body)) ||
(type == self.class.mime_type)
(type == self.class.mime_type)
)
end
@ -79,7 +84,9 @@ module Faraday
# @param pieces [Array]
def process_params(params, prefix = nil, pieces = nil, &block)
params.inject(pieces || []) do |all, (key, value)|
key = "#{prefix}[#{key}]" if prefix
if prefix
key = @options[:flat_encode] ? prefix.to_s : "#{prefix}[#{key}]"
end
case value
when Array

View File

@ -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