avocado 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e265345c4e35e1dd2caed0c61da1298f12767aac67bf9e87b92433d47866375b
-  data.tar.gz: 1253d00e053907caa9d78cd7f8667a695aae55853fbb6db94b45bbcd1845da10
+  metadata.gz: a530ebf9605c2bb861d2da09da546513e68c4f647fc97c80686e07b32985cabe
+  data.tar.gz: 3be481be5c31ce2ee3bb1ea1a2d796bb7f8cbe850f7ccf2de6f296384a656bb2
 SHA512:
-  metadata.gz: 2fb300cf06c7c67fc9ecfea196bd23b770482f2b765d9438fb2ee24f193942565db6d470a75bce99bb1b016b94f355ab9e4b6f6a5a19bb0277d79c7bb06c247d
-  data.tar.gz: 9437dfe9000245f75089c3705a3bf4527705ceccab38a6760381d57dd13fda74881eb14db25b8ca33f26aee67fa6fd30ce42632a24541bcb1c672e6ea9eb80b5
+  metadata.gz: cf3320eb985cc65c05c2da2d007697b4b9016d9a85f7ebebbd0735d744d7f8ca77096d86182c6761b63ea6f51f4b942a3c2dd363bb102ccc4ed53da6f5702c4f
+  data.tar.gz: f0b021b9e0f3433f2034e5cccdc751a446b50bc870474376e1a39b84e973bbabfaef95b59d96f60986bbddc7695afe88b860bd2d1568f991a17b3b654d7f3995

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.5.0] - 2023-07-21
+
+- Add controller for "passwordless" email-link sign-in
+- Add event class to log user auth events
+- Add user-facing email and password edit pages
+- Add various event logging callbacks
+- Sign out all non current sessions when password changes
+
 ## [0.4.0] - 2023-07-19
 
 - Convert the `Avocado::Mailer` module into a class

data/README.md

@@ -29,6 +29,10 @@ class Session < ApplicationRecord
   include Avocado::Session
 end
 
+class Event < ApplicationRecord
+  include Avocado::Event
+end
+
 class ApplicationController < ActionController::Base
   include Avocado::Authentication
 end

data/app/controllers/avocado/affirmations_controller.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Avocado
+  class AffirmationsController < BaseController
+    skip_before_action :authenticate
+
+    before_action :set_user, only: :show
+    before_action :verify_user, only: :create
+
+    def new
+    end
+
+    def show
+      sign_in(@user)
+      redirect_to(root_path, notice: "Signed in successfully")
+    end
+
+    def create
+      send_affirmation_email
+      redirect_to new_session_path, notice: "Check your email for sign in instructions"
+    end
+
+    private
+
+    def set_user
+      @user = user_from_signed_affirmation_token
+    rescue ActiveSupport::MessageVerifier::InvalidSignature
+      redirect_to new_affirmation_path, alert: "That sign in link is invalid"
+    end
+
+    def user_from_signed_affirmation_token
+      ::User.find_by_token_for!(:email_affirmation, params[:id])
+    end
+
+    def verify_user
+      unless user_from_params_email
+        redirect_to new_affirmation_path, alert: "You can't sign in until you verify your email"
+      end
+    end
+
+    def send_affirmation_email
+      mailer_for(user_from_params_email)
+        .email_affirmation
+        .deliver_later
+    end
+
+    def user_from_params_email
+      ::User.verified.find_by(email: params[:email])
+    end
+  end
+end

data/app/controllers/avocado/base_controller.rb

@@ -4,6 +4,16 @@ module Avocado
   class BaseController < ApplicationController
     private
 
+    def verify_password_challenge
+      unless current_user.authenticate(params_password_challenge)
+        redirect_back alert: "Password challenge failed.", fallback_location: root_path
+      end
+    end
+
+    def params_password_challenge
+      params.dig(:user, :password_challenge)
+    end
+
     def mailer_for(user)
       Avocado::Mailer.with(user: user)
     end

data/app/controllers/avocado/emails_controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Avocado
+  class EmailsController < BaseController
+    PERMITTED_PARAMS = [:email]
+
+    before_action :set_user
+    before_action :verify_password_challenge, only: :update
+
+    def edit
+    end
+
+    def update
+      if @user.update(user_params)
+        process_email_update
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def set_user
+      @user = current_user
+    end
+
+    def user_params
+      params
+        .require(:user)
+        .permit(PERMITTED_PARAMS)
+    end
+
+    def process_email_update
+      if @user.email_previously_changed?
+        resend_email_verification
+        redirect_to root_path, notice: "Your email has been changed"
+      else
+        redirect_to root_path
+      end
+    end
+
+    def resend_email_verification
+      mailer_for(@user)
+        .email_verification
+        .deliver_later
+    end
+  end
+end

