Tarantula 技术文档

1. 安装指南

Tarantula 是一款针对 Rails 2.3 和 3.x 应用的爬虫工具，用于检测应用中的数据异常。您可以通过以下方式将 Tarantula 添加到您的项目中：

首先，在您的 Gemfile 文件中添加以下代码：

gem "tarantula"

如果是 Rails 3 应用，请使用以下代码：

gem 'tarantula', :require => 'tarantula-rails3'

然后运行 bundle install 命令安装依赖。

2. 项目使用说明

Tarantula 提供了一个 Rake 任务来创建一个集成测试，允许 Tarantula 爬取您的应用。

运行以下命令：

$ rake tarantula:setup

生成的测试代码可能需要根据您的应用进行适当的调整。如果您的应用需要登录才能访问某些页面，请更新测试代码以允许 Tarantula 访问这些页面。

以下是一个示例代码：

require "relevance/tarantula"
require "test_helper"

class TarantulaTest < ActionController::IntegrationTest
  fixtures :all

  def test_tarantula
    # 如果您的应用需要登录，取消注释并更新以下代码
    # post '/session', :login => 'quentin', :password => 'monkey'
    # follow_redirect!

    tarantula_crawl(self)
  end
end

如果需要设置自定义选项，可以在运行爬虫之前访问爬虫对象并设置属性。

3. 项目 API 使用文档

Tarantula 提供了一些 API 以便于自定义爬取行为。以下是一些常用 API 的使用方法：

• tarantula_crawler(self): 获取当前测试的爬虫对象。
• t.handlers << Relevance::Tarantula::TidyHandler.new: 添加 HTMLTidy 处理器。
• t.allow_404_for %r{/users/\d+/}: 允许匹配正则表达式的 URL 返回 404 错误。
• Relevance::Tarantula::FormSubmission.attacks: 添加针对常见攻击的测试字符串。
• t.times_to_crawl = 2: 设置爬取次数。
• t.crawl_timeout = 5.minutes: 设置爬取超时时间。

4. 项目安装方式

Tarantula 的安装方式已在安装指南中说明。您需要将 Tarantula 添加到 Gemfile 文件中，然后运行 bundle install 命令安装依赖。

以上就是关于 Tarantula 项目的技术文档。希望对您使用 Tarantula 有所帮助。