recaptcha 5.0.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b146b489348963aec2bc4576903ff9d4f130fb65b7fe268558d4ce1430be0078
-  data.tar.gz: 63c8a898a6e1e207e3988105a8916954e959fb77dc762d77c03ebd6c76bd95f1
+  metadata.gz: adcc7a846c1b2cbac386af0946cd3c810803860f85ca363e5453582354c618b0
+  data.tar.gz: b1ac10dd569bc7220b81505c9c6565d3db900a3c737ed1c184dcd1c96a12c963
 SHA512:
-  metadata.gz: 3850b9716c496b63d25485ce9cf422a5610aeb5f348acbe6fd5bb0e20cd4834290890f6f8aa6927fe997085b19371f9414a57954176c2244f84e855d6f7ec9d0
-  data.tar.gz: 492f92ab871182c685f4fa098cea1bdc616ae377b2df376c7e24e3ae65739c02871d7dd7fe95ba89d5ded14445cd480904cd180437482d67d6d98cffbc2f224c
+  metadata.gz: 8f9f6271ee715f1fbe543ed1b27cc8088678f5da8326718ad60587128e550fbb9073558fa147a4b608469da82af4cfd86ee255c39a7f69e0bd6b1d590ac109d8
+  data.tar.gz: 94fbd105e5b6f1cf23fd23cb5dac6040d9e642d5110beae4b9982c6a232f24323ed9ab145b3aa9ef7f6d5786537a20ea03dfacde5638c5f82d5921999c398bd7

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Next
 
+## 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

data/README.md

