shieldify 0.1.2.pre.alpha → 0.2.9.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6517cc618765bddd3e12fae12071e15d5c1fce7caba98f48468b8997d7269d72
-  data.tar.gz: b62d7d9fd12ffbaa0dd40261925e537bbfe88dbcaafa40f54b2fb666b44c400d
+  metadata.gz: 8007ae4f6ae3303eea8c4c4e235e5f44e6ab2fee48462cbee91a298401bcb218
+  data.tar.gz: 65351705a326f96589ab63b68a09c1b253e6a2a7460960aa3fa7b3a6ee54c367
 SHA512:
-  metadata.gz: cde0954c079bd2fa807002523e8f0b9d6fa929efef4c8c2154fb737625fa6c8e9a54041426718172e663f46cc664eb158f42fd3b2e783acdf3a7f375a7ec9394
-  data.tar.gz: 05e5de36f1b7344fbdd56610ad32b0169be7e9e57c4cbea03b32483a7f7972a220d7915fa024dbb1f298b4eac00204852df081a4f456cc7ccfd6bc45f2ccf4ac
+  metadata.gz: 4227ce3246d89c0e59c6aa4d788d026ca529a1d64811da6a0185f2af48a8144b7f4547c325136e05224a09705617cba8016d89692b877e228337f3851d7165d8
+  data.tar.gz: 9980cb0d979723be2cc09199e08e093ab1983bdaef237cf04bda874f3d3a239aa9954e9564d79c08009c962ea27472bf2a58fbc5cb5eed0124879a0375d0a972

data/app/controllers/users/access_controller.rb

@@ -1,16 +1,7 @@
 module Users
-  class AccessController < ActionController::Base
-    # GET /users/access/:token/unlock
+  class AccessController < ActionController::API
     def show
-      user = User.find_by(unlock_token: params[:token])
-
-      if user.present? && user.unlock_access
-        # Asume que `unlock_access` es un método en tu modelo User que realiza la lógica necesaria
-        # para desbloquear el acceso del usuario y limpiar el token de desbloqueo.
-        render json: { message: 'Tu cuenta ha sido desbloqueada exitosamente. Ahora puedes iniciar sesión.' }, status: :ok
-      else
-        render json: { error: 'El token proporcionado no es válido o ya ha sido utilizado.' }, status: :not_found
-      end
+      # pending
     end
   end
 end

data/app/controllers/users/emails/reset_passwords_controller.rb

@@ -1,30 +1,33 @@
 module Users
   module Emails
-    class ResetPasswordsController < ActionController::Base
-      # POST /users/email/reset_password
+    class ResetPasswordsController < ActionController::API
+      # Action to request a password reset
       def create
         user = User.find_by(email: params[:email])
+        message = I18n.t("shieldify.controllers.emails.reset_passwords.create.success")
 
-        if user.present?
-          # Aquí se asume la existencia de un método que genera un token de restablecimiento
-          # de contraseña y envía un correo electrónico al usuario con instrucciones.
-          user.send_reset_email_password_instructions
-          render json: { message: 'Se ha enviado un correo con instrucciones para restablecer tu contraseña.' }, status: :ok
-        else
-          render json: { error: 'No se encontró un usuario con ese correo electrónico.' }, status: :not_found
-        end
+        user.send_reset_email_password_instructions if user
+
+        render json: { message: message }, status: :ok
       end
 
-      # PUT /users/email/:token/reset_password
+      # Action to update the password
       def update
-        user = User.find_by(reset_email_password_token: params[:token])
-
-        if user.present? && user.reset_password(params[:password], params[:password_confirmation])
-          render json: { message: 'Tu contraseña ha sido restablecida exitosamente.' }, status: :ok
+        user = User.find_by_reset_email_password_token(params[:token])
+        
+        if user
+          if user.reset_password(new_password: params[:password], new_password_confirmation: params[:password_confirmation])
+            message = I18n.t("shieldify.controllers.emails.reset_passwords.update.success")
+            render json: { message: message }, status: :ok
+          else
+            render json: { errors: user.errors.full_messages }, status: :unprocessable_entity
+          end
         else
