Class: RSpec::DocumentRequests::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/document_requests/request.rb

Defined Under Namespace

Classes: Parameter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(explanation:, example:, method:, path:, request_parameters:, request_headers:, response:) ⇒ Request

Returns a new instance of Request.



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/rspec/document_requests/request.rb', line 17

def initialize(explanation:, example:, method:, path:, request_parameters:, request_headers:, response:)
  @explanation    = explanation
  @example        = example
  @method         = method
  @path           = path
  @response       = response

  process_request_parameters(request_parameters)
  process_request_headers(request_headers)
  process_response_parameters
  process_response_headers
end

Instance Attribute Details

#example ⇒ Object (readonly)

Returns the value of attribute example.



14
15
16
 
# File 'lib/rspec/document_requests/request.rb', line 14

def example
  @example
end

#explanation ⇒ Object (readonly)

Returns the value of attribute explanation.



14
15
16
 
# File 'lib/rspec/document_requests/request.rb', line 14

def explanation
  @explanation
end

#method ⇒ Object (readonly)

Returns the value of attribute method.



14
15
16
 
# File 'lib/rspec/document_requests/request.rb', line 14

def method
  @method
end

#parsed_response ⇒ Object (readonly)

Returns the value of attribute parsed_response.



16
17
18
 
# File 'lib/rspec/document_requests/request.rb', line 16

def parsed_response
  @parsed_response
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



14
15
16
 
# File 'lib/rspec/document_requests/request.rb', line 14

def path
  @path
end

#request_headers ⇒ Object (readonly)

Returns the value of attribute request_headers.



15
16
17
 
# File 'lib/rspec/document_requests/request.rb', line 15

def request_headers
  @request_headers
end

#request_parameters ⇒ Object (readonly)

Returns the value of attribute request_parameters.



15
16
17
 
# File 'lib/rspec/document_requests/request.rb', line 15

def request_parameters
  @request_parameters
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



16
17
18
 
# File 'lib/rspec/document_requests/request.rb', line 16

def response
  @response
end

#response_headers ⇒ Object (readonly)

Returns the value of attribute response_headers.



16
17
18
 
# File 'lib/rspec/document_requests/request.rb', line 16

def response_headers
  @response_headers
end

#response_parameters ⇒ Object (readonly)

Returns the value of attribute response_parameters.



16
17
18
 
# File 'lib/rspec/document_requests/request.rb', line 16

def response_parameters
  @response_parameters
end

Class Method Details

.filter_values(name) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rspec/document_requests/request.rb', line 32

def self.filter_values(name)
  define_method(name) do
    values = instance_variable_get(:"@#{name}")
    next values if values.nil?

    included_values = DocumentRequests.configuration.send(:"include_#{name}")
    excluded_values = DocumentRequests.configuration.send(:"exclude_#{name}")
    hidden_values = DocumentRequests.configuration.send(:"hide_#{name}")

    values.select! do |k, v|
      next false if included_values and included_values.exclude?(k)
      next false if excluded_values.include?(k)
      values[k].value = "..." if hidden_values.include?(k)
      true
    end
    values
  end
end