@@ -270,7 +270,8 @@ For more information, refer to the [v3 documentation](https://developers.google.
 ### Examples
 
 With v3, you can let all users log in without any intervention at all if their score is above some
-threshold, and only show a v2 checkbox recaptcha challenge if it is below the threshold:
+threshold, and only show a v2 checkbox recaptcha challenge (fall back to v2) if it is below the
+threshold:
 
 ```erb
   …
@@ -286,7 +287,7 @@ threshold, and only show a v2 checkbox recaptcha challenge if it is below the th
 # app/controllers/sessions_controller.rb
 def create
   success = verify_recaptcha(action: 'login', minimum_score: 0.5)
-  checkbox_success = verify_recaptcha_tags unless success
+  checkbox_success = verify_recaptcha unless success
   if success || checkbox_success
     # Perform action
   else
@@ -298,6 +299,8 @@ def create
 end
 ```
 
+(You can also find this [example](demo/rails/app/controllers/v3_captchas_controller.rb) in the demo app.)
+
 Another example:
 
 ```erb
@@ -332,7 +335,7 @@ end
 
 Adds an inline script tag that calls `grecaptcha.execute` for the given `site_key` and `action` and
 calls the `callback` with the resulting response token. You need to verify this token with
-[`verify_recaptcha`](#verify_recaptcha_use_with_v3) in your controller in order to get the
+[`verify_recaptcha`](#verify_recaptcha-use-with-v3) in your controller in order to get the
 [score](https://developers.google.com/recaptcha/docs/v3#score).
 
 By default, this inserts a hidden `<input type="hidden" class="g-recaptcha-response">` tag. The
@@ -390,6 +393,7 @@ but only accepts the following options:
 | `:script`           | Same as setting both `:inline_script` and `:external_script`. (default: `true`). |
 | `:inline_script`    | If `true`, adds an inline script tag that calls `grecaptcha.execute` for the given `site_key` and `action` and calls the `callback` with the resulting response token. Pass `false` if you want to handle calling `grecaptcha.execute` yourself. (default: `true`) |
 | `:element`          | The element to render, if any (default: `:input`)<br/>`:input`: Renders a hidden `<input type="hidden">` tag. The value of this will be set to the response token by the default `setInputWithRecaptchaResponseTokenFor{action}` callback.<br/>`false`: Doesn't render any tag. You'll have to add a custom callback that does something with the token. |
+| `:turbolinks`          | If `true`, calls the js function which executes reCAPTCHA after all the dependencies have been loaded. This cannot be used with the js param `:onload`. This makes reCAPTCHAv3 usable with turbolinks. |
 
 [JavaScript resource (api.js) parameters](https://developers.google.com/recaptcha/docs/invisible#js_param):
 
@@ -437,20 +441,17 @@ It is recommended to pass `external_script: false` on all but one of the calls t
 `recaptcha` since you only need to include the script tag once for a given `site_key`.
 
 ## I18n support
-reCAPTCHA passes two types of error explanation to a linked model. It will use the I18n gem
-to translate the default error message if I18n is available. To customize the messages to your locale,
-add these keys to your I18n backend:
-
-`recaptcha.errors.verification_failed` error message displayed if the captcha words didn't match
-`recaptcha.errors.recaptcha_unreachable` displayed if a timeout error occured while attempting to verify the captcha
 
-Also you can translate API response errors to human friendly by adding translations to the locale (`config/locales/en.yml`):
+reCAPTCHA supports the I18n gem (it comes with English translations)
+To override or add new languages, add to `config/locales/*.yml`
 
 ```yaml
+# config/locales/en.yml
 en:
   recaptcha:
     errors:
-      verification_failed: 'Fail'
+      verification_failed: 'reCAPTCHA was incorrect, please try again.'
+      recaptcha_unreachable: 'reCAPTCHA verification server error, please try again.'
 ```
 
 ## Testing
@@ -501,4 +502,3 @@ verify_recaptcha secret_key: '6Lc6BAAAAAAAAKN3DRm6VA_xxxxxxxxxxxxxxxxx'
  - Check out the [wiki](https://github.com/ambethia/recaptcha/wiki) and leave whatever you found valuable there.
  - [Add multiple widgets to the same page](https://github.com/ambethia/recaptcha/wiki/Add-multiple-widgets-to-the-same-page)
  - [Use Recaptcha with Devise](https://github.com/plataformatec/devise/wiki/How-To:-Use-Recaptcha-with-Devise)
-

data/lib/recaptcha.rb

@@ -99,7 +99,8 @@ module Recaptcha
     end
   end
 
-  def self.api_verification(verify_hash, timeout: DEFAULT_TIMEOUT)
+  def self.api_verification(verify_hash, timeout: nil)
+    timeout ||= DEFAULT_TIMEOUT
     http = if configuration.proxy
       proxy_server = URI.parse(configuration.proxy)
       Net::HTTP::Proxy(proxy_server.host, proxy_server.port, proxy_server.user, proxy_server.password)

data/lib/recaptcha/helpers.rb

@@ -10,8 +10,9 @@ module Recaptcha
     def self.recaptcha_v3(options = {})
       site_key = options[:site_key] ||= Recaptcha.configuration.site_key!
       action = options.delete(:action) || raise(Recaptcha::RecaptchaError, 'action is required')
-      id   = options.delete(:id)   || "g-recaptcha-response-" + dasherize_action(action)
+      id = options.delete(:id) || "g-recaptcha-response-" + dasherize_action(action)
       name = options.delete(:name) || "g-recaptcha-response[#{action}]"
+      turbolinks = options.delete(:turbolinks)
       options[:render] = site_key
       options[:script_async] ||= false
       options[:script_defer] ||= false
@@ -22,8 +23,13 @@ module Recaptcha
       end
       options[:class] = "g-recaptcha-response #{options[:class]}"
 
+      if turbolinks
+        options[:onload] = recaptcha_v3_execute_function_name(action)
+      end
       html, tag_attributes = components(options)
-      if recaptcha_v3_inline_script?(options)
+      if turbolinks
+        html << recaptcha_v3_onload_script(site_key, action, callback, id, options)
+      elsif recaptcha_v3_inline_script?(options)
         html << recaptcha_v3_inline_script(site_key, action, callback, id, options)
       end
       case element
@@ -177,10 +183,10 @@ module Recaptcha
       <<-HTML
         <script#{nonce_attr}>
           // 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)}() {
             grecaptcha.ready(function() {
               grecaptcha.execute('#{site_key}', {action: '#{action}'}).then(function(token) {
-                //console.log('#{id}', token)
                 #{callback}('#{id}', token)
               });
             });
@@ -190,6 +196,7 @@ module Recaptcha
 
           // 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) => {
               grecaptcha.ready(async function() {
@@ -203,6 +210,24 @@ module Recaptcha
       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
+        <script#{nonce_attr}>
+          function #{recaptcha_v3_execute_function_name(action)}() {
+            grecaptcha.ready(function() {
+              grecaptcha.execute('#{site_key}', {action: '#{action}'}).then(function(token) {
+                #{callback}('#{id}', token)
+              });
+            });
+          };
+          #{recaptcha_v3_define_default_callback(callback) if recaptcha_v3_define_default_callback?(callback, action, options)}
+        </script>
+      HTML
+    end
+
     private_class_method def self.recaptcha_v3_inline_script?(options)
       !Recaptcha.skip_env?(options[:env]) &&
       options[:script] != false &&
@@ -215,7 +240,6 @@ module Recaptcha
             var element = document.getElementById(id);
             element.value = token;
           }
-        </script>
       HTML
     end
 
@@ -281,13 +305,13 @@ module Recaptcha
     # 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/, '_').camelize
+      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/, '-').dasherize
+      action.to_s.gsub(/\W/, '-').tr('_', '-')
     end
 
     private_class_method def self.hash_to_query(hash)

data/lib/recaptcha/railtie.rb

@@ -9,5 +9,27 @@ module Recaptcha
     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

data/lib/recaptcha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Recaptcha
-  VERSION = '5.0.0'
+  VERSION = '5.3.0'
 end

data/rails/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  recaptcha:
+    errors:
+      verification_failed: reCAPTCHA verification failed, please try again.
+      recaptcha_unreachable: Oops, we failed to validate your reCAPTCHA response. Please try again.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recaptcha
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Jason L Perry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -154,6 +154,7 @@ files:
 - lib/recaptcha/rails.rb
 - lib/recaptcha/railtie.rb
 - lib/recaptcha/version.rb
+- rails/locales/en.yml
 homepage: http://github.com/ambethia/recaptcha
 licenses:
 - MIT