action_auth 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c85ae94ede51ba040295cfca1ec2f6a46f412642bc3e3a3ada8fd102bec41ab
-  data.tar.gz: bf218c5419f6cf1a7f8eb5b70f0cbb58f9af1710be3222ee0a333075af32e5c5
+  metadata.gz: 2199e638d124811034db20d5d3cd6f0b23d56acf260d42e18f9559bf54405295
+  data.tar.gz: ab312a35ead67087ab41cfb30f54a42696521924fb1e695870e87632742497d6
 SHA512:
-  metadata.gz: e09cef2c34868ff6e6bd0e4d81f6e5fa577d91c0b38d957f09b36aa48a2cf4a183b2ff0bc400c321eb03829aef23c3976188d108b3e9a2f6f887e2e3a86f7043
-  data.tar.gz: c3cce12a87a5bfdc1b785ed01cb2cbed07325f9e65150e4fe5e5a7b86c6f6a52f5357aad6d51510a9e87a92f389441b268462917f0ea619980d6d130bd681ad6
+  metadata.gz: 53f6e3b604bc0037a751269cd16975e243e84ebd1018419764c88a2b60a8309455736b2b7a2ec1e6b29cb2970e4e0020348756fed9658400f32d2d3a2f3b179a
+  data.tar.gz: 0ccad04b7a3e4ccbb50e80149b40d452364089600a2a5462ea2392ece13151f8903f65c491d8bd3dc5507ae6fac3ac6430ae18b0b0ac247acb434f898a3c3055

data/README.md

@@ -98,12 +98,13 @@ settings.
 
 ```ruby
 ActionAuth.configure do |config|
+  config.allow_user_deletion = true
+  config.default_from_email = "from@example.com"
+  config.magic_link_enabled = true
+  config.verify_email_on_sign_in = true
   config.webauthn_enabled = true
   config.webauthn_origin = "http://localhost:3000" # or "https://example.com"
   config.webauthn_rp_name = Rails.application.class.to_s.deconstantize
-  config.verify_email_on_sign_in = true
-  config.magic_link_enabled = true
-  config.default_from_email = "from@example.com"
 end
 ```
 
@@ -129,7 +130,7 @@ These are the planned features for ActionAuth. The ones that are checked off are
 
 ⏳ - OAuth with Google, Facebook, Github, Twitter, etc.
 
-⏳ - Account Deletion
+✅ - Account Deletion
 
 ⏳ - Account Lockout
 
@@ -213,6 +214,29 @@ they can add a Passkey to their account. The Passkey could be an iCloud Keychain
 key like a Yubikey, or a mobile device. If enabled and configured, the user will be prompted to use
 their Passkey after they log in.
 
+## Magic Links
+
+Magic Links are a way to authenticate a user without requiring a password. This is done by sending
+an email to the user with a link that will log them in. This is a great way to allow users to log in
+without having to remember a password. This is especially useful for users who may not have a password
+manager or have a hard time remembering passwords.
+
+## Account Deletion
+
+Account deletion is a feature that is enabled by default. When a user deletes their account, the account
+is marked as deleted and the user is logged out. The user will no longer be able to log in with their
+email and password. The user will need to create a new account if they wish to continue using the application.
+
+Here's an example of how you may want to add a delete account button to your application. Obviously, you
+will want to style this to fit your application and have some kind of confirmation dialog.
+
+```
+<p>
+  Unhappy with the service?
+  <%= button_to "Delete Account", action_auth.users_path, method: :delete %>
+</p>
+```
+
 #### Configuration
 
 The migrations are already copied over to your application when you run

data/app/controllers/action_auth/users_controller.rb

@@ -0,0 +1,10 @@
+module ActionAuth
+  class UsersController < ApplicationController
+    before_action :authenticate_user!
+
+    def destroy
+      Current.user.destroy
+      redirect_to main_app.root_url, notice: "Your account has been deleted."
+    end
+  end
+end

data/config/routes.rb

@@ -3,13 +3,18 @@ ActionAuth::Engine.routes.draw do
   post "sign_in", to: "sessions#create"
   get  "sign_up", to: "registrations#new"
   post "sign_up", to: "registrations#create"
-  resources :sessions, only: [:index, :show, :destroy]
-  resource  :password, only: [:edit, :update]
+
   namespace :identity do
     resource :email,              only: [:edit, :update]
     resource :email_verification, only: [:show, :create]
     resource :password_reset,     only: [:new, :edit, :create, :update]
   end
+  resource  :password, only: [:edit, :update]
+  resources :sessions, only: [:index, :show, :destroy]
+
+  if ActionAuth.configuration.allow_user_deletion?
+    resource  :users, only: [:destroy]
+  end
 
   if ActionAuth.configuration.webauthn_enabled?
     resources :webauthn_credentials, only: [:new, :create, :destroy] do

data/lib/action_auth/configuration.rb

@@ -1,29 +1,36 @@
 module ActionAuth
   class Configuration
 
+    attr_accessor :allow_user_deletion
+    attr_accessor :default_from_email
+    attr_accessor :magic_link_enabled
+    attr_accessor :verify_email_on_sign_in
     attr_accessor :webauthn_enabled
     attr_accessor :webauthn_origin
     attr_accessor :webauthn_rp_name
-    attr_accessor :verify_email_on_sign_in
-    attr_accessor :magic_link_enabled
-    attr_accessor :default_from_email
+
 
     def initialize
+      @allow_user_deletion = true
+      @default_from_email = "from@example.com"
+      @magic_link_enabled = true
+      @verify_email_on_sign_in = true
       @webauthn_enabled = defined?(WebAuthn)
       @webauthn_origin = "http://localhost:3000"
       @webauthn_rp_name = Rails.application.class.to_s.deconstantize
-      @verify_email_on_sign_in = true
-      @magic_link_enabled = true
-      @default_from_email = "from@example.com"
     end
 
-    def webauthn_enabled?
-      @webauthn_enabled.respond_to?(:call) ? @webauthn_enabled.call : @webauthn_enabled
+    def allow_user_deletion?
+      @allow_user_deletion.respond_to?(:call) ? @allow_user_deletion.call : @allow_user_deletion
     end
 
     def magic_link_enabled?
       @magic_link_enabled.respond_to?(:call) ? @magic_link_enabled.call : @magic_link_enabled
     end
 
+    def webauthn_enabled?
+      @webauthn_enabled.respond_to?(:call) ? @webauthn_enabled.call : @webauthn_enabled
+    end
+
   end
 end

data/lib/action_auth/version.rb

@@ -1,3 +1,3 @@
 module ActionAuth
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_auth
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dave Kimura
@@ -61,6 +61,7 @@ files:
 - app/controllers/action_auth/passwords_controller.rb
 - app/controllers/action_auth/registrations_controller.rb
 - app/controllers/action_auth/sessions_controller.rb
+- app/controllers/action_auth/users_controller.rb
 - app/controllers/action_auth/webauthn_credential_authentications_controller.rb
 - app/controllers/action_auth/webauthn_credentials_controller.rb
 - app/helpers/action_auth/application_helper.rb