https://github.com/flyerhzm/uniform_notifier
uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp
https://github.com/flyerhzm/uniform_notifier
Keywords from Contributors
activerecord activejob mvc rubygems crash-reporting gem static-code-analysis rubocop code-formatter rspec
Last synced: about 21 hours ago
JSON representation
Repository metadata
uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp
- Host: GitHub
- URL: https://github.com/flyerhzm/uniform_notifier
- Owner: flyerhzm
- License: mit
- Created: 2010-11-18T15:16:10.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2025-08-31T13:53:00.000Z (6 months ago)
- Last Synced: 2026-02-14T20:38:56.536Z (17 days ago)
- Language: Ruby
- Homepage:
- Size: 160 KB
- Stars: 240
- Watchers: 6
- Forks: 40
- Open Issues: 7
- Releases: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
README.md
UniformNotifier
uniform_notifier is extracted from bullet, it gives you the ability to send notification through rails logger, customized logger, javascript alert, javascript console, xmpp, airbrake, honeybadger and AppSignal.
Install
install directly
gem install uniform_notifier
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 AppSignal, you should install AppSignal first
gem install appsignal
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 xmpp4r, airbrake, bugsnag, honeybadger, slack-notifier, terminal-notifier gem if you want.
Usage
There are two types of notifications,
one is inline_notify, for javascript alert and javascript console notifiers, which returns a string and will be combined,
the other is out_of_channel_notify, for rails logger, customized logger, 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 }
# AppSignal
UniformNotifier.appsignal = true
# AppSignal with options
UniformNotifier.appsignal = { :namespace => "Background", :tags => { :hostname => "frontend1" } }
# 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
# xmpp
UniformNotifier.xmpp = { :account => 'sender_account@jabber.org',
:password => 'password_for_jabber',
:receiver => 'recipient_account@jabber.org',
: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 or xmpp.
UniformNotifier.active_notifiers.each do |notifier|
notifier.out_of_channel_notify("customize message")
end
# the notify message will be wrapped by <script type="text/javascript">...</script>,
# 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")
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.
Owner metadata
- Name: Richard Huang
- Login: flyerhzm
- Email:
- Kind: user
- Description: Founder at synvert.net and awesomecode.io Speaker of RailsConf and RubyConf
- Website: https://synvert.net
- Location: Shanghai, China
- Twitter: flyerhzm
- Company:
- Icon url: https://avatars.githubusercontent.com/u/66836?v=4
- Repositories: 110
- Last ynced at: 2024-04-14T15:24:03.749Z
- Profile URL: https://github.com/flyerhzm
GitHub Events
Total
- Watch event: 4
- Issue comment event: 2
- Push event: 5
- Pull request review event: 2
- Pull request review comment event: 1
- Pull request event: 1
- Fork event: 1
- Create event: 2
Last Year
- Watch event: 3
- Issue comment event: 1
- Push event: 5
- Pull request review event: 2
- Pull request review comment event: 1
- Pull request event: 1
- Fork event: 1
- Create event: 2
Committers metadata
Last synced: about 23 hours ago
Total Commits: 171
Total Committers: 41
Avg Commits per committer: 4.171
Development Distribution Score (DDS): 0.585
Commits in past year: 7
Committers in past year: 4
Avg Commits per committer in past year: 1.75
Development Distribution Score (DDS) in past year: 0.429
| Name | Commits | |
|---|---|---|
| Richard Huang | f****m@g****m | 71 |
| Awesome Code | t****m@x****m | 35 |
| dtaniwaki | d****i@g****m | 6 |
| mishina | t****8@g****m | 5 |
| Dan Finnie | d****n@d****m | 4 |
| Konstantin Kosmatov | k****y@k****u | 3 |
| Akira Matsuda | r****e@d****p | 3 |
| Andrew King | me@a****m | 3 |
| Fabio Perrella | f****a@g****m | 3 |
| Stefan Wrobel | s****l | 3 |
| Joshua Wood | j****h@h****m | 2 |
| Brian Kelly | p****c@g****m | 2 |
| Sinan Keskin | s****n@k****n | 2 |
| Steven Soroka | s****8@g****m | 2 |
| tinogomes | t****j@g****m | 1 |
| teckwan | w****n@o****m | 1 |
| skawaji | s****i@e****p | 1 |
| Alexey Nikitin | n****n@d****o | 1 |
| Andrew Hao | a****o@b****m | 1 |
| AwesomeCode | t****m@a****o | 1 |
| Flip Sasser | f****p@x****m | 1 |
| Name=Goslawski Dawid | d****i@n****m | 1 |
| Nicolas Besnard | n****d@r****m | 1 |
| jeniaefimov | e****v@m****u | 1 |
| dmathieu | 42@d****m | 1 |
| adamors | a****s | 1 |
| Yuriy Tsemashko | y****o@g****m | 1 |
| Tim van der Horst | t****h@g****m | 1 |
| Stanisław Pitucha | s****a@e****m | 1 |
| Olle Jonsson | o****n@g****m | 1 |
| and 11 more... | ||
Committer domains:
- tanda.co: 1
- sugarcrm.com: 1
- ruby-lang.org: 1
- ianduggan.net: 1
- nickhammond.com: 1
- envato.com: 1
- dmathieu.com: 1
- mail.ru: 1
- rea-group.com: 1
- nsn.com: 1
- x451.com: 1
- awesomecode.io: 1
- blurb.com: 1
- dreamindustries.co: 1
- ehealthcare.co.jp: 1
- kesk.in: 1
- hintmedia.com: 1
- andrewsking.com: 1
- dio.jp: 1
- kosmatov.su: 1
- danfinnie.com: 1
- xinminlabs.com: 1
Issue and Pull Request metadata
Last synced: 13 days ago
Total issues: 15
Total pull requests: 59
Average time to close issues: 5 months
Average time to close pull requests: about 1 month
Total issue authors: 14
Total pull request authors: 36
Average comments per issue: 1.6
Average comments per pull request: 0.53
Merged pull request: 48
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: about 17 hours
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 1.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- nicolas-besnard (2)
- tay (1)
- utkarsh2102 (1)
- jpmckinney (1)
- Piioo (1)
- notslang (1)
- vassilevsky (1)
- hderms (1)
- victormatheusdev (1)
- ruckc (1)
- datnt (1)
- aniketstiwari (1)
- tnm (1)
- CloCkWeRX (1)
Top Pull Request Authors
- flyerhzm (13)
- dtaniwaki (6)
- mishina2228 (3)
- sinankeskin (3)
- dmathieu (2)
- nicolas-besnard (2)
- danfinnie (2)
- cabello (1)
- kosmatov (1)
- hsbt (1)
- viraptor (1)
- adamors (1)
- ssoroka (1)
- alkuzad (1)
- vdh (1)
Top Issue Labels
- feature (1)
Top Pull Request Labels
Package metadata
- Total packages: 8
-
Total downloads:
- rubygems: 332,080,475 total
- Total docker downloads: 942,782,004
- Total dependent packages: 8 (may contain duplicates)
- Total dependent repositories: 12,017 (may contain duplicates)
- Total versions: 64
- Total maintainers: 1
gem.coop: uniform_notifier
uniform notifier for rails logger, customized logger, javascript alert, javascript console and xmpp
- Homepage: http://rubygems.org/gems/uniform_notifier
- Documentation: http://www.rubydoc.info/gems/uniform_notifier/
- Licenses: MIT
- Latest release: 1.18.0 (published 6 months ago)
- Last Synced: 2026-03-01T03:03:52.619Z (3 days ago)
- Versions: 29
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 166,000,337 Total
- Docker Downloads: 471,391,002
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.051%
- Downloads: 0.154%
- Maintainers (1)
rubygems.org: uniform_notifier
uniform notifier for rails logger, customized logger, javascript alert, javascript console and xmpp
- Homepage: http://rubygems.org/gems/uniform_notifier
- Documentation: http://www.rubydoc.info/gems/uniform_notifier/
- Licenses: MIT
- Latest release: 1.18.0 (published 6 months ago)
- Last Synced: 2026-03-02T12:32:38.154Z (1 day ago)
- Versions: 29
- Dependent Packages: 8
- Dependent Repositories: 12,017
- Downloads: 166,080,138 Total
- Docker Downloads: 471,391,002
-
Rankings:
- Downloads: 0.163%
- Docker downloads count: 0.277%
- Dependent repos count: 0.313%
- Average: 1.786%
- Dependent packages count: 2.044%
- Stargazers count: 3.729%
- Forks count: 4.188%
- Maintainers (1)
ubuntu-23.10: ruby-uniform-notifier
- Homepage: https://github.com/flyerhzm/uniform_notifier
- Licenses:
- Latest release: 1.16.0-1 (published 18 days ago)
- Last Synced: 2026-02-13T18:35:19.349Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
ubuntu-23.04: ruby-uniform-notifier
- Homepage: https://github.com/flyerhzm/uniform_notifier
- Licenses:
- Latest release: 1.16.0-1 (published 20 days ago)
- Last Synced: 2026-02-11T06:51:53.096Z (20 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
debian-12: ruby-uniform-notifier
- Homepage: https://github.com/flyerhzm/uniform_notifier
- Documentation: https://packages.debian.org/bookworm/ruby-uniform-notifier
- Licenses:
- Latest release: 1.16.0-1 (published 19 days ago)
- Last Synced: 2026-02-12T23:43:32.452Z (19 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
debian-13: ruby-uniform-notifier
- Homepage: https://github.com/flyerhzm/uniform_notifier
- Documentation: https://packages.debian.org/trixie/ruby-uniform-notifier
- Licenses:
- Latest release: 1.16.0-1 (published 19 days ago)
- Last Synced: 2026-02-13T13:20:41.169Z (18 days ago)
- Versions: 1
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 100%
Dependencies
- rake >= 0
- rexml >= 0
- rspec > 0 development
- slack-notifier >= 1.0 development
- xmpp4r = 0.5 development
- actions/checkout v3 composite
- ruby/setup-ruby v1 composite
Score: 30.189074521548278