Exception: SuggestGrid::DetailedErrorResponse

Inherits:
APIException
  • Object
show all
Defined in:
lib/suggestgrid/exceptions/detailed_error_response.rb

Overview

Error response.

Instance Attribute Summary collapse

Attributes inherited from APIException

#context, #response_code

Instance Method Summary collapse

Constructor Details

#initialize(reason, context) ⇒ DetailedErrorResponse

The constructor.

Parameters:

  • The (String) —

    reason for raising an exception.

  • The (HttpContext) —

    HttpContext of the API call.



26
27
28
29
30
 
# File 'lib/suggestgrid/exceptions/detailed_error_response.rb', line 26

def initialize(reason, context)
  super(reason, context)
  hash = APIHelper.json_deserialize(@context.response.raw_body)
  unbox(hash)
end

Instance Attribute Details

#error_description ⇒ String

Description of the response.

Returns:



13
14
15
 
# File 'lib/suggestgrid/exceptions/detailed_error_response.rb', line 13

def error_description
  @error_description
end

#error_details ⇒ String

Details of the response.

Returns:



21
22
23
 
# File 'lib/suggestgrid/exceptions/detailed_error_response.rb', line 21

def error_details
  @error_details
end

#error_text ⇒ String

Message of the response.

Returns:



9
10
11
 
# File 'lib/suggestgrid/exceptions/detailed_error_response.rb', line 9

def error_text
  @error_text
end

#error_uri ⇒ String

The URI of the error for more details.

Returns:



17
18
19
 
# File 'lib/suggestgrid/exceptions/detailed_error_response.rb', line 17

def error_uri
  @error_uri
end

Instance Method Details

#unbox(hash) ⇒ Object

Populates this object by extracting properties from a hash. response body.

Parameters:

  • The (Hash) —

    deserialized response sent by the server in the



35
36
37
38
39
40
 
# File 'lib/suggestgrid/exceptions/detailed_error_response.rb', line 35

def unbox(hash)
  @error_text = hash['error_text']
  @error_description = hash['error_description']
  @error_uri = hash['error_uri']
  @error_details = hash['error_details']
end