active_authentication 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8b956c6e7b16a3f007c97efaf865bd070897b57fcef56be4f6a8615c6e83b37
-  data.tar.gz: 365972997162dcbc741186117bcb43fc45c04338ce3d4c8dd7562f9ac1d9a6ea
+  metadata.gz: 6f71840fc4d08d8eb9ec344aeb3f779e276b09c9812e5a380d1e3455d4d4f29b
+  data.tar.gz: 602d85a21c8cea03d629ca0abfd3698344cb9560e376745aea5d964a6e9b9064
 SHA512:
-  metadata.gz: f3e34c5159ff44130cd296ece54c3e5ba02158f247775f0a1af856c70efdd2369bf20ccf522d5cb1dc2ec76e7f2bc37b488f5117c1f93d6cf5987a6adc9354e6
-  data.tar.gz: b7bb7d568d98831ee2d18309da36ba125ee0f2a1aa76197c2e2d37aa66d78febfe5368f63f62819802907e7aba73a205e6db6255a519a4ca96c56c29916a858c
+  metadata.gz: d4307d0af7c4d2a319f2714c1ada81b60956f5a41e7e4d11f17a917e33bf2d2bfa7eeff3d41d3c7ded2a846af2eec55937230f8db6c44c548529d4f21bd4a8a2
+  data.tar.gz: f6e78e92c1298baa72ddf0be06f2bd90553fac04ece61813b0d3829eacc0861d5028ff73200131a4b8e4df51155253f8cd016a79b426c20f50be5d558535a933

data/README.md

@@ -13,15 +13,16 @@ A pure Rails authentication solution.
 * Authenticatable: provides the standard email/password authentication. It's the only concern that can't be turned off.
 * Confirmable: allows users to confirm their email addresses.
 * Lockable: locks users after a number of failed sign in attempts.
+* MagicLinkable: allows users to sign in with a magic link.
+* Omniauthable: allows users to sign up and sign in using a third party service through Omniauth. Turned off by default.
 * Recoverable: allows users to reset their password.
 * Registerable: allows users to sign up and edit their profile.
+* Timeoutable: expires sessions after a period of inactivity. Turned off by default.
 * Trackable: tracks users sign in count, timestamps and ip addresses.
 
 Planned concerns:
 
-* MagicLinkable: to allow users to sign in with a magic link.
-* Omniauthable: to allow users to sign up and sign in using a third party service through Omniauth.
-* Timeoutable: to expire sessions after a period of inactivity.
+* Invitable: to allow users to invite other users.
 
 ## Installation
 
@@ -51,7 +52,13 @@ After installing the gem, you need to generate the `User` model. To generate it,
 $ rails generate active_authentication:install
 ```
 
-This command will generate the `User` model, add the `active_authentication` route, and generate an initializer (`config/initializers/active_authentication.rb`) where you can configure the concerns.
+This command will generate the `User` model, add the `active_authentication` route, and generate an initializer (`config/initializers/active_authentication.rb`) where you can configure the concerns. By default, this command enables all concerns. If you want to use a subset of the concerns, you can specify them:
+
+```bash
+$ rails generate active_authentication:install confirmable
+```
+
+In this example, only the confirmable concern will be enabled (along with authenticatable, which can't be turned off).
 
 You will need to set up the default url options in your `config/environments/development.rb`:
 
@@ -69,13 +76,13 @@ If you look at the `User` model (in `app/models/user.rb`), you will notice there
 
 ```ruby
 class User < ApplicationRecord
-  authenticates_with :confirmable, :lockable, :recoverable, :registerable, :trackable
+  authenticates_with :confirmable, :lockable, :recoverable, :registerable, :timeoutable, :trackable
 end
 ```
 
 Notice that `:authenticatable` is not in the list. This is because you cannot turn it off.
 
-By default, all concerns are turned on. But you can turn them off by just removing them from the list. If you plan to not use any concerns, you can replace `authenticates_with` with `authenticates`.
+By default, all concerns are turned on except omniauthable. But you can turn it on by adding it to the list, and similarly, you can turn any concern off by just removing them from the list. If you plan to not use any concerns, you can replace `authenticates_with` with `authenticates`.
 
 ### Filters and helpers
 
@@ -91,12 +98,62 @@ Then, to verify if there's an authenticated user, you can use the `user_signed_i
 
 Similarly, you can use `current_user` to access the current authenticated user.
 
