Exception: NWS::APIError

Inherits:

Error

• Object
• StandardError
• Error
• NWS::APIError

Defined in:

lib/nws/errors.rb

Overview

Error raised when the NWS API returns an error response

Direct Known Subclasses

NotFoundError, RateLimitError, ServerError

Instance Attribute Summary

• #response_body ⇒ String^? readonly

  Raw response body from the API.

• #status_code ⇒ Integer^? readonly

  HTTP status code from the API response.

Instance Method Summary

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

  A new instance of APIError.

Constructor Details

#initialize(message, status_code: nil, response_body: nil) ⇒ APIError

Returns a new instance of APIError.

Parameters:

• message (String) —

  Error message

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

  HTTP status code

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

  Raw response body

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

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

Instance Attribute Details

#response_body ⇒ String^? (readonly)

Returns Raw response body from the API.

Returns:

• (String, nil) —

  Raw response body from the API

# File 'lib/nws/errors.rb', line 13

def response_body
  @response_body
end

#status_code ⇒ Integer^? (readonly)

Returns HTTP status code from the API response.

Returns:

• (Integer, nil) —

  HTTP status code from the API response

# File 'lib/nws/errors.rb', line 10

def status_code
  @status_code
end