card-mod-recaptcha 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 401f01a508d89f16d576d0eba9be296ed70c94118f06a3a2eabbd2c4b53c7e63
-  data.tar.gz: 62119671698e2adf4fffa4c84737eb0304efe8ffbb5779c25a1f83df2e04b29b
+  metadata.gz: ad98d42ca508bbf0d27cb2d653751ace79557fb26816f96255b0f38632b1695d
+  data.tar.gz: 397183d1b43f25cdf8a854911d57784fa6f90255adbea4c4d9bfc977a651a668
 SHA512:
-  metadata.gz: 13639bf7512b46965b7e6123de531057dd9282b00f77048ddc35eaaa8c2b22a2aef348c76f076c2bb75db19191531b3e7683f5138e71e48c867d6a693b2608a5
-  data.tar.gz: 4279e90ced604d1e0e997c7517b1b1320671f2c895a0d0949a4a9e118bc90a9d5dcca288c4336039c6d19ff3b339fb0064900087f168a2a6cd62cc22da468f48
+  metadata.gz: 1ca552cca2c85b058155509d46c11102f529ae421658c0655bcbe646842a8514a04bdf02560629cc53aa8298830fc5fe113e1de643be3d4f7ac1c4ac66eef0bd
+  data.tar.gz: 3583498a9b11836546e714cc13b916d5ccd301b79d4b245f58f78a669cb0cd369102e3e37a79bab0403fa337a8ebac03c6a320ce5935cfe96478da0850edb960

data/assets/script/recaptcha.js.coffee

@@ -0,0 +1,41 @@
+$(window).ready ->
+  $('body').on 'submit', 'form.slotter', (event)->
+    form = $(this)
+    handleRecaptcha form, event if form.data('recaptcha') == 'on'
+
+handleRecaptcha = (form, event) ->
+  recaptcha = form.find("input._recaptcha-token")
+
+  if !recaptcha[0]?
+# monkey error (bad form)
+    recaptcha.val "recaptcha-token-field-missing"
+  else if recaptcha.hasClass "_token-updated"
+# recaptcha token is fine - continue submitting
+    recaptcha.removeClass "_token-updated"
+  else if !grecaptcha?
+# shark error (probably recaptcha keys of pre v3 version)
+    recaptcha.val "grecaptcha-undefined"
+  else
+    updateRecaptchaToken(form, event)
+# this stops the submit here
+# and submits again when the token is ready
+
+updateRecaptchaToken = (form, event) ->
+  recaptcha = form.find("input._recaptcha-token")
+
+  if !recaptcha[0]?
+    recaptcha.val "recaptcha-token-field-missing"
+  else if !grecaptcha?
+    recaptcha.val "grecaptcha-undefined"
+  else
+    event.stopPropagation() if event
+    executeGrecaptcha form, event, recaptcha
+    false
+
+executeGrecaptcha = (form, event, recaptcha) ->
+  siteKey = recaptcha.data "site-key"
+  action = recaptcha.data "action"
+  grecaptcha.execute(siteKey, action: action).then (token) ->
+    recaptcha.val token
+    recaptcha.addClass "_token-updated"
+    form.submit() if event

data/data/files/mod_recaptcha_script_asset_output/file.js

@@ -0,0 +1,2 @@
+// recaptcha.js.coffee
+(function(){var t,a,n;$(window).ready(function(){return $("body").on("submit","form.slotter",function(t){var n;if("on"===(n=$(this)).data("recaptcha"))return a(n,t)})}),a=function(t,a){var e;return null==(e=t.find("input._recaptcha-token"))[0]?e.val("recaptcha-token-field-missing"):e.hasClass("_token-updated")?e.removeClass("_token-updated"):"undefined"==typeof grecaptcha||null===grecaptcha?e.val("grecaptcha-undefined"):n(t,a)},n=function(a,n){var e;return null==(e=a.find("input._recaptcha-token"))[0]?e.val("recaptcha-token-field-missing"):"undefined"==typeof grecaptcha||null===grecaptcha?e.val("grecaptcha-undefined"):(n&&n.stopPropagation(),t(a,n,e),!1)},t=function(t,a,n){var e,c;return c=n.data("site-key"),e=n.data("action"),grecaptcha.execute(c,{action:e}).then(function(e){if(n.val(e),n.addClass("_token-updated"),a)return t.submit()})}}).call(this);

data/data/real.yml

@@ -0,0 +1,20 @@
+- :name: "*captcha"
+  :type: :setting
+  :codename: captcha
+- :name:
+    - :all
+    - :captcha
+  :type: :toggle
+  :content: '1'
+- :name:
+    - :signup
+    - :type
+    - :captcha
+  :type: :toggle
+  :content: '1'
+- :name: "*recaptcha settings"
+  :codename: recaptcha_settings
+- :name: site key
+  :codename: site_key
+- :name: secret key
+  :codename: secret_key

