new_google_recaptcha 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa810b760940cf717035ca4440a7fdc6fa770cde651ff6b987c0e10d0a471718
-  data.tar.gz: 41af27ec27a704388b0bc6e946fbf3ee595a261df8b90355720a9f6cb9742131
+  metadata.gz: a187e51b64407ccc6cae4186568b1f0deac59c601e6b095424dcb5aad7243edd
+  data.tar.gz: 5660c73c953982985bd3b926071e38040e64615cf9bfed9342cb71d2eed05ddf
 SHA512:
-  metadata.gz: d378417f2010faed2b3bea508a54d17ddf66ca38766ba5d8c9ec3224a04742000c56a2121a1ec07217c86bfa59f2e36a7d84b680617cac2bb700093c0da39930
-  data.tar.gz: 9a3dad7d9fb2236905e94a970e499935b52f2d9281e56a9612c3439ccc229aa545afc43fb8a3c0992de4c7faa0551a0047b89064be9fd9dfd8b1ee74f937bd73
+  metadata.gz: f4032d4cfa438d70622a2f7b49f4af670b52f6e67fe81638cbb50396fdf240fa356fc23a3417d8b57ba78d2e2fef294f59bcd62037352fcda7d801066837d712
+  data.tar.gz: bd804e4ace434e6dab65d07eef3988c9d6880671a69ee04d8fe081c964ca6b4b94818506165af14aa9a09ded729f0806e77ff0cd637cf36401f4268f4169971d

data/README.md

@@ -1,6 +1,10 @@
 # Google Recaptcha v3 + Rails
 