+If you want to close your application entirely, you can add the before action to your application controller, in conjunction with `active_authentication_controller?`, like this:
+
+```ruby
+before_action :authenticate_user!, unless: :active_authentication_controller?
+```
+
+### Omniauthable
+
+ActiveAuthentication's implementation of OmniAuth allows you to sign in and/or sign up with your third party accounts or sign up with ActiveAuthentication and later connect your third party accounts to ActiveAuthentication's User. To accomplish this, ActiveAuthentication relies on an `Authentication` model which can be created with the `active_authentication:omniauthable` generator.
+
+To set up the omniauthable concern you must configure your OmniAuth providers as you would do with plain OmniAuth. There's no OmniAuth config in ActiveAuthentication. For example, in `config/initializers/omniauth.rb` you would set the middleware:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :facebook, ENV["FACEBOOK_APP_ID"], ENV["FACEBOOK_APP_SECRET"]
+  provider :google_oauth2, ENV["GOOGLE_CLIENT_ID"], ENV["GOOGLE_CLIENT_SECRET"]
+  # ... and any other omniauth strategies
+end
+```
+
+And then you need to run the omniauthable generator to generate the `Authentication` model:
+
+```bash
+$ rails g active_authentication:omniauthable
+```
+
+The User model has many Authentication models associated, to allow you to connect your user with multiple third party services if required.
+
+By adding the `:omniauthable` concern to your `User` model, the following routes will be added to your app:
+
+* `/auth/:provider` to redirect your users to the provider consent screen
+* `/auth/:provider/callback` to actually sign in/sign up with the given providers
+
+The sign in and sign up views will show a link to sign in or sign up with each provider you configured if and only if you set the `ActiveAuthentication.omniauth_providers` setting in your ActiveAuthentication initializer.
+
 ## Customization
 
 ### Concerns configuration
 
 When you run the `active_authentication:install` generator, an initializer will be copied to your app at `config/initializers/active_authentication.rb`. There's a section per concern where you can configure certain aspects of their behavior.
 
+### Customize registration and profile params
+
+If you add extra fields to your User model, you will likely want to allow users to fill in those fields upon registration or when editing their profile. By default, only email, password and password confirmation are allowed. To change this behavior, just add these lines to your `config/initializers/active_authentication.rb` file:
+
+```ruby
+ActiveAuthentication.configure do |config|
+  config.profile_params = ->(controller) {
+    controller.params.require(:user).permit(:first_name, :email, :last_name, :password, :password_confirmation) # first_name and last_name were added in this example
+  }
+  config.registration_params = config.profile_params
+end
+```
+
+We believe that the configuration of a gem should be placed in just one place. For this gem, it's the initializer. The `profile_params` and `registration_params` take a lambda and that lambda receives a controller. Why a lambda? and why does it take a controller? We could have allowed the params to be just an array of symbols instead of the whole `params.require.permit` call, but in edge cases you might want to post-process the required params, or call tap, or whatever. And to be able to call `params.require.permit`, you need to run this lambda in the context of the registrations controller. That's why the lambda receives the controller.
+
 ### Views
 
 The default views are good enough to get you started, but you'll want to customize them sooner than later. To copy the default views into your app, run the following command:
@@ -111,6 +168,26 @@ If you're not using all the concerns, you might want to copy only the views you
 $ rails generate active_authentication:views -v sessions
 ```
 
+### Omniauthable
+
+By default, ActiveAuthentication stores the `provider`, `uid` and `auth_data` in the `Authentication` model. There are some cases where you want to store, for example, the first name and last name in the `User` model to avoid digging into the `auth_data` hash each time. Or if you have multiple authentications, you might want to pull first and last name on registration and later allow the user to change them. To pull that data from an Authentication object at sign up, you don't really need to change the controller, instead you can add a callback to your Authentication model, like this:
+
+```ruby
+class Authentication < ApplicationRecord
+  before_validation :update_user_attributes, if: ->(auth) { auth.auth_data.present? && auth.user.present? }
+
+  private
+
+  def update_user_attributes
+    first_name, last_name = auth_data.dig("info", "first_name"), auth_data.dig("info", "last_name")
+
+    user.update first_name: first_name, last_name: last_name
+  end
+end
+```
+
+Note: this example assumes `first_name:string` and `last_name:string` have been added to the User model and are required. Optional first_name and last_name can be handled similarly.
+
 ## Contributing
 
 You can open an issue or a PR in GitHub.

data/app/controllers/active_authentication/confirmations_controller.rb

@@ -1,4 +1,4 @@
-class ActiveAuthentication::ConfirmationsController < ApplicationController
+class ActiveAuthentication::ConfirmationsController < ActiveAuthenticationController
   before_action :require_no_authentication, except: :show
   before_action :set_user, only: :show
 

data/app/controllers/active_authentication/magic_links_controller.rb

