class HTTP::Request::Body

Attributes

source[R]

Public Class Methods

new(source) click to toggle source
# File lib/http/request/body.rb, line 8
def initialize(source)
  @source = source

  validate_source_type!
end

Public Instance Methods

==(other) click to toggle source

Request bodies are equivalent when they have the same source.

# File lib/http/request/body.rb, line 48
def ==(other)
  self.class == other.class && self.source == other.source # rubocop:disable Style/RedundantSelf
end
each() { |source| ... } click to toggle source

Yields chunks of content to be streamed to the request body.

@yieldparam [String]

# File lib/http/request/body.rb, line 34
def each(&block)
  if @source.is_a?(String)
    yield @source
  elsif @source.respond_to?(:read)
    IO.copy_stream(@source, ProcIO.new(block))
    rewind(@source)
  elsif @source.is_a?(Enumerable)
    @source.each(&block)
  end

  self
end
size() click to toggle source

Returns size which should be used for the “Content-Length” header.

@return [Integer]

# File lib/http/request/body.rb, line 17
def size
  if @source.is_a?(String)
    @source.bytesize
  elsif @source.respond_to?(:read)
    raise RequestError, "IO object must respond to #size" unless @source.respond_to?(:size)

    @source.size
  elsif @source.nil?
    0
  else
    raise RequestError, "cannot determine size of body: #{@source.inspect}"
  end
end

Private Instance Methods

rewind(io) click to toggle source
# File lib/http/request/body.rb, line 54
def rewind(io)
  io.rewind if io.respond_to? :rewind
rescue Errno::ESPIPE, Errno::EPIPE
  # Pipe IOs respond to `:rewind` but fail when you call it.
  #
  # Calling `IO#rewind` on a pipe, fails with *ESPIPE* on MRI,
  # but *EPIPE* on jRuby.
  #
  # - **ESPIPE** -- "Illegal seek."
  #   Invalid seek operation (such as on a pipe).
  #
  # - **EPIPE** -- "Broken pipe."
  #   There is no process reading from the other end of a pipe. Every
  #   library function that returns this error code also generates
  #   a SIGPIPE signal; this signal terminates the program if not handled
  #   or blocked. Thus, your program will never actually see EPIPE unless
  #   it has handled or blocked SIGPIPE.
  #
  # See: https://www.gnu.org/software/libc/manual/html_node/Error-Codes.html
  nil
end
validate_source_type!() click to toggle source
# File lib/http/request/body.rb, line 76
def validate_source_type!
  return if @source.is_a?(String)
  return if @source.respond_to?(:read)
  return if @source.is_a?(Enumerable)
  return if @source.nil?

  raise RequestError, "body of wrong type: #{@source.class}"
end