Ruby GNTP 库使用技术文档

1. 安装指南

首先，您需要确保您的系统中已安装 Ruby 环境。接下来，可以使用以下命令通过 RubyGems 安装 ruby_gntp 库：

gem install ruby_gntp

确保在安装过程中没有出现任何错误。

2. 项目的使用说明

本项目是一个用于发送 GNTP（Growl Notification Transport Protocol）通知的 Ruby 库。以下是如何使用此库的一个基本示例：

require 'ruby_gntp'

# 创建 GNTP 对象
growl = GNTP.new("Ruby/GNTP 自测")

# 注册通知
growl.register({
  :notifications => [{
    :name => "notify",
    :enabled => true
  }]
})

# 发送通知
growl.notify({
  :name => "notify",
  :title => "恭喜",
  :text => "恭喜！您已成功安装 ruby_gntp。",
  :icon => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
  :sticky => true
})

# 立即发送通知
GNTP.notify({
  :app_name => "即时通知",
  :title => "即时通知",
  :text => "即时通知现在可用。",
  :icon => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif"
})

3. 项目API使用文档

以下是 ruby_gntp 库的主要 API 方法：

GNTP.new(app_name)

创建一个新的 GNTP 对象。

• 参数:
  • app_name: String，应用程序的名称。

growl.register(options)

注册应用程序和通知。

• 参数:
  • options: Hash，包含以下键：
    • :notifications: Array，包含通知信息。

growl.notify(options)

发送通知。

• 参数:
  • options: Hash，包含以下键：
    • :name: String，通知的名称。
    • :title: String，通知的标题。
    • :text: String，通知文本内容。
    • :icon: String，通知图标 URL。
    • :sticky: Boolean，通知是否持续显示。

GNTP.notify(options)

立即发送通知。

• 参数:
  • options: Hash，与 growl.notify 的参数相同。

4. 项目安装方式

项目的安装方式已在“1. 安装指南”中详细介绍。简要概括，您需要通过 RubyGems 使用以下命令安装 ruby_gntp：

gem install ruby_gntp

以上就是关于 Ruby GNTP 库的基本技术文档。通过上述指南和文档，您应能顺利安装并使用此库来发送通知。