Module: Notiffany

Defined in:
lib/notiffany/notifier/tmux.rb,
lib/notiffany.rb,
lib/notiffany/version.rb,
lib/notiffany/notifier.rb,
lib/notiffany/notifier/base.rb,
lib/notiffany/notifier/file.rb,
lib/notiffany/notifier/gntp.rb,
lib/notiffany/notifier/emacs.rb,
lib/notiffany/notifier/growl.rb,
lib/notiffany/notifier/config.rb,
lib/notiffany/notifier/detected.rb,
lib/notiffany/notifier/libnotify.rb,
lib/notiffany/notifier/rb_notifu.rb,
lib/notiffany/notifier/notifysend.rb,
lib/notiffany/notifier/tmux/client.rb,
lib/notiffany/notifier/emacs/client.rb,
lib/notiffany/notifier/tmux/session.rb,
lib/notiffany/notifier/terminal_title.rb,
lib/notiffany/notifier/terminal_notifier.rb,
lib/notiffany/notifier/tmux/notification.rb

Overview

TODO: this probably deserves a gem of it’s own

Defined Under Namespace

Classes: Notifier

Constant Summary collapse

VERSION = 
"0.1.3"

Class Method Summary collapse

Class Method Details

.connect(options = {}) ⇒ Object

The notifier handles sending messages to different notifiers. Currently the following libraries are supported:

  • Ruby GNTP

  • Growl

  • Libnotify

  • rb-notifu

  • emacs

  • Terminal Notifier

  • Terminal Title

  • Tmux

Please see the documentation of each notifier for more information about the requirements and configuration possibilities.

Notiffany knows four different notification types:

  • success

  • pending

  • failed

  • notify

The notification type selection is based on the image option that is sent to #notify. Each image type has its own notification type, and notifications with custom images goes all sent as type ‘notify`. The `gntp` notifier is able to register these types at Growl and allows customization of each notification type.

Notiffany can be configured to make use of more than one notifier at once.



41
42
43
 
# File 'lib/notiffany/notifier.rb', line 41

def self.connect(options = {})
  Notifier.new(options)
end