action_auth 0.2.8 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8811e289816e2dfabd2b7437b6f877abd02064151218f3be79ef05572ccfd4a
-  data.tar.gz: be2a7a8b5e8f63c9f6b5f76e04a828f2ac05974f8fd2ba19a244e562ef92eca1
+  metadata.gz: 66dba288eaf6e2910d810a8109c454756234feadc58f817347e61112383c5bd8
+  data.tar.gz: c90e89c2ea39cac613776d91a3d0b827b393e7e7632c71d2380705949b591606
 SHA512:
-  metadata.gz: c78ba18c296297ec6057ee91b0b9ed5d28813e2cd4f0786a297064f79105877b30730d64ee41743c42402027457971e121ba8913d74ce975a9a2a05498a26ce5
-  data.tar.gz: 66dfffe305815384216de8ebe9beb6d2195050a4a28d231c432aa1b92d80bca87cac4056685fe3cdfa1bfd63829265f20a468385757d25e8c4de2a13ca4dd8b9
+  metadata.gz: ea654d512bb836d4a4f148fc8a4ac21770b9654bd4f465fde624d654d1fe53e6c776f0046b0a24f5e407a849b1ed07adadd3be6a4d94a3f95092067a1b63dd66
+  data.tar.gz: 4f56bf4c79c9adc8229d474c2b55ad3848e72f68c765ce0806e441415d0961838101a96b5732dc55f7d0fdd5b921e62e64813ded0b58990cb8c81e8e3cb6d5b5

data/README.md