-          render json: { error: 'El token no es válido o las contraseñas no coinciden.' }, status: :unprocessable_entity
+          message = I18n.t("shieldify.controllers.emails.reset_passwords.update.failure")
+          render json: { error: message }, status: :unprocessable_entity
         end
       end
     end
   end
-end
+end
+

data/app/controllers/users/emails_controller.rb

@@ -1,17 +1,23 @@
 module Users
-  class EmailsController < ActionController::Base
+  class EmailsController < ActionController::API
+    # Action to confirm an email
     def show
       token = params[:token]
       user = User.confirm_email_by_token(token)
 
-      if user.errors.blank?
-        render(
-          json: { message: I18n.t("shieldify.controllers.emails.confirmation.success_messages") },
-          status: :ok
-        )
-      else
-        render json: { errors: user.errors.full_messages }, status: :unprocessable_entity
-      end
+      message = user.errors.blank? ? I18n.t("shieldify.controllers.emails.confirmation.success_messages") : user.errors.full_messages.last
+      status = user.errors.blank? ? 'success' : 'error'
+
+      set_cookie('shfy_message', message)
+      set_cookie('shfy_status', status)
+
+      redirect_to(Shieldify::Configuration.before_confirmation_url, allow_other_host: true)
+    end
+
+    private
+
+    def set_cookie(name, value)
+      response.set_cookie(name, { value: value, expires: 1.hour.from_now, path: '/' })
     end
   end
-end
+end

data/lib/generators/shieldify/install_generator.rb

@@ -30,13 +30,14 @@ module Shieldify
 
     def copy_locale_file
       template "locales/en.shieldify.yml", File.join("config", "locales", "en.shieldify.yml")
+      template "locales/es.shieldify.yml", File.join("config", "locales", "es.shieldify.yml")
     end
 
     private
 
     def model_contents
       <<-CONTENT
-  shieldify email_authenticatable: %i[registerable confirmable]
+  shieldify email_authenticatable: %i[registerable confirmable password_recoverable]
 CONTENT
     end
 

data/lib/generators/shieldify/templates/initializer.rb.tt

@@ -1,4 +1,19 @@
 Shieldify.setup do |conf|
+
+  ## Reset Email Password
+  
+  # This configuration defines the URL of the frontend form where users will be redirected to reset their password.
+  # When a user requests a password reset, the backend will generate a token and include this URL in the email sent to the user.
+  # The URL should point to the password reset form on the frontend application, and it will include the reset token as a query parameter.
+  # conf.reset_password_form_url = "http://localhost:3000/reset-password"
+
+  ## Email Confirmation
+
+  # This configuration defines the URL to redirect users to after they have confirmed their email address.
+  # This URL is used for redirection following a successful email confirmation.
+  # It can be set to any page in your frontend application where users should land after their email has been confirmed.
+  # conf.before_confirmation_url = "http://localhost:3000/login"
+
   ## Mailer
 
   # The parent mailer for internal mailers.

data/lib/generators/shieldify/templates/locales/en.shieldify.yml.tt

@@ -1,26 +1,33 @@
 en:
+  activerecord:
+    attributes:
+      user:
+        email: "Email"
+        unconfirmed_email: "Unconfirmed Email"
+        password: "Password"
+        email_confirmation_token: "Email Confirmation Token"
+        email_confirmation_token_generated_at: "Email Confirmation Token Generated At"
+        reset_email_password_token: "Reset Email Password Token"
+        reset_email_password_token_generated_at: "Reset Email Password Token Generated At"
+    errors:
+      messages:
+        invalid: "is not valid"
+        invalid_or_expired: "is invalid or has expired"
+        password_not_match: "doesn't match Password"
+        password_complexity: "It must include at least one uppercase letter, one lowercase letter, one number, and one special character (@$!%*?&)"
+        expired: "has expired"
+        not_found: "not found"
   shieldify:
     controllers:
       emails:
         confirmation:
           success_messages: "Email successfully confirmed"
