Exception: Supercast::SupercastError
- Inherits:
-
StandardError
- Object
- StandardError
- Supercast::SupercastError
- Defined in:
- lib/supercast/errors.rb
Overview
SupercastError is the base error from which all other more specific Supercast errors derive.
Direct Known Subclasses
APIConnectionError, APIError, AuthenticationError, InvalidRequestError, PermissionError, RateLimitError
Instance Attribute Summary collapse
-
#code ⇒ Object
readonly
Returns the value of attribute code.
-
#http_body ⇒ Object
readonly
Returns the value of attribute http_body.
-
#http_headers ⇒ Object
readonly
Returns the value of attribute http_headers.
-
#http_status ⇒ Object
readonly
Returns the value of attribute http_status.
-
#json_body ⇒ Object
readonly
equivalent to #data.
-
#message ⇒ Object
readonly
Returns the value of attribute message.
-
#response ⇒ Object
Response contains a SupercastResponse object that has some basic information about the response that conveyed the error.
Instance Method Summary collapse
-
#initialize(message = nil, http_status: nil, http_body: nil, json_body: nil, http_headers: nil, code: nil) ⇒ SupercastError
constructor
Initializes a SupercastError.
- #to_s ⇒ Object
Constructor Details
#initialize(message = nil, http_status: nil, http_body: nil, json_body: nil, http_headers: nil, code: nil) ⇒ SupercastError
Initializes a SupercastError.
20 21 22 23 24 25 26 27 |
# File 'lib/supercast/errors.rb', line 20 def initialize( = nil, http_status: nil, http_body: nil, json_body: nil, http_headers: nil, code: nil) @message = @http_status = http_status @http_body = http_body @http_headers = http_headers || {} @json_body = json_body @code = code end |
Instance Attribute Details
#code ⇒ Object (readonly)
Returns the value of attribute code.
13 14 15 |
# File 'lib/supercast/errors.rb', line 13 def code @code end |
#http_body ⇒ Object (readonly)
Returns the value of attribute http_body.
14 15 16 |
# File 'lib/supercast/errors.rb', line 14 def http_body @http_body end |
#http_headers ⇒ Object (readonly)
Returns the value of attribute http_headers.
15 16 17 |
# File 'lib/supercast/errors.rb', line 15 def http_headers @http_headers end |
#http_status ⇒ Object (readonly)
Returns the value of attribute http_status.
16 17 18 |
# File 'lib/supercast/errors.rb', line 16 def http_status @http_status end |
#json_body ⇒ Object (readonly)
equivalent to #data
17 18 19 |
# File 'lib/supercast/errors.rb', line 17 def json_body @json_body end |
#message ⇒ Object (readonly)
Returns the value of attribute message.
7 8 9 |
# File 'lib/supercast/errors.rb', line 7 def @message end |
#response ⇒ Object
Response contains a SupercastResponse object that has some basic information about the response that conveyed the error.
11 12 13 |
# File 'lib/supercast/errors.rb', line 11 def response @response end |
Instance Method Details
#to_s ⇒ Object
29 30 31 32 |
# File 'lib/supercast/errors.rb', line 29 def to_s status_string = @http_status.nil? ? '' : "(Status #{@http_status}) " "#{status_string}#{@message}" end |