@@ -0,0 +1,28 @@
+class ActiveAuthentication::MagicLinksController < ActiveAuthenticationController
+  before_action :require_no_authentication
+  before_action :set_user, only: :show
+
+  def new
+  end
+
+  def create
+    @user = User.find_by email: params[:email]
+    @user&.send_magic_link
+
+    redirect_to root_path, notice: t(".success")
+  end
+
+  def show
+    sign_in @user
+
+    redirect_to root_url, notice: t(".success")
+  end
+
+  private
+
+  def set_user
+    @user = User.find_by_token_for :magic_link, params[:token]
+
+    redirect_to root_url, alert: t(".invalid_token") unless @user.present?
+  end
+end

data/app/controllers/active_authentication/omniauth_callbacks_controller.rb

@@ -0,0 +1,30 @@
+class ActiveAuthentication::OmniauthCallbacksController < ActiveAuthenticationController
+  def create
+    auth = request.env["omniauth.auth"]
+    provider = auth["provider"]
+
+    @authentication = Authentication.find_or_create_by uid: auth["uid"], provider: provider
+
+    @authentication.update auth_data: auth.as_json
+
+    if user_signed_in?
+      if @authentication.user == current_user
+        redirect_to root_path, notice: t(".already_linked", provider: provider)
+      else
+        @authentication.update user: current_user
+        redirect_to root_path, notice: t(".successfully_linked", provider: provider)
+      end
+    elsif @authentication.user.blank?
+      @user = User.find_or_initialize_by email: auth.dig("info", "email")
+      @user.password = SecureRandom.hex if @user.new_record?
+
+      @authentication.update user: @user
+
+      sign_in @authentication.user
+      redirect_to root_path, notice: t(".successfully_signed_up", provider: provider)
+    else
+      sign_in @authentication.user
+      redirect_to root_path, notice: t("active_authentication.sessions.create.success")
+    end
+  end
+end

data/app/controllers/active_authentication/passwords_controller.rb

@@ -1,4 +1,4 @@
-class ActiveAuthentication::PasswordsController < ApplicationController
+class ActiveAuthentication::PasswordsController < ActiveAuthenticationController
   before_action :require_no_authentication
   before_action :set_user, only: [:edit, :update]
 

data/app/controllers/active_authentication/registrations_controller.rb

@@ -1,4 +1,4 @@
-class ActiveAuthentication::RegistrationsController < ApplicationController
+class ActiveAuthentication::RegistrationsController < ActiveAuthenticationController
   before_action :require_no_authentication, only: [:new, :create]
   before_action :authenticate_user!, only: [:edit, :update, :destroy]
 
@@ -7,7 +7,7 @@ class ActiveAuthentication::RegistrationsController < ApplicationController
   end
 
   def create
-    @user = User.new user_params
+    @user = User.new registration_params
 
     if @user.save
       sign_in @user
@@ -21,7 +21,7 @@ class ActiveAuthentication::RegistrationsController < ApplicationController
   end
 
   def update
-    if current_user.update(user_params)
+    if current_user.update(profile_params)
       redirect_to edit_profile_path, notice: t(".success")
     else
       render :edit, status: :unprocessable_entity
@@ -36,7 +36,11 @@ class ActiveAuthentication::RegistrationsController < ApplicationController
 
   private
 
-  def user_params
-    params.require(:user).permit(:email, :password, :password_confirmation)
+  def profile_params
+    ActiveAuthentication.profile_params.call self
+  end
+
+  def registration_params
+    ActiveAuthentication.registration_params.call self
   end
 end

data/app/controllers/active_authentication/sessions_controller.rb

@@ -1,4 +1,4 @@
-class ActiveAuthentication::SessionsController < ApplicationController
+class ActiveAuthentication::SessionsController < ActiveAuthenticationController
   include ActiveSupport::Callbacks
 
   before_action :require_no_authentication, except: :destroy

data/app/controllers/active_authentication/unlocks_controller.rb

@@ -1,4 +1,4 @@
-class ActiveAuthentication::UnlocksController < ApplicationController
+class ActiveAuthentication::UnlocksController < ActiveAuthenticationController
   before_action :require_no_authentication
   before_action :set_user, only: :show
 

data/app/controllers/active_authentication_controller.rb

@@ -0,0 +1,2 @@
+class ActiveAuthenticationController < ApplicationController
+end

data/app/mailers/active_authentication/mailer.rb

@@ -6,6 +6,12 @@ module ActiveAuthentication
       mail to: @user.unconfirmed_email
     end
 
+    def magic_link
+      @token, @user = params[:token], params[:user]
+
+      mail to: @user.email
+    end
+
     def password_reset_instructions
       @token, @user = params[:token], params[:user]
 

data/app/views/active_authentication/magic_links/new.html.erb

@@ -0,0 +1,14 @@
+<h1 class="text-4xl font-bold"><%=t ".send_magic_link" %></h1>
+
+<%= form_with url: magic_links_path, data: {turbo: false} do |form| %>
+  <div>
+    <%= form.label :email, t("activerecord.attributes.user.email") %>
+    <%= form.email_field :email %>
+  </div>
+
+  <div>
+    <%= form.submit t(".send_magic_link") %>
+  </div>
+<% end %>
+
+<%= render "active_authentication/shared/links" %>