data/init/late/recaptcha.rb

@@ -2,34 +2,43 @@
 
 require "recaptcha"
 
-# This initializer module is mostly here to avoid adding methods/vars to the Object
-# namespace
+# This Recaptcha initializer handles the multiple ways in which the recaptcha site and
+# secret key can be configured.  These include:
+#
+# - in config files with config.recaptcha_site_key and config.recaptcha_secret_key
+#   (PREFERRED!)
+# - via the :recaptcha_settings card
+# - in config files with config.recaptcha_public_key and config.recaptcha_private_key
+#   (DEPRECATED!)
+# - by using the defaults below (DEVELOPMENT ONLY)
+#
 module RecaptchaCard
   @deprecated = {
-    recaptcha_site_key: :recaptcha_public_key,
-    recaptcha_secret_key: :recaptcha_private_key
+    site_key: :recaptcha_public_key,
+    secret_key: :recaptcha_private_key
   }
   @defaults = {
-    recaptcha_site_key: "6LdoqpgUAAAAAEdhJ4heI1h3XLlpXcDf0YubriCG",
-    recaptcha_secret_key: "6LdoqpgUAAAAAP4Sz1L5PY6VKrum_RFxq4-awj4BH"
+    site_key: "6LdoqpgUAAAAAEdhJ4heI1h3XLlpXcDf0YubriCG",
+    secret_key: "6LdoqpgUAAAAAP4Sz1L5PY6VKrum_RFxq4-awj4BH"
   }
 
-  mattr_accessor :using_card_defaults
-
   class << self
     def load_recaptcha_config setting
-      setting = "recaptcha_#{setting}".to_sym
-      Cardio.config.send "#{setting}=", recaptcha_setting_value(setting)
+      full_setting = "recaptcha_#{setting}".to_sym
+      Cardio.config.send "#{full_setting}=",
+                         recaptcha_setting_value(setting, full_setting)
     end
 
     def using_defaults?
-      Cardio.config.recaptcha_site_key == @defaults[:recaptcha_site_key]
+      Cardio.config.recaptcha_site_key == @defaults[:site_key]
     end
 
+    private
+
     # card config overrides application.rb config overrides default
-    def recaptcha_setting_value setting
-      card_value(setting) ||                  # card content
-        config_value(setting) ||              # application.rb (current setting)
+    def recaptcha_setting_value setting, full_setting
+      card_value(full_setting) ||             # card content
+        config_value(full_setting) ||         # application.rb (current setting)
         config_value(@deprecated[setting]) || # application.rb (deprecated setting)
         @defaults[setting]
     end
@@ -39,9 +48,11 @@ module RecaptchaCard
     end
 
     def card_value setting
-      return unless Card::Codename.exist? setting # prevents breakage in migrations
+      # prevent breakage in migrations
+      return unless Card::Codename.exist?(:recaptcha_settings) &&
+                    Card::Codename.exist?(setting)
 
-      value = Card[setting]&.content
+      value = setting.card&.content
       value if value.present?
     end
   end
@@ -52,7 +63,7 @@ ActiveSupport.on_load :after_card do
     %i[site_key secret_key].each do |setting|
       config.send "#{setting}=", RecaptchaCard.load_recaptcha_config(setting)
     end
-    config.verify_url = "https://www.google.com/recaptcha/api/siteverify"
+    config.verify_url = Cardio.config.recaptcha_verify_url
   end
 end
 

data/lib/card/mod/recaptcha.rb

@@ -0,0 +1,10 @@
+Cardio::Railtie.config.tap do |config|
+  config.recaptcha_public_key = nil  # deprecated; use recaptcha_site_key instead
+  config.recaptcha_private_key = nil # deprecated; use recaptcha_secret_key instead
+
+  config.recaptcha_proxy = nil
+  config.recaptcha_site_key = nil
+  config.recaptcha_secret_key = nil
+  config.recaptcha_minimum_score = 0.5
+  config.recaptcha_verify_url = "https://www.google.com/recaptcha/api/siteverify"
+end

data/set/abstract/recaptcha_setting.rb

@@ -0,0 +1,13 @@
+event :validate_recaptcha_field, :validate, when: :recaptcha_setting? do
+  return if content.match?(/^[a-zA-Z0-9\-_]*$/)
+
+  errors.add :content, "invalid key" # LOCALIZE
+end
+
+event :set_recaptcha_site_key, :finalize, when: :recaptcha_setting? do
+  Card.config.send "recaptcha_#{codename}=", content
+end
+
+def recaptcha_setting?
+  left&.codename == :recaptcha_settings
+end

