Exception: Woods::Unblocked::ApiError

Inherits:

Error

• Object
• StandardError
• Error
• Woods::Unblocked::ApiError

Defined in:

lib/woods/unblocked/client.rb

Overview

API error carrying the HTTP status code, so callers can branch on status (e.g. treat a 404 on delete as “already gone”) instead of matching message strings. Subclasses Woods::Error, so existing rescue Woods::Error sites keep working unchanged.

Instance Attribute Summary

• #status ⇒ Integer readonly

  HTTP status code of the failed response.

Instance Method Summary

• #initialize(message, status:) ⇒ ApiError constructor

  A new instance of ApiError.

Constructor Details

#initialize(message, status:) ⇒ ApiError

Returns a new instance of ApiError.

Parameters:

• message (String) —

  Error message

• status (Integer) —

  HTTP status code — required, because callers branch on it (a nil status would silently miss every status check)

# File 'lib/woods/unblocked/client.rb', line 22

def initialize(message, status:)
  super(message)
  @status = Integer(status)
end

Instance Attribute Details

#status ⇒ Integer (readonly)

Returns HTTP status code of the failed response.

Returns:

• (Integer) —

  HTTP status code of the failed response

# File 'lib/woods/unblocked/client.rb', line 17

def status
  @status
end