data/app/views/active_authentication/mailer/magic_link.html.erb

@@ -0,0 +1,5 @@
+<p><%=t ".hello", email: @user.email %></p>
+
+<p><%=t ".magic_link_below" %></p>
+
+<p><%= link_to t(".sign_in"), magic_link_url(token: @token) %></p>

data/app/views/active_authentication/shared/_links.html.erb

@@ -2,10 +2,20 @@
   <p><%= link_to t(".sign_in"), new_session_path %></p>
 <% end %>
 
+<% if controller_name != "magic_links" %>
+  <p><%= link_to t(".send_magic_link"), new_magic_link_path %></p>
+<% end %>
+
 <% if User.registerable? && controller_name != "registrations" %>
   <p><%= link_to t(".sign_up"), new_registration_path %></p>
 <% end %>
 
+<% if User.omniauthable? && (controller_name == "sessions" || controller_name == "registrations") %>
+  <% ActiveAuthentication.omniauth_providers.each do |provider| %>
+    <p><%= link_to t(".sign_in_or_sign_up_with", provider: provider), omniauth_path(provider) %></p>
+  <% end %>
+<% end  %>
+
 <% if User.recoverable? && controller_name != "registrations" && controller_name != "passwords" %>
   <p><%= link_to t(".reset_password"), new_password_path %></p>
 <% end %>

data/config/locales/en.yml

@@ -14,13 +14,28 @@ en:
       already_signed_in: You are already signed in.
       form_errors: "%{errors} prohibited this user from being saved:"
       locked: Your account has been locked after %{count} failed attempts. Unlock instructions will be sent to your email.
+      timedout: Your session expired. Sign in again to continue.
       unauthenticated: You need to sign in or sign up before continuing.
+    magic_links:
+      create:
+        success: Magic link will be sent to your email.
+      new:
+        send_magic_link: Send magic link
+      set_user:
+        invalid_token: Magic link is invalid.
+      show:
+        success: Signed in successfully.
     mailer:
       email_confirmation_instructions:
         confirm_email: Confirm my account
         confirm_email_below: 'You can confirm your account email by clicking the link below:'
         hello: Hello, %{email}!
         subject: Confirmation instructions
+      magic_link:
+        hello: Hello, %{email}!
+        magic_link_below: 'You can sign in to your account by clicking the link below:'
+        sign_in: Sign in
+        subject: Magic link
       password_reset_instructions:
         hello: Hello, %{email}!
         reset_password: Reset your password
@@ -31,6 +46,11 @@ en:
         subject: Unlock instructions
         unlock: Unlock your account
         unlock_below: 'You can unlock your account by clicking the link below:'
+    omniauth_callbacks:
+      create:
+        already_linked: Your %{provider} account has already been linked.
+        successfully_linked: Your %{provider} account has been succesfully linked.
+        successfully_signed_up: You have signed up successfully with %{provider}.
     passwords:
       create:
         success: Password reset instructions will be sent to your email.
@@ -70,8 +90,10 @@ en:
       links:
         reset_password: Reset password
         send_email_confirmation_instructions: Didn't receive confirmation instructions?
+        send_magic_link: Send me a magic link
         send_unlock_instructions: Didn't receive unlock instructions?
         sign_in: Sign in
+        sign_in_or_sign_up_with: Sign in or sign up with %{provider}
         sign_up: Sign up
     unlocks:
       create:

data/config/locales/es.yml

@@ -14,13 +14,28 @@ es:
       already_signed_in: Ya iniciaste sesión.
       form_errors: "%{errors} no permitieron guardar este elemento:"
       locked: Tu cuenta fue bloqueada después de %{count} intentos fallidos. Te enviaremos un email con las instrucciones de desbloqueo.
+      timedout: Tu sesión expiró. Iniciá sesión nuevamente para continuar.
       unauthenticated: Tenés que iniciar sesión antes de continuar.
+    magic_links:
+      create:
+        success: Te enviaremos un email con un enlace mágico para iniciar sesión.
+      new:
+        send_magic_link: Enviar enlace mágico
+      set_user:
+        invalid_token: El enlace mágico es inválido.
+      show:
+        success: Inicio de sesión existoso.
     mailer:
       email_confirmation_instructions:
         confirm_email: Confirmar mi cuenta
         confirm_email_below: 'Podés confirmar tu cuenta haciendo click en el siguiente link:'
         hello: Hola, %{email}!
         subject: Instrucciones de confirmación
