Exception: Apertur::Error

Inherits:

StandardError

• Object
• StandardError
• Apertur::Error

Defined in:

lib/apertur/errors.rb

Overview

Base error class for all Apertur API errors.

Direct Known Subclasses

AuthenticationError, NotFoundError, RateLimitError, ValidationError

Instance Attribute Summary

• #code ⇒ String^? readonly

  the error code returned by the API.

• #status_code ⇒ Integer^? readonly

  the HTTP status code.

Instance Method Summary

• #initialize(message, status_code: nil, code: nil) ⇒ Error constructor

  A new instance of Error.

Constructor Details

#initialize(message, status_code: nil, code: nil) ⇒ Error

Returns a new instance of Error.

Parameters:

• message (String) —

  the error message

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

  the HTTP status code

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

  the API error code

# File 'lib/apertur/errors.rb', line 14

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

Instance Attribute Details

#code ⇒ String^? (readonly)

the error code returned by the API

Returns:

• (String, nil) —

  the current value of code

# File 'lib/apertur/errors.rb', line 8

def code
  @code
end

#status_code ⇒ Integer^? (readonly)

the HTTP status code

Returns:

• (Integer, nil) —

  the current value of status_code

# File 'lib/apertur/errors.rb', line 8

def status_code
  @status_code
end