turnstiled 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da753c2bafbc45fa1b878958ab03e1131979c8cfa0299a0bb2cbdd48594da72b
-  data.tar.gz: 7f6a09f9e461ca65f612d1a5e1dc3259b6a88d70f6c542f42a85ad13b3b93845
+  metadata.gz: 8459e2a83594eee0f04026d446a3696225b29af2b8bb5f749104d5179bd7098c
+  data.tar.gz: e14e6ff91ae43a3f515e729c90a5bf194935241553d3bc6b47157e0e491d9827
 SHA512:
-  metadata.gz: 99c3f6895fa3817093d3a3eb35da430d0877b49dcaf0e80b6a08524bb9552920fcdff7d7355525d5513ca370fba4a74cc8405a65d68951a0710a3c0aa53521bd
-  data.tar.gz: 802b6644f991b9fa2875bff02422f0865bdab972b320472c09cb4d50df3fcb85834c5b720cf1538e2f4f598fd2be3a45733e2727ce2b4ce9961c320ca5679d98
+  metadata.gz: e5ff34b9c984a69069bee6a2d15c8cac54dff142832a297d2d90d020f041fa47ad527b2ec7465192672464e0f687726acc17e31e2f4e1487538854c05b7e30b7
+  data.tar.gz: cf1aeaa863d06b1d2e4fddcb0e418eeaddcae133a62691dc633e34fbeec0467970fa837642858f4973f4f4ed133f85f00f0ee06ec796ebc2a950ad890009bbb1

data/README.md

@@ -1,28 +1,54 @@
-# Turnstiled
-Short description and motivation.
+Turnstiled
+==========
 
-## Usage
-How to use my plugin.
+Turnstiled makes it easy to add the Cloudflare Turnstile Captcha to your Rails app.
 
-## Installation
-Add this line to your application's Gemfile:
+For development, it even inlucdes a Mock widget.
 
-```ruby
+Getting Usage
+-------------
+
+### Installation
+
+First install the gem by adding this line to your application's Gemfile:
+
+``` ruby
 gem "turnstiled"
 ```
 
-And then execute:
-```bash
+And executing:
+
+``` bash
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install turnstiled
+### Configuration
+
+Create a file called `config/initializers/turnstiled.rb` and add the following:
+
+``` ruby
+Turnstiled.configure do |config|
+  config.api_key = "YOUR_API_KEY"
+  config.api_secret = "YOUR_API_SECRET"
+end
 ```
 
-## Contributing
-Contribution directions go here.
+In your layout, add the widget to the head of the document:
+
+``` erb
+<%= turnstiled_javascript_tag %>
+```
+
+In test and development, it will include a mock widget that fires the callback after 2 seconds.
+
+The mock widget will send the `cf-turnstile-response` parameter with a value of `1`.
+
+In your controller, you also need to verify the response with the following:
+
+``` ruby
+class PostsController < ApplicationController
+  verify_turnstile_requwst only: %i[create]
+end
+```
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The `verify_turnstile_requwst` takes the same options as a `before_action` method call.

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/turnstiled/engine.rb

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

data/lib/turnstiled/verifier.rb

@@ -3,15 +3,15 @@
 module Turnstiled
   class Verifier
     def verify(request)
-      return request.params['cf-turnstile-response'] == '1' if Turnstiled.mock
+      return request.params["cf-turnstile-response"] == "1" if Turnstiled.mock
 
-      response = client.post('siteverify', {
+      response = client.post("siteverify", {
         secret: Turnstiled.site_secret,
-        response: request.params['cf-turnstile-response'],
-        remoteip: request.remote_ip,
+        response: request.params["cf-turnstile-response"],
+        remoteip: request.remote_ip
       })
 
-      response.body.fetch('success', false)
+      response.body.fetch("success", false)
     end
 
     def client
@@ -23,10 +23,10 @@ module Turnstiled
 
     def client_options
       {
-        url: 'https://challenges.cloudflare.com/turnstile/v0',
+        url: "https://challenges.cloudflare.com/turnstile/v0",
         request: {
-          timeout: 3,
-        },
+          timeout: 3
+        }
       }
     end
   end

data/lib/turnstiled/version.rb

@@ -1,3 +1,3 @@
 module Turnstiled
-  VERSION = "0.1.0"
+  VERSION = File.read(File.expand_path("../../../VERSION", __FILE__)).strip
 end

data/lib/turnstiled/view_helper.rb

@@ -2,28 +2,28 @@
 
 module Turnstiled
   module ViewHelper
-    def turnstile_tag(size: 'compact', **options)
+    def turnstile_tag(size: "compact", **options)
       options = options.deep_merge(
         class: "cf-turnstile #{options[:class]}",
         data: {
           sitekey: Turnstiled.site_key,
-          controller: 'turnstile',
+          controller: "turnstile",
           turnstile_site_key_value: Turnstiled.site_key,
-          size:,
+          size:
         }
       )
 
-      content_tag(:div, '', options)
+      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' })
+        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',
+        javascript_include_tag("https://challenges.cloudflare.com/turnstile/v0/api.js?render=explicit",
                                defer: true,
                                data: {
-                                 turbo_track: 'reload',
+                                 turbo_track: "reload"
                                })
       end
     end

data/lib/turnstiled.rb

@@ -2,9 +2,9 @@ require "turnstiled/version"
 require "turnstiled/engine"
 
 module Turnstiled
-  autoload :ControllerMethods, 'turnstiled/controller_methods'
-  autoload :ViewHelper, 'turnstiled/view_helper'
-  autoload :Verifier, 'turnstiled/verifier'
+  autoload :ControllerMethods, "turnstiled/controller_methods"
+  autoload :ViewHelper, "turnstiled/view_helper"
+  autoload :Verifier, "turnstiled/verifier"
 
   mattr_accessor :site_key
   mattr_accessor :site_secret

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: turnstiled
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Displayful
 - Henrik Hauge Bjørnskov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2025-02-25 00:00:00.000000000 Z
@@ -15,22 +15,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 7.0.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.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::Version
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -45,7 +45,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - hb@displayful.co
 executables: []
@@ -55,6 +55,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- VERSION
 - app/assets/config/turnstiled/manifest.js
 - app/javascript/turnstiled/controllers/turnstile_controller.js
 - app/javascript/turnstiled/mock_turnstile_widget.js
@@ -69,7 +70,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,8 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Cloudflare Turnstile for Rails
 test_files: []