reCAPTCHA 项目技术文档

1. 安装指南

1.1 获取 API 密钥

首先，访问 reCAPTCHA 管理控制台 获取 reCAPTCHA API 密钥。根据你的需求选择 reCAPTCHA 类型（v2 Checkbox、v2 Invisible 或 v3），并生成相应的密钥。

1.2 配置环境变量

在开发环境中，你可以使用环境变量来存储 API 密钥。例如，使用 dotenv gem 来管理环境变量：

export RECAPTCHA_SITE_KEY   = '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
export RECAPTCHA_SECRET_KEY = '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'

如果你使用的是企业版 API 密钥，还需要设置以下环境变量：

export RECAPTCHA_ENTERPRISE            = 'true'
export RECAPTCHA_ENTERPRISE_API_KEY    = 'AIzvFyE3TU-g4K_Kozr9F1smEzZSGBVOfLKyupA'
export RECAPTCHA_ENTERPRISE_PROJECT_ID = 'my-project'

2. 项目安装方式

2.1 Rails 安装

在 Rails 项目中，首先在 Gemfile 中添加 recaptcha gem：

gem "recaptcha"

然后运行 bundle install 安装 gem。

2.2 Sinatra / Rack / Ruby 安装

在 Sinatra 或 Rack 项目中，同样需要在 Gemfile 中添加 recaptcha gem：

gem 'recaptcha'

然后设置环境变量，并在需要的地方包含 Recaptcha::Adapters::ViewMethods 和 Recaptcha::Adapters::ControllerMethods。

3. 项目的使用说明

3.1 在视图中嵌入 reCAPTCHA

在需要保护的表单中，使用 recaptcha_tags 方法嵌入 reCAPTCHA：

<%= form_for @foo do |f| %>
  # …
  <%= recaptcha_tags %>
  # …
<% end %>

3.2 在控制器中验证 reCAPTCHA

在表单提交的控制器中，使用 verify_recaptcha 方法验证 reCAPTCHA 响应：

# app/controllers/users_controller.rb
@user = User.new(params[:user].permit(:name))
if verify_recaptcha(model: @user) && @user.save
  redirect_to @user
else
  render 'new'
end

4. 项目 API 使用文档

4.1 reCAPTCHA V2 API 使用

recaptcha_tags

当你的 reCAPTCHA 类型为 "v2 Checkbox" 时，使用此方法。

可用选项：

• :theme：指定主题，可选值为 dark 或 light（默认：light）。
• :ajax：渲染动态 AJAX reCAPTCHA（默认：false）。
• :site_key：覆盖配置中的站点 API 密钥。
• :error：覆盖 reCAPTCHA API 返回的错误代码（默认：nil）。
• :size：指定大小（默认：nil）。
• :nonce：可选。为脚本设置 nonce 属性（默认：nil）。
• :id：指定 HTML id 属性（默认：nil）。
• :callback：可选。成功回调函数的名称。
• :expired_callback：可选。过期回调函数的名称。
• :error_callback：可选。错误回调函数的名称。
• :noscript：包含 <noscript> 内容（默认：true）。

verify_recaptcha

此方法返回 true 或 false，用于处理 reCAPTCHA 小部件的响应令牌。通常在控制器中调用。

可用选项：

• :model：设置错误的模型。
• :attribute：模型属性接收错误（默认：:base）。
• :message：自定义错误消息。
• :secret_key：覆盖配置中的密钥 API 密钥。
• :enterprise_api_key：覆盖企业 API 密钥。
• :enterprise_project_id：覆盖企业项目 ID。
• :timeout：等待 reCAPTCHA 服务器的秒数（默认：3）。
• :response：自定义响应参数（默认：params['g-recaptcha-response-data']）。

4.2 reCAPTCHA V3 API 使用

recaptcha_v3

当你的 reCAPTCHA 类型为 "v3" 时，使用此方法。

verify_recaptcha（用于 v3）

与 v2 类似，但用于验证 v3 的响应。

recaptcha_reply

获取 reCAPTCHA 响应的详细信息。

5. 国际化支持

reCAPTCHA 支持多语言，可以通过 :hl 选项指定语言代码。

6. 测试

在测试环境中，可以通过设置 RECAPTCHA_TESTING 环境变量为 true 来跳过 reCAPTCHA 验证。

7. 其他 API 密钥设置

除了环境变量，还可以通过其他方式配置或覆盖 API 密钥，具体参考项目的 Alternative API Key Setup 部分。