turnstiled 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da753c2bafbc45fa1b878958ab03e1131979c8cfa0299a0bb2cbdd48594da72b
-  data.tar.gz: 7f6a09f9e461ca65f612d1a5e1dc3259b6a88d70f6c542f42a85ad13b3b93845
+  metadata.gz: ed188fe3df0cb80cc0c7dccd9d16f757c911997357c3e203588cfb4b6a9034bd
+  data.tar.gz: 156a94a657896e935cd94dcdb03a1172838697fe078f2caa2dd57e96410926ba
 SHA512:
-  metadata.gz: 99c3f6895fa3817093d3a3eb35da430d0877b49dcaf0e80b6a08524bb9552920fcdff7d7355525d5513ca370fba4a74cc8405a65d68951a0710a3c0aa53521bd
-  data.tar.gz: 802b6644f991b9fa2875bff02422f0865bdab972b320472c09cb4d50df3fcb85834c5b720cf1538e2f4f598fd2be3a45733e2727ce2b4ce9961c320ca5679d98
+  metadata.gz: '0483bcfdf269c1bd3a3a03d28487d191f689cc3144269383330b6266a62e5290ab9dbbf1295b9e74f453df3a6162d88651656a59c5b991cba6a415c53472447d'
+  data.tar.gz: d5011bde496d6bd7578dbfaff2d830c25acd3309bc9b4f793045ec3f627fe3f7a7f725ecaa1086c65454ecd7e25e34078c643df7732541dd5fd4606e5f1d81fc

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/lib/turnstiled/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turnstiled
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Displayful