altcha-rails 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90110a4f6b3610f15fc055ff3112584ebbce5d95c83bef42edbe1231c8ea8bfa
-  data.tar.gz: 57b70648aca748843334555ef4248b797ec0a4c8afcdb80bdd5e838dd3a147e4
+  metadata.gz: 166ab2cdd6732e309f96c332d0483bcb16f984697f6f56ffab78357635aaccc3
+  data.tar.gz: baa9cf000ae61e2a1da2e3571827ff318d046ca3707e0341c6a6c036718b9278
 SHA512:
-  metadata.gz: 521a8e5a81fa59babb816ea1ff8b352f57362af59744b01cab0dcb176fd458e899410d7273cd633fe4a8fac4cbce9bda0858b47193c5f1a916c0c51d41158561
-  data.tar.gz: fcbf3c2d8cddaf1dd3e46e101df6334ab32b17ff2ca1da01a7b873a7ff9030f84730756c420f06b75e1ef4b826857ec27dabbc20bf3e7f3379633ee46fb15923
+  metadata.gz: 554a2a258ad6e498034ae21d82788ca50b93543fcdfe086cc346b270c8ebc35a7c44702a30bf3ca0d618ac3b38c0943f04099b47a34c37ad33c8f5a2e1555b11
+  data.tar.gz: 9acd0d3bedda678efb8480d9d4935cdc1e1d8f97455eeba40e4dbb692e9753a5d9662ce0d05f841f98af2d2288aa6102267e93765d6873df2c12d59d1b4be0f2

data/README.md

@@ -4,7 +4,7 @@
 
 [ALTCHA](https://altcha.org/) is a protocol designed for safeguarding against spam and abuse by utilizing a proof-of-work mechanism. This protocol comprises both a client-facing widget and a server-side verification process.
 
-`altcha-ruby` is a Ruby gem that provides a simple way to integrate ALTCHA into your Ruby on Rails application.
+`altcha-rails` is a Ruby gem that provides a simple way to integrate ALTCHA into your Ruby on Rails application.
 
 The main functionality of the gem is to generate a challenge and verify the response from the client. This is done in the library code. An initializer and a controller is installed in the host application to handle the challenge generation and verification.
 
@@ -13,14 +13,14 @@ The main functionality of the gem is to generate a challenge and verify the resp
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'altcha-ruby'
+gem 'altcha-rails'
 ```
 
 Then execute `bundle install` to install the gem for your application.
 
 Next, run the generator to install the initializer and the controller:
 
-```bash
+```
 $ rails generate altcha:install
       create  app/models/altcha_solution.rb
       create  app/controllers/altcha_controller.rb
@@ -31,6 +31,8 @@ $ rails generate altcha:install
 
 This will create an initializer file at `config/initializers/altcha.rb` and a controller at `app/controllers/altcha_controller.rb` as well as a route in `config/routes.rb` and a model at `app/models/altcha-solutions.rb` (see below).
 
+You will also have to run 'rails db:migrate` to apply pending changes to the database.
+
 ## Configuration
 
 The initializer file `config/initializers/altcha.rb` contains the following configuration options:
@@ -45,7 +47,7 @@ end
 ```
 
 The `algorithm` option specifies the hashing algorithm to use and must currently be set to `SHA-256`.
-It is crucial change the `hmac_key` to a secure value. This key is used to sign the challenge and the response,
+It is crucial change the `hmac_key` to a random value. This key is used to sign the challenge and the response,
 so it must be treated as a secret within your application.
 The `num_range` option specifies the range of numbers to use in the challenge and determines the difficulty of the proof-of-work.
 For an explanation of the `timeout` option see below.
@@ -65,31 +67,35 @@ To also guard against replay attacks within the configured `timeout` period, the
 store completed responses. A unique constraint is added to the database to prevent the same response from being stored.
 
 As these stored solutions are useless after the `timeout` period, the `AltchaSolution.cleanup` convenience function
-should be called regularly.
+should be called regularly to purge outdates soltutions from the database.
 
 ## Usage
 
 You need to include the ALTCHA javascript widget in your application's asset pipeline. This is not done by the gem
 at this point. Read up on the [ALTCHA documentation](https://altcha.org/docs/website-integration) for more information.
 
-Add then following code to the form you want to protect:
+Then add the following code to the form you want to protect:
 
 ```erb
 <altcha-widget challengeurl="<%= altcha_url() %>"></altcha-widget>
 ```
 
-The widget will create a hidden input field with the name `altcha` and the response to the challenge as its value.
+Once the user clicks the checkbox, the widget will send a request to the server to get a new challenge.
+When the user-side code inside the widget found the solution to the challenge, the spinner will stop
+and a hidden input field with the name `altcha` will be created in the form to convey the solution as
+base64 encoded JSON dictionary.
 
 In the controller that handles the form submission, you can verify the response with the following code:
 
 ```ruby
 def create
-  @model = Model.new(model_params)
+  @model = Model.create(model_params)
 
-unless AltchaSolution.verify_and_save(params.permit(:altcha)[:altcha])
-  flash.now[:alert] = 'ALTCHA verification failed.'
-  render :new
-  return
+  unless AltchaSolution.verify_and_save(params.permit(:altcha)[:altcha])
+    flash.now[:alert] = 'ALTCHA verification failed.'
+    render :new, status: :unprocessable_entity
+    return
+  end
 
   # ...
 end

data/altcha-rails.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "altcha-rails"
-  s.version = "0.0.5"
+  s.version = "0.0.6"
   s.authors = ["Daniel Mack"]
   s.homepage = "https://github.com/zonque/altcha-rails"
   s.metadata = { "source_code_uri" => "https://github.com/zonque/altcha-rails" }

data/lib/generators/altcha/install/templates/migrations/create_altcha_solutions.rb.erb

@@ -10,6 +10,6 @@ class CreateAltchaSolutions < ActiveRecord::Migration[<%= ActiveRecord::Migratio
       t.timestamps
     end
 
-    add_index :altcha_solutions, [ :algorithm, :challenge, :salt, :signature, :number ], unique: true
+    add_index :altcha_solutions, [ :algorithm, :challenge, :salt, :signature, :number ], unique: true, name: 'index_altcha_solutions'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: altcha-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Daniel Mack
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies: []
 description: ALTCHA is a free, open-source CAPTCHA alternative that protects your
   website from spam and abuse