Class: FriendlyShipping::ApiResult

Inherits:
Object
  • Object
show all
Defined in:
lib/friendly_shipping/api_result.rb

Direct Known Subclasses

ApiFailure

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data, original_request: nil, original_response: nil) ⇒ ApiResult

Returns a new instance of ApiResult.

Parameters:

  • data (Object) —

    The API result

  • original_request (FriendlyShipping::Request) (defaults to: nil) —

    The HTTP request (when debugging is enabled)

  • original_response (FriendlyShipping::Response) (defaults to: nil) —

    The HTTP response (when debugging is enabled)



10
11
12
13
14
15
16
17
18
 
# File 'lib/friendly_shipping/api_result.rb', line 10

def initialize(data, original_request: nil, original_response: nil)
  @data = data

  # We do not want to attach debugging information in every single response to save memory in production
  return unless original_request&.debug

  @original_request = original_request
  @original_response = original_response
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



5
6
7
 
# File 'lib/friendly_shipping/api_result.rb', line 5

def data
  @data
end

#original_request ⇒ Object (readonly)

Returns the value of attribute original_request.



5
6
7
 
# File 'lib/friendly_shipping/api_result.rb', line 5

def original_request
  @original_request
end

#original_response ⇒ Object (readonly)

Returns the value of attribute original_response.



5
6
7
 
# File 'lib/friendly_shipping/api_result.rb', line 5

def original_response
  @original_response
end