Ruby
Need help with uniform_notifier?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
flyerhzm

Description

uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp

201 Stars 32 Forks MIT License 173 Commits 9 Opened issues

Services available

Need anything else?

UniformNotifier

Build
Status AwesomeCode Status for flyerhzm/uniform_notifier

uniform_notifier is extracted from bullet, it gives you the ability to send notification through rails logger, customized logger, javascript alert, javascript console, growl, xmpp, airbrake and honeybadger.

Install

install directly

gem install uniform_notifier

if you want to notify by growl < v1.3, you should install ruby-growl first

gem install ruby-growl

if you want to notify by growl v1.3+, you should install ruby_gntp first

gem install ruby_gntp

if you want to notify by xmpp, you should install xmpp4r first

gem install xmpp4r

if you want to notify by airbrake, you should install airbrake first

gem install airbrake

if you want to notify by Honeybadger, you should install honeybadger first

gem install honeybadger

if you want to notify by rollbar, you should install rollbar first

gem install rollbar

if you want to notify by bugsnag, you should install bugsnag first

gem install bugsnag

if you want to notify by slack, you should install slack-notifier first

gem install slack-notifier

if you want to notify by terminal-notifier, you must install it first

gem install terminal-notifier

add it into Gemfile (Bundler)

gem "uniform_notifier"

you should add ruby-growl, ruby_gntp, xmpp4r, airbrake, bugsnag, honeybadger, slack-notifier, terminal-notifier gem if you want.

Usage

There are two types of notifications, one is inlinenotify, for javascript alert and javascript console notifiers, which returns a string and will be combined, the other is outofchannelnotify, for rails logger, customized logger, growl and xmpp, which doesn't return anything, just send the message to the notifiers.

By default, all notifiers are disabled, you should enable them first.

# javascript alert
UniformNotifier.alert = true
# javascript alert with options
# the attributes key adds custom attributes to the script tag appended to the body
UniformNotifier.alert = { :attributes => { :nonce => 'mySecret-nonce', 'data-key' => 'value' } }

javascript console (Safari/Webkit browsers or Firefox w/Firebug installed)

UniformNotifier.console = true

javascript console with options

the attributes key adds custom attributes to the script tag appended to the body

UniformNotifier.console = { :attributes => { :nonce => 'mySecret-nonce', 'data-key' => 'value' } }

rails logger

UniformNotifier.rails_logger = true

airbrake

UniformNotifier.airbrake = true

airbrake with options

UniformNotifier.airbrake = { :error_class => Exception }

Honeybadger

#

Reporting live data from development is disabled by default. Ensure

that the report_data option is enabled via configuration.

UniformNotifier.honeybadger = true

Honeybadger with options

UniformNotifier.honeybadger = { :error_class => 'Exception' }

rollbar

UniformNotifier.rollbar = true

rollbar with options (level can be 'debug', 'info', 'warning', 'error' or 'critical')

UniformNotifier.rollbar = { :level => 'warning' }

bugsnag

UniformNotifier.bugsnag = true

bugsnag with options

UniformNotifier.bugsnag = { :api_key => 'something' }

slack

UniformNotifier.slack = true

slack with options

UniformNotifier.slack = { :webhook_url => 'http://some.slack.url', :channel => '#default', :username => 'notifier' }

customized logger

logger = File.open('notify.log', 'a+') logger.sync = true UniformNotifier.customized_logger = logger

growl without password

UniformNotifier.growl = true

growl with passowrd

UniformNotifier.growl = { :password => 'growl password' }

xmpp

UniformNotifier.xmpp = { :account => '[email protected]', :password => 'password_for_jabber', :receiver => '[email protected]', :show_online_status => true }

terminal-notifier

UniformNotifier.terminal_notifier = true

raise an error

UniformNotifier.raise = true # raise a generic exception

class MyExceptionClass < Exception; end UniformNotifier.raise = MyExceptionClass # raise a custom exception type

UniformNotifier.raise = false # don't raise errors

After that, you can enjoy the notifiers, that's cool!

# the notify message will be notified to rails logger, customized logger, growl or xmpp.
UniformNotifier.active_notifiers.each do |notifier|
  notifier.out_of_channel_notify("customize message")
end

the notify message will be wrapped by ,

you should append the javascript_str at the bottom of http response body.

for more information, please check https://github.com/flyerhzm/bullet/blob/master/lib/bullet/rack.rb

responses = [] UniformNotifier.active_notifiers.each do |notifier| responses << notifier.inline_notify("customize message") end javascript_str = responses.join("\n")

Growl Support

To get Growl support up-and-running, follow the steps below:

  • For Growl < v1.3, install the ruby-growl gem: gem install ruby-growl
  • For Growl v1.3+, install the rubygntp gem: gem install rubygntp
  • Open the Growl preference pane in Systems Preferences
  • Click the "Network" tab
  • Make sure both "Listen for incoming notifications" and "Allow remote application registration" are checked. Note: If you set a password, you will need to set UniformNotifier.growl_password = { :password => 'growl password' } in the config file.
  • Restart Growl ("General" tab -> Stop Growl -> Start Growl)
  • Boot up your application. UniformNotifier will automatically send a Growl notification when Growl is turned on. If you do not see it when your application loads, make sure it is enabled in your initializer and double-check the steps above.

XMPP/Jabber Support

To get XMPP support up-and-running, follow the steps below:

  • Install the xmpp4r gem: gem install xmpp4r
  • Make both the sender and the recipient account add each other as contacts. This will require you to manually log into both accounts, add each other as contact and confirm each others contact request.
  • Boot up your application. UniformNotifier will automatically send an XMPP notification when XMPP is turned on.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.