@@ -7,6 +7,21 @@ user experience akin to that offered by the well-regarded Devise gem.
 
 [![Ruby](https://github.com/kobaltz/action_auth/actions/workflows/test.yml/badge.svg)](https://github.com/kobaltz/action_auth/actions/workflows/test.yml)
 
+## Table of Contents
+1. [Introduction](#introduction)
+2. [Installation](#installation)
+3. [Features](#features)
+4. [Usage](#usage)
+   - [Routes](#routes)
+   - [Helper Methods](#helper-methods)
+   - [Restricting and Changing Routes](#restricting-and-changing-routes)
+5. [WebAuthn](#webauthn)
+6. [Within Your Application](#within-your-application)
+7. Customizing
+   - [Sign In Page](https://github.com/kobaltz/action_auth/wiki/Overriding-Sign-In-page-view)
+7. [License](#license)
+8. [Credits](#credits)
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -33,6 +48,13 @@ In your view layout
 <% end %>
 ```
 
+If you're using something like importmaps and plain css, then you may need to add the lines below to your `app/assets/config/manifest.js` file.
+
+```javascript
+//= link action_auth/application.css
+//= link action_auth/application.js
+```
+
 See [WebAuthn](#webauthn) for additional configuration steps if you want to enable WebAuthn.
 In your `config/initializers/action_auth.rb` file, you can add the following configuration
 settings.
@@ -114,8 +136,10 @@ can create a constraint to restrict access to these routes.
       end
 
       def self.current_user(request)
-        session_token = request.cookie_jar.signed[:session_token]
-        ActionAuth::Session.find_by(id: session_token)&.action_auth_user
+         session_token = request.cookie_jar.signed[:session_token]
+         session = ActionAuth::Session.find_by(id: session_token)
+         return nil unless session.present?
+         session.action_auth_user&.becomes(User)
       end
     end
 
@@ -150,7 +174,7 @@ 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.
 
-### Configuration
+#### Configuration
 
 The migrations are already copied over to your application when you run
 `bin/rails action_auth:install:migrations`. There are only two steps that you have to take to enable
@@ -185,6 +209,74 @@ Here's a view of the experience with WebAuthn
 
 ![action_auth](https://github.com/kobaltz/action_auth/assets/635114/fa88d83c-5af5-471b-a094-ec9785ea2f87)
 
+## Within Your Application
+
+It can be cumbersome to have to reference ActionAuth::User within the application as well as in the
+relationships between models. Luckily, we can use ActiveSupport::CurrentAttributes to make this
+process easier as well as inheritance of our models.
+
+#### Setting up the User model
+
+```ruby
+# app/models/user.rb
+class User < ActionAuth::User
+  has_many :posts, dependent: :destroy
+end
+```
+
+#### Setting up the Current model
+
+We can set the user to become a User record instead of an ActionAuth::User record. This will then allow `Current.user.posts` to work.
+
+```ruby
+# app/models/current.rb
+class Current < ActiveSupport::CurrentAttributes
+  def user
+    return unless ActionAuth::Current.user
+    ActionAuth::Current.user.becomes(User)
+  end
+end
+```
+
+#### Generating an association
+
+There's one little gotcha when generating the associations. We are using `user:belongs_to` instead of
+`action_auth_user:belongs_to`. However, when the foreign key is generated, it will look for the users table
+instead of the action_auth_users table. To get around this, we'll need to modify the migration.
+
+```bash
+bin/rails g scaffold posts user:belongs_to title
+```
+
+We can update the `foreign_key` from `true` to `{ to_table: :action_auth_users }` to get around this.
+
+```ruby
+# db/migrate/XXXXXXXXXXX_create_posts.rb
+class CreatePosts < ActiveRecord::Migration[7.1]
+  def change
+    create_table :posts do |t|
+      t.belongs_to :user, null: false, foreign_key: { to_table: :action_auth_users }
+      t.string :title
+
+      t.timestamps
+    end
+  end
+end
+```
+
+And the post model doesn't need anything special to ActionAuth.
+
+```ruby
+# app/models/post.rb
+class Post < ApplicationRecord
+  belongs_to :user
+end
+```
+
+#### Using the Current model
+
+Now, you'll be able to do things like `Current.user` and `Current.user.posts` within your application. However, I recommend that you still use
+the helpers around `user_signed_in?` to verify that the `ActionAuth::Current.user` is not nil (or nil if they are signed out). This will help ensure that any thread safety issues are avoided.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -193,5 +285,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Credits
 
 ❤️ Heavily inspired by [Drifting Ruby #300](https://www.driftingruby.com/episodes/authentication-from-scratch)
-and [Authentication Zero](https://github.com/lazaronixon/authentication-zero) and WebAuthn work from
+and [Authentication Zero](https://github.com/lazaronixon/authentication-zero) and
 [cedarcode](https://www.cedarcode.com/).

data/app/controllers/action_auth/sessions_controller.rb

@@ -2,9 +2,9 @@ module ActionAuth
   class SessionsController < ApplicationController
     before_action :set_current_request_details
     before_action :authenticate_user!, only: [:index, :destroy]
-    layout "action_auth/application-full-width", only: :index
 
     def index
+      @action_auth_wide = true
       @sessions = Current.user.action_auth_sessions.order(created_at: :desc)
     end
 

data/app/models/action_auth/user.rb

@@ -5,7 +5,7 @@ module ActionAuth
     has_many :action_auth_sessions, dependent: :destroy,
       class_name: "ActionAuth::Session", foreign_key: "action_auth_user_id"
 
-    if ActionAuth.configuration&.webauthn_enabled?
+    if ActionAuth.configuration.webauthn_enabled?
       has_many :action_auth_webauthn_credentials, dependent: :destroy,
         class_name: "ActionAuth::WebauthnCredential", foreign_key: "action_auth_user_id"
     end

data/app/views/action_auth/identity/password_resets/new.html.erb

@@ -13,7 +13,9 @@
 <% end %>
 
 <div class="mb-3">
-  <%= link_to "Sign In", sign_in_path %> |
-  <%= link_to "Sign Up", sign_up_path %> |
-  <%= link_to "Verify Email", identity_email_verification_path %>
+  <%= link_to "Sign In", sign_in_path %>
+  | <%= link_to "Sign Up", sign_up_path %>
+  <% if ActionAuth.configuration.verify_email_on_sign_in %>
+    | <%= link_to "Verify Email", identity_email_verification_path %>
+  <% end %>
 </div>

data/app/views/action_auth/registrations/new.html.erb

@@ -36,6 +36,8 @@
 
 <div class="mb-3">
   <%= link_to "Sign In", sign_in_path %> |
-  <%= link_to "Reset Password", new_identity_password_reset_path %> |
-  <%= link_to "Verify Email", identity_email_verification_path %>
+  <%= link_to "Reset Password", new_identity_password_reset_path %>
+  <% if ActionAuth.configuration.verify_email_on_sign_in %>
+    | <%= link_to "Verify Email", identity_email_verification_path %>
+  <% end %>
 </div>

data/app/views/action_auth/sessions/index.html.erb

@@ -21,15 +21,15 @@
         <%= content_tag :tr, id: dom_id(session) do %>
           <td><%= session.user_agent %></td>
           <td nowrap><%= session.ip_address %></td>
-          <td nowrap><%= session.created_at %></td>
-          <td nowrap><%= button_to "Log out", session, method: :delete, class: "btn btn-primary" %></td>
+          <td><%= session.created_at %></td>
+          <td><%= button_to "Log out", session, method: :delete, class: "btn btn-primary" %></td>
         <% end %>
       <% end %>
     </tbody>
   </table>
 </div>
 
-<% if ActionAuth.configuration&.webauthn_enabled? %>
+<% if ActionAuth.configuration.webauthn_enabled? %>
   <% if current_user.second_factor_enabled? %>
     <h3>Your Security Keys:</h3>
     <table class="action-auth--table">

data/app/views/action_auth/sessions/new.html.erb

@@ -21,6 +21,8 @@
 
 <div class="mb-3">
   <%= link_to "Sign Up", sign_up_path %> |
-  <%= link_to "Reset Password", new_identity_password_reset_path %> |
-  <%= link_to "Verify Email", identity_email_verification_path %>
+  <%= link_to "Reset Password", new_identity_password_reset_path %>
+  <% if ActionAuth.configuration.verify_email_on_sign_in %>
+    | <%= link_to "Verify Email", identity_email_verification_path %>
+  <% end %>
 </div>

data/app/views/layouts/action_auth/application.html.erb

@@ -2,18 +2,19 @@
 <html>
 <head>
   <title>Action Auth</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
   <%= stylesheet_link_tag "action_auth/application", media: "all" %>
   <%= javascript_include_tag "action_auth/application", "data-turbo-track": "reload", type: "module" %>
-  <% if ActionAuth.configuration&.webauthn_enabled? %>
+  <% if ActionAuth.configuration.webauthn_enabled? %>
     <%= tag :meta, name: :webauthn_auth_url, content: action_auth.webauthn_credential_authentications_url %>
     <%= tag :meta, name: :webauthn_cred_url, content: action_auth.webauthn_credentials_url %>
     <%= tag :meta, name: :webauthn_redirect_url, content: action_auth.sessions_url %>
   <% end %>
 </head>
 <body class="bg-light">
-  <div class="container bg-white border pb-3">
+  <div class="<%= defined?(@action_auth_wide) ? 'container-fluid' : 'container' %> bg-white border pb-3">
     <%= yield %>
   </div>
   <div class="action-auth--text-center">

data/config/routes.rb

@@ -11,7 +11,7 @@ ActionAuth::Engine.routes.draw do
     resource :password_reset,     only: [:new, :edit, :create, :update]
   end
 
-  if ActionAuth.configuration&.webauthn_enabled?
+  if ActionAuth.configuration.webauthn_enabled?
     resources :webauthn_credentials, only: [:new, :create, :destroy] do
       post :options, on: :collection, as: 'options_for'
     end

data/lib/action_auth/version.rb

@@ -1,3 +1,3 @@
 module ActionAuth
-  VERSION = "0.2.8"
+  VERSION = "0.2.10"
 end

data/lib/action_auth.rb

@@ -4,11 +4,14 @@ require "action_auth/configuration"
 
 module ActionAuth
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
     def configure
-      self.configuration ||= Configuration.new
-      yield(configuration)
+      yield(configuration) if block_given?
       configure_webauthn
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_auth
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.10
 platform: ruby
 authors:
 - Dave Kimura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-14 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -83,7 +83,6 @@ files:
 - app/views/action_auth/user_mailer/password_reset.text.erb
 - app/views/action_auth/webauthn_credential_authentications/new.html.erb
 - app/views/action_auth/webauthn_credentials/new.html.erb
-- app/views/layouts/action_auth/application-full-width.html.erb
 - app/views/layouts/action_auth/application.html.erb
 - app/views/layouts/action_auth/mailer.html.erb
 - app/views/layouts/action_auth/mailer.text.erb
@@ -121,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: A simple Rails engine for authorization.

data/app/views/layouts/action_auth/application-full-width.html.erb

@@ -1,20 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Action Auth</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-  <%= stylesheet_link_tag "action_auth/application", media: "all" %>
-  <%= javascript_include_tag "action_auth/application", "data-turbo-track": "reload", type: "module" %>
-  <% if ActionAuth.configuration&.webauthn_enabled? %>
-    <%= tag :meta, name: :webauthn_auth_url, content: action_auth.webauthn_credential_authentications_url %>
-    <%= tag :meta, name: :webauthn_cred_url, content: action_auth.webauthn_credentials_url %>
-    <%= tag :meta, name: :webauthn_redirect_url, content: action_auth.sessions_url %>
-  <% end %>
-</head>
-<body class="bg-light">
-  <div class="container-fluid bg-white border pb-3">
-    <%= yield %>
-  </div>
-</body>
-</html>