-    models:
-      email_authenticatable:
-        registerable:
-          password:
-            errors:
-              invalid: "invalid"
-          password_complexity:
-            format: It must include at least one uppercase letter, one lowercase letter, one number, and one special character (@$!%*?&)
-        confirmable:
-          email_confirmation_token:
-            errors:
-              invalid: "invalid"
-              expired: "has expired"
-          unconfirmed_email:
-            errors:
-              not_found: "not found"
-          email_confirmation_token_generated_at:
+        reset_passwords:
+          create:
+            success: "If the email exists, the reset password instructions will be sent to your email."
+          update:
+            success: "Password has been reset successfully."
+            failure: "Password reset failed. Please try again."
     mailer:
       email_confirmation_instructions:
         subject: "Email Confirmation Instructions"
@@ -29,7 +36,7 @@ en:
         thanks: "Please confirm your email by clicking on the following link:"
         confirm_account: "Confirm email"
         ignore: "If you did not request this confirmation, please ignore this email."
-      reset_password_instructions:
+      reset_email_password_instructions:
         subject: "Password Reset Instructions"
         title: "Password Reset Instructions"
         greeting: "Hello %{email},"

data/lib/generators/shieldify/templates/locales/es.shieldify.yml.tt

@@ -1,16 +1,34 @@
 es:
+  activerecord:
+    attributes:
+      user:
+        email: "Correo electrónico"
+        unconfirmed_email: "Correo electrónico no confirmado"
+        password: "Contraseña"
+        current_password: "Contraseña actual"
+        email_confirmation_token: "Token de confirmación del correo electrónico"
+        email_confirmation_token_generated_at: "Token de confirmación del correo electrónico generado en"
+        reset_email_password_token: "Token de restablecimiento de contraseña del correo electrónico"
+        reset_email_password_token_generated_at: "Token de restablecimiento de contraseña del correo electrónico generado en"
+    errors:
+      messages:
+        invalid: "no es válido"
+        invalid_or_expired: "no es válido o ha expirado"
+        password_not_match: "no coincide con la contraseña"
+        password_complexity: "Debe incluir al menos una letra mayúscula, una letra minúscula, un número y un carácter especial (@$!%*?&)"
+        expired: "ha expirado"
+        not_found: "no encontrado"
   shieldify:
-    models:
-      email_authenticatable:
-        confirmable:
-          email_confirmation_token:
-            errors:
-              invalid: "inválido"
-              expired: "ha expirado"
-          unconfirmed_email:
-            errors:
-              not_found: "no encontrado"
-          email_confirmation_token_generated_at:
+    controllers:
+      emails:
+        confirmation:
+          success_messages: "Correo electrónico confirmado con éxito"
+        reset_passwords:
+          create:
+            success: "Si el correo electrónico existe, se enviarán las instrucciones para restablecer la contraseña."
+          update:
+            success: "La contraseña se ha restablecido con éxito."
+            failure: "El restablecimiento de la contraseña falló. Por favor, inténtalo de nuevo."
     mailer:
       email_confirmation_instructions:
         subject: "Instrucciones de Confirmación de Email"
@@ -19,7 +37,7 @@ es:
         thanks: "Por favor confirma tu email haciendo clic en el siguiente enlace:"
         confirm_account: "Confirmar email"
         ignore: "Si no has solicitado esta confirmación, por favor ignora este correo."
-      reset_password_instructions:
+      reset_email_password_instructions:
         subject: "Instrucciones para Restablecer Contraseña"
         title: "Instrucciones para Restablecer Contraseña"
         greeting: "Hola %{email},"

data/lib/generators/shieldify/templates/mailer_layouts/mailer.html.erb