+      magic_link:
+        hello: Hola, %{email}!
+        magic_link_below: 'Podés iniciar sesión haciendo click en el siguiente link:'
+        sign_in: Iniciar sesión
+        subject: Enlace mágico
       password_reset_instructions:
         hello: Hola, %{email}!
         reset_password: Recuperar contraseña
@@ -31,6 +46,11 @@ es:
         subject: Instrucciones de desbloqueo
         unlock: Desbloquear cuenta
         unlock_below: 'Podés desbloquear tu contraseña haciendo click en el siguiente link:'
+    omniauth_callbacks:
+      create:
+        already_linked: Tu cuenta de %{provider} ya fue enlazada.
+        successfully_linked: Tu cuenta de %{provider} fue enlazada exitosamente.
+        successfully_signed_up: Te registraste exitosamente con %{provider}.
     passwords:
       create:
         success: Te enviaremos un email con las instrucciones de para recuperar tu contraseña.
@@ -70,8 +90,10 @@ es:
       links:
         reset_password: Recuperar contraseña
         send_email_confirmation_instructions: "¿No recibiste las instrucciones de confirmación?"
+        send_magic_link: Enviarme un enlace mágico
         send_unlock_instructions: "¿No recibiste las instrucciones de desbloqueo?"
         sign_in: Iniciar sesión
+        sign_in_or_sign_up_with: Iniciar sesión o crear una cuenta con %{provider}
         sign_up: Crear una cuenta
     unlocks:
       create:

data/lib/active_authentication/controller/authenticatable.rb

@@ -0,0 +1,53 @@
+module ActiveAuthentication
+  module Controller
+    module Authenticatable
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :current_user
+        helper_method :user_signed_in?
+      end
+
+      def active_authentication_controller?
+        is_a? ::ActiveAuthenticationController
+      end
+
+      def authenticate_user!
+        redirect_to new_session_path, alert: t("active_authentication.failure.unauthenticated") unless user_signed_in?
+      end
+
+      def current_user
+        Current.user ||= user_from_session
+      end
+
+      def require_no_authentication
+        redirect_to root_path, alert: t("active_authentication.failure.already_signed_in") if user_signed_in?
+      end
+
+      def sign_in(user)
+        reset_session
+        Current.user = user
+        session[:user_id] = user.id
+      end
+
+      def sign_out
+        reset_session
+        Current.user = nil
+      end
+
+      def user_signed_in?
+        current_user.present?
+      end
+
+      private
+
+      def scope
+        User
+      end
+
+      def user_from_session
+        User.find_by id: session[:user_id]
+      end
+    end
+  end
+end

data/lib/active_authentication/controller/lockable.rb

@@ -6,24 +6,24 @@ module ActiveAuthentication
       included do
         set_callback :failed_sign_in, :before, :increment_failed_attempts
         set_callback :failed_sign_in, :after, :set_alert
+      end
 
-        private
+      private
 
-        def increment_failed_attempts
-          user = User.find_by email: params[:email]
-          user&.increment_failed_attempts
-        end
+      def increment_failed_attempts
+        user = User.find_by email: params[:email]
+        user&.increment_failed_attempts
+      end
 
-        def scope
-          User.unlocked
-        end
+      def scope
+        User.unlocked
+      end
 
-        def set_alert
-          user = User.find_by email: params[:email]
+      def set_alert
+        user = User.find_by email: params[:email]
 
-          if user.locked?
-            flash[:alert] = t "active_authentication.failure.locked", count: user.failed_attempts
-          end
+        if user&.locked?
+          flash[:alert] = t "active_authentication.failure.locked", count: user.failed_attempts
         end
       end
     end

data/lib/active_authentication/controller/timeoutable.rb

@@ -0,0 +1,26 @@
+module ActiveAuthentication
+  module Controller
+    module Timeoutable
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :sign_out_user_if_timedout, if: :user_signed_in?
+      end
+
+      private
+
+      def sign_out_user_if_timedout
+        last_request_at = session[:last_request_at].yield_self do |timestamp|
+          Time.at(timestamp).utc if timestamp.present?
+        end
+
+        if current_user.timedout?(last_request_at)
+          sign_out
+          redirect_to root_path, alert: t("active_authentication.failure.timedout")
+        end
+
+        session[:last_request_at] = Time.now.utc.to_i
+      end
+    end
+  end
+end

data/lib/active_authentication/controller/trackable.rb

@@ -5,12 +5,12 @@ module ActiveAuthentication
 
       included do
         set_callback :successful_sign_in, :after, :track
+      end
 
-        private
+      private
 
-        def track
-          current_user.track request
-        end
+      def track
+        current_user.track request
       end
     end
   end

data/lib/active_authentication/controller.rb

@@ -1,48 +1,9 @@
 module ActiveAuthentication
   module Controller
     extend ActiveSupport::Concern
