Exception: Helio::HelioError

Inherits:
StandardError
  • Object
show all
Defined in:
lib/helio/errors.rb

Overview

HelioError is the base error from which all other more specific Helio errors derive.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message = nil, http_status: nil, http_body: nil, json_body: nil, http_headers: nil) ⇒ HelioError

Initializes a HelioError.



22
23
24
25
26
27
28
29
30
 
# File 'lib/helio/errors.rb', line 22

def initialize(message = nil, http_status: nil, http_body: nil, json_body: nil,
               http_headers: nil)
  @message = message
  @http_status = http_status
  @http_body = http_body
  @http_headers = http_headers || {}
  @json_body = json_body
  @request_id = @http_headers[:request_id]
end

Instance Attribute Details

#http_body ⇒ Object (readonly)

These fields are now available as part of #response and that usage should be preferred.



15
16
17
 
# File 'lib/helio/errors.rb', line 15

def http_body
  @http_body
end

#http_headers ⇒ Object (readonly)

Returns the value of attribute http_headers.



16
17
18
 
# File 'lib/helio/errors.rb', line 16

def http_headers
  @http_headers
end

#http_status ⇒ Object (readonly)

Returns the value of attribute http_status.



17
18
19
 
# File 'lib/helio/errors.rb', line 17

def http_status
  @http_status
end

#json_body ⇒ Object (readonly)

equivalent to #data



18
19
20
 
# File 'lib/helio/errors.rb', line 18

def json_body
  @json_body
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



7
8
9
 
# File 'lib/helio/errors.rb', line 7

def message
  @message
end

#request_id ⇒ Object (readonly)

Returns the value of attribute request_id.



19
20
21
 
# File 'lib/helio/errors.rb', line 19

def request_id
  @request_id
end

#response ⇒ Object

Response contains a HelioResponse object that has some basic information about the response that conveyed the error.



11
12
13
 
# File 'lib/helio/errors.rb', line 11

def response
  @response
end

Instance Method Details

#to_s ⇒ Object 



32
33
34
35
36
 
# File 'lib/helio/errors.rb', line 32

def to_s
  status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
  id_string = @request_id.nil? ? "" : "(Request #{@request_id}) "
  "#{status_string}#{id_string}#{@message}"
end