@@ -1,7 +1,6 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title><%= t('shieldify.mailer.confirmation_instructions.title') %></title>
     <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
   </head>
   <body>

data/lib/generators/shieldify/templates/mailer_layouts/mailer.text.erb

@@ -1,3 +1 @@
-<%= t('shieldify.mailer.email_changed.title') %>
-
 <%= yield %>

data/lib/generators/shieldify/templates/mailer_views/reset_email_password_instructions.html.erb

@@ -1,5 +1,5 @@
-<h1><%= t('shieldify.mailer.reset_password_instructions.greeting', name: @user.name) %></h1>
-<p><%= t('shieldify.mailer.reset_password_instructions.instructions') %></p>
-<p><%= link_to t('shieldify.mailer.reset_password_instructions.change_password'), edit_password_url(@user.reset_password_token) %></p>
-<p><%= t('shieldify.mailer.reset_password_instructions.link_expiration', expiration_hours: 24) %></p>
-<p><%= t('shieldify.mailer.reset_password_instructions.ignore') %></p>
+<h1><%= t('shieldify.mailer.reset_email_password_instructions.greeting', email: @user.email) %></h1>
+<p><%= t('shieldify.mailer.reset_email_password_instructions.instructions') %></p>
+<p><%= link_to t('shieldify.mailer.reset_email_password_instructions.change_password'), @reset_password_form_url %></p>
+<p><%= t('shieldify.mailer.reset_email_password_instructions.link_expiration', expiration_hours: 24) %></p>
+<p><%= t('shieldify.mailer.reset_email_password_instructions.ignore') %></p>

data/lib/generators/shieldify/templates/mailer_views/reset_email_password_instructions.text.erb

@@ -1,9 +1,9 @@
-<%= t('shieldify.mailer.reset_password_instructions.greeting', name: @user.name) %>
+<%= t('shieldify.mailer.reset_email_password_instructions.greeting', email: @user.email) %>
 
-<%= t('shieldify.mailer.reset_password_instructions.instructions') %>
+<%= t('shieldify.mailer.reset_email_password_instructions.instructions') %>
 
-<%= edit_password_url(@user.reset_password_token) %>
+<%= @reset_password_form_url %>
 
-<%= t('shieldify.mailer.reset_password_instructions.link_expiration', expiration_hours: 24) %>
+<%= t('shieldify.mailer.reset_email_password_instructions.link_expiration', expiration_hours: 24) %>
 
-<%= t('shieldify.mailer.reset_password_instructions.ignore') %>
+<%= t('shieldify.mailer.reset_email_password_instructions.ignore') %>

data/lib/generators/shieldify/templates/migration.rb.tt

@@ -12,6 +12,10 @@ class ShieldifyCreateUsers < ActiveRecord::Migration<%= migration_version %>
       t.string :email_confirmation_token
       t.string :email_confirmation_token_generated_at
 
+      ## Email password recoverable
+      t.string :reset_email_password_token
+      t.string :reset_email_password_token_generated_at
+
       t.timestamps null: false
     end
 
@@ -22,7 +26,7 @@ class ShieldifyCreateUsers < ActiveRecord::Migration<%= migration_version %>
       t.timestamps
     end
 
-    add_index :users, :email, unique: true
+    add_index :users, :email
     add_index :jwt_sessions, :jti, unique: true
   end
 end

data/lib/shieldify/mailer.rb

@@ -5,8 +5,8 @@ module Shieldify
     layout 'layouts/shieldify/mailer'
 
     default(
-      from: Shieldify::Configuration.mailer_sender,
-      reply_to: Shieldify::Configuration.reply_to
+      from: -> { Shieldify::Configuration.mailer_sender },
+      reply_to: -> { Shieldify::Configuration.reply_to }
     )
 
     def base_mailer

data/lib/shieldify/models/email_authenticatable/confirmable.rb

@@ -123,8 +123,7 @@ module Shieldify
             return add_error_to_empty_user(:email_confirmation_token, :invalid) if user.blank?
 
             if user.email_confirmation_token_expired?
