Class: VCR::Response

Inherits:

Struct

• Object
• Struct
• VCR::Response

Includes:

Normalizers::Body, Normalizers::Header

Defined in:

lib/vcr/structs.rb

Overview

The response of an HTTPInteraction.

Instance Attribute Summary

• #adapter_metadata ⇒ Hash

  Additional metadata used by a specific VCR adapter.

• #body ⇒ String

  the response body.

• #headers ⇒ Hash{String => Array<String>}

  the response headers.

• #http_version ⇒ nil, String

  the HTTP version.

• #status ⇒ ResponseStatus

  the status of the response.

Class Method Summary

• .decompress(body, type) ⇒ Object

  Decode string compressed with gzip or deflate.

• .from_hash(hash) ⇒ Response

  Constructs a new instance from a hash.

Instance Method Summary

• #compressed? ⇒ Boolean

  Checks if the type of encoding is one of “gzip” or “deflate”.

• #content_encoding ⇒ String

  The type of encoding.

• #decompress ⇒ Object

  Decodes the compressed body and deletes evidence that it was ever compressed.

• #initialize(*args) ⇒ Response constructor

  A new instance of Response.

• #recompress ⇒ Object

  Recompresses the decompressed body according to adapter metadata.

• #to_hash ⇒ Hash

  Builds a serializable hash from the response data.

• #update_content_length_header ⇒ Object

  Updates the Content-Length response header so that it is accurate for the response body.

• #vcr_decompressed? ⇒ Boolean

  Checks if VCR decompressed the response body.

Methods included from Normalizers::Body

included

Constructor Details

#initialize(*args) ⇒ Response

Returns a new instance of Response.

# File 'lib/vcr/structs.rb', line 338

def initialize(*args)
  super(*args)
  self.adapter_metadata ||= {}
end

Instance Attribute Details

#adapter_metadata ⇒ Hash

Additional metadata used by a specific VCR adapter.

Returns:

• (Hash) —

  the current value of adapter_metadata

# File 'lib/vcr/structs.rb', line 334

def adapter_metadata
  @adapter_metadata
end

#body ⇒ String

the response body

Returns:

• (String) —

  the current value of body

# File 'lib/vcr/structs.rb', line 334

def body
  @body
end

#headers ⇒ Hash{String => Array<String>}

the response headers

Returns:

• (Hash{String => Array<String>}) —

  the current value of headers

# File 'lib/vcr/structs.rb', line 334

def headers
  @headers
end

#http_version ⇒ nil, String

the HTTP version

Returns:

• (nil, String) —

  the current value of http_version

# File 'lib/vcr/structs.rb', line 334

def http_version
  @http_version
end

#status ⇒ ResponseStatus

the status of the response

Returns:

• (ResponseStatus) —

  the current value of status

# File 'lib/vcr/structs.rb', line 334

def status
  @status
end

Class Method Details

.decompress(body, type) ⇒ Object

Decode string compressed with gzip or deflate

Raises:

• (VCR::Errors::UnknownContentEncodingError) —

  if the content encoding is not a known encoding.

# File 'lib/vcr/structs.rb', line 452

def self.decompress(body, type)
  unless HAVE_ZLIB
    warn "VCR: cannot decompress response; Zlib not available"
    return
  end

  case type
  when 'gzip'
    gzip_reader_options = {}
    gzip_reader_options[:encoding] = 'ASCII-8BIT' if ''.respond_to?(:encoding)
    yield Zlib::GzipReader.new(StringIO.new(body),
                               **gzip_reader_options).read
  when 'deflate'
    yield Zlib::Inflate.inflate(body)
  when 'identity', NilClass
    return
  else
    raise Errors::UnknownContentEncodingError, "unknown content encoding: #{type}"
  end
end

.from_hash(hash) ⇒ Response

Constructs a new instance from a hash.

Parameters:

• hash (Hash) —

  the hash to use to construct the instance.

Returns:

• (Response) —

  the response

# File 'lib/vcr/structs.rb', line 363

def self.from_hash(hash)
  new ResponseStatus.from_hash(hash.fetch('status', {})),
      hash['headers'],
      body_from(hash['body']),
      hash['http_version'],
      hash['adapter_metadata']
end

Instance Method Details

#compressed? ⇒ Boolean

Checks if the type of encoding is one of “gzip” or “deflate”.

Returns:

• (Boolean)