data/app/controllers/avocado/events_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Avocado
+  class EventsController < BaseController
+    def index
+      @events = current_user.events.newest_first
+    end
+  end
+end

data/app/controllers/avocado/passwords_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Avocado
+  class PasswordsController < BaseController
+    PERMITTED_PARAMS = [:password, :password_confirmation, :password_challenge]
+
+    before_action :set_user
+    before_action :verify_password_challenge, only: :update
+
+    def edit
+    end
+
+    def update
+      if @user.update(user_params)
+        redirect_to root_path, notice: "Your password has been changed"
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def set_user
+      @user = current_user
+    end
+
+    def user_params
+      params
+        .require(:user)
+        .permit(PERMITTED_PARAMS)
+        .with_defaults(password_challenge: "")
+    end
+  end
+end

data/app/views/avocado/affirmations/new.html.erb

@@ -0,0 +1,14 @@
+<h2>
+  Sign in without password
+</h2>
+
+<p>
+  <%= link_to "Reset your password", new_recovery_path %>
+</p>
+
+<%= form_with url: affirmations_path do |form| %>
+  <%= form.label :email %>
+  <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
+
+  <%= form.button "Submit", name: nil %>
+<% end -%>

data/app/views/avocado/emails/edit.html.erb

@@ -0,0 +1,20 @@
+<h2>
+  Change your email address
+</h2>
+
+<% if current_user.verified? %>
+  <p>Your email address is verified.</p>
+<% else %>
+  <p>Your email address is not verified. Check your email and follow the instructions to confirm it's your email address.</p>
+  <p><%= button_to "Re-send verification email", verifications_path %></p>
+<% end %>
+
+<%= form_with model: @user, url: email_path, method: :patch do |form| %>
+  <%= form.label :email %>
+  <%= form.email_field :email, autocomplete: "email", required: true %>
+
+  <%= form.label :password_challenge, "Current password" %>
+  <%= form.password_field :password_challenge, autocomplete: "current-password", required: true %>
+
+  <%= form.button "Submit", name: nil %>
+<% end %>

data/app/views/avocado/events/_event.html.erb

@@ -0,0 +1,6 @@
+<tr id="<%= dom_id event %>">
+  <td><%= event.action %></td>
+  <td><%= event.created_at %></td>
+  <td><%= truncate event.user_agent %></td>
+  <td><%= event.ip_address %></td>
+</tr>

data/app/views/avocado/events/index.html.erb

@@ -0,0 +1,17 @@
+<h2>
+  Events
+</h2>
+
+<table id="events">
+  <thead>
+    <tr>
+      <th scope="col">Action</th>
+      <th scope="col">Created</th>
+      <th scope="col">User Agent</th>
+      <th scope="col">IP Address</th>
+    </tr>
+  </thead>
+  <tbody>
+    <%= render @events %>
+  </tbody>
+</table>

data/app/views/avocado/mailer/email_affirmation.text.erb

@@ -1 +1,3 @@
-Email affirmation email
+Sign in by following this link:
+
+<%= affirmation_url(id: @signed_id) %>

data/app/views/avocado/mailer/email_verification.text.erb

@@ -1,3 +1,3 @@
-Email verification email
+Verify your email by following this link:
 
 <%= verification_url(id: @signed_id) %>

data/app/views/avocado/mailer/password_reset.text.erb

@@ -1,3 +1,3 @@
-Password reset email
+Reset your password by following this link:
 
 <%= edit_recovery_url(id: @signed_id) %>

data/app/views/avocado/passwords/edit.html.erb

@@ -0,0 +1,16 @@
+<h2>
+  Change your password
+</h2>
+
+<%= form_with model: @user, url: password_path, method: :patch do |form| %>
+  <%= form.label :password_challenge, "Current password" %>
+  <%= form.password_field :password_challenge, autocomplete: "current-password", required: true %>
+
+  <%= form.label :password %>
+  <%= form.password_field :password, autocomplete: "new-password", required: true %>
+
+  <%= form.label :password_confirmation %>
+  <%= form.password_field :password_confirmation, autocomplete: "new-password", required: true %>
+
+  <%= form.button "Submit", name: nil %>
+<% end %>

data/app/views/avocado/recoveries/edit.html.erb

@@ -1,5 +1,5 @@
 <h2>
-  Reset your password
+  Change your password
 </h2>
 
 <p>
@@ -13,5 +13,5 @@
   <%= form.label :password_confirmation %>
   <%= form.password_field :password_confirmation, autocomplete: "new-password", required: true %>
 
