Class: VCR::Request

Inherits:

Struct

• Object
• Struct
• VCR::Request

Includes:

Normalizers::Body, Normalizers::Header

Defined in:

lib/vcr/structs.rb

Overview

The request of an HTTPInteraction.

Defined Under Namespace

Classes: FiberAware, Typed

Constant Summary

@@object_method =

Object.instance_method(:method)

Instance Attribute Summary

• #body ⇒ String^?

  the request body.

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

  the request headers.

• #method(*args) ⇒ Symbol

  the HTTP method (i.e. :head, :options, :get, :post, :put, :patch or :delete).

• #uri ⇒ String

  the request URI.

Class Method Summary

• .from_hash(hash) ⇒ Request

  Constructs a new instance from a hash.

Instance Method Summary

• #initialize(*args) ⇒ Request constructor

  A new instance of Request.

• #parsed_uri ⇒ #schema, ...

  Parses the URI using the configured ‘uri_parser`.

• #to_hash ⇒ Hash

  Builds a serializable hash from the request data.

Methods included from Normalizers::Body

included

Constructor Details

#initialize(*args) ⇒ Request

Returns a new instance of Request.

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

def initialize(*args)
  skip_port_stripping = false
  if args.last == :skip_port_stripping
    skip_port_stripping = true
    args.pop
  end

  super(*args)
  self.method = self.method.to_s.downcase.to_sym if self.method
  self.uri = without_standard_port(self.uri) unless skip_port_stripping
end

Instance Attribute Details

#body ⇒ String^?

the request body

Returns:

• (String, nil) —

  the current value of body

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

def body
  @body
end

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

the request headers

Returns:

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

  the current value of headers

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

def headers
  @headers
end

#method(*args) ⇒ Symbol

the HTTP method (i.e. :head, :options, :get, :post, :put, :patch or :delete)

Returns:

• (Symbol) —

  the current value of method

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

def method
  @method
end

#uri ⇒ String

the request URI

Returns:

• (String) —

  the current value of uri

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

def uri
  @uri
end

Class Method Details

.from_hash(hash) ⇒ Request

Constructs a new instance from a hash.

Parameters:

• hash (Hash) —

  the hash to use to construct the instance.

Returns:

• (Request) —

  the request

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

def self.from_hash(hash)
  method = hash['method']
  method &&= method.to_sym
  new method,
      hash['uri'],
      body_from(hash['body']),
      hash['headers'],
      :skip_port_stripping
end

Instance Method Details

#parsed_uri ⇒ #schema, ...

Parses the URI using the configured ‘uri_parser`.

Returns:

• (#schema, #host, #port, #path, #query) —

  A parsed URI object.

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

def parsed_uri
  VCR.configuration.uri_parser.parse(uri)
end

#to_hash ⇒ Hash

Builds a serializable hash from the request data.

Returns:

• (Hash) —

  hash that represents this request and can be easily serialized.

See Also:

• from_hash

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

def to_hash
  {
    'method'  => method.to_s,
    'uri'     => uri,
    'body'    => serializable_body,
    'headers' => headers
  }
end