-              msg = I18n.t('shieldify.models.email_authenticatable.confirmable.email_confirmation_token.errors.expired')
-              user.errors.add(:email_confirmation_token, msg)
+              user.errors.add(:email_confirmation_token, :expired)
 
               return user
             end
@@ -144,12 +143,7 @@ module Shieldify
 
           def add_error_to_empty_user(param, error)
             user = new
-
-            user.errors.add(
-              param.to_sym,
-              I18n.t("shieldify.models.email_authenticatable.confirmable.#{param.to_sym}.errors.#{error.to_sym}")
-            )
-
+            user.errors.add(param, error)
             user
           end
         end

data/lib/shieldify/models/email_authenticatable/password_recoverable.rb

@@ -0,0 +1,76 @@
+module Shieldify
+  module Models
+    module EmailAuthenticatable
+      module PasswordRecoverable
+        extend ActiveSupport::Concern
+
+        included do
+          before_save :clear_reset_email_password_token, if: -> { password_digest_changed? }
+        end
+
+        class_methods do
+          def find_by_reset_email_password_token(token)
+            return nil if token.nil?
+
+            find_by(reset_email_password_token: token)
+          end
+        end
+
+        def generate_reset_email_password_token
+          self.reset_email_password_token = SecureRandom.hex(10)
+          self.reset_email_password_token_generated_at = Time.current
+          save
+        end
+
+        def send_reset_email_password_instructions
+          generate_reset_email_password_token
+
+          params = {
+            user: self,
+            email_to: email,
+            reset_password_form_url: reset_password_form_url(reset_email_password_token),
+            action: :reset_email_password_instructions
+          }
+          
+          Shieldify::Mailer.with(params).base_mailer.deliver_now
+        end
+
+        def reset_password(new_password:, new_password_confirmation:)
+          if reset_email_password_token_valid?
+            if new_password == new_password_confirmation
+              self.password = new_password
+              clear_reset_email_password_token
+              save
+            else
+              errors.add(:password_confirmation, :password_not_match)
+              false
+            end
+          else
+            errors.add(:reset_email_password_token, :invalid_or_expired)
+            false
+          end
+        end
+
+        private
+
+        def clear_reset_email_password_token
+          self.reset_email_password_token = nil
+          self.reset_email_password_token_generated_at = nil
+        end
+
+        def reset_email_password_token_valid?
+          reset_email_password_token_generated_at && reset_email_password_token_generated_at >= 2.hours.ago
+        end
+
+        def reset_password_form_url(token = nil)
+          if token.present?
+            Shieldify::Configuration.reset_password_form_url + "?token=#{token}"
+          else
+            Shieldify::Configuration.reset_password_form_url
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/shieldify/models/email_authenticatable/registerable.rb

@@ -55,13 +55,10 @@ module Shieldify
         def update_password(current_password:, new_password:, password_confirmation:)
           if authenticate(current_password)
             if update(password: new_password, password_confirmation: password_confirmation)
-              send_password_changed_notification if Shieldify::Configuration.send_password_changed_notification
+              send_password_changed_notification if should_send_password_changed_notification?
             end
           else
-            errors.add(
-              :current_password,
-              I18n.t("shieldify.models.email_authenticatable.registerable.password.errors.invalid")
-            )
+            errors.add(:password, :invalid)
           end
         
           self
@@ -75,12 +72,10 @@ module Shieldify
         def update_email(current_password:, new_email:)
           if authenticate(current_password)
             if update(email: new_email)
-              send_email_changed_notification if Shieldify::Configuration.send_email_changed_notification
+              send_email_changed_notification if should_send_email_changed_notification?
             end
           else
-            errors.add(
-              :password,
-              I18n.t("shieldify.models.email_authenticatable.registerable.password.errors.invalid"))
+            errors.add(:password, :invalid)
           end
         
           self
