turnstiled 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da753c2bafbc45fa1b878958ab03e1131979c8cfa0299a0bb2cbdd48594da72b
+  data.tar.gz: 7f6a09f9e461ca65f612d1a5e1dc3259b6a88d70f6c542f42a85ad13b3b93845
+SHA512:
+  metadata.gz: 99c3f6895fa3817093d3a3eb35da430d0877b49dcaf0e80b6a08524bb9552920fcdff7d7355525d5513ca370fba4a74cc8405a65d68951a0710a3c0aa53521bd
+  data.tar.gz: 802b6644f991b9fa2875bff02422f0865bdab972b320472c09cb4d50df3fcb85834c5b720cf1538e2f4f598fd2be3a45733e2727ce2b4ce9961c320ca5679d98

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Displayful
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Turnstiled
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "turnstiled"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install turnstiled
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/app/assets/config/turnstiled/manifest.js

@@ -0,0 +1 @@
+//= link_tree ../../javascript/turnstiled .js

data/app/javascript/turnstiled/controllers/turnstile_controller.js

@@ -0,0 +1,20 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static values = {
+    siteKey: String,
+  }
+
+  connect() {
+    turnstile.render(this.element, {
+      sitekey: this.siteKeyValue,
+      callback: this.callback.bind(this),
+    })
+  }
+
+  callback(token) {
+    this.dispatch('success', {
+      detail: { token },
+    })
+  }
+}

data/app/javascript/turnstiled/mock_turnstile_widget.js

@@ -0,0 +1,37 @@
+
+function turnstile() {
+}
+
+turnstile.render = function(container, options) {
+  var element = document.createElement('div')
+  element.textContent = 'Cloudflare Turnstile'
+  element.style.background = 'yellow'
+  element.style.width = '100%'
+  element.style.height = '65px'
+  element.style.padding = '1rem'
+  element.style.display = 'flex'
+  element.style.alignItems = 'center'
+  element.style.justifyContent = 'center'
+
+  var input = Object.assign(document.createElement('input'), {
+    type: 'hidden',
+    name: 'cf-turnstile-response',
+    autocomplete: 'off',
+    ariaHidden: 'true',
+  })
+
+  container.appendChild(element)
+  container.appendChild(input)
+
+  setTimeout(function() {
+    element.textContent = 'Cloudflare Turnstile'
+    element.style.background = 'green'
+    element.style.color = 'white'
+
+    input.value = '1'
+
+    if (options.callback) {
+      options.callback('1')
+    }
+  }, 2000)
+}

data/lib/turnstiled/controller_methods.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Turnstiled
+  module ControllerMethods
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def verify_turnstile_request(**)
+        before_action(:verify_turnstile_request, **)
+      end
+    end
+
+    def verify_turnstile_request
+      head :bad_request unless Turnstiled.verify(request)
+    end
+  end
+end

data/lib/turnstiled/engine.rb

@@ -0,0 +1,15 @@
+module Turnstiled
+  class Engine < ::Rails::Engine
+    initializer 'turnstiled.controller' do
+      ActiveSupport.on_load(:action_controller_base) { include Turnstiled::ControllerMethods }
+    end
+
+    initializer 'turnstiled.controller' do
+      ActiveSupport.on_load(:action_view) { include Turnstiled::ViewHelper }
+    end
+
+    initializer 'turnstiled.assets' do |app|
+      app.config.assets.paths << root.join("app/javascript")
+    end
+  end
+end

data/lib/turnstiled/verifier.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Turnstiled
+  class Verifier
+    def verify(request)
+      return request.params['cf-turnstile-response'] == '1' if Turnstiled.mock
+
+      response = client.post('siteverify', {
+        secret: Turnstiled.site_secret,
+        response: request.params['cf-turnstile-response'],
+        remoteip: request.remote_ip,
+      })
+
+      response.body.fetch('success', false)
+    end
+
+    def client
+      @client ||= Faraday.new(client_options) do |f|
+        f.request :json
+        f.response :json
+      end
+    end
+
+    def client_options
+      {
+        url: 'https://challenges.cloudflare.com/turnstile/v0',
+        request: {
+          timeout: 3,
+        },
+      }
+    end
+  end
+end

data/lib/turnstiled/version.rb

@@ -0,0 +1,3 @@
+module Turnstiled
+  VERSION = "0.1.0"
+end

data/lib/turnstiled/view_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Turnstiled
+  module ViewHelper
+    def turnstile_tag(size: 'compact', **options)
+      options = options.deep_merge(
+        class: "cf-turnstile #{options[:class]}",
+        data: {
+          sitekey: Turnstiled.site_key,
+          controller: 'turnstile',
+          turnstile_site_key_value: Turnstiled.site_key,
+          size:,
+        }
+      )
+
+      content_tag(:div, '', options)
+    end
+
+    def turnstile_javascript_tag
+      if ::Turnstiled.mock
+        javascript_include_tag('turnstiled/mock_turnstile_widget.js', defer: true, data: { turbo_track: 'reload' })
+      else
+        javascript_include_tag('https://challenges.cloudflare.com/turnstile/v0/api.js?render=explicit',
+                               defer: true,
+                               data: {
+                                 turbo_track: 'reload',
+                               })
+      end
+    end
+  end
+end

data/lib/turnstiled.rb

@@ -0,0 +1,16 @@
+require "turnstiled/version"
+require "turnstiled/engine"
+
+module Turnstiled
+  autoload :ControllerMethods, 'turnstiled/controller_methods'
+  autoload :ViewHelper, 'turnstiled/view_helper'
+  autoload :Verifier, 'turnstiled/verifier'
+
+  mattr_accessor :site_key
+  mattr_accessor :site_secret
+  mattr_accessor :mock, default: Rails.env.local?
+
+  def self.verify(request)
+    Verifier.new.verify(request)
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: turnstiled
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Displayful
+- Henrik Hauge Bjørnskov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hb@displayful.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/turnstiled/manifest.js
+- app/javascript/turnstiled/controllers/turnstile_controller.js
+- app/javascript/turnstiled/mock_turnstile_widget.js
+- lib/turnstiled.rb
+- lib/turnstiled/controller_methods.rb
+- lib/turnstiled/engine.rb
+- lib/turnstiled/verifier.rb
+- lib/turnstiled/version.rb
+- lib/turnstiled/view_helper.rb
+homepage: https://github.com/displayful/turnstiled
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Cloudflare Turnstile for Rails
+test_files: []