class Faraday::Request::Multipart

Middleware for supporting multi-part requests.

Constants

DEFAULT_BOUNDARY_PREFIX

Public Class Methods

new(app = nil, options = {}) click to toggle source
Calls superclass method
# File lib/faraday/request/multipart.rb, line 15
def initialize(app = nil, options = {})
  super(app)
  @options = options
end

Public Instance Methods

call(env) click to toggle source

Checks for files in the payload, otherwise leaves everything untouched.

@param env [Faraday::Env]

# File lib/faraday/request/multipart.rb, line 23
def call(env)
  match_content_type(env) do |params|
    env.request.boundary ||= unique_boundary
    env.request_headers[CONTENT_TYPE] +=
      "; boundary=#{env.request.boundary}"
    env.body = create_multipart(env, params)
  end
  @app.call env
end
create_multipart(env, params) click to toggle source

@param env [Faraday::Env] @param params [Hash]

# File lib/faraday/request/multipart.rb, line 57
def create_multipart(env, params)
  boundary = env.request.boundary
  parts = process_params(params) do |key, value|
    part(boundary, key, value)
  end
  parts << Faraday::Parts::EpiloguePart.new(boundary)

  body = Faraday::CompositeReadIO.new(parts)
  env.request_headers[Faraday::Env::ContentLength] = body.length.to_s
  body
end
has_multipart?(obj) click to toggle source

Returns true if obj is an enumerable with values that are multipart.

@param obj [Object] @return [Boolean]

# File lib/faraday/request/multipart.rb, line 46
def has_multipart?(obj) # rubocop:disable Naming/PredicateName
  if obj.respond_to?(:each)
    (obj.respond_to?(:values) ? obj.values : obj).each do |val|
      return true if val.respond_to?(:content_type) || has_multipart?(val)
    end
  end
  false
end
part(boundary, key, value) click to toggle source
# File lib/faraday/request/multipart.rb, line 69
def part(boundary, key, value)
  if value.respond_to?(:to_part)
    value.to_part(boundary, key)
  else
    Faraday::Parts::Part.new(boundary, key, value)
  end
end
process_params(params, prefix = nil, pieces = nil, &block) click to toggle source

@param params [Hash] @param prefix [String] @param pieces [Array]

# File lib/faraday/request/multipart.rb, line 85
def process_params(params, prefix = nil, pieces = nil, &block)
  params.inject(pieces || []) do |all, (key, value)|
    if prefix
      key = @options[:flat_encode] ? prefix.to_s : "#{prefix}[#{key}]"
    end

    case value
    when Array
      values = value.inject([]) { |a, v| a << [nil, v] }
      process_params(values, key, all, &block)
    when Hash
      process_params(value, key, all, &block)
    else
      # rubocop:disable Performance/RedundantBlockCall
      all << block.call(key, value)
      # rubocop:enable Performance/RedundantBlockCall
    end
  end
end
process_request?(env) click to toggle source

@param env [Faraday::Env]

# File lib/faraday/request/multipart.rb, line 34
def process_request?(env)
  type = request_type(env)
  env.body.respond_to?(:each_key) && !env.body.empty? && (
    (type.empty? && has_multipart?(env.body)) ||
      (type == self.class.mime_type)
  )
end
unique_boundary() click to toggle source

@return [String]

# File lib/faraday/request/multipart.rb, line 78
def unique_boundary
  "#{DEFAULT_BOUNDARY_PREFIX}-#{SecureRandom.hex}"
end