recaptcha 5.18.0 → 5.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41990aba0d4786ebf87da392ac025d8725d5ca5f30c9e1018b0cf2197f8efada
-  data.tar.gz: 34b8d6b1dc5e34d9349c64f3a2d2c77f0cc67b2570077788e9e128d2a855a927
+  metadata.gz: 995e891c595981b495f6911abe80bdc9de1df1f2d445e12cc9129f4fcc5d523d
+  data.tar.gz: b160af36ee62814a45c2c3e96a0e6e268521b6f0eacc7dee2bcc130068384dd9
 SHA512:
-  metadata.gz: b3d440a27b41351c81ca9ad94368ea5485d1a1bed05092c011bbfe358cb8c829e89bc295a52a0e323333fc1a3135384149bd3ec13f0cd4c6a8fcc09184a3d4d4
-  data.tar.gz: f176ce1beb9764f342dedc8c36cbc40b248ae230c758f2df3053c891c5616b4898e435fde8251da03ff5e690b535bef64bdc7e2257aadc8755f7f0e4efbddbfd
+  metadata.gz: fa21ffc606ec9e389970f607aaab34449a21454c4ce5044092ae773dab3a2f622b097504969dd4ec3e532222bed29b8185936f4def1ec17886201ff1869106cd
+  data.tar.gz: 7dfe2542b8cda9555c578c4c9c1977d5ddc6ac6a8955b19f0b5abb96e5946cb4d7b25627a107f8bd2aa60984cb6babd0594fc1ae6e856f66ca500265f92be484

data/CHANGELOG.md

@@ -1,4 +1,12 @@
 ## Next
+
+## 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

data/README.md

@@ -589,6 +589,7 @@ Recaptcha.configure do |config|
   config.verify_url = 'https://hcaptcha.com/siteverify'
   config.api_server_url = 'https://hcaptcha.com/1/api.js'
   config.response_limit = 100000
+  config.response_minimum = 100
 end
 ```
 

data/lib/recaptcha/adapters/controller_methods.rb

@@ -31,16 +31,18 @@ module Recaptcha
 
             success, @_recaptcha_reply =
               Recaptcha.verify_via_api_call(recaptcha_response, options.merge(with_reply: true))
+
             unless success
-              @_recaptcha_failure_reason = if @_recaptcha_reply["score"] &&
-                                              @_recaptcha_reply["score"].to_f < options[:minimum_score].to_f
-                "Recaptcha score didn't exceed the minimum: #{@_recaptcha_reply["score"]} < #{options[:minimum_score]}."
-              elsif @_recaptcha_reply['error-codes']
-                "Recaptcha api call returned with error-codes: #{@_recaptcha_reply['error-codes']}."
-              else
-                "Recaptcha failure after api call. Api reply: #{@_recaptcha_reply}."
-              end
+              @_recaptcha_failure_reason =
+                if @_recaptcha_reply.score && @_recaptcha_reply.score.to_f < options[:minimum_score].to_f
+                  "Recaptcha score didn't exceed the minimum: #{@_recaptcha_reply.score} < #{options[:minimum_score]}."
+                elsif @_recaptcha_reply.error_codes.any?
+                  "Recaptcha api call returned with error-codes: #{@_recaptcha_reply.error_codes}."
+                else
+                  "Recaptcha failure after api call. Api reply: #{@_recaptcha_reply}."
+                end
             end
+
             success
           end
 

data/lib/recaptcha/configuration.rb

@@ -37,8 +37,10 @@ module Recaptcha
       'enterprise_verify_url' => 'https://recaptchaenterprise.googleapis.com/v1/projects'
     }.freeze
 
-    attr_accessor :default_env, :skip_verify_env, :proxy, :secret_key, :site_key, :handle_timeouts_gracefully,
-                  :hostname, :enterprise, :enterprise_api_key, :enterprise_project_id, :response_limit
+    attr_accessor(
+      :default_env, :skip_verify_env, :proxy, :secret_key, :site_key, :handle_timeouts_gracefully,
+      :hostname, :enterprise, :enterprise_api_key, :enterprise_project_id, :response_limit, :response_minimum
+    )
     attr_writer :api_server_url, :verify_url
 
     def initialize # :nodoc:
@@ -57,6 +59,7 @@ module Recaptcha
       @api_server_url = nil
 
       @response_limit = 4000
+      @response_minimum = 100
     end
 
     def secret_key!

data/lib/recaptcha/reply.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Recaptcha
+  class Reply
+    def initialize(raw_reply, enterprise:)
+      @raw_reply = raw_reply
+      @enterprise = enterprise
+    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

data/lib/recaptcha/version.rb

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

data/lib/recaptcha.rb

@@ -6,6 +6,7 @@ require 'uri'
 
 require 'recaptcha/configuration'
 require 'recaptcha/helpers'
+require 'recaptcha/reply'
 require 'recaptcha/adapters/controller_methods'
 require 'recaptcha/adapters/view_methods'
 if defined?(Rails)
@@ -55,7 +56,7 @@ module Recaptcha
   end
 
   def self.invalid_response?(resp)
-    resp.empty? || resp.length > configuration.response_limit
+    resp.empty? || resp.length > configuration.response_limit || resp.length < configuration.response_minimum
   end
 
   def self.verify_via_api_call(response, options)
@@ -76,21 +77,10 @@ module Recaptcha
     body['event']['expectedAction'] = options[:action] if options.key?(:action)
     body['event']['userIpAddress'] = options[:remote_ip] if options.key?(:remote_ip)
 
-    reply = api_verification_enterprise(query_params, body, project_id, timeout: options[:timeout])
-    score = reply.dig('riskAnalysis', 'score')
-    token_properties = reply['tokenProperties']
-    success = !token_properties.nil? &&
-      token_properties['valid'].to_s == 'true' &&
-      hostname_valid?(token_properties['hostname'], options[:hostname]) &&
-      action_valid?(token_properties['action'], options[:action]) &&
-      score_above_threshold?(score, options[:minimum_score]) &&
-      score_below_threshold?(score, options[:maximum_score])
-
-    if options[:with_reply] == true
-      [success, reply]
-    else
-      success
-    end
+    raw_reply = api_verification_enterprise(query_params, body, project_id, timeout: options[:timeout])
+    reply = Reply.new(raw_reply, enterprise: true)
+    result = reply.success?(options)
+    options[:with_reply] == true ? [result, reply] : result
   end
 
   def self.verify_via_api_call_free(response, options)
@@ -98,43 +88,10 @@ module Recaptcha
     verify_hash = { 'secret' => secret_key, 'response' => response }
     verify_hash['remoteip'] = options[:remote_ip] if options.key?(:remote_ip)
 
-    reply = api_verification_free(verify_hash, timeout: options[:timeout], json: options[:json])
-    success = reply['success'].to_s == 'true' &&
-      hostname_valid?(reply['hostname'], options[:hostname]) &&
-      action_valid?(reply['action'], options[:action]) &&
-      score_above_threshold?(reply['score'], options[:minimum_score]) &&
-      score_below_threshold?(reply['score'], options[:maximum_score])
-
-    if options[:with_reply] == true
-      [success, reply]
-    else
-      success
-    end
-  end
-
-  def self.hostname_valid?(hostname, validation)
-    validation ||= configuration.hostname
-
-    case validation
-    when nil, FalseClass then true
-    when String then validation == hostname
-    else validation.call(hostname)
-    end
-  end
-
-  def self.action_valid?(action, expected_action)
-    case expected_action
-    when nil, FalseClass then true
-    else action == expected_action.to_s
-    end
-  end
-
-  def self.score_above_threshold?(score, minimum_score)
-    !minimum_score || (score && score >= minimum_score)
-  end
-
-  def self.score_below_threshold?(score, maximum_score)
-    !maximum_score || (score && score <= maximum_score)
+    raw_reply = api_verification_free(verify_hash, timeout: options[:timeout], json: options[:json])
+    reply = Reply.new(raw_reply, enterprise: false)
+    result = reply.success?(options)
+    options[:with_reply] == true ? [result, reply] : result
   end
 
   def self.http_client_for(uri:, timeout: nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recaptcha
 version: !ruby/object:Gem::Version
-  version: 5.18.0
+  version: 5.20.0
 platform: ruby
 authors:
 - Jason L Perry
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-08 00:00:00.000000000 Z
+date: 2025-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -139,6 +139,7 @@ files:
 - lib/recaptcha/helpers.rb
 - lib/recaptcha/rails.rb
 - lib/recaptcha/railtie.rb
+- lib/recaptcha/reply.rb
 - lib/recaptcha/version.rb
 - rails/locales/de.yml
 - rails/locales/en.yml