pax_global_header 0000666 0000000 0000000 00000000064 15165761772 0014533 g ustar 00root root 0000000 0000000 52 comment=9b261bbd3fa8b5537e8bf56b37e1fda1c27b4ad7
ambethia-recaptcha-db974b3/ 0000775 0000000 0000000 00000000000 15165761772 0015655 5 ustar 00root root 0000000 0000000 ambethia-recaptcha-db974b3/.github/ 0000775 0000000 0000000 00000000000 15165761772 0017215 5 ustar 00root root 0000000 0000000 ambethia-recaptcha-db974b3/.github/PULL_REQUEST_TEMPLATE.md 0000664 0000000 0000000 00000000172 15165761772 0023016 0 ustar 00root root 0000000 0000000 Why and what is being done.
## Pre-Merge Checklist
- [ ] CHANGELOG.md updated with short summary for user facing changes
ambethia-recaptcha-db974b3/.github/workflows/ 0000775 0000000 0000000 00000000000 15165761772 0021252 5 ustar 00root root 0000000 0000000 ambethia-recaptcha-db974b3/.github/workflows/ci.yml 0000664 0000000 0000000 00000001510 15165761772 0022365 0 ustar 00root root 0000000 0000000 name: CI
on:
pull_request:
branches: [ master ]
push:
branches: [ master ]
jobs:
test:
name: Test ruby version matrix
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
ruby-version: ['3.0', '3.1', '3.2', '3.3', 'head', 'truffleruby-head'] # keep in sync with gemspec
steps:
- uses: actions/checkout@v2
- uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ matrix.ruby-version }}
bundler-cache: true
- run: bundle exec rake test
rubocop:
name: Run rubocop
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: ruby/setup-ruby@v1
with:
ruby-version: '3.0' # lowest supported version, keep in sync with .rubocop.yml
bundler-cache: true
- run: bundle exec rake rubocop
ambethia-recaptcha-db974b3/.gitignore 0000664 0000000 0000000 00000000130 15165761772 0017637 0 ustar 00root root 0000000 0000000 rdoc
pkg
.ruby-gemset
.ruby-version
.bundle
.gems
.rbenv-gemsets
/demo/*/Gemfile.lock
ambethia-recaptcha-db974b3/.rubocop.yml 0000664 0000000 0000000 00000005030 15165761772 0020125 0 ustar 00root root 0000000 0000000 AllCops:
TargetRubyVersion: 3.0 # lowest supported version, see .github/workflows/ci.yml
Include:
- 'lib/**/*'
- 'Rakefile'
- 'Gemfile'
Exclude:
- 'vendor/**/*'
- 'demo/**/*'
SuggestExtensions: false
NewCops: enable
Layout/LineLength:
Max: 120
Metrics/ClassLength:
Enabled: false
Style/FetchEnvVar:
Enabled: false
Style/StringLiterals:
Enabled: false
Layout/SpaceInsideHashLiteralBraces:
Enabled: false
Lint/AmbiguousOperator:
Enabled: false
Style/Lambda:
Enabled: false
Style/SpecialGlobalVars:
Enabled: false
Metrics/MethodLength:
Enabled: false
Metrics/AbcSize:
Enabled: false
Style/WordArray:
Enabled: false
Layout/EndAlignment:
EnforcedStyleAlignWith: variable
Style/StringLiteralsInInterpolation:
Enabled: false
Style/NumericLiterals:
Enabled: false
Layout/FirstArgumentIndentation:
Enabled: false
Layout/FirstHashElementIndentation:
Enabled: false
Layout/ParameterAlignment:
EnforcedStyle: with_fixed_indentation
Layout/MultilineOperationIndentation:
Enabled: false
Metrics/ModuleLength:
Enabled: false
Metrics/PerceivedComplexity:
Enabled: false
Style/DoubleNegation:
Enabled: false
Style/Documentation:
Enabled: false
Metrics/CyclomaticComplexity:
Enabled: false
Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented
Layout/ExtraSpacing:
Enabled: false
Layout/DotPosition:
EnforcedStyle: trailing
Style/SingleLineBlockParams:
Enabled: false
Style/TrailingCommaInArrayLiteral:
Enabled: false
Style/TrailingCommaInHashLiteral:
Enabled: false
Style/PerlBackrefs:
Enabled: false
Style/IfUnlessModifier:
Enabled: false
# alias / alias_method are both fine
Style/Alias:
Enabled: false
# for simple cases more readable
Style/GuardClause:
Enabled: false
# for single `/` more readable
Style/RegexpLiteral:
Enabled: false
# %w[] shows that it will return an array
Style/PercentLiteralDelimiters:
PreferredDelimiters:
'%i': '[]'
'%w': '[]'
'%W': '[]'
Lint/AssignmentInCondition:
Enabled: false
Lint/AmbiguousRegexpLiteral:
Enabled: false
Metrics/ParameterLists:
Enabled: false
# looks correct / intuitive
Lint/ParenthesesAsGroupedExpression:
Enabled: false
Style/FormatString:
Enabled: false
Metrics/BlockNesting:
Enabled: false
Layout/IndentationWidth:
Width: 2
Lint/NonLocalExitFromIterator:
Enabled: false
# often makes logical sense to not combine if with elsif
Style/IfInsideElse:
Enabled: false
Style/FrozenStringLiteralComment:
Exclude:
- 'test/**/*'
Style/SymbolArray:
Enabled: false
ambethia-recaptcha-db974b3/CHANGELOG.md 0000664 0000000 0000000 00000012003 15165761772 0017462 0 ustar 00root root 0000000 0000000 ## Next
## 5.21.2
* make env fall back to Rails.env if it is unset
## 5.21.1
* Fix flash not being updated when responding to :turbo_stream requests
## 5.21.0
* add referer header to #api_verification_entreprise
## 5.20.0
* turn recpatch reply into a object with logic
## 5.19.0
* require a minimum lenght of 100 for responses, configured via response_minimum
## 5.18.0
* Add key setup to v3 example in README
* Remove unnecessary id from textarea - This was unused and may cause accessability concerns if there is more than one recaptcha on the page due to multiple elements with the same id
* Update to latest version of rubocop
* Drop support for Ruby 2.7; add Ruby 3.3
* Add i18n: de, es, it, pt, pt-BR
* Added recaptcha_failure_reason
## 5.16.0
* Allow usage of `options[:turbo]` as well as `options[:turbolinks]` for `recaptcha_v3`
## 5.15.0
* Add 3.2 to the list of Ruby CI versions
* Add ability to submit verify_recaptcha via POST with JSON Body with `options[:json] = true`
## 5.14.0
* drop json dependency
## 5.13.1
* Permit actions as symbol
## 5.13.0
* Added option to ignore_no_element.
## 5.12.3
* Remove score fallback for enterprise
* Update enterprise tests to v1 assessment schema
## 5.12.2
* Fix minimum score for enterprise
## 5.12.1
* Fix Japanese locale
## 5.12.0
* Added Japanese locale
## 5.11.0
* Added Dutch locale
## 5.10.1
* Fix enterprise_verify_url #415
## 5.10.0
* Drop ruby 2.4 2.5 2.6
* Add maxiumm score support for hcaptcha
## 5.9.0
* Gracefully handle invalid params
## 5.8.1
* Allow configuring response limit
## 5.8.0
* Add support for the enterprise API
## 5.7.0
* french locale
* drop ruby 2.3
## 5.6.0
* Allow multiple invisible recaptchas on a single page by setting custom selector
## 5.5.0
* add `recaptcha_reply` controller method for better debugging/inspection
## 5.4.1
* fix v2 vs 'data' postfix
## 5.4.0
* added 'data' postfix to g-recaptcha-response attribute name to avoid collisions
## 5.3.0
* turbolinks support
## 5.2.0
* remove dependency on rails methods
## 5.1.0
* Added default translations for rails/i18n
* use recaptcha.net for the script tag
## 5.0.0
* Changed host to Recaptcha.net
* Add v3 API support
* Renamed `Recaptcha::ClientHelper` to `Recaptcha::Adapters::ViewMethods`
* Renamed `Recaptcha::Verify` to `Recaptcha::Adapters::ControllerMethods`
## 4.12.0 - 2018-08-30
* add `input` option to `invisible_recaptcha_tags`'s `ui` setting
## 4.11.1 - 2018-08-08
* leave `tabindex` attribute alone for `invisible_recaptcha_tags`
## 4.11.0 - 2018-08-06
* prefer RAILS_ENV over RACK_ENV #286
## 4.0.0 - 2016-11-14
* public_key -> site_key and private_key -> secret_key
## 3.4.0 - 2016-11-01
* Update fallback html
## 3.2.0 - 2016-06-13
* remove SKIP_VERIFY_ENV constant, use `skip_verify_env` instance variable instead
## 3.1.0 - 2016-06-10
* better error messages
* frozen constants
## 3.0.0 - 2016-05-27
* remove all non-ssl options
## 2.3.0 - 2016-05-25
* enable ssl verification by default ... disable via `disable_ssl_verification = true`
## 2.2.0 - 2016-05-23
* Add global hostname validator config
* Clean up after with_configuration exception
## 2.1.0 - 2016-05-19
* do not query google if repactcha was not submitted
## 2.0.0 - 2016-05-17
* remove stoken support, must use custom domain verification or domain whitelist
## 1.3.0 - 2016-04-07
* do not set model error and flash
## 1.2.0 - 2016-04-01
* custom domain validation
## 1.1.0 - 2016-01-27
* support RACK_ENV
## 1.0.2 - 2015-11-30
* nice deprecations for api_version
## 1.0.1 - 2015-11-30
* no longer defines `Rails` when `recaptcha/rails` is required
## 1.0.0 - 2015-11-30
* remove api v1 support
* remove ssl_api_server_url, nonssl_api_server_url, change api_server_url to always need ssl option
* removed activesupport dependency for .to_query
* made flash and models both have descriptive errors
## 0.6.0 - 2015-11-19
* extract token module
* need to use `gem "recaptcha", require: "recaptcha/rails"` to get rails helpers installed
## 0.5.0 - 2015-11-18
* size option
* support disabling stoken
* support Rails.env
## 0.4.0 / 2015-03-22
* Add support for ReCaptcha v2 API
* V2 API requires `g-recaptcha-response` parameters; https://github.com/ambethia/recaptcha/pull/114
## 0.3.6 / 2012-01-07
* Many documentation changes
* Fixed deprecations in dependencies
* Protocol relative JS includes
* Fixes for options hash
* Fixes for failing tests
## 0.3.5 / 2012-05-02
* I18n for error messages
* Rails: delete flash keys if unused
## 0.3.4 / 2011-12-13
* Rails 3
* Remove jeweler
## 0.2.2 / 2009-09-14
* Add a timeout to the validator
* Give the documentation some love
## 0.2.1 / 2009-09-14
* Removed Ambethia namespace, and restructured classes a bit
* Added an example rails app in the example-rails branch
## 0.2.0 / 2009-09-12
* RecaptchaOptions AJAX API Fix
* Added 'cucumber' as a test environment to skip
* Ruby 1.9 compat fixes
* Added option :message => 'Custom error message' to verify_recaptcha
* Removed dependency on ActiveRecord constant
* Add I18n
## 0.1.0 / 2008-2-8
* 1 major enhancement
* Initial Gem Release
ambethia-recaptcha-db974b3/Gemfile 0000664 0000000 0000000 00000000106 15165761772 0017145 0 ustar 00root root 0000000 0000000 # frozen_string_literal: true
source 'https://rubygems.org'
gemspec
ambethia-recaptcha-db974b3/Gemfile.lock 0000664 0000000 0000000 00000003304 15165761772 0020077 0 ustar 00root root 0000000 0000000 PATH
remote: .
specs:
recaptcha (5.21.2)
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
ast (2.4.2)
bigdecimal (3.1.8)
bump (0.10.0)
byebug (11.1.3)
coderay (1.1.3)
concurrent-ruby (1.3.4)
crack (1.0.0)
bigdecimal
rexml
hashdiff (1.1.2)
i18n (1.14.6)
concurrent-ruby (~> 1.0)
json (2.9.0)
language_server-protocol (3.17.0.3)
maxitest (5.8.0)
minitest (>= 5.14.0, < 5.26.0)
method_source (1.1.0)
minitest (5.25.4)
mocha (2.7.0)
ruby2_keywords (>= 0.0.5)
parallel (1.26.3)
parser (3.3.6.0)
ast (~> 2.4.1)
racc
pry (0.14.2)
coderay (~> 1.1)
method_source (~> 1.0)
pry-byebug (3.10.1)
byebug (~> 11.0)
pry (>= 0.13, < 0.15)
public_suffix (6.0.1)
racc (1.8.1)
rainbow (3.1.1)
rake (13.2.1)
regexp_parser (2.9.3)
rexml (3.3.9)
rubocop (1.69.1)
json (~> 2.3)
language_server-protocol (>= 3.17.0)
parallel (~> 1.10)
parser (>= 3.3.0.2)
rainbow (>= 2.2.2, < 4.0)
regexp_parser (>= 2.9.3, < 3.0)
rubocop-ast (>= 1.36.2, < 2.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 2.4.0, < 4.0)
rubocop-ast (1.36.2)
parser (>= 3.3.1.0)
ruby-progressbar (1.13.0)
ruby2_keywords (0.0.5)
unicode-display_width (3.1.2)
unicode-emoji (~> 4.0, >= 4.0.4)
unicode-emoji (4.0.4)
webmock (3.24.0)
addressable (>= 2.8.0)
crack (>= 0.3.2)
hashdiff (>= 0.4.0, < 2.0.0)
PLATFORMS
ruby
DEPENDENCIES
bump
i18n
maxitest
mocha
pry-byebug
rake
recaptcha!
rubocop
webmock
BUNDLED WITH
2.5.5
ambethia-recaptcha-db974b3/LICENSE 0000664 0000000 0000000 00000002040 15165761772 0016656 0 ustar 00root root 0000000 0000000 Copyright (c) 2007 Jason L Perry
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. ambethia-recaptcha-db974b3/README.md 0000664 0000000 0000000 00000074777 15165761772 0017162 0 ustar 00root root 0000000 0000000
# reCAPTCHA
[](https://badge.fury.io/rb/recaptcha)
Author: Jason L Perry (http://ambethia.com)
Copyright: Copyright (c) 2007-2013 Jason L Perry
License: [MIT](http://creativecommons.org/licenses/MIT/)
Info: https://github.com/ambethia/recaptcha
Bugs: https://github.com/ambethia/recaptcha/issues
This gem provides helper methods for the [reCAPTCHA API](https://www.google.com/recaptcha). In your
views you can use the `recaptcha_tags` method to embed the needed javascript, and you can validate
in your controllers with `verify_recaptcha` or `verify_recaptcha!`, which raises an error on
failure.
# Table of Contents
1. [Obtaining a key](#obtaining-a-key)
2. [Rails Installation](#rails-installation)
3. [Sinatra / Rack / Ruby Installation](#sinatra--rack--ruby-installation)
4. [reCAPTCHA V2 API & Usage](#recaptcha-v2-api-and-usage)
- [`recaptcha_tags`](#recaptcha_tags)
- [`verify_recaptcha`](#verify_recaptcha)
- [`invisible_recaptcha_tags`](#invisible_recaptcha_tags)
5. [reCAPTCHA V3 API & Usage](#recaptcha-v3-api-and-usage)
- [`recaptcha_v3`](#recaptcha_v3)
- [`verify_recaptcha` (use with v3)](#verify_recaptcha-use-with-v3)
- [`recaptcha_reply`](#recaptcha_reply)
6. [I18n Support](#i18n-support)
7. [Testing](#testing)
8. [Alternative API Key Setup](#alternative-api-key-setup)
## Obtaining a key
Go to the [reCAPTCHA admin console](https://www.google.com/recaptcha/admin) to obtain a reCAPTCHA API key.
The reCAPTCHA type(s) that you choose for your key will determine which methods to use below.
| reCAPTCHA type | Methods to use | Description |
|----------------------------------------------|----------------|-------------|
| v3 | [`recaptcha_v3`](#recaptcha_v3) | Verify requests with a [score](https://developers.google.com/recaptcha/docs/v3#score)
| v2 Checkbox ("I'm not a robot" Checkbox) | [`recaptcha_tags`](#recaptcha_tags) | Validate requests with the "I'm not a robot" checkbox |
| v2 Invisible (Invisible reCAPTCHA badge) | [`invisible_recaptcha_tags`](#invisible_recaptcha_tags) | Validate requests in the background |
Note: You can _only_ use methods that match your key's type. You cannot use v2 methods with a v3
key or use `recaptcha_tags` with a v2 Invisible key, for example. Otherwise you will get an
error like "Invalid key type" or "This site key is not enabled for the invisible captcha."
Note: Enter `localhost` or `127.0.0.1` as the domain if using in development with `localhost:3000`.
## Rails Installation
**If you are having issues with Rails 7, Turbo, and Stimulus, make sure to check [this Wiki page](https://github.com/ambethia/recaptcha/wiki/Recaptcha-with-Turbo-and-Stimulus)!**
```ruby
gem "recaptcha"
```
You can keep keys out of the code base with environment variables or with Rails [secrets](https://api.rubyonrails.org/classes/Rails/Application.html#method-i-secrets).
In development, you can use the [dotenv](https://github.com/bkeepers/dotenv) gem. (Make sure to add it above `gem 'recaptcha'`.)
See [Alternative API key setup](#alternative-api-key-setup) for more ways to configure or override
keys. See also the
[Configuration](https://www.rubydoc.info/github/ambethia/recaptcha/master/Recaptcha/Configuration)
documentation.
```shell
export RECAPTCHA_SITE_KEY = '6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy'
export RECAPTCHA_SECRET_KEY = '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
```
If you have an Enterprise API key:
```shell
export RECAPTCHA_ENTERPRISE = 'true'
export RECAPTCHA_ENTERPRISE_API_KEY = 'AIzvFyE3TU-g4K_Kozr9F1smEzZSGBVOfLKyupA'
export RECAPTCHA_ENTERPRISE_PROJECT_ID = 'my-project'
```
_note:_ you'll still have to provide `RECAPTCHA_SITE_KEY`, which will hold the value of your enterprise recaptcha key id. You will not need to provide a `RECAPTCHA_SECRET_KEY`, however.
`RECAPTCHA_ENTERPRISE_API_KEY` is the enterprise key of your Google Cloud Project, which you can generate here: https://console.cloud.google.com/apis/credentials.
Add `recaptcha_tags` to the forms you want to protect:
```erb
<%= form_for @foo do |f| %>
# …
<%= recaptcha_tags %>
# …
<% end %>
```
Then, add `verify_recaptcha` logic to each form action that you've protected:
```ruby
# 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
```
Please note that this setup uses [`reCAPTCHA_v2`](#recaptcha-v2-api-and-usage). For a `recaptcha_v3` use, please refer to [`reCAPTCHA_v3 setup`](#examples).
## Sinatra / Rack / Ruby installation
See [sinatra demo](/demo/sinatra) for details.
- add `gem 'recaptcha'` to `Gemfile`
- set env variables
- `include Recaptcha::Adapters::ViewMethods` where you need `recaptcha_tags`
- `include Recaptcha::Adapters::ControllerMethods` where you need `verify_recaptcha`
## reCAPTCHA v2 API and Usage
### `recaptcha_tags`
Use this when your key's reCAPTCHA type is "v2 Checkbox".
The following options are available:
| Option | Description |
|---------------------|-------------|
| `:theme` | Specify the theme to be used per the API. Available options: `dark` and `light`. (default: `light`) |
| `:ajax` | Render the dynamic AJAX captcha per the API. (default: `false`) |
| `:site_key` | Override site API key from configuration |
| `:error` | Override the error code returned from the reCAPTCHA API (default: `nil`) |
| `:size` | Specify a size (default: `nil`) |
| `:nonce` | Optional. Sets nonce attribute for script. Can be generated via `SecureRandom.base64(32)`. Use `content_security_policy_nonce` if you have `config.content_security_policy_nonce_generator` set in Rails. (default: `nil`) |
| `:id` | Specify an html id attribute (default: `nil`) |
| `:callback` | Optional. Name of success callback function, executed when the user submits a successful response |
| `:expired_callback` | Optional. Name of expiration callback function, executed when the reCAPTCHA response expires and the user needs to re-verify. |
| `:error_callback` | Optional. Name of error callback function, executed when reCAPTCHA encounters an error (e.g. network connectivity) |
| `:noscript` | Include `
HTML
end
html.respond_to?(:html_safe) ? html.html_safe : html
end
def self.invisible_recaptcha_tags(custom)
options = {callback: 'invisibleRecaptchaSubmit', ui: :button}.merge(custom)
text = options.delete(:text)
html, tag_attributes = components(options.dup)
html << default_callback(options) if default_callback_required?(options)
case options[:ui]
when :button
html << %(\n)
when :invisible
html << %(\n)
when :input
html << %(\n)
else
raise(RecaptchaError, "ReCAPTCHA ui `#{options[:ui]}` is not valid.")
end
html.respond_to?(:html_safe) ? html.html_safe : html
end
def self.to_error_message(key)
default = DEFAULT_ERRORS.fetch(key) { raise ArgumentError "Unknown reCAPTCHA error - #{key}" }
to_message("recaptcha.errors.#{key}", default)
end
if defined?(I18n)
def self.to_message(key, default)
I18n.translate(key, default: default)
end
else
def self.to_message(_key, default)
default
end
end
private_class_method def self.components(options)
html = +''
attributes = {}
fallback_uri = +''
options = options.dup
env = options.delete(:env)
class_attribute = options.delete(:class)
site_key = options.delete(:site_key)
hl = options.delete(:hl)
onload = options.delete(:onload)
render = options.delete(:render)
script_async = options.delete(:script_async)
script_defer = options.delete(:script_defer)
nonce = options.delete(:nonce)
skip_script = (options.delete(:script) == false) || (options.delete(:external_script) == false)
ui = options.delete(:ui)
options.delete(:ignore_no_element)
options.delete(:inline_script)
data_attribute_keys = [:badge, :theme, :type, :callback, :expired_callback, :error_callback, :size]
data_attribute_keys << :tabindex unless ui == :button
data_attributes = {}
data_attribute_keys.each do |data_attribute|
value = options.delete(data_attribute)
data_attributes["data-#{data_attribute.to_s.tr('_', '-')}"] = value if value
end
unless Recaptcha.skip_env?(env)
site_key ||= Recaptcha.configuration.site_key!
script_url = Recaptcha.configuration.api_server_url
query_params = hash_to_query(
hl: hl,
onload: onload,
render: render
)
script_url += "?#{query_params}" unless query_params.empty?
async_attr = "async" if script_async != false
defer_attr = "defer" if script_defer != false
nonce_attr = " nonce='#{nonce}'" if nonce
html << %(\n) unless skip_script
fallback_uri = %(#{script_url.chomp(".js")}/fallback?k=#{site_key})
attributes["data-sitekey"] = site_key
attributes.merge! data_attributes
end
# The remaining options will be added as attributes on the tag.
attributes["class"] = "g-recaptcha #{class_attribute}"
tag_attributes = attributes.merge(options).map { |k, v| %(#{k}="#{v}") }.join(" ")
[html, tag_attributes, fallback_uri]
end
# v3
# Renders a script that calls `grecaptcha.execute` or
# `grecaptcha.enterprise.execute` for the given `site_key` and `action` and
# calls the `callback` with the resulting response token.
private_class_method def self.recaptcha_v3_inline_script(site_key, action, callback, id, options = {})
nonce = options[:nonce]
nonce_attr = " nonce='#{nonce}'" if nonce
<<-HTML
// Define function so that we can call it again later if we need to reset it
// This executes reCAPTCHA and then calls our callback.
function #{recaptcha_v3_execute_function_name(action)}() {
#{recaptcha_ready_method_name}(function() {
#{recaptcha_execute_method_name}('#{site_key}', {action: '#{action}'}).then(function(token) {
#{callback}('#{id}', token)
});
});
};
// Invoke immediately
#{recaptcha_v3_execute_function_name(action)}()
// Async variant so you can await this function from another async function (no need for
// an explicit callback function then!)
// Returns a Promise that resolves with the response token.
async function #{recaptcha_v3_async_execute_function_name(action)}() {
return new Promise((resolve, reject) => {
#{recaptcha_ready_method_name}(async function() {
resolve(await #{recaptcha_execute_method_name}('#{site_key}', {action: '#{action}'}))
});
})
};
#{recaptcha_v3_define_default_callback(callback, options) if recaptcha_v3_define_default_callback?(callback, action, options)}
HTML
end
private_class_method def self.recaptcha_v3_onload_script(site_key, action, callback, id, options = {})
nonce = options[:nonce]
nonce_attr = " nonce='#{nonce}'" if nonce
<<-HTML
function #{recaptcha_v3_execute_function_name(action)}() {
#{recaptcha_ready_method_name}(function() {
#{recaptcha_execute_method_name}('#{site_key}', {action: '#{action}'}).then(function(token) {
#{callback}('#{id}', token)
});
});
};
#{recaptcha_v3_define_default_callback(callback, options) if recaptcha_v3_define_default_callback?(callback, action, options)}
HTML
end
private_class_method def self.recaptcha_v3_inline_script?(options)
!Recaptcha.skip_env?(options[:env]) &&
options[:script] != false &&
options[:inline_script] != false
end
private_class_method def self.recaptcha_v3_define_default_callback(callback, options)
<<-HTML
var #{callback} = function(id, token) {
var element = document.getElementById(id);
#{element_check_condition(options)} element.value = token;
}
HTML
end
# Returns true if we should be adding the default callback.
# That is, if the given callback name is the default callback name (for the given action) and we
# are not skipping inline scripts for any reason.
private_class_method def self.recaptcha_v3_define_default_callback?(callback, action, options)
callback == recaptcha_v3_default_callback_name(action) &&
recaptcha_v3_inline_script?(options)
end
# Returns the name of the JavaScript function that actually executes the
# reCAPTCHA code (calls `grecaptcha.execute` or
# `grecaptcha.enterprise.execute`). You can call it again later to reset it.
def self.recaptcha_v3_execute_function_name(action)
"executeRecaptchaFor#{sanitize_action_for_js(action)}"
end
# Returns the name of an async JavaScript function that executes the reCAPTCHA code.
def self.recaptcha_v3_async_execute_function_name(action)
"#{recaptcha_v3_execute_function_name(action)}Async"
end
def self.recaptcha_v3_default_callback_name(action)
"setInputWithRecaptchaResponseTokenFor#{sanitize_action_for_js(action)}"
end
# v2
private_class_method def self.default_callback(options = {})
nonce = options[:nonce]
nonce_attr = " nonce='#{nonce}'" if nonce
selector_attr = options[:id] ? "##{options[:id]}" : ".g-recaptcha"
<<-HTML
var invisibleRecaptchaSubmit = function () {
var closestForm = function (ele) {
var curEle = ele.parentNode;
while (curEle.nodeName !== 'FORM' && curEle.nodeName !== 'BODY'){
curEle = curEle.parentNode;
}
return curEle.nodeName === 'FORM' ? curEle : null
};
var el = document.querySelector("#{selector_attr}")
if (!!el) {
var form = closestForm(el);
if (form) {
form.submit();
}
}
};
HTML
end
def self.recaptcha_execute_method_name
Recaptcha.configuration.enterprise ? "grecaptcha.enterprise.execute" : "grecaptcha.execute"
end
def self.recaptcha_ready_method_name
Recaptcha.configuration.enterprise ? "grecaptcha.enterprise.ready" : "grecaptcha.ready"
end
private_class_method def self.default_callback_required?(options)
options[:callback] == 'invisibleRecaptchaSubmit' &&
!Recaptcha.skip_env?(options[:env]) &&
options[:script] != false &&
options[:inline_script] != false
end
# Returns a camelized string that is safe for use in a JavaScript variable/function name.
# sanitize_action_for_js('my/action') => 'MyAction'
private_class_method def self.sanitize_action_for_js(action)
action.to_s.gsub(/\W/, '_').split(/\/|_/).map(&:capitalize).join
end
# Returns a dasherized string that is safe for use as an HTML ID
# dasherize_action('my/action') => 'my-action'
private_class_method def self.dasherize_action(action)
action.to_s.gsub(/\W/, '-').tr('_', '-')
end
private_class_method def self.hash_to_query(hash)
hash.delete_if { |_, val| val.nil? || val.empty? }.to_a.map { |pair| pair.join('=') }.join('&')
end
private_class_method def self.element_check_condition(options)
options[:ignore_no_element] ? "if (element !== null)" : ""
end
end
end
ambethia-recaptcha-db974b3/lib/recaptcha/rails.rb 0000664 0000000 0000000 00000000140 15165761772 0022007 0 ustar 00root root 0000000 0000000 # frozen_string_literal: true
# deprecated, but let's not blow everyone up
require 'recaptcha'
ambethia-recaptcha-db974b3/lib/recaptcha/railtie.rb 0000664 0000000 0000000 00000001464 15165761772 0022340 0 ustar 00root root 0000000 0000000 # frozen_string_literal: true
module Recaptcha
class Railtie < Rails::Railtie
ActiveSupport.on_load(:action_view) do
include Recaptcha::Adapters::ViewMethods
end
ActiveSupport.on_load(:action_controller) do
include Recaptcha::Adapters::ControllerMethods
end
initializer 'recaptcha' do |app|
Recaptcha::Railtie.instance_eval do
pattern = pattern_from app.config.i18n.available_locales
add("rails/locales/#{pattern}.yml")
end
end
class << self
protected
def add(pattern)
files = Dir[File.join(File.dirname(__FILE__), '../..', pattern)]
I18n.load_path.concat(files)
end
def pattern_from(args)
array = Array(args || [])
array.blank? ? '*' : "{#{array.join ','}}"
end
end
end
end
ambethia-recaptcha-db974b3/lib/recaptcha/reply.rb 0000664 0000000 0000000 00000004354 15165761772 0022043 0 ustar 00root root 0000000 0000000 # frozen_string_literal: true
module Recaptcha
class Reply
def initialize(raw_reply, enterprise:)
@raw_reply = raw_reply
@enterprise = enterprise
end
def [](key)
@raw_reply[key.to_s]
end
def success?(options = {})
success.to_s == 'true' &&
hostname_valid?(options[:hostname]) &&
action_valid?(options[:action]) &&
score_above_threshold?(options[:minimum_score]) &&
score_below_threshold?(options[:maximum_score])
end
def token_properties
@raw_reply['tokenProperties'] if enterprise?
end
def success
if enterprise?
token_properties&.dig('valid')
else
@raw_reply['success']
end
end
def hostname
if enterprise?
token_properties&.dig('hostname')
else
@raw_reply['hostname']
end
end
def action
if enterprise?
token_properties&.dig('action')
else
@raw_reply['action']
end
end
def score
if enterprise?
@raw_reply.dig('riskAnalysis', 'score')
else
@raw_reply['score'] unless enterprise?
end
end
def error_codes
if enterprise?
[]
else
@raw_reply['error-codes'] || []
end
end
def challenge_ts
return @raw_reply['challenge_ts'] unless enterprise?
token_properties&.dig('createTime')
end
def hostname_valid?(validation)
validation ||= Recaptcha.configuration.hostname
case validation
when nil, FalseClass
true
when String
validation == hostname
else
validation.call(hostname)
end
end
def action_valid?(expected_action)
case expected_action
when nil, FalseClass
true
else
action == expected_action.to_s
end
end
def score_above_threshold?(minimum_score)
!minimum_score || (score && score >= minimum_score)
end
def score_below_threshold?(maximum_score)
!maximum_score || (score && score <= maximum_score)
end
def enterprise?
@enterprise
end
def to_h
@raw_reply
end
def to_s
@raw_reply.to_s
end
def to_json(*args)
@raw_reply.to_json(*args)
end
end
end
ambethia-recaptcha-db974b3/lib/recaptcha/version.rb 0000664 0000000 0000000 00000000111 15165761772 0022360 0 ustar 00root root 0000000 0000000 # frozen_string_literal: true
module Recaptcha
VERSION = '5.21.2'
end
ambethia-recaptcha-db974b3/rails/ 0000775 0000000 0000000 00000000000 15165761772 0016767 5 ustar 00root root 0000000 0000000 ambethia-recaptcha-db974b3/rails/locales/ 0000775 0000000 0000000 00000000000 15165761772 0020411 5 ustar 00root root 0000000 0000000 ambethia-recaptcha-db974b3/rails/locales/de.yml 0000664 0000000 0000000 00000000376 15165761772 0021532 0 ustar 00root root 0000000 0000000 de:
recaptcha:
errors:
verification_failed: Die reCAPTCHA-Überprüfung ist fehlgeschlagen, bitte versuchen Sie es erneut.
recaptcha_unreachable: Oops, wir konnten Ihre reCAPTCHA-Antwort nicht validieren. Bitte versuchen Sie es erneut.
ambethia-recaptcha-db974b3/rails/locales/en.yml 0000664 0000000 0000000 00000000315 15165761772 0021535 0 ustar 00root root 0000000 0000000 en:
recaptcha:
errors:
verification_failed: reCAPTCHA verification failed, please try again.
recaptcha_unreachable: Oops, we failed to validate your reCAPTCHA response. Please try again.
ambethia-recaptcha-db974b3/rails/locales/es.yml 0000664 0000000 0000000 00000000346 15165761772 0021546 0 ustar 00root root 0000000 0000000 es:
recaptcha:
errors:
verification_failed: La verificación de reCAPTCHA falló, por favor intente de nuevo.
recaptcha_unreachable: Ups, no pudimos validar su respuesta de reCAPTCHA. Por favor intente de nuevo.
ambethia-recaptcha-db974b3/rails/locales/fr.yml 0000664 0000000 0000000 00000000362 15165761772 0021544 0 ustar 00root root 0000000 0000000 fr:
recaptcha:
errors:
verification_failed: La vérification reCAPTCHA a échoué, veuillez essayer à nouveau.
recaptcha_unreachable: Oops, nous n'avons pas pu valider votre réponse reCAPTCHA. Veuillez essayer à nouveau.
ambethia-recaptcha-db974b3/rails/locales/it.yml 0000664 0000000 0000000 00000000350 15165761772 0021546 0 ustar 00root root 0000000 0000000 it:
recaptcha:
errors:
verification_failed: La verifica reCAPTCHA non è riuscita, si prega di riprovare.
recaptcha_unreachable: Ops, non siamo riusciti a convalidare la tua risposta reCAPTCHA. Per favore riprova.
ambethia-recaptcha-db974b3/rails/locales/ja.yml 0000664 0000000 0000000 00000000405 15165761772 0021525 0 ustar 00root root 0000000 0000000 ja:
recaptcha:
errors:
verification_failed: reCAPTCHA認証に失敗しました。もう一度お試しください。
recaptcha_unreachable: reCAPTCHAのレスポンスを検証できませんでした。もう一度お試しください。
ambethia-recaptcha-db974b3/rails/locales/nl.yml 0000664 0000000 0000000 00000000333 15165761772 0021544 0 ustar 00root root 0000000 0000000 nl:
recaptcha:
errors:
verification_failed: reCAPTCHA-verificatie mislukt, probeer het opnieuw.
recaptcha_unreachable: Oeps, we hebben uw reCAPTCHA-antwoord niet kunnen valideren. Probeer het opnieuw.
ambethia-recaptcha-db974b3/rails/locales/pt-BR.yml 0000664 0000000 0000000 00000000357 15165761772 0022065 0 ustar 00root root 0000000 0000000 pt-BR:
recaptcha:
errors:
verification_failed: A verificação do reCAPTCHA falhou, por favor, tente novamente.
recaptcha_unreachable: Oops, não conseguimos validar sua resposta do reCAPTCHA. Por favor, tente novamente.
ambethia-recaptcha-db974b3/rails/locales/pt.yml 0000664 0000000 0000000 00000000354 15165761772 0021561 0 ustar 00root root 0000000 0000000 pt:
recaptcha:
errors:
verification_failed: A verificação do reCAPTCHA falhou, por favor, tente novamente.
recaptcha_unreachable: Oops, não conseguimos validar sua resposta do reCAPTCHA. Por favor, tente novamente.
ambethia-recaptcha-db974b3/recaptcha.gemspec 0000664 0000000 0000000 00000001647 15165761772 0021164 0 ustar 00root root 0000000 0000000 require "./lib/recaptcha/version"
Gem::Specification.new do |s|
s.name = "recaptcha"
s.version = Recaptcha::VERSION
s.authors = ["Jason L Perry"]
s.email = ["jasper@ambethia.com"]
s.homepage = "http://github.com/ambethia/recaptcha"
s.summary = s.description = "Helpers for the reCAPTCHA API"
s.license = "MIT"
s.required_ruby_version = '>= 3.0.0'
s.files = `git ls-files lib rails README.md CHANGELOG.md LICENSE`.split("\n")
s.add_development_dependency "mocha"
s.add_development_dependency "rake"
s.add_development_dependency "i18n"
s.add_development_dependency "maxitest"
s.add_development_dependency "pry-byebug"
s.add_development_dependency "bump"
s.add_development_dependency "webmock"
s.add_development_dependency "rubocop"
s.metadata = {
"source_code_uri" => "https://github.com/ambethia/recaptcha",
"rubygems_mfa_required" => "true"
}
end
ambethia-recaptcha-db974b3/test/ 0000775 0000000 0000000 00000000000 15165761772 0016634 5 ustar 00root root 0000000 0000000 ambethia-recaptcha-db974b3/test/client_helper_test.rb 0000664 0000000 0000000 00000021471 15165761772 0023042 0 ustar 00root root 0000000 0000000 require_relative 'helper'
describe 'View helpers' do
include Recaptcha::Adapters::ViewMethods
it "uses ssl" do
recaptcha_tags.must_include "\"#{Recaptcha.configuration.api_server_url}\""
end
describe "noscript" do
it "does not add noscript tags when noscript is given" do
recaptcha_tags(noscript: false).wont_include "noscript"
end
it "does not add noscript tags" do
recaptcha_tags.must_include "noscript"
end
end
it "can include size" do
html = recaptcha_tags(size: 10)
html.must_include("data-size=\"10\"")
end
it "raises without site key" do
Recaptcha.configuration.site_key = nil
assert_raises Recaptcha::RecaptchaError do
recaptcha_tags
end
end
it "includes id as div attribute" do
html = recaptcha_tags(id: 'my_id')
html.must_include(" id=\"my_id\"")
end
it "translates tabindex attribute to data- attribute for recaptcha_tags" do
html = recaptcha_tags(tabindex: 123)
html.must_include(" data-tabindex=\"123\"")
end
it "leaves tabindex attribute as-is for invisible_recaptcha_tags" do
html = invisible_recaptcha_tags(tabindex: 123)
html.must_include(" tabindex=\"123\"")
end
it "includes nonce attribute" do
html = recaptcha_tags(nonce: 'P9Y0b6dLSkApYRdOULGW57XHcYNJJKeLwxA2az/Ka9s=')
html.must_include(" nonce='P9Y0b6dLSkApYRdOULGW57XHcYNJJKeLwxA2az/Ka9s='")
end
it "does not include