verify_it 0.4.1.beta → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f2e332e6a7ecae4c16eaf2232cb6f5826c26cd1a5c3de98c98a7cf0f1bf9968
-  data.tar.gz: 14e43962ebc0e2b2ca553324aadb0780aa1c2e6b22f4d4a1c6c9ab7fad285442
+  metadata.gz: '0638bdc85958eb337d3239d426d9b68a640d1130614406711dad37c1da11c7a2'
+  data.tar.gz: 7c40e0432c8e2627c26cbfac91b32f13358fa13a476cb22bc922d3fa1d5db897
 SHA512:
-  metadata.gz: cc77c48de4632d3c129dcd3b3f614e909107d906dd3bdbf66d3d0771eb3609a3978916c318ccdaef873544b50f64f1a6be411f5554a8a882b1ec681eda4c0e8e
-  data.tar.gz: ecff61e7e94a7aaf27bf91f7ea0e13635c64dcde5413054077d366a8f36e2dd546bb049c18939374885675a8f5fdb9fe714ba82d4cd3caca3f875fe3245a9362
+  metadata.gz: 159d3ae1264b6095b229c4d5d24a925074c1a49c7be7894b44d1c9a8dfb5f87e840f569f5b54ba9d6b968d3092d34dfe1e9d2d5fb608101d1a730c75f572421d
+  data.tar.gz: 46c8621291849844500dfb31753870e7d7de574dbb178c1db318fe64a680cf612110361b162479cb5521047f319d8e609443f5f1f1a7d022a26d5cd0ec8c0fd5

data/CHANGELOG.md

@@ -1,14 +1,42 @@
-## [Unreleased]
+## [0.4.2] - 2026-03-21
 
 ### Added
 - `on_verify_success` callback now receives `request:` as an optional keyword argument,
   enabling apps to access HTTP context (e.g. set session) at verification time.
-  Thread: `VerifyIt.verify_code(request:)` → `Verifier#verify_code` → `handle_verification_success`.
   Existing proc-based callbacks are unaffected (procs ignore unknown keyword args);
   lambda-based callbacks should add `request: nil` to their signature.
+- `Verifiable#verify_{channel}_code` now accepts an optional `request:` keyword,
+  forwarding it to `on_verify_success` so the model-level API has parity with the
+  engine and the direct `VerifyIt.verify_code` call.
+- `current_record_resolver` and `identifier_resolver` are now listed in the
+  Configuration Reference table in the README.
+- Install generator accepts `--engine` flag to mount engine routes and generate
+  resolver config. Without the flag, the installer produces a minimal initializer
+  with no engine routes or resolver boilerplate.
 
 ### Changed
-- Dropped Ruby 3.1 support; minimum required Ruby is now 3.2 (due to `connection_pool >= 3.0` transitive dependency)
+- **Breaking (engine only):** `POST /verify/send` renamed to `POST /verify/request`
+  to avoid collision with Ruby's `Object#send`. Update client code that hits this
+  endpoint. The `/verify/confirm` endpoint is unchanged.
+- Dropped Ruby 3.1 support; minimum required Ruby is now 3.2 (due to `connection_pool >= 3.0` transitive dependency).
+- RuboCop `TargetRubyVersion` updated from 3.0 to 3.2 to match `required_ruby_version`.
+
+### Removed
+- Engine no longer auto-includes `VerifyIt::Verifiable` into all ActiveRecord models.
+  Add `include VerifyIt::Verifiable` explicitly in models that need it (as shown in
+  the README). This avoids polluting unrelated models with verification methods.
+- Install generator no longer unconditionally mounts the engine. Pass `--engine`
+  to opt in.
+
+### Fixed
+- Initializer template `delivery_channel` default corrected from `:email` to `:sms`.
+- Unused rescue variable in `Verifier#attempt_delivery` (RuboCop `Lint/UselessAssignment`).
+- README testing example now uses correct engine params (`channel`, `auth_headers`)
+  instead of the outdated standalone format.
+- README `on_verify_success` callback signature now includes `request: nil`.
+- Install generator mount path changed from `/verify_it` to `/verify` to match
+  README examples.
+- Initializer template `on_verify_success` callback signature now includes `request: nil`.
 
 ## [0.4.0] - 2026-03-07
 