-  <%= form.button "Update password", name: nil %>
+  <%= form.button "Submit", name: nil %>
 <% end %>

data/app/views/avocado/recoveries/new.html.erb

@@ -1,5 +1,5 @@
 <h2>
-  Recover your password
+  Reset your password
 </h2>
 
 <p>
@@ -10,5 +10,5 @@
   <%= form.label :email %>
   <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
 
-  <%= form.button "Recover", name: nil %>
+  <%= form.button "Submit", name: nil %>
 <% end -%>

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

@@ -19,5 +19,5 @@
     <%= form.label :password_confirmation %>
     <%= form.password_field :password_confirmation, autocomplete: "new-password", required: true %>
   </div>
-  <%= form.button "Sign up", name: nil %>
+  <%= form.button "Submit", name: nil %>
 <% end %>

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

@@ -11,5 +11,5 @@
   <%= form.email_field :email, autofocus: true, autocomplete: "email", required: true %>
   <%= form.label :password %>
   <%= form.password_field :password, autocomplete: "current-password", required: true %>
-  <%= form.button "Sign in", name: nil %>
+  <%= form.button "Submit", name: nil %>
 <% end -%>

data/config/routes.rb

@@ -1,5 +1,9 @@
 Rails.application.routes.draw do
   scope module: :avocado do
+    resource :email, only: %i[edit update]
+    resource :password, only: %i[edit update]
+    resources :affirmations, only: %i[new show create]
+    resources :events, only: %i[index]
     resources :recoveries, only: %i[new create edit update]
     resources :registrations, only: %i[new create]
     resources :sessions, only: %i[index new create destroy]

data/lib/avocado/current.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
-class Current < ActiveSupport::CurrentAttributes
-  attribute :session,
-    :user,
-    :user_agent,
-    :ip_address
+module Avocado
+  class Current < ActiveSupport::CurrentAttributes
+    attribute :session,
+      :user,
+      :user_agent,
+      :ip_address
 
-  def session=(session)
-    super
-    self.user = session.user
+    def session=(session)
+      super
+      self.user = session.user
+    end
   end
 end

data/lib/avocado/event.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Avocado
+  module Event
+    extend ActiveSupport::Concern
+
+    VALID_ACTIONS = [
+      "email:update",
+      "email:verified",
+      "password:update",
+      "session:create",
+      "session:destroy"
+    ]
+
+    included do
+      belongs_to :user
+
+      scope :newest_first, -> { order(created_at: :desc) }
+
+      validates :action, inclusion: VALID_ACTIONS
+
+      before_create :capture_request_details
+    end
+
+    private
+
+    def capture_request_details
+      self.user_agent = Current.user_agent
+      self.ip_address = Current.ip_address
+    end
+  end
+end

data/lib/avocado/session.rb

@@ -5,9 +5,12 @@ module Avocado
     extend ActiveSupport::Concern
 
     included do
+      include SessionCallbacks
+
       belongs_to :user
 
       scope :newest_first, -> { order(created_at: :desc) }
+      scope :non_current, -> { where.not(id: Current.session) }
     end
   end
 end

data/lib/avocado/session_callbacks.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Avocado
+  module SessionCallbacks
+    extend ActiveSupport::Concern
+
+    included do
+      after_create :record_activity_create
+
+      after_destroy :record_activity_destroy
+
+      before_create :capture_request_details
+    end
+
+    private
+
+    def record_activity_create
+      create_user_event "session:create"
+    end
+
+    def record_activity_destroy
+      create_user_event "session:destroy"
+    end
+
+    def create_user_event(action)
+      user.events.create! action: action
+    end
+
+    def capture_request_details
+      self.user_agent = Current.user_agent
+      self.ip_address = Current.ip_address
+    end
+  end
+end

data/lib/avocado/user.rb

@@ -5,14 +5,21 @@ module Avocado
     extend ActiveSupport::Concern
 
     included do
-      include UserEmail
+      include UserCallbacks
       include UserTokens
-      include UserPassword
+      include UserValidations
 
-      has_many :sessions
+      has_secure_password
+
+      with_options dependent: :destroy do
+        has_many :events
+        has_many :sessions
+      end
 
       scope :newest_first, -> { order(created_at: :desc) }
       scope :verified, -> { where(verified: true) }
+
+      normalizes :email, with: ->(email) { email.downcase.strip }
     end
   end
 end

