Exception: Pike13::APIError

Inherits:

Error

• Object
• StandardError
• Error
• Pike13::APIError

Defined in:

lib/pike13/errors.rb

Overview

Base class for all API-related errors Provides access to HTTP status and response body

Direct Known Subclasses

AuthenticationError, BadRequestError, NotFoundError, RateLimitError, ServerError, ValidationError

Instance Attribute Summary

• #http_status ⇒ Integer^? readonly

  HTTP status code from the API.

• #response_body ⇒ Hash, ... readonly

  Response body from the API.

Instance Method Summary

• #initialize(message = nil, http_status: nil, response_body: nil) ⇒ APIError constructor

  A new instance of APIError.

Constructor Details

#initialize(message = nil, http_status: nil, response_body: nil) ⇒ APIError

Returns a new instance of APIError.

Parameters:

• message (String, nil) (defaults to: nil) —

  Error message

• http_status (Integer, nil) (defaults to: nil) —

  HTTP status code

• response_body (Hash, String, nil) (defaults to: nil) —

  API response body

# File 'lib/pike13/errors.rb', line 24

def initialize(message = nil, http_status: nil, response_body: nil)
  @http_status = http_status
  @response_body = response_body
  super(message)
end

Instance Attribute Details

#http_status ⇒ Integer^? (readonly)

HTTP status code from the API

Returns:

• (Integer, nil) —

  the current value of http_status

# File 'lib/pike13/errors.rb', line 18

def http_status
  @http_status
end

#response_body ⇒ Hash, ... (readonly)

Response body from the API

Returns:

• (Hash, String, nil) —

  the current value of response_body

# File 'lib/pike13/errors.rb', line 18

def response_body
  @response_body
end