Class: SplititWebApiV4::ApiErrorResponseException

Inherits:
APIException
  • Object
show all
Defined in:
lib/splitit_web_api_v4/exceptions/api_error_response_exception.rb

Overview

ApiErrorResponse class.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(reason, response) ⇒ ApiErrorResponseException

The constructor.

Parameters:

  • reason (String) —

    The reason for raising an exception.

  • response (HttpResponse) —

    The HttpReponse of the API call.



23
24
25
26
27
 
# File 'lib/splitit_web_api_v4/exceptions/api_error_response_exception.rb', line 23

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

Instance Attribute Details

#error ⇒ ApiErrorModel

TODO: Write general description for this method

Returns:



18
19
20
 
# File 'lib/splitit_web_api_v4/exceptions/api_error_response_exception.rb', line 18

def error
  @error
end

#trace_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/splitit_web_api_v4/exceptions/api_error_response_exception.rb', line 14

def trace_id
  @trace_id
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



46
47
48
49
 
# File 'lib/splitit_web_api_v4/exceptions/api_error_response_exception.rb', line 46

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} trace_id: #{@trace_id.inspect}, error: #{@error.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



40
41
42
43
 
# File 'lib/splitit_web_api_v4/exceptions/api_error_response_exception.rb', line 40

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} trace_id: #{@trace_id}, error: #{@error}>"
end

#unbox(hash) ⇒ Object

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

Parameters:

  • hash (Hash) —

    The deserialized response sent by the server in the



32
33
34
35
36
37
 
# File 'lib/splitit_web_api_v4/exceptions/api_error_response_exception.rb', line 32

def unbox(hash)
  return nil unless hash

  @trace_id = hash.key?('TraceId') ? hash['TraceId'] : SKIP
  @error = ApiErrorModel.from_hash(hash['Error']) if hash['Error']
end