@@ -105,12 +100,17 @@ module Shieldify
           regex = Shieldify::Configuration.password_complexity
 
           unless password.match?(regex)
-            errors.add(
-              :password,
-              I18n.t("shieldify.models.email_authenticatable.registerable.password_complexity.format")
-            )
+            errors.add(:password, :password_complexity)
           end
         end
+
+        def should_send_password_changed_notification?
+          Shieldify::Configuration.send_password_changed_notification
+        end
+
+        def should_send_email_changed_notification?
+          Shieldify::Configuration.send_email_changed_notification
+        end
       end
     end
   end

data/lib/shieldify/railtie.rb

@@ -3,9 +3,8 @@ module Shieldify
     initializer 'shieldify.add_routes' do |app|
       app.routes.prepend do
         get 'shfy/users/email/:token/confirm', to: 'users/emails#show', as: :users_email_confirmation
-        # post 'shfy/users/email/reset_password', to: 'users/emails/reset_passwords#create'
-        # put 'shfy/users/email/:token/reset_password', to: 'users/emails/reset_passwords#update'
-        # get 'shfy/users/access/:token/unlock', to: 'users/access#show'
+        post 'shfy/users/email/request_password_recovery', to: 'users/emails/reset_passwords#create', as: :users_request_password_recovery
+        put 'shfy/users/email/reset_password', to: 'users/emails/reset_passwords#update', as: :users_reset_password
       end
     end
 
@@ -29,6 +28,7 @@ module Shieldify
     initializer 'shieldify.require' do
       require_relative '../../app/models/jwt_session'
       require_relative '../../app/controllers/users/emails_controller'
+      require_relative '../../app/controllers/users/emails/reset_passwords_controller'
     end
 
     initializer 'shieldify.active_record' do

data/lib/shieldify/version.rb

@@ -1,3 +1,3 @@
 module Shieldify
-  VERSION = "0.1.2-alpha"
+  VERSION = "0.2.9-alpha"
 end

data/lib/shieldify.rb

@@ -13,6 +13,18 @@ module Shieldify
   class Configuration
     include Singleton
 
+    # This configuration defines the URL of the frontend form where users will be redirected to reset their password.
+    # When a user requests a password reset, the backend will generate a token and include this URL in the email sent to the user.
+    # The URL should point to the password reset form on the frontend application, and it will include the reset token as a query parameter.
+    mattr_accessor :reset_password_form_url
+    @@reset_password_form_url = "http://localhost:3000/reset-password"
+
+    # This configuration defines the URL to redirect users to after they have confirmed their email address.
+  # This URL is used for redirection following a successful email confirmation.
+  # It can be set to any page in your frontend application where users should land after their email has been confirmed.
+    mattr_accessor :before_confirmation_url
+    @@before_confirmation_url = "http://localhost:3000/login"
+
     # Default mailer sender.
     mattr_accessor :mailer_sender
     @@mailer_sender = "shieldify@example.com"
@@ -70,5 +82,6 @@ end
 require "shieldify/models/email_authenticatable"
 require "shieldify/models/email_authenticatable/registerable"
 require "shieldify/models/email_authenticatable/confirmable"
+require "shieldify/models/email_authenticatable/password_recoverable"
 require "shieldify/jwt_service"
 require "shieldify/mailer"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shieldify
 version: !ruby/object:Gem::Version
-  version: 0.1.2.pre.alpha
+  version: 0.2.9.pre.alpha
 platform: ruby
 authors:
 - Armando Alejandre
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-07 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -127,6 +127,7 @@ files:
 - lib/shieldify/model_extensions.rb
 - lib/shieldify/models/email_authenticatable.rb
 - lib/shieldify/models/email_authenticatable/confirmable.rb
+- lib/shieldify/models/email_authenticatable/password_recoverable.rb
 - lib/shieldify/models/email_authenticatable/registerable.rb
 - lib/shieldify/railtie.rb
 - lib/shieldify/strategies/email.rb