Exception: Usps::Imis::Error

Inherits:

StandardError

• Object
• StandardError
• Usps::Imis::Error

Defined in:

lib/usps/imis/error.rb

Overview

Base error class for all internal exceptions

Direct Known Subclasses

Usps::Imis::Errors::ApiError, Usps::Imis::Errors::CommandLineError, Usps::Imis::Errors::ConfigError, Usps::Imis::Errors::LockedIdError, Usps::Imis::Errors::MapperError, Usps::Imis::Errors::MissingIdError, Usps::Imis::Errors::NotFoundError, Usps::Imis::Errors::PanelUnimplementedError, Usps::Imis::Errors::ResponseError, Usps::Imis::Errors::UnexpectedPropertyTypeError

Instance Attribute Summary

• #metadata ⇒ Object

  Additional call-specific metadata to pass through to Bugsnag.

Instance Method Summary

• #bugsnag_meta_data ⇒ Hash

  Additional metadata to include in Bugsnag reports.

• #initialize(message, metadata = {}) ⇒ Error constructor

  A new instance of ApiError.

Constructor Details

#initialize(message, metadata = {}) ⇒ Error

A new instance of ApiError

Parameters:

• message (String) —

  The base exception message

• metadata (Hash) (defaults to: {}) —

  Additional call-specific metadata to pass through to Bugsnag

# File 'lib/usps/imis/error.rb', line 17

def initialize(message, metadata = {})
  super(message)
  @metadata = metadata

  Imis.logger(self.class.name).error self
end

Instance Attribute Details

#metadata ⇒ Object

Additional call-specific metadata to pass through to Bugsnag

# File 'lib/usps/imis/error.rb', line 10

def metadata
  @metadata
end

Instance Method Details

#bugsnag_meta_data ⇒ Hash

Additional metadata to include in Bugsnag reports

Can include fields at the top level, which will be shows on the custom tab

Can include fields nested under a top-level key, which will be shown on a tab with the top-level key as its name

Returns:

• (Hash)

# File 'lib/usps/imis/error.rb', line 33

def bugsnag_meta_data
  metadata == {} ? {} : base_metadata
end