Voight-Kampff 技术文档

1. 安装指南

要安装 Voight-Kampff，请运行以下命令：

gem install voight_kampff

如果您在使用 Rails 并希望添加 ActionDispatch::Request#bot? 和 ActionDispatch::Request#human? 方法，请在 Gemfile 中按如下方式配置：

gem 'voight_kampff', require: 'voight_kampff/rails'

如果使用纯 Rack，以下方式进行配置：

gem 'voight_kampff', require: 'voight_kampff/rack'

2. 项目的使用说明

Voight-Kampff 依赖于用户代理列表进行机器人检测。它能轻松地告诉您一个请求是否来自爬虫、蜘蛛或机器人。这在分析如页面点击跟踪等方面尤其有用。

使用方式

• 通过 Rack::Request：如在 Ruby on Rails 控制器中使用 request.bot?
• 通过 VoightKampff 模块：使用 VoightKampff.bot? '用户代理字符串'
• 通过 VoightKampff::Test 实例：使用 VoightKampff::Test.new('用户代理字符串').bot?

上述所有示例都接受 human? 和 bot? 方法。所有这些方法都将返回 true 或 false。

3. 项目API使用文档

目前 Voight-Kampff 提供以下方法：

• VoightKampff.bot? '用户代理字符串'：检查提供的用户代理字符串是否属于机器人。
• VoightKampff.human? '用户代理字符串'：检查提供的用户代理字符串是否属于人类用户。

4. 项目安装方式

Voight-Kampff 可以通过 Ruby 的包管理工具 gem 进行安装。以下是安装步骤：

# 安装 Voight-Kampff
gem install voight_kampff

# 如果使用 Rails
gem 'voight_kampff', require: 'voight_kampff/rails'

# 如果使用 Rack
gem 'voight_kampff', require: 'voight_kampff/rack'

在配置文件中，根据实际使用情况进行相应配置。

以上即为 Voight-Kampff 的技术文档，希望能帮助您更好地了解和使用该项目。