-Integrate Google Recaptcha v3 with Rails app. 
+[![Build Status](https://travis-ci.org/igorkasyanchuk/new_google_recaptcha.svg?branch=master)](https://travis-ci.org/igorkasyanchuk/new_google_recaptcha)
+[![RailsJazz](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/my_other.svg?raw=true)](https://www.railsjazz.com)
+[![https://www.patreon.com/igorkasyanchuk](https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/patron.svg?raw=true)](https://www.patreon.com/igorkasyanchuk)
+
+Integrate Google Recaptcha v3 with Rails app.
 
 Google Recaptcha console: https://www.google.com/recaptcha/admin#list
 
@@ -44,6 +48,31 @@ Recaptcha v3 documentation: https://developers.google.com/recaptcha/docs/v3
       render :new
     end
   end
+
+
+  # or
+  # if you need to capture a humanity `score` from Google
+  # before you need to add a column for example `humanity_score` (type: float) where this score will be saved.
+
+
+  def create
+    @post = Post.new(post_params)
+    humanity_details =
+      NewGoogleRecaptcha.get_humanity_detailed(
+        params[:new_google_recaptcha_token],
+        "checkout",
+        NewGoogleRecaptcha.minimum_score,
+        @post
+      )
+
+    @post.humanity_score = humanity_details[:score]
+
+    if humanity_details[:is_human] && @post.save
+      redirect_to @post, notice: 'Post was successfully created.'
+    else
+      render :new
+    end
+  end
   ```
 
 There are two mandatory arguments for `human?` method:
@@ -67,6 +96,16 @@ like this:
   NewGoogleRecaptcha.human?(params[:new_google_recaptcha_token], "checkout")
 ```
 
+### Saving humanity score from Google in your model
+
+`get_humanity_detailed` method acts like `human?` method, the only difference is that it returns following hash with three key-value pairs:
+
+- `is_human` - whether actor is a human or not (same as result of `human?` method)
+- `score` - actual humanity score from recaptcha response
+- `model` - model which you trying to save
+
+It could be handy if you want to store score in db or put it into logs or smth else. Real example is above in the code samples.
+
 Add to your navigation links `data-turbolinks="false"` to make it works with `turbolinks`.
 
 ## Installation
@@ -90,20 +129,71 @@ And edit new_google_recaptcha.rb and enter your site_key and secret_key.
 
 ## API
 
-**NewGoogleRecaptcha.human?(token, model)** in contoller
+`NewGoogleRecaptcha.human?(token, model)` or `NewGoogleRecaptcha.get_humanity_detailed(token, model)` in contoller
 
 - token is received from google, must be sent to backend
 - model optional parameter. if you want to add error to model.
 
-**<%= include_recaptcha_js %>** in layout (by using yield)
+`<%= include_recaptcha_js %>` in layout (by using yield)
 
 Include Google Recaptcha v3 JS into your Rails app. In head, right before `</head>`.
 
-**<%= recaptcha_action(action_name) %>** in view
+`<%= recaptcha_action(action_name) %>` in view
 
 Action where recaptcha action was executed. Actions could be viewed in Admin console. More docs: https://developers.google.com/recaptcha/docs/v3. Action name could be "comments", "checkout", etc. Put any name and check scores in console.
 
+## How to add to the Devise
+
+Generate Devise controllers and views, and edit "create" method.
+
+```ruby
+class Users::RegistrationsController < Devise::RegistrationsController
+...
+  def create
+    build_resource(sign_up_params)
+
+    NewGoogleRecaptcha.human?(
+      params[:new_google_recaptcha_token],
+      "user",
+      NewGoogleRecaptcha.minimum_score,
+      resource) && resource.save
+
+    yield resource if block_given?
+    if resource.persisted?
+      if resource.active_for_authentication?
+        set_flash_message! :notice, :signed_up
+        sign_up(resource_name, resource)
+        respond_with resource, location: after_sign_up_path_for(resource)
+      else
+        set_flash_message! :notice, :"signed_up_but_#{resource.inactive_message}"
+        expire_data_after_sign_in!
+        respond_with resource, location: after_inactive_sign_up_path_for(resource)
+      end
+    else
+      clean_up_passwords resource
+      set_minimum_password_length
+      respond_with resource
+    end
+  end
+```
+
+## How to use in test or specs
+
+At the end of the spec/rails_helper.rb put:
+
+```ruby
+module NewGoogleRecaptcha
+  def self.human?(*attrs)
+    true
+  end
+end
+```
+
+Tests are located in `specs` folder and `test/dummy/tests` folder.
+
+
 ## I18n support
+
 reCAPTCHA passes one 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:
@@ -119,11 +209,21 @@ en:
       verification_human: 'Fail'
 ```
 
+## Badge position
+
+NewGoogleRecaptcha allows you to render badge in different positions
+
+```ruby
+    <%= include_recaptcha_js badge: "bottomleft" %>
+```
+
+Three of existing `badge` values are `bottomright`, `bottomleft` and `inline`.
+'inline' lets you position it with CSS. 
+
 ## TODO
 
 - check everything works with turbolinks
 - allow custom ID for input
-- return score ?
 - more tests
 - handle exceptions with timeouts, json is not parsed
 - add support for non-Rails apps
@@ -137,7 +237,15 @@ You are welcome to contribute.
 * [gilcierweb](https://github.com/gilcierweb)
 * [RoRElessar](https://github.com/RoRElessar)
 * [rubyconvict](https://github.com/rubyconvict)
+* [adelnabiullin](https://github.com/adelnabiullin)
+* [jhill](https://github.com/jhill)
+* [dachinat](https://github.com/dachinat)
+* [edugonch](https://github.com/edugonch)
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+[<img src="https://github.com/igorkasyanchuk/rails_time_travel/blob/main/docs/more_gems.png?raw=true"
+/>](https://www.railsjazz.com/)

data/lib/new_google_recaptcha/validator.rb

@@ -2,9 +2,24 @@ require 'net/http'
 
 module NewGoogleRecaptcha
   class Validator
-    def self.valid?(token, action, minimum_score)
-      uri    = URI("https://www.google.com/recaptcha/api/siteverify?secret=#{NewGoogleRecaptcha.secret_key}&response=#{token}")
-      result = JSON.parse(Net::HTTP.get(uri))
+    attr_reader :score
+    attr_reader :token, :action, :minimum_score
+
+    def initialize(token:, action:, minimum_score:)
+      @token         = token
+      @action        = action
+      @minimum_score = minimum_score
+    end
+
+    def call
+      uri    = NewGoogleRecaptcha.compose_uri(token)
+      
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https' 
+      result = JSON.parse(http.request(Net::HTTP::Get.new(uri)).body)
+
+      @score = result['score'].to_f
+
       conditions = []
       conditions << !!result['success']
       conditions << (result['score'].to_f >= minimum_score)
@@ -12,4 +27,4 @@ module NewGoogleRecaptcha
       conditions.none?(&:!)
     end
   end
-end
+end

data/lib/new_google_recaptcha/version.rb

@@ -1,3 +1,3 @@
 module NewGoogleRecaptcha
-  VERSION = '1.0.0'
+  VERSION = '1.4.0'
 end

data/lib/new_google_recaptcha/view_ext.rb

@@ -2,24 +2,45 @@ module NewGoogleRecaptcha
   module ViewExt
     include ActionView::Helpers::TagHelper
 
-    def include_recaptcha_js
-      raw %Q{
-        <script src="https://www.google.com/recaptcha/api.js?render=#{NewGoogleRecaptcha.site_key}"></script>
-      }
+    def include_recaptcha_js(opts = {})
+      badge = opts[:badge] ? "&badge=#{opts[:badge]}" : ""
+      generate_recaptcha_callback +
+        javascript_include_tag(
+          "https://www.google.com/recaptcha/api.js?render=#{NewGoogleRecaptcha.site_key}&onload=newGoogleRecaptchaCallback#{badge}",
+          defer: true
+        )
     end
 
     def recaptcha_action(action)
       id = "new_google_recaptcha_token_#{SecureRandom.hex(10)}"
-      raw %Q{
-        <input name="new_google_recaptcha_token" type="hidden" id="#{id}"/>
-        <script>
-          grecaptcha.ready(function() {
-            grecaptcha.execute("#{NewGoogleRecaptcha.site_key}", {action: "#{action}"}).then(function(token) {
-              document.getElementById("#{id}").value = token;
-            });
-          });
-        </script>
-      }
+      hidden_field_tag(
+        'new_google_recaptcha_token',
+        nil,
+        readonly: true,
+        'data-google-recaptcha-action' => action,
+        id: id
+      )
+    end
+
+    private
+
+    def generate_recaptcha_callback
+      javascript_tag %(
+        function newGoogleRecaptchaCallback () {
+          grecaptcha.ready(function () {
+            var elements = document.querySelectorAll('[data-google-recaptcha-action]')
+            Array.prototype.slice.call(elements).forEach(function (el) {
+              var action = el.dataset.googleRecaptchaAction
+              if (!action) return
+              grecaptcha
+                .execute("#{NewGoogleRecaptcha.site_key}", { action: action })
+                .then(function (token) {
+                  el.value = token
+                })
+            })
+          })
+        }
+      )
     end
   end
-end
+end

data/lib/new_google_recaptcha.rb

@@ -10,13 +10,37 @@ module NewGoogleRecaptcha
   end
 
   def self.human?(token, action, minimum_score = self.minimum_score, model = nil)
-    is_valid = NewGoogleRecaptcha::Validator.valid?(token, action, minimum_score)
+    is_valid =
+      NewGoogleRecaptcha::Validator.new(
+        token: token,
+        action: action,
+        minimum_score: minimum_score
+      ).call
+
     if model && !is_valid
       model.errors.add(:base, self.i18n("new_google_recaptcha.errors.verification_human", "Looks like you are not a human"))
     end
+
     is_valid
   end
 
+  def self.get_humanity_detailed(token, action, minimum_score = self.minimum_score, model = nil)
+    validator =
+      NewGoogleRecaptcha::Validator.new(
+        token: token,
+        action: action,
+        minimum_score: minimum_score
+      )
+
+    is_valid = validator.call
+
+    if model && !is_valid
+      model.errors.add(:base, self.i18n("new_google_recaptcha.errors.verification_human", "Looks like you are not a human"))
+    end
+
+    { is_human: is_valid, score: validator.score, model: model }
+  end
+
   def self.i18n(key, default)
     if defined?(I18n)
       I18n.translate(key, default: default)
@@ -25,7 +49,13 @@ module NewGoogleRecaptcha
     end
   end
 
+  def self.compose_uri(token)
+    URI(
+      "https://www.google.com/recaptcha/api/siteverify?"\
+      "secret=#{self.secret_key}&response=#{token}"
+    )
+  end
 end
 
 require_relative "new_google_recaptcha/view_ext"
-require_relative "new_google_recaptcha/validator"
+require_relative "new_google_recaptcha/validator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: new_google_recaptcha
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -123,7 +123,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Google reCaptcha v3 + Rails (integration)
+description: Google reCAPTCHA v3 + Rails (integration)
 email:
 - igorkasyanchuk@gmail.com
 executables: []
@@ -161,8 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: Google reCaptcha v3 + Rails
+summary: Google reCAPTCHA v3 + Rails
 test_files: []