Exception: Zizq::ResponseError

Inherits:
Error
  • Object
show all
Defined in:
lib/zizq/error.rb,
sig/generated/zizq/error.rbs

Overview

HTTP error — the server returned a non-success status code. Carries the status code and parsed body.

Direct Known Subclasses

ClientError, ServerError

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message, status:, body: nil) ⇒ Object

Create a new ResponseError with the given error message, response status and decoded response body.

Parameters:

  • message (Object)
  • status: (Object)
  • body: (Object) (defaults to: nil) 


27
28
29
30
31
 
# File 'lib/zizq/error.rb', line 27

def initialize(message, status:, body: nil) #: (String, status: Integer, ?body: Hash[String, untyped]?) -> void
  @status = status
  @body = body
  super(message)
end

Instance Attribute Details

#body ⇒ Hash[String, untyped]? (readonly)

The decoded body of the error response.

Returns:

  • (Hash[String, untyped], nil) 


23
24
25
 
# File 'lib/zizq/error.rb', line 23

def body
  @body
end

#status ⇒ Integer (readonly)

The HTTP response status from the Zizq server.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/zizq/error.rb', line 20

def status
  @status
end