rails_cloudflare_turnstile 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 213b9ea35b854fa37d8fc8b18e62f37a55d594a23df7d8b4717ed6d528a164a3
-  data.tar.gz: 1182162d69f5a507075de7c9e5a9ba30a5661fa08587b95399078e37f5ab021d
+  metadata.gz: 945f56fd2e6ef412bd71d68a58ca63978499ac4948ac4cdb640852a0d7f13cbf
+  data.tar.gz: 446c952679cf658fbc9e6e031043ca272ef8ef0ce5b3c6d40229461643725c07
 SHA512:
-  metadata.gz: 49f8cfbf351ac4a46258dadc8d21751849fe345519919053e30bf01f3a7972d2265548822423a18e9c5d2e956db8ffbcdc192aa5467de871b44e98989b076223
-  data.tar.gz: 534896363c9408f0f6c145c6f4b14599631dc77ea507d113bbb24f8d2d81f17bf47a8fc97e866cebe83f42b1dface02f3b2193bc3d47db86ef99995e56e5b593
+  metadata.gz: 6d27317d8fba8949675177a9fbbe798d0f57f7a26c2fad0ae72fe0b00337f6721dab1c298af562839a012d2f68764db99fe07fe2cb78ce44d6c996fa5ee0dc8b
+  data.tar.gz: 5549a4a67796a43b4effb39c4d50bef488f47164f3efcfb285c3ce8f64da445d23c1aefe4adc318da4964f79ea28af125d21972001da79ab5d00291649be4bda

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ChangeLog
 =========
 
+0.1.3
+-----
+- Add mocked functionality in dev/test
+
 0.1.2
 -----
 - Fix URIs in gemspec

data/README.md

