Class: Backup::Notifier::Base

Inherits:

Object

• Object
• Backup::Notifier::Base

Includes:

Configuration::Helpers

Defined in:

lib/backup/notifier/base.rb

Direct Known Subclasses

Campfire, Mail, Presently, Twitter

Instance Attribute Summary

• #on_failure ⇒ Object (also: #notify_on_failure?)

  When set to true, the user will be notified by email when a backup process raises an exception before finishing.

• #on_success ⇒ Object (also: #notify_on_success?)

  When set to true, the user will be notified by email when a backup process ends without raising any exceptions.

Instance Method Summary

• #log! ⇒ Object

  Logs a message to the console and log file to inform the client that Backup is notifying about the process.

Methods included from Configuration::Helpers

#clear_defaults!, #getter_methods, #load_defaults!, #setter_methods

Instance Attribute Details

#on_failure ⇒ Object Also known as: notify_on_failure?

When set to true, the user will be notified by email when a backup process raises an exception before finishing

# File 'lib/backup/notifier/base.rb', line 17

def on_failure
  @on_failure
end

#on_success ⇒ Object Also known as: notify_on_success?

When set to true, the user will be notified by email when a backup process ends without raising any exceptions

# File 'lib/backup/notifier/base.rb', line 11

def on_success
  @on_success
end

Instance Method Details

#log! ⇒ Object

Logs a message to the console and log file to inform the client that Backup is notifying about the process

# File 'lib/backup/notifier/base.rb', line 23

def log!
  Logger.message "#{ self.class } started notifying about the process."
end