-    include ActiveSupport::Callbacks
 
     included do
-      helper_method :current_user
-      helper_method :user_signed_in?
-    end
-
-    def authenticate_user!
-      redirect_to new_session_path, alert: t("active_authentication.failure.unauthenticated") unless user_signed_in?
-    end
-
-    def current_user
-      Current.user ||= user_from_session
-    end
-
-    def require_no_authentication
-      redirect_to root_path, alert: t("active_authentication.failure.already_signed_in") if user_signed_in?
-    end
-
-    def sign_in(user)
-      reset_session
-      Current.user = user
-      session[:user_id] = user.id
-    end
-
-    def sign_out
-      reset_session
-      Current.user = nil
-    end
-
-    def user_signed_in?
-      current_user.present?
-    end
-
-    private
-
-    def scope
-      User
-    end
-
-    def user_from_session
-      User.find_by id: session[:user_id]
+      include Authenticatable
     end
   end
 end

data/lib/active_authentication/engine.rb

@@ -3,14 +3,16 @@ require "active_authentication/model"
 
 module ActiveAuthentication
   class Engine < ::Rails::Engine
-    initializer :active_authentication_controller do
-      ActiveSupport.on_load :action_controller_base do
-        include ActiveAuthentication::Controller
-      end
-
+    initializer "active_authentication.model" do
       ActiveSupport.on_load :active_record do
         include ActiveAuthentication::Model
       end
     end
+
+    initializer "active_authentication.controller" do
+      ActiveSupport.on_load :action_controller_base do
+        include ActiveAuthentication::Controller
+      end
+    end
   end
 end

data/lib/active_authentication/model/magiclinkable.rb

@@ -0,0 +1,16 @@
+module ActiveAuthentication
+  module Model
+    module Magiclinkable
+      extend ActiveSupport::Concern
+
+      included do
+        generates_token_for :magic_link, expires_in: ActiveAuthentication.magic_link_token_expires_in
+      end
+
+      def send_magic_link
+        token = generate_token_for :magic_link
+        ActiveAuthentication::Mailer.with(token: token, user: self).magic_link.deliver
+      end
+    end
+  end
+end

data/lib/active_authentication/model/omniauthable.rb

@@ -0,0 +1,11 @@
+module ActiveAuthentication
+  module Model
+    module Omniauthable
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :authentications, dependent: :destroy
+      end
+    end
+  end
+end

data/lib/active_authentication/model/timeoutable.rb

@@ -0,0 +1,15 @@
+module ActiveAuthentication
+  module Model
+    module Timeoutable
+      extend ActiveSupport::Concern
+
+      included do
+        ApplicationController.send :include, ActiveAuthentication::Controller::Timeoutable
+      end
+
+      def timedout?(last_request_at)
+        last_request_at && last_request_at <= ActiveAuthentication.timeout_in.ago
+      end
+    end
+  end
+end

data/lib/active_authentication/model.rb

@@ -2,7 +2,7 @@ module ActiveAuthentication
   module Model
     extend ActiveSupport::Concern
 
-    CONCERNS = %i[authenticatable confirmable lockable recoverable registerable trackable]
+    CONCERNS = %i[authenticatable confirmable lockable magiclinkable omniauthable recoverable registerable timeoutable trackable]
 
     class_methods do
       def authenticates_with(*concerns)

data/lib/active_authentication/routes.rb

@@ -22,6 +22,15 @@ module ActionDispatch::Routing
       resources :unlocks, param: :token, only: [:new, :create, :show]
     end
 
+    def magiclinkable
+      resources :magic_links, param: :token, only: [:new, :create, :show]
+    end
+
+    def omniauthable
+      get "auth/:provider", to: "omniauth_callbacks#pass", as: :omniauth
+      get "auth/:provider/callback", to: "omniauth_callbacks#create", as: :omniauth_callback
+    end
+
     def registerable
       resources :registrations, only: [:new, :create]
       resource :profile, only: [:edit, :update, :destroy], path: :profile, controller: :registrations

data/lib/active_authentication/version.rb

@@ -1,3 +1,3 @@
 module ActiveAuthentication
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/active_authentication.rb

@@ -10,7 +10,9 @@ module ActiveAuthentication
   autoload :Model, "active_authentication/model"
 
   module Controller
+    autoload :Authenticatable, "active_authentication/controller/authenticatable"
     autoload :Lockable, "active_authentication/controller/lockable"
+    autoload :Timeoutable, "active_authentication/controller/timeoutable"
     autoload :Trackable, "active_authentication/controller/trackable"
   end
 
@@ -18,8 +20,11 @@ module ActiveAuthentication
     autoload :Authenticatable, "active_authentication/model/authenticatable"
     autoload :Confirmable, "active_authentication/model/confirmable"
     autoload :Lockable, "active_authentication/model/lockable"
+    autoload :Magiclinkable, "active_authentication/model/magiclinkable"
+    autoload :Omniauthable, "active_authentication/model/omniauthable"
     autoload :Recoverable, "active_authentication/model/recoverable"
     autoload :Registerable, "active_authentication/model/registerable"
+    autoload :Timeoutable, "active_authentication/model/timeoutable"
     autoload :Trackable, "active_authentication/model/trackable"
   end
 
@@ -37,6 +42,21 @@ module ActiveAuthentication
   config_accessor :unlock_token_expires_in, default: 24.hours
   config_accessor :max_failed_attempts, default: 10
 
+  # magiclinkable
+  config_accessor :magic_link_token_expires_in, default: 24.hours
+
+  # omniauthable
+  config_accessor :omniauth_providers, default: []
+
   # recoverable
   config_accessor :password_reset_token_expires_in, default: 1.hour
+
+  # registerable
+  config_accessor :profile_params, default: ->(controller) {
+    controller.params.require(:user).permit(:email, :password, :password_confirmation)
+  }
+  config_accessor :registration_params, default: profile_params
+
+  # timeoutable
+  config_accessor :timeout_in, default: 30.minutes
 end

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

@@ -3,6 +3,8 @@ class ActiveAuthentication::InstallGenerator < Rails::Generators::Base
 
   source_root File.expand_path("templates", __dir__)
 
+  argument :concerns, type: :array, default: %w[confirmable lockable recoverable registerable trackable], banner: "concern concern"
+
   desc "Creates the User model, the active_authentication initializer, and adds the active_authentication route."
 
   def self.next_migration_number(dirname)
@@ -13,12 +15,12 @@ class ActiveAuthentication::InstallGenerator < Rails::Generators::Base
     invoke "active_record:model", %w[User], migration: false, skip_collision_check: true
 
     if behavior == :invoke
-      inject_into_class "app/models/user.rb", "User", "  authenticates_with :confirmable, :lockable, :recoverable, :registerable, :trackable\n"
+      inject_into_class "app/models/user.rb", "User", "  authenticates_with #{concerns.map { ":#{_1}" }.join(", ")}\n"
     end
   end
 
   def generate_migration
-    migration_template "migration.rb", "db/migrate/create_users.rb", migration_version: migration_version, ip_column: ip_column
+    migration_template "migration.rb", "db/migrate/create_users.rb", concerns: concerns, migration_version: migration_version, ip_column: ip_column
   end
 
   def add_route
@@ -48,6 +50,6 @@ class ActiveAuthentication::InstallGenerator < Rails::Generators::Base
   end
 
   def postgresql?
-    ar_config.present? && ar_config["adapter"] == "postgresql"
+    ar_config.present? && ar_config.with_indifferent_access[:adapter] == "postgresql"
   end
 end

data/lib/generators/active_authentication/install/templates/initializer.rb

@@ -9,6 +9,21 @@ ActiveAuthentication.configure do |config|
   # config.unlock_token_expires_in = 24.hours
   # config.max_failed_attempts = 10
 
+  # configuration for the magiclinkable concern
+  # config.magic_link_token_expires_in = 24.hours
+
   # configuration for the recoverable concern
   # config.password_reset_token_expires_in = 1.hour
+
+  # configuration for the registerable concern
+  # config_accessor :profile_params, default: ->(controller) {
+  #   controller.params.require(:user).permit(:email, :password, :password_confirmation)
+  # }
+  # by default the registration_params take the same lambda as the profile_params. if you redefine the
+  # profile_params setting, you will need to uncomment this line as otherwise it will take the default value,
+  # previously defined.
+  # config_accessor :registration_params, default: profile_params
+
+  # configuration for the timeoutable concern
+  # config.timeout_in = 30.minutes
 end

data/lib/generators/active_authentication/install/templates/migration.rb

@@ -6,18 +6,18 @@ class CreateUsers < ActiveRecord::Migration<%= migration_version %>
       t.string :password_digest, null: false
 
       # confirmable
-      t.string :unconfirmed_email
+      <%= "# " unless concerns.include? "confirmable" -%>t.string :unconfirmed_email
 
       # lockable
-      t.integer :failed_attempts, null: false, default: 0
-      t.datetime :locked_at
+      <%= "# " unless concerns.include? "lockable" -%>t.integer :failed_attempts, null: false, default: 0
+      <%= "# " unless concerns.include? "lockable" -%>t.datetime :locked_at
 
       # trackable