@@ -34,7 +34,6 @@ RailsCloudflareTurnstile.configure do |c|
   c.fail_open = true
 end
 ```
-
 To totally disable Turnstile, you can set `c.enabled = false` and all other config values are ignored.
 
 To use Turnstile for a view:
@@ -46,5 +45,8 @@ To use Turnstile for a view:
 If the challenge fails, the exception `RailsCloudflareTurnstile::Forbidden` will be raised; you should handle this with
 a `rescue_from` block.
 
+By default, in development and test mode, a special mock view will be inserted if real credentials are not present. To
+disable this, set the `mock_enable` property of the configuration to false.
+
 ## License
 The gem is available as open source under the terms of the [ISC License](LICENSE.txt).

data/lib/rails_cloudflare_turnstile/configuration.rb

@@ -21,11 +21,14 @@ module RailsCloudflareTurnstile
 
     attr_accessor :enabled
 
+    attr_accessor :mock_enabled
+
     def initialize
       @site_key = nil
       @secret_key = nil
       @fail_open = true
       @enabled = nil
+      @mock_enabled = nil
       @timeout = 5.0
       @size = :regular
       @validation_url = "https://challenges.cloudflare.com/turnstile/v0/siteverify"

data/lib/rails_cloudflare_turnstile/controller_helpers.rb

@@ -5,54 +5,58 @@ require "faraday"
 module RailsCloudflareTurnstile
   module ControllerHelpers
     def cloudflare_turnstile_ok?
-      return true unless RailsCloudflareTurnstile.enabled?
+      if RailsCloudflareTurnstile.enabled?
+        config = RailsCloudflareTurnstile.configuration
 
-      config = RailsCloudflareTurnstile.configuration
+        url = URI(config.validation_url)
 
-      url = URI(config.validation_url)
+        body = {
+          secret: config.secret_key,
+          response: params["cf-turnstile-response"],
+          remoteip: request.remote_ip
+        }
 
-      body = {
-        secret: config.secret_key,
-        response: params["cf-turnstile-response"],
-        remoteip: request.remote_ip
-      }
-
-      begin
-        resp = Faraday.new(url) { |conn|
-          conn.options.timeout = config.timeout
-          conn.options.open_timeout = config.timeout
-          conn.use Faraday::Response::RaiseError
-          conn.request :json
-          conn.response :json
-        }.post(url, body)
-      rescue Faraday::Error => e
-        Rails.logger.error "Error response from CloudFlare Turnstile: #{e}"
-        if config.fail_open
-          return true
-        else
-          return false
+        begin
+          resp = Faraday.new(url) { |conn|
+            conn.options.timeout = config.timeout
+            conn.options.open_timeout = config.timeout
+            conn.use Faraday::Response::RaiseError
+            conn.request :json
+            conn.response :json
+          }.post(url, body)
+        rescue Faraday::Error => e
+          Rails.logger.error "Error response from CloudFlare Turnstile: #{e}"
+          if config.fail_open
+            return true
+          else
+            return false
+          end
         end
-      end
 
-      json = resp.body
+        json = resp.body
 
-      success = json["success"]
+        success = json["success"]
 
-      return true if success
+        return true if success
 
-      error = json["error-codes"][0]
+        error = json["error-codes"][0]
 
-      ActiveSupport::Notifications.instrument(
-        "rails_cloudflare_turnstile.failure",
-        message: error,
-        remote_ip: request.remote_ip,
-        user_agent: request.user_agent,
-        controller: params[:controller],
-        action: params[:action],
-        url: request.url
-      )
+        ActiveSupport::Notifications.instrument(
+          "rails_cloudflare_turnstile.failure",
+          message: error,
+          remote_ip: request.remote_ip,
+          user_agent: request.user_agent,
+          controller: params[:controller],
+          action: params[:action],
+          url: request.url
+        )
 
-      false
+        false
+      elsif RailsCloudflareTurnstile.mock_enabled?
+        params["cf-turnstile-response"] == "mocked"
+      else
+        true
+      end
     end
 
     private

data/lib/rails_cloudflare_turnstile/version.rb

@@ -1,3 +1,3 @@
 module RailsCloudflareTurnstile
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/rails_cloudflare_turnstile/view_helpers.rb

@@ -3,9 +3,14 @@
 module RailsCloudflareTurnstile
   module ViewHelpers
     def cloudflare_turnstile(action: "other")
-      return nil unless RailsCloudflareTurnstile.enabled?
-      content_tag(:div, class: "cloudflare-turnstile") do
-        concat turnstile_div(action)
+      if RailsCloudflareTurnstile.enabled?
+        content_tag(:div, class: "cloudflare-turnstile") do
+          concat turnstile_div(action)
+        end
+      elsif RailsCloudflareTurnstile.mock_enabled?
+        content_tag(:div, class: "cloudflare-turnstile") do
+          concat mock_turnstile_div(action)
+        end
       end
     end
 
@@ -25,6 +30,17 @@ module RailsCloudflareTurnstile
       end
     end
 
+    def mock_turnstile_div(action)
+      content_tag(:div, class: "cf-turnstile", style: "width: 300px; height: 65px: border: 1px solid gray") do
+        [
+          tag.input(type: "hidden", name: "cf-turnstile-response", value: "mocked"),
+          content_tag(:p) do
+            "CAPTCHA goes here in production"
+          end
+        ].reduce(:<<)
+      end
+    end
+
     def site_key
       RailsCloudflareTurnstile.configuration.site_key
     end

data/lib/rails_cloudflare_turnstile.rb

@@ -16,12 +16,19 @@ module RailsCloudflareTurnstile
     if configuration.enabled.nil?
       configuration.enabled = true
     end
+    if configuration.mock_enabled.nil?
+      configuration.mock_enabled = Rails.env.development? || Rails.env.test?
+    end
   end
 
   def self.enabled?
     configuration.enabled == true
   end
 
+  def self.mock_enabled?
+    configuration.mock_enabled == true
+  end
+
   def self.reset_configuration!
     LOCK.synchronize do
       @configuration = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_cloudflare_turnstile
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - James Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails