support logging api call replies

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Next
 * Gracefully handle invalid params
+* support logging api call replies
 
 ## 5.8.0
 * Add support for the enterprise API

README.md

@@ -526,6 +526,8 @@ Recaptcha.configure do |config|
   # config.enterprise = true
   # config.enterprise_api_key = 'AIzvFyE3TU-g4K_Kozr9F1smEzZSGBVOfLKyupA'
   # config.enterprise_project_id = 'my-project'
+
+  # config.logger = Rails.logger # log the api call replies
 end
 ```
 

lib/recaptcha.rb

@@ -60,14 +60,22 @@ def self.invalid_response?(resp)
   end
 
   def self.verify_via_api_call(response, options)
-    if Recaptcha.configuration.enterprise
-      verify_via_api_call_enterprise(response, options)
+    success, reply = if Recaptcha.configuration.enterprise
+      verify_via_api_call_enterprise(response, options.merge(with_reply: true))
     else
-      verify_via_api_call_free(response, options)
+      verify_via_api_call_free(response, options.merge(with_reply: true))
+    end
+
+    Recaptcha.configuration.logger&.info(reply.merge(event: 'recaptcha-response'))
+
+    if options[:with_reply]
+      [success, reply]
+    else
+      success
     end
   end
 
-  def self.verify_via_api_call_enterprise(response, options)
+  private_class_method def self.verify_via_api_call_enterprise(response, options)
     site_key = options.fetch(:site_key) { configuration.site_key! }
     api_key = options.fetch(:enterprise_api_key) { configuration.enterprise_api_key! }
     project_id = options.fetch(:enterprise_project_id) { configuration.enterprise_project_id! }
@@ -85,14 +93,10 @@ def self.verify_via_api_call_enterprise(response, options)
       action_valid?(token_properties['action'], options[:action]) &&
       score_above_threshold?(reply['score'], options[:minimum_score])
 
-    if options[:with_reply] == true
-      return success, reply
-    else
-      return success
-    end
+    [success, reply]
   end
 
-  def self.verify_via_api_call_free(response, options)
+  private_class_method def self.verify_via_api_call_free(response, options)
     secret_key = options.fetch(:secret_key) { configuration.secret_key! }
     verify_hash = { 'secret' => secret_key, 'response' => response }
     verify_hash['remoteip'] = options[:remote_ip] if options.key?(:remote_ip)
@@ -103,11 +107,7 @@ def self.verify_via_api_call_free(response, options)
       action_valid?(reply['action'], options[:action]) &&
       score_above_threshold?(reply['score'], options[:minimum_score])
 
-    if options[:with_reply] == true
-      return success, reply
-    else
-      return success
-    end
+    [success, reply]
   end
 
   def self.hostname_valid?(hostname, validation)

lib/recaptcha/configuration.rb

@@ -38,7 +38,7 @@ class Configuration
     }.freeze
 
     attr_accessor :default_env, :skip_verify_env, :proxy, :secret_key, :site_key, :handle_timeouts_gracefully, :hostname
-    attr_accessor :enterprise, :enterprise_api_key, :enterprise_project_id
+    attr_accessor :enterprise, :enterprise_api_key, :enterprise_project_id, :logger
     attr_writer :api_server_url, :verify_url
 
     def initialize #:nodoc:

test/verify_test.rb

@@ -174,6 +174,16 @@
       assert_equal "reCAPTCHA verification failed, please try again.", @controller.flash[:recaptcha_error]
     end
 
+    it "can log the response" do
+      logger = mock('STDOUT')
+
+      Recaptcha.with_configuration(logger: logger) do
+        expect_http_post.to_return(body: '{"success":true}')
+        logger.expects(:info).with("success" => true, :event => "recaptcha-response")
+        @controller.verify_recaptcha
+      end
+    end
+
     describe ':hostname' do
       let(:hostname) { 'fake.hostname.com' }