-      t.integer :sign_in_count, null: false, default: 0
-      t.datetime :current_sign_in_at
-      t.datetime :last_sign_in_at
-      t.<%= ip_column %> :current_sign_in_ip
-      t.<%= ip_column %> :last_sign_in_ip
+      <%= "# " unless concerns.include? "trackable" -%>t.integer :sign_in_count, null: false, default: 0
+      <%= "# " unless concerns.include? "trackable" -%>t.datetime :current_sign_in_at
+      <%= "# " unless concerns.include? "trackable" -%>t.datetime :last_sign_in_at
+      <%= "# " unless concerns.include? "trackable" -%>t.<%= ip_column %> :current_sign_in_ip
+      <%= "# " unless concerns.include? "trackable" -%>t.<%= ip_column %> :last_sign_in_ip
 
       t.timestamps
     end

data/lib/generators/active_authentication/omniauthable/omniauthable_generator.rb

@@ -0,0 +1,13 @@
+class ActiveAuthentication::OmniauthableGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  desc "Creates the Authentication model"
+
+  def generate_model
+    invoke "active_record:model", %w[Authentication uid:string provider:string user:references auth_data:json], skip_collision_check: true
+
+    if behavior == :invoke
+      inject_into_class "app/models/authentication.rb", "Authentication", "  validates :provider, presence: true\n  validates :uid, presence: true, uniqueness: {scope: :provider}\n"
+    end
+  end
+end

data/lib/generators/active_authentication/views/views_generator.rb

@@ -3,7 +3,7 @@ class ActiveAuthentication::ViewsGenerator < Rails::Generators::Base
 
   desc "Generates active_authentication's views."
 
-  class_option :views, aliases: "-v", type: :array, desc: "Views to generate (available: confirmations, mailer, passwords, registrations, sessions, shared, unlocks)"
+  class_option :views, aliases: "-v", type: :array, desc: "Views to generate (available: confirmations, magic_links, mailer, passwords, registrations, sessions, shared, unlocks)"
 
   def copy_views
     if options[:views]

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: active_authentication
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Patricio Mac Adden
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
@@ -49,13 +49,18 @@ files:
 - README.md
 - Rakefile
 - app/controllers/active_authentication/confirmations_controller.rb
+- app/controllers/active_authentication/magic_links_controller.rb
+- app/controllers/active_authentication/omniauth_callbacks_controller.rb
 - app/controllers/active_authentication/passwords_controller.rb
 - app/controllers/active_authentication/registrations_controller.rb
 - app/controllers/active_authentication/sessions_controller.rb
 - app/controllers/active_authentication/unlocks_controller.rb
+- app/controllers/active_authentication_controller.rb
 - app/mailers/active_authentication/mailer.rb
 - app/views/active_authentication/confirmations/new.html.erb
+- app/views/active_authentication/magic_links/new.html.erb
 - app/views/active_authentication/mailer/email_confirmation_instructions.html.erb
+- app/views/active_authentication/mailer/magic_link.html.erb
 - app/views/active_authentication/mailer/password_reset_instructions.html.erb
 - app/views/active_authentication/mailer/unlock_instructions.html.erb
 - app/views/active_authentication/passwords/edit.html.erb
@@ -70,7 +75,9 @@ files:
 - config/locales/es.yml
 - lib/active_authentication.rb
 - lib/active_authentication/controller.rb
+- lib/active_authentication/controller/authenticatable.rb
 - lib/active_authentication/controller/lockable.rb
+- lib/active_authentication/controller/timeoutable.rb
 - lib/active_authentication/controller/trackable.rb
 - lib/active_authentication/current.rb
 - lib/active_authentication/engine.rb
@@ -78,8 +85,11 @@ files:
 - lib/active_authentication/model/authenticatable.rb
 - lib/active_authentication/model/confirmable.rb
 - lib/active_authentication/model/lockable.rb
+- lib/active_authentication/model/magiclinkable.rb
+- lib/active_authentication/model/omniauthable.rb
 - lib/active_authentication/model/recoverable.rb
 - lib/active_authentication/model/registerable.rb
+- lib/active_authentication/model/timeoutable.rb
 - lib/active_authentication/model/trackable.rb
 - lib/active_authentication/routes.rb
 - lib/active_authentication/test/helpers.rb
@@ -87,6 +97,7 @@ files:
 - lib/generators/active_authentication/install/install_generator.rb
 - lib/generators/active_authentication/install/templates/initializer.rb
 - lib/generators/active_authentication/install/templates/migration.rb
+- lib/generators/active_authentication/omniauthable/omniauthable_generator.rb
 - lib/generators/active_authentication/views/views_generator.rb
 homepage: https://github.com/sinaptia/active_authentication
 licenses:
@@ -94,7 +105,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/sinaptia/active_authentication
   source_code_uri: https://github.com/sinaptia/active_authentication
-post_install_message: 
+  changelog_uri: https://github.com/sinaptia/active_authentication/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: A pure Rails authentication solution
 test_files: []