Exception: Servus::Support::Errors::ServiceError

Inherits:

StandardError

• Object
• StandardError
• Servus::Support::Errors::ServiceError

Defined in:

lib/servus/support/errors.rb

Overview

Base error class for all Servus service errors.

Subclasses define their HTTP status via #http_status and their API response format via #api_error.

Examples:

Creating a custom error type

class InsufficientFundsError < Servus::Support::Errors::ServiceError
  DEFAULT_MESSAGE = 'Insufficient funds'

  def http_status = :unprocessable_entity

  def api_error
    { code: 'insufficient_funds', message: message }
  end
end

Using with failure method

def call
  return failure("User not found", type: NotFoundError)
end

Direct Known Subclasses

AuthenticationError, BadGatewayError, BadRequestError, ConflictError, ExpectationFailedError, FailedDependencyError, ForbiddenError, GatewayTimeoutError, GoneError, GuardError, HttpVersionNotSupportedError, ImATeapotError, InsufficientStorageError, InternalServerError, LengthRequiredError, LockedError, LoopDetectedError, MethodNotAllowedError, MisdirectedRequestError, NetworkAuthenticationRequiredError, NotAcceptableError, NotExtendedError, NotFoundError, NotImplementedError, PayloadTooLargeError, PreconditionFailedError, PreconditionRequiredError, ProxyAuthenticationRequiredError, RangeNotSatisfiableError, RequestHeaderFieldsTooLargeError, RequestTimeoutError, ServiceUnavailableError, TooEarlyError, TooManyRequestsError, UnavailableForLegalReasonsError, UnprocessableEntityError, UnsupportedMediaTypeError, UpgradeRequiredError, UriTooLongError, VariantAlsoNegotiatesError

Constant Summary

DEFAULT_MESSAGE =

'An error occurred'

Instance Attribute Summary

• #message ⇒ Object readonly

  Returns the value of attribute message.

Instance Method Summary

• #api_error ⇒ Hash

  Returns an API-friendly error response.

• #http_status ⇒ Symbol

  Returns the HTTP status code for this error.

• #initialize(message = nil) ⇒ ServiceError constructor

  Creates a new service error instance.

Constructor Details

#initialize(message = nil) ⇒ ServiceError

Creates a new service error instance.

Parameters:

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

  custom error message (uses DEFAULT_MESSAGE if nil)

# File 'lib/servus/support/errors.rb', line 41

def initialize(message = nil)
  @message = message || self.class::DEFAULT_MESSAGE
  super("#{self.class}: #{@message}")
end

Instance Attribute Details

#message ⇒ Object (readonly)

Returns the value of attribute message.

# File 'lib/servus/support/errors.rb', line 34

def message
  @message
end

Instance Method Details

#api_error ⇒ Hash

Returns an API-friendly error response.

Returns:

• (Hash) —

  hash with :code and :message keys

# File 'lib/servus/support/errors.rb', line 54

def api_error = { code: http_status, message: message }

#http_status ⇒ Symbol

Returns the HTTP status code for this error.

Returns:

• (Symbol) —

  Rails-compatible status symbol

# File 'lib/servus/support/errors.rb', line 49

def http_status = :bad_request