Scamp 项目技术文档

1. 安装指南

Scamp 是一个用于编写 Campfire 机器人的框架。在安装之前，确保您使用的 Ruby 版本不低于 1.9.2。

通过以下命令安装 Scamp：

gem install scamp

或者，如果您使用 Bundler，可以将 gem 'scamp' 添加到您的 Gemfile 中。

2. 项目使用说明

Scamp 设计为简单易用，允许用户自由地构建自己的功能。以下是一些基本的使用示例：

简单示例

require 'scamp'

scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)

scamp.behaviour do
  match "ping" do
    say "pong"
  end
end

scamp.connect!([293788, "Monitoring"])

图片搜索

require 'scamp'
require 'cgi'

scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)

scamp.behaviour do
  match /^artme (?<search>\w+)/ do
    url = "http://ajax.googleapis.com/ajax/services/search/images?rsz=large&start=0&v=1.0&q=#{CGI.escape(search)}"
    # ...省略 HTTP 请求和处理代码...
  end
end

scamp.connect!([293788, "Monitoring"])

进阶使用

Scamp 支持正则表达式匹配、条件限制、命令帮助等多种功能。以下是一个更复杂的示例：

require 'scamp'

scamp = Scamp.new(:api_key => "YOUR API KEY", :subdomain => "yoursubdomain", :verbose => true)

scamp.behaviour do
  # ...省略更多匹配和使用示例...
end

scamp.connect!([293788, "Monitoring"])

3. 项目 API 使用文档

Scamp 的 API 包括以下主要方法和选项：

• Scamp.new：创建一个新的 Scamp 实例，需要提供 API 密钥和子域名。
• behaviour：定义机器人的行为，包括匹配消息和处理响应。
• match：定义一个匹配规则，可以基于正则表达式或字符串。
• say：在聊天室发送消息。
• paste：发送多行文本。
• play：播放声音。

更多方法和详细用法，请参考项目示例和文档。

4. 项目安装方式

Scamp 可以通过 Ruby 的包管理器 gem 进行安装。确保您的系统中已经安装了 Ruby（版本不低于 1.9.2），然后使用以下命令：

gem install scamp

如果您使用 Bundler，请将 Scamp 添加到 Gemfile 中：

gem 'scamp'

然后执行 bundle install 命令进行安装。

以上就是 Scamp 的安装指南、使用说明和 API 使用文档。希望对您有所帮助！