Exception: EasyPost::Error

Inherits:
StandardError
  • Object
show all
Defined in:
lib/easypost/error.rb

Overview

EasyPost Error object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message = nil, status = nil, code = nil, errors = nil, http_body = nil) ⇒ Error

Initialize a new EasyPost Error



8
9
10
11
12
13
14
15
16
 
# File 'lib/easypost/error.rb', line 8

def initialize(message = nil, status = nil, code = nil, errors = nil, http_body = nil)
  @message = message
  @status = status
  @code = code
  @errors = errors
  @http_body = http_body

  super(message)
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.



5
6
7
 
# File 'lib/easypost/error.rb', line 5

def code
  @code
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



5
6
7
 
# File 'lib/easypost/error.rb', line 5

def errors
  @errors
end

#http_body ⇒ Object (readonly)

Returns the value of attribute http_body.



5
6
7
 
# File 'lib/easypost/error.rb', line 5

def http_body
  @http_body
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



5
6
7
 
# File 'lib/easypost/error.rb', line 5

def message
  @message
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



5
6
7
 
# File 'lib/easypost/error.rb', line 5

def status
  @status
end

Instance Method Details

#==(other) ⇒ Object

Compare error properties.



24
25
26
27
28
29
30
 
# File 'lib/easypost/error.rb', line 24

def ==(other)
  other.is_a?(EasyPost::Error) &&
    message == other.message &&
    status == other.status &&
    code == other.code &&
    errors == other.errors
end

#to_s ⇒ Object

Convert an error to a string.



19
20
21
 
# File 'lib/easypost/error.rb', line 19

def to_s
  "#{code} (#{status}): #{message} #{errors}".strip
end