data/README.md

@@ -35,15 +35,21 @@ bundle install
 ### 1. Generate configuration files
 
 ```bash
-bundle exec verify_it install
+rails generate verify_it:install --storage=redis
 ```
 
-The installer will ask you to choose a storage backend and generate:
+The installer generates:
 
 - `config/initializers/verify_it.rb` — your main configuration
-- A database migration (if you chose Database storage)
+- A database migration (if you chose `--storage=database`)
 
-If you chose Database storage, run:
+Pass `--engine` to also mount the engine routes and generate resolver config:
+
+```bash
+rails generate verify_it:install --storage=redis --engine
+```
+
+If you chose database storage, run:
 
 ```bash
 rails db:migrate
@@ -187,8 +193,10 @@ VerifyIt.cleanup(to: "+15551234567", record: current_user)
 
 ## Rails Engine (HTTP Endpoints)
 
-VerifyIt ships a mountable Rails Engine that exposes two JSON endpoints. This is
-optional, if you prefer to not use the engine, skip to the next section.
+VerifyIt ships a mountable Rails Engine that exposes two JSON endpoints. Use the
+engine when you want drop-in endpoints without writing controller code. This is
+optional - skip this section if you prefer to handle verification in your own
+controllers using the `Verifiable` concern or the plain Ruby API.
 
 ### Mount the engine
 
@@ -201,7 +209,7 @@ This adds two routes:
 
 | Method | Path | Action |
 |---|---|---|
-| POST | `/verify/send` | Send a verification code |
+| POST | `/verify/request` | Send a verification code |
 | POST | `/verify/confirm` | Confirm a verification code |
 
 ### Configure the resolvers
@@ -240,7 +248,7 @@ end
 **Send a code:**
 
 ```bash
-POST /verify/send
+POST /verify/request
 Content-Type: application/json
 
 { "channel": "sms" }
@@ -297,11 +305,14 @@ en:
 | `max_verification_attempts` | `5` | Integer |
 | `max_identifier_changes` | `5` | Integer |
 | `rate_limit_window` | `3600` | Seconds (integer) |
+| `delivery_channel` | `:sms` | `:sms`, `:email` |
 | `sms_sender` | `nil` | Lambda `(to:, code:, context:) { }` |
 | `email_sender` | `nil` | Lambda `(to:, code:, context:) { }` |
 | `on_send` | `nil` | Lambda `(record:, identifier:, channel:) { }` |
-| `on_verify_success` | `nil` | Lambda `(record:, identifier:) { }` |
+| `on_verify_success` | `nil` | Lambda `(record:, identifier:, request: nil) { }` |
 | `on_verify_failure` | `nil` | Lambda `(record:, identifier:, attempts:) { }` |
+| `current_record_resolver` | `nil` | Lambda `(request) { }` — required when mounting the engine |
+| `identifier_resolver` | `nil` | Lambda `(record, channel) { }` — required when mounting the engine |
 | `namespace` | `nil` | Lambda `(record) { }` returning a string or nil |
 | `test_mode` | `false` | Boolean — exposes `result.code` |
 | `bypass_delivery` | `false` | Boolean — skips actual delivery |
@@ -313,7 +324,7 @@ config.on_send = ->(record:, identifier:, channel:) {
   Analytics.track("verification_sent", user_id: record.id, channel: channel)
 }
 
