UniformNotifier 技术文档

1. 安装指南

直接安装

使用以下命令直接安装 UniformNotifier：

gem install uniform_notifier

如果你需要通过 XMPP 发送通知，首先应该安装 xmpp4r：

gem install xmpp4r

对于其他通知方式，如 airbrake、Honeybadger、rollbar、bugsnag、AppSignal 或 slack，也需要安装相应的 gem。

使用 Bundler

你也可以将 UniformNotifier 添加到你的 Gemfile 中，然后运行 bundle install：

gem "uniform_notifier"

在 Gemfile 中添加其他通知方式所需的 gem。

2. 项目使用说明

UniformNotifier 支持两种类型的通知：

• inline_notify：用于 javascript alert 和 javascript console，返回一个字符串，并将被组合。
• out_of_channel_notify：用于 rails logger、自定义 logger、XMPP 等，不返回任何内容，仅发送消息到通知器。

默认情况下，所有通知器都是禁用的，你需要先启用它们。

以下是启用不同类型通知器的示例：

# 启用 javascript alert
UniformNotifier.alert = true

# 启用 rails logger
UniformNotifier.rails_logger = true

# 启用 airbrake
UniformNotifier.airbrake = true

# 启用 AppSignal
UniformNotifier.appsignal = true

# 启用 Honeybadger
UniformNotifier.honeybadger = true

# 启用 rollbar
UniformNotifier.rollbar = true

# 启用 bugsnag
UniformNotifier.bugsnag = true

# 启用 slack
UniformNotifier.slack = true

# 配置自定义 logger
logger = File.open('notify.log', 'a+')
logger.sync = true
UniformNotifier.customized_logger = logger

# 启用 XMPP
UniformNotifier.xmpp = { :account => '[e-mail]', :password => 'password_for_jabber', :receiver => '[e-mail]', :show_online_status => true }

# 启用 terminal-notifier
UniformNotifier.terminal_notifier = true

启用后，你可以通过以下方式发送通知：

# 发送通知到 rails logger、自定义 logger 或 XMPP
UniformNotifier.active_notifiers.each do |notifier|
  notifier.out_of_channel_notify("自定义消息")
end

# 获取所有激活通知器的 inline 通知，并添加到 HTTP 响应体底部
responses = []
UniformNotifier.active_notifiers.each do |notifier|
  responses << notifier.inline_notify("自定义消息")
end
javascript_str = responses.join("\n")

3. 项目 API 使用文档

UniformNotifier 提供了以下 API 方法：

• alert: 启用或配置 javascript alert 通知。
• console: 启用或配置 javascript console 通知。
• rails_logger: 启用 rails logger 通知。
• airbrake: 启用或配置 airbrake 通知。
• appsignal: 启用或配置 AppSignal 通知。
• honeybadger: 启用或配置 Honeybadger 通知。
• rollbar: 启用或配置 rollbar 通知。
• bugsnag: 启用或配置 bugsnag 通知。
• slack: 启用或配置 slack 通知。
• customized_logger: 配置自定义 logger 通知。
• xmpp: 启用或配置 XMPP 通知。
• terminal_notifier: 启用 terminal-notifier 通知。
• raise: 配置是否抛出异常。

4. 项目安装方式

请参考安装指南部分，使用 gem 命令或 Bundler 将 UniformNotifier 添加到你的项目中。