Merge pull request #26 from Vagab/passkey-keyword-param

Add passkey keyword to `after_passkey_authentication`

CHANGELOG.md

@@ -13,6 +13,8 @@
   - https://github.com/ruby-passkeys/devise-passkeys/pull/11
 - Document `Devise::Passkeys::Model`
   - https://github.com/ruby-passkeys/devise-passkeys/pull/12
+- Add `passkey:` keyword param to `after_passkey_authentication` callback
+  - https://github.com/ruby-passkeys/devise-passkeys/pull/26
 
 ## [0.1.0] - 2023-05-07
 

README.md

@@ -35,7 +35,7 @@ class User < ApplicationRecord
     self.find_by(id: passkey.user.id)
   end
 
-  def after_passkey_authentication
+  def after_passkey_authentication(passkey:)
   end
 end
 ```

lib/devise/passkeys/model.rb

@@ -8,8 +8,10 @@ module Models
     module PasskeyAuthenticatable
       # This is a callback that is called right after a successful passkey authentication.
       #
-      # By default, it is a no-op, but you can override it in your model for any custom behavior (such as notifying users of a new login).
-      def after_passkey_authentication; end
+      # By default, it is a no-op, but you can override it in your model for any custom behavior
+      # (such as notifying the user of a new login).
+      # @param passkey [String] the passkey that was used for authentication
+      def after_passkey_authentication(passkey:); end
     end
   end
 end

lib/devise/passkeys/strategy.rb

@@ -32,7 +32,7 @@ def authenticate!
 
         if validate(resource)
           remember_me(resource)
-          resource.after_passkey_authentication
+          resource.after_passkey_authentication(passkey: passkey)
           record_passkey_use(passkey: passkey)
           success!(resource)
           return

test/devise/passkeys/controllers/test_reauthentication_controller_concern.rb

@@ -93,6 +93,7 @@ def root_path
 
     response_json = JSON.parse(response.body)
 
+    assert_equal User.after_passkey_authentication_passkey, passkey.label
     assert_equal ({ "reauthentication_token" => session["user_current_reauthentication_token"] }), response_json
     assert_nil session["user_current_reauthentication_challenge"]
   end

test/rails_app/app/active_record/user.rb

@@ -9,4 +9,11 @@ class User < ActiveRecord::Base
   has_many :passkeys, class_name: "UserPasskey", dependent: :destroy
 
   validates :sign_in_count, presence: true
+
+  cattr_accessor :after_passkey_authentication_passkey
+
+  def after_passkey_authentication(passkey:)
+    # used to check in our test if the callbacks were called
+    @@after_passkey_authentication_passkey = passkey.label
+  end
 end

test/rails_app/app/mongoid/user.rb

@@ -38,4 +38,11 @@ class User
   field :failed_attempts, type: Integer, default: 0 # Only if lock strategy is :failed_attempts
   field :unlock_token,    type: String # Only if unlock strategy is :email or :both
   field :locked_at,       type: Time
+
+  cattr_accessor :after_passkey_authentication_passkey
+
+  def after_passkey_authentication(passkey:)
+    # used to check in our test if the callbacks were called
+    @@after_passkey_authentication_passkey = passkey.label
+  end
 end