-config.on_verify_success = ->(record:, identifier:) {
+config.on_verify_success = ->(record:, identifier:, request: nil) {
   Analytics.track("verification_success", user_id: record.id)
 }
 
@@ -368,14 +379,14 @@ RSpec.configure do |config|
 end
 ```
 
-In a request spec:
+In a request spec (with the engine mounted):
 
 ```ruby
 it "verifies phone number" do
-  post "/verify/send", params: { phone: "+15551234567" }
+  post "/verify/request", params: { channel: "sms" }, headers: auth_headers
   code = JSON.parse(response.body)["code"]  # available in test_mode
 
-  post "/verify/confirm", params: { phone: "+15551234567", code: code }
+  post "/verify/confirm", params: { channel: "sms", code: code }, headers: auth_headers
   expect(response).to have_http_status(:ok)
 end
 ```

data/config/routes.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 VerifyIt::Engine.routes.draw do
-  post "send",    to: "verifications#create",  as: :send_verification
+  post "request", to: "verifications#create",  as: :request_verification
   post "confirm", to: "verifications#verify",  as: :confirm_verification
 end

data/lib/generators/verify_it/install/install_generator.rb

@@ -10,11 +10,13 @@ module VerifyIt
 
       source_root File.expand_path("templates", __dir__)
 
-      desc "Creates a VerifyIt initializer, mounts the engine in routes, " \
+      desc "Creates a VerifyIt initializer and optionally mounts the engine routes " \
            "and generates a migration when using database storage."
 
       class_option :storage, type: :string, default: "memory",
                              desc: "Storage backend to use: memory, redis, or database"
+      class_option :engine, type: :boolean, default: false,
+                            desc: "Mount the VerifyIt engine and generate resolver config"
 
       def self.next_migration_number(dirname)
         next_num = current_migration_number(dirname) + 1
@@ -26,7 +28,9 @@ module VerifyIt
       end
 
       def mount_engine
-        route 'mount VerifyIt::Engine, at: "/verify_it"'
+        return unless options[:engine]
+
+        route 'mount VerifyIt::Engine, at: "/verify"'
       end
 
       def generate_migration

data/lib/generators/verify_it/install/templates/initializer.rb.erb

@@ -23,24 +23,27 @@ VerifyIt.configure do |config|
     # e.g. Twilio, Vonage, etc.
   }
 
-  # Required: resolve the current authenticated record from a request.
+<% if options[:engine] -%>
+  # Required when mounting the engine (VerifyIt::Engine):
+  # Resolve the current authenticated record from a request.
   config.current_record_resolver = ->(request) {
     # User.find_by(id: request.session[:user_id])
   }
 
-  # Required: resolve the delivery identifier (phone/email) from the record and channel.
+  # Resolve the delivery identifier (phone/email) from the record and channel.
   config.identifier_resolver = ->(record, channel) {
     # channel == :sms ? record.phone_number : record.email
   }
 
+<% end -%>
   # Optional overrides (shown with defaults):
   # config.code_length = 6
   # config.code_ttl = 300
   # config.code_format = :numeric
   # config.max_send_attempts = 3
   # config.max_verification_attempts = 5
-  # config.delivery_channel = :email
+  # config.delivery_channel = :sms
   # config.on_send = ->(record:, identifier:, channel:) {}
-  # config.on_verify_success = ->(record:, identifier:) {}
+  # config.on_verify_success = ->(record:, identifier:, request: nil) {}
   # config.on_verify_failure = ->(record:, identifier:, attempts:) {}
 end

data/lib/verify_it/engine.rb

@@ -9,11 +9,5 @@ module VerifyIt
     initializer "verify_it.i18n" do
       config.i18n.load_path += Dir[Engine.root.join("config", "locales", "**", "*.yml").to_s]
     end
-
-    initializer "verify_it.active_record" do
-      ActiveSupport.on_load(:active_record) do
-        include VerifyIt::Verifiable
-      end
-    end
   end
 end

data/lib/verify_it/verifiable.rb

@@ -30,12 +30,13 @@ module VerifyIt
           )
         end
 
-        define_method(verify_method) do |code|
+        define_method(verify_method) do |code, request: nil|
           identifier = send(attribute)
           VerifyIt.verify_code(
             to: identifier,
             code: code,
-            record: self
+            record: self,
+            request: request
           )
         end
 

data/lib/verify_it/verifier.rb

@@ -100,7 +100,7 @@ module VerifyIt
       delivery = get_delivery_adapter(channel)
       delivery.deliver(to: to, code: code, context: context)
       nil
-    rescue StandardError => e
+    rescue StandardError
       delivery_failed_result
     end
 

data/lib/verify_it/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VerifyIt
-  VERSION = "0.4.1.beta"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: verify_it
 version: !ruby/object:Gem::Version
-  version: 0.4.1.beta
+  version: 0.4.2
 platform: ruby
 authors:
 - Jeremias Ramirez