class Notiffany::Notifier::Growl

System notifications using the [growl](github.com/visionmedia/growl) gem.

This gem is available for OS X and sends system notifications to [Growl](growl.info) through the [GrowlNotify](growl.info/downloads) executable.

The ‘growlnotify` executable must be installed manually or by using [Homebrew](mxcl.github.com/homebrew/).

Sending notifications with this notifier will not show the different notifications in the Growl preferences. Use the :gntp notifier if you want to customize each notification type in Growl.

@example Install ‘growlnotify` with Homebrew

brew install growlnotify

@example Add the ‘growl` gem to your `Gemfile`

group :development
  gem 'growl'
end

@example Add the ‘:growl` notifier to your `Guardfile`

notification :growl

@example Add the ‘:growl_notify` notifier with configuration options to your `Guardfile` notification :growl, sticky: true, host: ’192.168.1.5’, password: ‘secret’

Constants

DEFAULTS

Default options for the growl notifications.

INSTALL_GROWLNOTIFY

Public Instance Methods

_check_available(_opts = {}) click to toggle source
# File lib/notiffany/notifier/growl.rb, line 48
def _check_available(_opts = {})
  fail UnavailableError, INSTALL_GROWLNOTIFY unless ::Growl.installed?
end
_perform_notify(message, opts = {}) click to toggle source

Shows a system notification.

The documented options are for GrowlNotify 1.3, but the older options are also supported. Please see ‘growlnotify –help`.

Priority can be one of the following named keys: ‘Very Low`, `Moderate`, `Normal`, `High`, `Emergency`. It can also be an integer between -2 and 2.

@param [String] message the notification message body @param [Hash] opts additional notification library options @option opts [String] type the notification type. Either ‘success’,

'pending', 'failed' or 'notify'

@option opts [String] title the notification title @option opts [String] image the path to the notification image @option opts [Boolean] sticky make the notification sticky @option opts [String, Integer] priority specify an int or named key

(default is 0)

@option opts [String] host the hostname or IP address to which to

send a remote notification

@option opts [String] password the password used for remote

notifications
# File lib/notiffany/notifier/growl.rb, line 75
def _perform_notify(message, opts = {})
  opts = { name: "Notiffany" }.merge(opts)
  opts.select! { |k, _| ::Growl::Base.switches.include?(k) }
  ::Growl.notify(message, opts)
end
_supported_hosts() click to toggle source
# File lib/notiffany/notifier/growl.rb, line 44
def _supported_hosts
  %w(darwin)
end