Exception: Reach::REST::RestError

Inherits:
ReachError
  • Object
show all
Defined in:
lib/reach-ruby/framework/rest/error.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message, response) ⇒ RestError

Returns a new instance of RestError.



16
17
18
19
20
21
22
23
24
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 16

def initialize(message, response)
  @status_code = response.status_code
  @code = response.body.fetch('errorCode', @status_code)
  @details = response.body.fetch('errorDetails', nil)
  @error_message = response.body.fetch('errorMessage', nil)
  @more_info = response.body.fetch('more_info', nil)
  @message = format_message(message)
  @response = response
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.



14
15
16
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 14

def code
  @code
end

#details ⇒ Object (readonly)

Returns the value of attribute details.



14
15
16
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 14

def details
  @details
end

#error_message ⇒ Object (readonly)

Returns the value of attribute error_message.



14
15
16
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 14

def error_message
  @error_message
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



14
15
16
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 14

def message
  @message
end

#more_info ⇒ Object (readonly)

Returns the value of attribute more_info.



14
15
16
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 14

def more_info
  @more_info
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



14
15
16
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 14

def response
  @response
end

#status_code ⇒ Object (readonly)

Returns the value of attribute status_code.



14
15
16
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 14

def status_code
  @status_code
end

Instance Method Details

#body ⇒ Object

Deprecated.

use #response instead



27
28
29
30
31
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 27

def body
  warn 'This error used to be a "Reach::REST::ReachError" but is now a "Reach::REST::RestError". ' \
       'Please use #response instead of #body.'
  @response
end

#to_s ⇒ Object 



33
34
35
 
# File 'lib/reach-ruby/framework/rest/error.rb', line 33

def to_s
  message
end