Exception: Hooksmith::Error

Inherits:

StandardError

• Object
• StandardError
• Hooksmith::Error

Defined in:

lib/hooksmith/errors.rb

Overview

Base error class for all Hooksmith errors.

All Hooksmith errors inherit from this class, allowing you to rescue all Hooksmith-related errors with a single rescue clause.

Examples:

Rescuing all Hooksmith errors

begin
  Hooksmith::Dispatcher.new(...).run!
rescue Hooksmith::Error => e
  logger.error("Hooksmith error: #{e.message}")
end

Direct Known Subclasses

ConfigurationError, InvalidPayloadError, MultipleProcessorsError, NoProcessorError, PersistenceError, ProcessorError, UnknownEventError, VerificationError

Instance Attribute Summary

• #event ⇒ String^? readonly

  The event name.

• #provider ⇒ String^? readonly

  The provider name.

Instance Method Summary

• #initialize(message = nil, provider: nil, event: nil) ⇒ Error constructor

  Initializes a new Error.

Constructor Details

#initialize(message = nil, provider: nil, event: nil) ⇒ Error

Initializes a new Error.

Parameters:

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

  the error message

• provider (String, Symbol, nil) (defaults to: nil) —

  the provider name

• event (String, Symbol, nil) (defaults to: nil) —

  the event name

# File 'lib/hooksmith/errors.rb', line 27

def initialize(message = nil, provider: nil, event: nil)
  @provider = provider&.to_s
  @event = event&.to_s
  super(message)
end

Instance Attribute Details

#event ⇒ String^? (readonly)

Returns the event name.

Returns:

• (String, nil) —

  the event name

# File 'lib/hooksmith/errors.rb', line 20

def event
  @event
end

#provider ⇒ String^? (readonly)

Returns the provider name.

Returns:

• (String, nil) —

  the provider name

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

def provider
  @provider
end