recaptcha 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b146b489348963aec2bc4576903ff9d4f130fb65b7fe268558d4ce1430be0078
-  data.tar.gz: 63c8a898a6e1e207e3988105a8916954e959fb77dc762d77c03ebd6c76bd95f1
+  metadata.gz: 424f86ca2326f83ccc3a2210b5c23a3341a16109a8297aa11dafc4aca051c21e
+  data.tar.gz: 2d6d8dbc65ba54bc3289e15d2f7635c90b521f2d3e3c04d04a673c3f65a14547
 SHA512:
-  metadata.gz: 3850b9716c496b63d25485ce9cf422a5610aeb5f348acbe6fd5bb0e20cd4834290890f6f8aa6927fe997085b19371f9414a57954176c2244f84e855d6f7ec9d0
-  data.tar.gz: 492f92ab871182c685f4fa098cea1bdc616ae377b2df376c7e24e3ae65739c02871d7dd7fe95ba89d5ded14445cd480904cd180437482d67d6d98cffbc2f224c
+  metadata.gz: fb30c399fb7b38fa0e0f3a8f59b146cdc7da3632f9e1d1a2716db5c1939c288e7993902f1c8f4c9a2ad41c4e8284c508d2e6b253da4a77366cd119a545f5b92f
+  data.tar.gz: 553c4b1672b8c60d42d0774397d4ade4dc5e33cb574bb8b113ffa4573a0e08af38e3bcee5808e7f326f8179496e18c9e6facc828f46b7e242ec8fd16435cfa5c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Next
 
+## 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
@@ -437,20 +440,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

data/lib/recaptcha/helpers.rb

@@ -177,6 +177,7 @@ 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) {
@@ -190,6 +191,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() {

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.1.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.1.0
 platform: ruby
 authors:
 - Jason L Perry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2019-08-06 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