new_google_recaptcha 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa810b760940cf717035ca4440a7fdc6fa770cde651ff6b987c0e10d0a471718
-  data.tar.gz: 41af27ec27a704388b0bc6e946fbf3ee595a261df8b90355720a9f6cb9742131
+  metadata.gz: 2c8de28bc957a91e857b5c7705c61ffdd50d38e3fb73211c36b3b2422ecf9fed
+  data.tar.gz: 955a648bfa588942fd8a349e32625c1860d8043a5b40e05f12af3bedf69cb05d
 SHA512:
-  metadata.gz: d378417f2010faed2b3bea508a54d17ddf66ca38766ba5d8c9ec3224a04742000c56a2121a1ec07217c86bfa59f2e36a7d84b680617cac2bb700093c0da39930
-  data.tar.gz: 9a3dad7d9fb2236905e94a970e499935b52f2d9281e56a9612c3439ccc229aa545afc43fb8a3c0992de4c7faa0551a0047b89064be9fd9dfd8b1ee74f937bd73
+  metadata.gz: a7d045939f0d14bd2c6c1b455191a35687eb09595488a852fcd2ace7cca04edfc37d1de3350de975fafce041c02e7679c4fd6a1a29cbab677228cf49406d4441
+  data.tar.gz: 2a4b26180887e1289a5ef605393dbffe9f213f2ca6196768a131c63b1fb6a18c36174f03a7ad8a1d1eb3a1ebd95b3e4bc3490f2b11e61545bf2315c8ceb7f020

data/README.md

@@ -1,6 +1,6 @@
 # Google Recaptcha v3 + Rails
 
-Integrate Google Recaptcha v3 with Rails app. 
+Integrate Google Recaptcha v3 with Rails app.
 
 Google Recaptcha console: https://www.google.com/recaptcha/admin#list
 
@@ -46,6 +46,32 @@ Recaptcha v3 documentation: https://developers.google.com/recaptcha/docs/v3
   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.
+
+
+  ```ruby
+  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:
 
 - `token` - token valid for your site
@@ -67,6 +93,14 @@ like this:
   NewGoogleRecaptcha.human?(params[:new_google_recaptcha_token], "checkout")
 ```
 
+`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.
+
 Add to your navigation links `data-turbolinks="false"` to make it works with `turbolinks`.
 
 ## Installation
@@ -90,20 +124,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:
@@ -123,7 +208,6 @@ en:
 
 - 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,6 +221,7 @@ 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)
 
 ## License
 

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"

data/lib/new_google_recaptcha/validator.rb

@@ -2,9 +2,21 @@ 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}")
+    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)
       result = JSON.parse(Net::HTTP.get(uri))
+
+      @score = result['score'].to_f
+
       conditions = []
       conditions << !!result['success']
       conditions << (result['score'].to_f >= minimum_score)

data/lib/new_google_recaptcha/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: new_google_recaptcha
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.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: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Google reCaptcha v3 + Rails