首页
/ Rack-Recaptcha 技术文档

Rack-Recaptcha 技术文档

2024-12-20 19:29:06作者:乔或婵

1. 安装指南

要使用 Rack-Recaptcha,首先需要安装相关的 Ruby gem 包。你可以使用以下命令进行安装:

[sudo] gem install rack-recaptcha

安装完成后,需要在你的项目 Gemfile 文件中添加以下内容:

gem 'rack-recaptcha', :require => 'rack/recaptcha'

确保执行 bundle install 命令来更新项目的依赖。

2. 项目使用说明

Rack-Recaptcha 是一个 Rack 中间件,它可以通过 Recaptcha API 实现验证码的校验功能。要在你的应用程序中使用它,需要按照以下步骤进行配置:

  1. 设置公开密钥(public key)和私有密钥(private key),你可以在 ReCaptcha 官网上注册获取。
  2. 根据使用的框架,在相应的配置文件中添加 Rack-Recaptcha 中间件。

以下是一些常见框架的配置示例:

Sinatra

app.rb 文件中配置中间件:

use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
helpers Rack::Recaptcha::Helpers

Padrino

app/app.rb 文件中配置中间件:

use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
helpers Rack::Recaptcha::Helpers

Rails

application.rb 文件中配置中间件:

module YourRailsAppName
  class Application < Rails::Application
    ...
    config.gem 'rack-recaptcha', :lib => 'rack/recaptcha'
    config.middleware.use Rack::Recaptcha, :public_key => 'KEY', :private_key => 'SECRET'
  end
end

并在对应的 helper 或 controller 文件中包含 Rack::Recaptcha::Helpers 模块。

3. 项目 API 使用文档

Rack-Recaptcha 提供了一个助手模块 Rack::Recaptcha::Helpers,它可以为你的应用添加以下方法:

  • recaptcha_tag :challenge:返回一个 JavaScript 验证码表单。
  • recaptcha_tag :noscript:返回一个非 JavaScript 验证码表单。
  • recaptcha_tag :ajax:返回一个 AJAX 验证码表单。

以下是一些使用示例:

# 返回 JavaScript 验证码表单
recaptcha_tag :challenge

# 返回非 JavaScript 验证码表单
recaptcha_tag :noscript, :height => 300, :width => 500

# 返回 AJAX 验证码表单
recaptcha_tag :ajax, :display => { :theme => 'red' }

可以使用 recaptcha_valid? 方法来检查验证是否通过。

if recaptcha_valid?
  # 验证通过
else
  # 验证失败
end

在测试环境中,可以通过以下方式覆盖 recaptcha_valid? 方法的行为:

# 使 recaptcha_valid? 返回 true
Rack::Recaptcha.test_mode!

# 使 recaptcha_valid? 返回 false
Rack::Recaptcha.test_mode! :return => false

4. 项目安装方式

请参考上述的安装指南,使用 Ruby gem 包管理器安装 Rack-Recaptcha。

[sudo] gem install rack-recaptcha

在 Gemfile 中添加 gem 'rack-recaptcha', :require => 'rack/recaptcha',然后执行 bundle install

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
197
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
59
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
973
574
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
549
81
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133