Rakismet 项目技术文档

1. 安装指南

1.1 添加 Gem

首先，在项目的 Gemfile 中添加 rakismet gem：

gem 'rakismet'

1.2 安装 Gem

执行以下命令安装 rakismet gem：

bundle install

1.3 获取 API 密钥

前往 Akismet 注册并获取 API 密钥。

1.4 配置 API 密钥和应用 URL

在 application.rb 或 config/initializers/rakismet.rb 中配置 API 密钥和应用的 URL：

# 在 application.rb 中配置
config.rakismet.key = 'your wordpress key'
config.rakismet.url = 'http://yourdomain.com/'

# 或在 config/initializers/rakismet.rb 中配置
YourApp::Application.config.rakismet.key = 'your wordpress key'
YourApp::Application.config.rakismet.url = 'http://yourdomain.com/'

1.5 配置代理（可选）

如果需要通过代理访问 Akismet，可以配置代理主机和端口：

config.rakismet.proxy_host = 'http://yourdomain.com/'
config.rakismet.proxy_port = '8080'

1.6 多租户应用配置（可选）

如果是多租户应用，可以将 URL 配置为一个 Proc：

config.rakismet.url = Proc.new { ApplicationController.current_tenant.url }

2. 项目的使用说明

2.1 检查垃圾评论

在模型中引入 Rakismet：

class Comment
  include Rakismet::Model
end

引入后，模型将获得三个实例方法：

• spam?：提交评论到 Akismet，返回 true 表示评论是垃圾评论，false 表示不是。
• ham!：重新提交被误判为垃圾评论的有效评论。
• spam!：重新提交被 Akismet 漏掉的垃圾评论。

2.2 配置模型

Rakismet 会向 Akismet 发送以下信息：

• author：评论者的名字
• author_url：评论者提交的 URL
• author_email：评论者提交的邮箱
• comment_type：默认是 comment，可以设置为 trackback、pingback 或其他类型
• content：评论内容
• permalink：评论所属条目的永久链接
• user_ip：提交评论的 IP 地址
• user_agent：用户代理字符串
• referrer：引荐 URL

如果模型的属性名称与上述不一致，可以通过 rakismet_attrs 进行配置：

class Comment
  include Rakismet::Model
  attr_accessor :commenter_name, :commenter_email
  rakismet_attrs :author => :commenter_name, :author_email => :commenter_email
end

2.3 可选的请求变量

Akismet 需要一些关于请求环境的信息，如远程 IP、用户代理字符串和 HTTP 引荐来源。如果模型中没有这些属性，Rakismet 会从当前请求中获取。

如果选择自己处理这些请求变量，可以通过以下配置禁用中间件：

config.rakismet.use_middleware = false

3. 项目 API 使用文档

3.1 检查评论是否为垃圾评论

使用 spam? 方法检查评论是否为垃圾评论：

if @comment.spam?
  # 处理垃圾评论
else
  # 处理正常评论
end

3.2 反馈误判

使用 ham! 和 spam! 方法向 Akismet 反馈误判：

@comment.ham!  # 反馈误判为垃圾评论的有效评论
@comment.spam! # 反馈被 Akismet 漏掉的垃圾评论

3.3 查看 Akismet 响应

可以通过 akismet_response 查看 Akismet 的响应：

response = @comment.akismet_response
puts response

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Gemfile 中添加 rakismet gem，并执行 bundle install 安装。

4.2 手动配置

如果使用的是非 Rails 框架，可以通过手动设置配置变量：

Rakismet.key = 'your wordpress key'
Rakismet.url = 'http://yourdomain.com/'
Rakismet.host = 'your service provider endpoint'

4.3 测试模式

可以通过配置 config.rakismet.test 启用测试模式：

config.rakismet.test = true

在 Rails 中，默认在 test 和 development 环境下启用测试模式。

---

通过以上步骤，您可以成功安装并使用 Rakismet 来集成 Akismet 垃圾评论过滤服务。