data/set/all/recaptcha.rb

@@ -15,7 +15,7 @@ end
 
 def recaptcha_on?
   recaptcha_keys? &&
-    Env[:controller] &&
+    Env.controller &&
     !Auth.signed_in? &&
     !Auth.always_ok? &&
     !Auth.needs_setup? &&
@@ -49,7 +49,7 @@ end
 
 event :recaptcha, :validate, when: :validate_recaptcha? do
   handle_recaptcha_config_errors do
-    Env[:recaptcha_used] = true
+    :captcha.card.captcha_used!
     human?
   end
 end
@@ -66,7 +66,9 @@ def handle_recaptcha_config_errors
 end
 
 def validate_recaptcha?
-  !@supercard && !Env[:recaptcha_used] && recaptcha_on?
+  return unless Card::Codename.exists? :captcha
+
+  !@supercard && !:captcha.card.captcha_used? && recaptcha_on?
 end
 
 format :html do

data/set/right/captcha.rb

@@ -0,0 +1 @@
+assign_type :toggle

data/set/right/secret_key.rb

@@ -0,0 +1 @@
+include_set Abstract::RecaptchaSetting

data/set/right/site_key.rb

@@ -0,0 +1 @@
+include_set Abstract::RecaptchaSetting

data/set/self/captcha.rb

@@ -3,3 +3,11 @@ setting_opts group: :permission,
              help_text: "Anti-spam setting.  Requires non-signed-in users to complete a "\
                         "[[http://decko.org/captcha|captcha]] before adding or editing "\
                         "cards (where permitted)."
+
+def captcha_used?
+  !@captcha_used.nil?
+end
+
+def captcha_used!
+  @captcha_used = true
+end

data/set/self/recaptcha_settings.rb

@@ -6,6 +6,10 @@ format :html do
     "If you want to turn captchas off then change all [[*captcha|captcha rules]] to 'no'."
   end
 
+  view :core do
+    [field_nest(:site_key), field_nest(:secret_key)]
+  end
+
   # def instructions title, steps
   #   steps = list_tag steps, ordered: true
   #   "#{title}#{steps}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: card-mod-recaptcha
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: card
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.104.1
+        version: 1.105.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.104.1
+        version: 1.105.0
 - !ruby/object:Gem::Dependency
   name: recaptcha
   requirement: !ruby/object:Gem::Requirement
@@ -47,16 +47,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- assets/script/recaptcha.js.coffee
+- data/files/mod_recaptcha_script_asset_output/file.js
+- data/real.yml
 - init/late/recaptcha.rb
+- lib/card/mod/recaptcha.rb
 - locales/de.yml
 - locales/en.yml
+- set/abstract/recaptcha_setting.rb
 - set/all/recaptcha.rb
-- set/self/admin_info.rb
+- set/right/captcha.rb
+- set/right/secret_key.rb
+- set/right/site_key.rb
+- set/self/admin.rb
 - set/self/captcha.rb
-- set/self/recaptcha_proxy.rb
-- set/self/recaptcha_secret_key.rb
 - set/self/recaptcha_settings.rb
-- set/self/recaptcha_site_key.rb
 homepage: https://decko.org
 licenses:
 - GPL-3.0
@@ -67,6 +72,7 @@ metadata:
   wiki_uri: https://decko.org
   documentation_url: http://docs.decko.org/
   card-mod: recaptcha
+  card-mod-group: gem-defaults
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -82,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: recaptcha support for decko

data/set/self/recaptcha_proxy.rb

@@ -1,3 +0,0 @@
-event :set_recaptcha_proxy, :finalize do
-  Card.config.recaptcha_proxy = content
-end

data/set/self/recaptcha_secret_key.rb

@@ -1,9 +0,0 @@
-event :validate_recaptcha_secret_key, :validate do
-  return if content.match?(/^[a-zA-Z0-9\-_]*$/)
-
-  errors.add :content, "invalid key" # LOCALIZE
-end
-
-event :set_recaptcha_secret_key, :finalize do
-  Card.config.recaptcha_secret_key = content
-end

data/set/self/recaptcha_site_key.rb

@@ -1,9 +0,0 @@
-event :validate_recaptcha_site_key, :validate do
-  return if content.match?(/^[a-zA-Z0-9\-_]*$/)
-
-  errors.add :content, "invalid key" # LOCALIZE
-end
-
-event :set_recaptcha_site_key, :finalize do
-  Card.config.recaptcha_site_key = content
-end