Merge pull request #1268 from Crown-Commercial-Service/feature/nrmi-289-update-user-email

Feature/nrmi 289 update user email

Author: reemi1510

Gemfile

@@ -105,6 +105,7 @@ gem 'net-http', '>= 0.4.0'
 gem 'sprockets-rails', '>= 3.5.1'
 
 gem 'connection_pool', '< 3'
+gem 'notifications-ruby-client'
 
 group :development, :test do
   gem 'brakeman', require: false

Gemfile.lock

@@ -355,6 +355,10 @@ GEM
     nokogiri (1.19.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
+    nokogiri (1.19.2-x86_64-linux-gnu)
+      racc (~> 1.4)
+    notifications-ruby-client (6.3.0)
+      jwt (>= 1.5, < 4)
     oauth2 (2.0.18)
       faraday (>= 0.17.3, < 4.0)
       jwt (>= 1.0, < 4.0)
@@ -628,7 +632,9 @@ GEM
     zeitwerk (2.7.5)
 
 PLATFORMS
+  aarch64-linux-musl
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   aasm
@@ -666,6 +672,7 @@ DEPENDENCIES
   mutex_m (~> 0.3.0)
   net-http (>= 0.4.0)
   nokogiri (>= 1.18.9)
+  notifications-ruby-client
   omniauth-google-oauth2 (>= 1.2.2)
   omniauth-rails_csrf_protection (~> 2.0, >= 2.0.0)
   parslet

app/controllers/admin/users_controller.rb

@@ -1,5 +1,7 @@
 class Admin::UsersController < AdminController
-  before_action :find_user, only: %i[show edit update reactivate_user confirm_delete confirm_reactivate destroy]
+  before_action :find_user,
+                only: %i[show edit update reactivate_user confirm_delete confirm_reactivate destroy edit_email
+                         update_email]
 
   def index
     @users = User.search(params[:search]).page(params[:page])
@@ -76,6 +78,26 @@ def update
     redirect_to admin_user_path(@user)
   end
 
+  def edit_email; end
+
+  def update_email
+    new_email = user_params[:email]
+    if new_email == @user.email
+      flash[:notice] = I18n.t('errors.messages.error_updating_same_user_email_in_auth0')
+      redirect_to admin_user_path(@user)
+      return
+    end
+
+    result = UpdateUserEmail.new(@user, new_email)
+    if result.call
+      flash[:notice] = I18n.t('errors.messages.success_updating_user_email_in_auth0')
+    elsif result.errors
+      flash[:alert] =
+        I18n.t('errors.messages.error_updating_user_email_in_auth0') + ": #{result.errors.full_messages.join(', ')}"
+    end
+    redirect_to admin_user_path(@user)
+  end
+
   def confirm_delete; end
 
   def confirm_reactivate; end

app/controllers/v1/email_verifications_controller.rb

@@ -0,0 +1,97 @@
+module V1
+  class EmailVerificationsController < ApiController
+    skip_before_action :reject_without_user!, only: [:verification]
+
+    def create
+      user = User.find_by(auth_id: current_auth_id)
+      new_email = params.dig('_jsonapi', 'new_email')
+
+      verification_request = verification_request(user, new_email)
+
+      if verification_request.save
+
+        SendEmailVerificationJob.perform_later(
+          new_email: new_email,
+          verification_url: verification_request.verification_url,
+          person_name: user.name
+        )
+
+        render jsonapi: verification_request, status: :ok, context: { request: request }
+      else
+        render jsonapi_errors: verification_request.errors, status: :unprocessable_entity
+      end
+    end
+
+    def verification
+      token = find_token_params || (return render_invalid_token_error)
+      email_change_request = EmailChangeRequest.find_by(token: token) || (return render_invalid_token_error)
+      update_user_email = update_email(email_change_request)
+      email_change_request.update(used_at: Time.current, active: false)
+
+      return render jsonapi: email_change_request.user, status: :ok if update_user_email&.call
+
+      error_body = verification_request&.errors ||
+                   { error: I18n.t('email_verifications.invalid_or_expired_token') }
+      render jsonapi_errors: error_body, status: :unprocessable_entity
+    end
+
+    def active
+      user = User.find_by(auth_id: current_auth_id)
+      unless user
+        render jsonapi_errors: { error: 'User not found' }, status: :not_found
+        return
+      end
+
+      verification = EmailChangeRequest.where(user: user, active: true).order(created_at: :desc).first
+
+      if verification
+        render jsonapi: verification, status: :ok, context: { request: request }
+      else
+        render jsonapi_errors: { error: 'No active email verification found' }, status: :not_found
+      end
+    end
+
+    def cancel_pending_email_change
+      user = User.find_by(auth_id: current_auth_id)
+      unless user
+        render jsonapi_errors: { error: 'User not found' }, status: :not_found
+        return
+      end
+
+      EmailChangeRequest.where(user: user, active: true).find_each do |record|
+        record.update(active: false)
+      end
+
+      head :no_content
+    end
+
+    private
+
+    def verification_request(user, new_email)
+      expires_at = 2.days.from_now
+
+      EmailChangeRequest.where(user: user, active: true).find_each do |record|
+        record.update(active: false)
+      end
+
+      EmailChangeRequest.new(
+        user: user,
+        new_email: new_email,
+        expires_at: expires_at
+      )
+    end
+
+    def update_email(email_change_request)
+      UpdateUserEmail.new(email_change_request.user, email_change_request.new_email)
+    end
+
+    def render_invalid_token_error
+      render jsonapi_errors: ApiMessage.new({ message: I18n.t('email_verifications.invalid_or_expired_token') }),
+             status: :unprocessable_entity
+    end
+
+    def find_token_params
+      params.dig('_jsonapi', 'token')
+    end
+  end
+end

app/controllers/v1/users_controller.rb

@@ -17,4 +17,60 @@ def update_name
              status: :unprocessable_entity
     end
   end
+
+  def update_email
+    user = User.find_by(auth_id: current_auth_id)
+    new_email = params.dig('_jsonapi', 'email')
+
+    if new_email.blank?
+      render jsonapi_errors: { email: ['is required'] }, status: :unprocessable_entity
+      return
+    end
+
+    verification_request = verification_request(user, new_email)
+
+    if verification_request.save
+      notify_result = SendEmailVerificationJob.perform_later(
+        new_email: new_email,
+        verification_url: verification_request.verification_url,
+        person_name: user.name
+      )
+
+      if notify_result == false
+        render jsonapi_errors: { notify: ['Failed to send email'] }, status: :unprocessable_entity
+        return
+      end
+
+      render jsonapi: verification_request, status: :ok, context: { request: request }
+    else
+      render jsonapi_errors: verification_request.errors.presence || { base: ['Failed to save verification request'] },
+             status: :unprocessable_entity
+    end
+  end
+
+  def verification_request(user, new_email)
+    token = SecureRandom.hex(24)
+    expires_at = 2.days.from_now
+
+    EmailChangeRequest.where(user: user, active: true).find_each do |record|
+      record.update(active: false)
+    end
+
+    EmailChangeRequest.new(
+      user: user,
+      new_email: new_email,
+      token: token,
+      expires_at: expires_at
+    )
+  end
+
+  def user_auth_logs
+    user = User.find_by!(auth_id: current_auth_id)
+    auth_logs = UserLogsInAuth0.new(user: user).call
+    objects = auth_logs.map do |log|
+      OpenStruct.new(log.merge('id' => SecureRandom.uuid))
+    end
+
+    render jsonapi: objects, class: { OpenStruct: SerializableUserAuthLog }, status: :ok
+  end
 end

app/jobs/send_confirm_email_verification_job.rb

@@ -0,0 +1,17 @@
+class SendConfirmEmailVerificationJob < ApplicationJob
+  queue_as :default
+
+  TEMPLATE_ID = '59cda9d1-9a70-4196-8b50-fba71e410765'.freeze
+
+  def perform(new_email:, person_name: nil)
+    Notify.new.send_email(
+      template_id: TEMPLATE_ID,
+      email: new_email,
+      vars: {
+        login_url: ENV['FRONTEND_URL'],
+        email_address: new_email,
+        person_name: person_name
+      }
+    )
+  end
+end

app/jobs/send_email_verification_job.rb

@@ -0,0 +1,17 @@
+class SendEmailVerificationJob < ApplicationJob
+  queue_as :default
+
+  TEMPLATE_ID = '26164cdb-915b-4e13-97e9-d4a42367f068'.freeze
+
+  def perform(new_email:, verification_url:, person_name: nil)
+    Notify.new.send_email(
+      template_id: TEMPLATE_ID,
+      email: new_email,
+      vars: {
+        verify_url: verification_url,
+        new_email: new_email,
+        person_name: person_name
+      }
+    )
+  end
+end

app/models/api_message.rb

@@ -0,0 +1,26 @@
+class ApiMessage
+  def initialize(attributes = {})
+    @attributes = attributes.transform_keys(&:to_sym)
+    @attributes[:id] ||= SecureRandom.uuid
+  end
+
+  def id
+    @attributes[:id]
+  end
+
+  def as_json(*_args)
+    @attributes
+  end
+
+  def method_missing(method, *args, &block)
+    if @attributes.key?(method)
+      @attributes[method]
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    @attributes.key?(method) || super
+  end
+end

app/models/email_change_request.rb

@@ -0,0 +1,39 @@
+class EmailChangeRequest < ApplicationRecord
+  has_secure_token :token, length: 64
+  belongs_to :user
+
+  validates :new_email, presence: true, format: { with: URI::MailTo::EMAIL_REGEXP }
+  validates :expires_at, presence: true
+  validate :new_email_not_taken
+  validate :email_not_verified
+  validate :verifiable, on: :update
+
+  def self.verified_email(user, new_email)
+    where(user: user, new_email: new_email, active: false)
+      .where.not(used_at: nil)
+      .order(used_at: :desc)
+      .first
+  end
+
+  def email_not_verified
+    return if self.class.verified_email(user, new_email).blank?
+
+    errors.add(:new_email, I18n.t('email_verifications.already_verified'))
+  end
+
+  def verification_url
+    "#{ENV['FRONTEND_URL']}/email/verification/#{token}"
+  end
+
+  def verifiable
+    used_at.nil? && expires_at > Time.current
+  end
+
+  private
+
+  def new_email_not_taken
+    return unless User.exists?(email: new_email)
+
+    errors.add(:new_email, 'is already taken')
+  end
+end

app/models/user.rb

@@ -1,6 +1,9 @@
 require './lib/auth0_api'
 
 class User < ApplicationRecord
+  has_one :email_change_request, lambda {
+    where(active: true).order(created_at: :desc)
+  }, class_name: 'EmailChangeRequest', dependent: :destroy, inverse_of: :user
   has_many :memberships, dependent: :destroy
   has_many :suppliers, through: :memberships
   has_many :submissions, through: :suppliers