data/lib/avocado/user_callbacks.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Avocado
+  module UserCallbacks
+    extend ActiveSupport::Concern
+
+    included do
+      with_options if: :password_digest_previously_changed? do
+        after_update :destroy_non_current_sessions
+        after_update :record_activity_password_update
+      end
+
+      after_update :record_activity_email_update, if: :email_previously_changed?
+      after_update :record_activity_email_verified, if: %i[verified_previously_changed? verified?]
+
+      before_validation :remove_email_verification, if: :email_changed?, on: :update
+    end
+
+    private
+
+    def record_activity_password_update
+      create_event "password:update"
+    end
+
+    def record_activity_email_update
+      create_event "email:update"
+    end
+
+    def record_activity_email_verified
+      create_event "email:verified"
+    end
+
+    def create_event(action)
+      events.create! action: action
+    end
+
+    def remove_email_verification
+      self.verified = false
+    end
+
+    def destroy_non_current_sessions
+      sessions.non_current.destroy_all
+    end
+  end
+end

data/lib/avocado/user_validations.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Avocado
+  module UserValidations
+    extend ActiveSupport::Concern
+
+    PASSWORD_FORMAT = /\A(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9]).*\z/x
+    PASSWORD_MINIMUM_LENGTH = 8
+
+    included do
+      validates :email,
+        presence: true,
+        uniqueness: true,
+        format: {with: URI::MailTo::EMAIL_REGEXP}
+
+      validates :password,
+        format: {with: PASSWORD_FORMAT},
+        length: {minimum: PASSWORD_MINIMUM_LENGTH},
+        allow_nil: true
+    end
+  end
+end

data/lib/avocado/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avocado
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/avocado.rb

@@ -7,10 +7,12 @@ module Avocado
 
   autoload :Authentication, "avocado/authentication"
   autoload :Current, "avocado/current"
+  autoload :Event, "avocado/event"
   autoload :Mailer, "avocado/mailer"
   autoload :Session, "avocado/session"
+  autoload :SessionCallbacks, "avocado/session_callbacks"
   autoload :User, "avocado/user"
-  autoload :UserEmail, "avocado/user_email"
+  autoload :UserCallbacks, "avocado/user_callbacks"
   autoload :UserTokens, "avocado/user_tokens"
-  autoload :UserPassword, "avocado/user_password"
+  autoload :UserValidations, "avocado/user_validations"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avocado
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Jankowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -80,14 +80,23 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/avocado/affirmations_controller.rb
 - app/controllers/avocado/base_controller.rb
+- app/controllers/avocado/emails_controller.rb
+- app/controllers/avocado/events_controller.rb
+- app/controllers/avocado/passwords_controller.rb
 - app/controllers/avocado/recoveries_controller.rb
 - app/controllers/avocado/registrations_controller.rb
 - app/controllers/avocado/sessions_controller.rb
 - app/controllers/avocado/verifications_controller.rb
+- app/views/avocado/affirmations/new.html.erb
+- app/views/avocado/emails/edit.html.erb
+- app/views/avocado/events/_event.html.erb
+- app/views/avocado/events/index.html.erb
 - app/views/avocado/mailer/email_affirmation.text.erb
 - app/views/avocado/mailer/email_verification.text.erb
 - app/views/avocado/mailer/password_reset.text.erb
+- app/views/avocado/passwords/edit.html.erb
 - app/views/avocado/recoveries/edit.html.erb
 - app/views/avocado/recoveries/new.html.erb
 - app/views/avocado/registrations/new.html.erb
@@ -100,12 +109,14 @@ files:
 - lib/avocado/authentication.rb
 - lib/avocado/current.rb
 - lib/avocado/engine.rb
+- lib/avocado/event.rb
 - lib/avocado/mailer.rb
 - lib/avocado/session.rb
+- lib/avocado/session_callbacks.rb
 - lib/avocado/user.rb
-- lib/avocado/user_email.rb
-- lib/avocado/user_password.rb
+- lib/avocado/user_callbacks.rb
 - lib/avocado/user_tokens.rb
+- lib/avocado/user_validations.rb
 - lib/avocado/version.rb
 - sig/avocado.rbs
 homepage: https://github.com/tcuwp/avocado

data/lib/avocado/user_email.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Avocado
-  module UserEmail
-    extend ActiveSupport::Concern
-
-    included do
-      validates :email, presence: true, uniqueness: true, format: {with: URI::MailTo::EMAIL_REGEXP}
-
-      normalizes :email, with: ->(email) { email.downcase.strip }
-    end
-  end
-end

data/lib/avocado/user_password.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Avocado
-  module UserPassword
-    extend ActiveSupport::Concern
-
-    REQUIRED_FORMAT = /\A(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9]).*\z/x
-    REQUIRED_LENGTH = 8
-
-    included do
-      has_secure_password
-
-      validates :password, format: {with: REQUIRED_FORMAT}, length: {minimum: REQUIRED_LENGTH}, allow_nil: true
-    end
-  end
-end