securial 0.7.0 → 0.8.0

data/lib/securial/logger/builder.rb

@@ -1,60 +1,45 @@
 require "logger"
 require "active_support/logger"
 require "active_support/tagged_logging"
-require_relative "colors"
-require_relative "broadcaster"
+
+require "securial/logger/broadcaster"
+require "securial/logger/formatter"
 
 module Securial
   module Logger
-    def self.build # rubocop:disable Metrics/MethodLength
-      loggers = []
-      colorize_stdout = false
+    class Builder
+      def self.build
+        loggers = []
+        progname = "Securial"
 
-      unless Securial.configuration.log_to_file == false
-        file_logger = ::Logger.new(Rails.root.join("log", "securial.log"))
-        file_logger.level = resolve_level(Securial.configuration.log_file_level)
-        file_logger.formatter = ::Logger::Formatter.new
-        loggers << file_logger
-      end
+        file_logger_enabled = Securial.configuration.log_to_file
+        file_logger_level = Securial.configuration.log_file_level
+        stdout_logger_enabled = Securial.configuration.log_to_stdout
+        stdout_logger_level = Securial.configuration.log_stdout_level
 
-      unless Securial.configuration.log_to_stdout == false
-        stdout_logger = ::Logger.new(STDOUT)
-        stdout_logger.level = resolve_level(Securial.configuration.log_stdout_level)
-        stdout_logger.formatter = proc do |severity, timestamp, progname, msg|
-          color = COLORS[severity] || CLEAR
-          padded = severity.ljust(SEVERITY_WIDTH)
-          formatted = "#{timestamp.strftime("%Y-%m-%d %H:%M:%S")} #{padded} -- : #{msg}\n"
-          "#{color}#{formatted}#{CLEAR}"
-        end
-        colorize_stdout = true
-        loggers << stdout_logger
-      end
+        create_file_logger(progname, file_logger_level, loggers) if file_logger_enabled
+        create_stdout_logger(progname, stdout_logger_level, loggers) if stdout_logger_enabled
 
-      if loggers.empty?
-        null_logger = ::Logger.new(IO::NULL)
-        return ActiveSupport::TaggedLogging.new(null_logger)
+        Broadcaster.new(loggers)
       end
 
-      broadcaster = Broadcaster.new(*loggers)
-      tagged_logger = ActiveSupport::TaggedLogging.new(broadcaster)
-
-      if colorize_stdout && !Rails.env.test?
-        tagged_logger.formatter = proc do |severity, timestamp, progname, msg|
-          color = COLORS[severity] || CLEAR
-          padded = severity.ljust(SEVERITY_WIDTH)
-          formatted = "#{timestamp.strftime("%Y-%m-%d %H:%M:%S")} #{padded} -- : #{msg}\n"
-          "#{color}#{formatted}#{CLEAR}"
-        end
+      def self.create_file_logger(progname, level, loggers)
+        file_logger = ::Logger.new(Rails.root.join("log", "securial-#{Rails.env}.log"))
+        file_logger.level = level
+        file_logger.progname = progname
+        file_logger.formatter = Formatter::PlainFormatter.new
+        tagged_file_logger = ActiveSupport::TaggedLogging.new(file_logger)
+        loggers << tagged_file_logger
       end
 
-      tagged_logger
-    end
-
-    def self.resolve_level(level)
-      return ::Logger::INFO if level.nil?
-      ::Logger.const_get(level.to_s.upcase)
-    rescue NameError
-      ::Logger::INFO
+      def self.create_stdout_logger(progname, level, loggers)
+        stdout_logger = ::Logger.new($stdout)
+        stdout_logger.level = level
+        stdout_logger.progname = progname
+        stdout_logger.formatter = Formatter::ColorfulFormatter.new
+        tagged_stdout_logger =  ActiveSupport::TaggedLogging.new(stdout_logger)
+        loggers << tagged_stdout_logger
+      end
     end
   end
 end

data/lib/securial/logger/formatter.rb

@@ -0,0 +1,35 @@
+module Securial
+  module Logger
+    module Formatter
+      COLORS = {
+        "DEBUG" => "\e[36m",   # cyan
+        "INFO" => "\e[32m",    # green
+        "WARN" => "\e[33m",    # yellow
+        "ERROR" => "\e[31m",   # red
+        "FATAL" => "\e[35m",   # magenta
+        "UNKNOWN" => "\e[37m", # white
+      }.freeze
+      CLEAR = "\e[0m"
+      SEVERITY_WIDTH = 5
+
+      class ColorfulFormatter
+        def call(severity, timestamp, progname, msg)
+          color = COLORS[severity] || CLEAR
+          padded_severity = severity.ljust(SEVERITY_WIDTH)
+          formatted = "[#{progname}][#{timestamp.strftime("%Y-%m-%d %H:%M:%S")}] #{padded_severity} -- #{msg}\n"
+
+          "#{color}#{formatted}#{CLEAR}"
+        end
+      end
+
+      class PlainFormatter
+        def call(severity, timestamp, progname, msg)
+          padded_severity = severity.ljust(SEVERITY_WIDTH)
+          formatted = "[#{timestamp.strftime("%Y-%m-%d %H:%M:%S")}] #{padded_severity} -- #{msg}\n"
+
+          formatted
+        end
+      end
+    end
+  end
+end

data/lib/securial/logger.rb

@@ -1,8 +1,15 @@
 require_relative "logger/builder"
 
 module Securial
-  module Logger
-    # This module serves as a namespace for logging functionality.
-    # It requires the Logger::Builder to provide logger building capabilities.
+  class << self
+    attr_accessor :logger
+
+    def logger
+      @logger ||= Logger::Builder.build
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
   end
 end

data/lib/securial/middleware/request_tag_logger.rb

@@ -0,0 +1,39 @@
+module Securial
+  module Middleware
+    class RequestTagLogger
+      def initialize(app, logger = Securial.logger)
+        @app = app
+        @logger = logger
+      end
+
+      def call(env)
+        request_id = request_id_from_env(env)
+        ip_address = ip_from_env(env)
+        user_agent = user_agent_from_env(env)
+
+        tags = []
+        tags << request_id if request_id
+        tags << "IP:#{ip_address}" if ip_address
+        tags << "UA:#{user_agent}" if user_agent
+
+        @logger.tagged(*tags) do
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def request_id_from_env(env)
+        env["action_dispatch.request_id"] || env["HTTP_X_REQUEST_ID"]
+      end
+
+      def ip_from_env(env)
+        env["action_dispatch.remote_ip"]&.to_s || env["REMOTE_ADDR"]
+      end
+
+      def user_agent_from_env(env)
+        env["HTTP_USER_AGENT"]
+      end
+    end
+  end
+end

data/lib/securial/middleware.rb

@@ -0,0 +1,13 @@
+require "securial/middleware/request_tag_logger"
+
+module Securial
+  module Middleware
+    # This module serves as a namespace for all middleware components in the Securial gem.
+    # It currently includes the RequestTagLogger middleware, which tags logs with request IDs.
+    #
+    # Additional middleware can be added here as the gem evolves.
+    #
+    # Example usage:
+    #   use Securial::Middleware::RequestTagLogger
+  end
+end

data/lib/securial/version.rb

@@ -1,3 +1,3 @@
 module Securial
-  VERSION = "0.7.0".freeze
+  VERSION = "0.8.0".freeze
 end

data/lib/securial.rb

@@ -1,35 +1,11 @@
 require "securial/version"
 require "securial/engine"
-require "securial/logger"
 
 require "jbuilder"
 
 module Securial
   class << self
-    attr_accessor :configuration
-    attr_accessor :logger
-
-    def configuration
-      @configuration ||= Securial::Config::Configuration.new
-    end
-
-    def configuration=(config)
-      @configuration = config
-      Securial::Config::Validation.validate_all!(configuration)
-    end
-
-    def configure
-      yield(configuration)
-    end
-
-    def logger
-      @logger ||= Securial::Logger.build
-    end
-
-    # Returns the pluralized form of the admin role.
-    # This behavior is intentional and aligns with the project's routing conventions.
-    def admin_namespace
-      configuration.admin_role.to_s.pluralize.downcase
-    end
+    delegate :protected_namespace, to: Securial::Helpers::RolesHelper
+    delegate :titleized_admin_role, to: Securial::Helpers::RolesHelper
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: securial
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aly Badawy
 bindir: bin
 cert_chain: []
-date: 2025-06-01 00:00:00.000000000 Z
+date: 2025-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,132 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.10'
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rack-attack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.7'
-- !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.40'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.40'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: factory_bot_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.4'
-- !ruby/object:Gem::Dependency
-  name: generator_spec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.1'
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.5'
 description: Securial is a mountable Rails engine that provides robust, extensible
   authentication and access control for Rails applications. It supports JWT, API tokens,
   session-based auth, and is designed for easy integration with modern web and mobile
@@ -231,8 +105,14 @@ files:
 - app/views/securial/roles/_securial_role.json.jbuilder
 - app/views/securial/roles/index.json.jbuilder
 - app/views/securial/roles/show.json.jbuilder
-- app/views/securial/securial_mailer/reset_password.html.erb
-- app/views/securial/securial_mailer/reset_password.text.erb
+- app/views/securial/securial_mailer/forgot_password.html.erb
+- app/views/securial/securial_mailer/forgot_password.text.erb
+- app/views/securial/securial_mailer/sign_in.html.erb
+- app/views/securial/securial_mailer/sign_in.text.erb
+- app/views/securial/securial_mailer/update_account.html.erb
+- app/views/securial/securial_mailer/update_account.text.erb
+- app/views/securial/securial_mailer/welcome.html.erb
+- app/views/securial/securial_mailer/welcome.text.erb
 - app/views/securial/sessions/_session.json.jbuilder
 - app/views/securial/sessions/index.json.jbuilder
 - app/views/securial/sessions/show.json.jbuilder
@@ -243,10 +123,10 @@ files:
 - app/views/securial/users/show.json.jbuilder
 - bin/securial
 - config/routes.rb
-- db/migrate/20250515104930_create_securial_roles.rb
-- db/migrate/20250517155521_create_securial_users.rb
-- db/migrate/20250518122749_create_securial_role_assignments.rb
-- db/migrate/20250519075407_create_securial_sessions.rb
+- db/migrate/20250603130214_create_securial_roles.rb
+- db/migrate/20250604110520_create_securial_users.rb
+- db/migrate/20250604123805_create_securial_role_assignments.rb
+- db/migrate/20250604184841_create_securial_sessions.rb
 - lib/generators/factory_bot/model/model_generator.rb
 - lib/generators/factory_bot/templates/factory.erb
 - lib/generators/securial/install/install_generator.rb
@@ -264,13 +144,24 @@ files:
 - lib/securial.rb
 - lib/securial/auth.rb
 - lib/securial/auth/auth_encoder.rb
-- lib/securial/auth/errors.rb
 - lib/securial/auth/session_creator.rb
+- lib/securial/auth/token_generator.rb
 - lib/securial/config.rb
 - lib/securial/config/configuration.rb
-- lib/securial/config/errors.rb
 - lib/securial/config/validation.rb
+- lib/securial/config/validation/logger_validation.rb
+- lib/securial/config/validation/mailer_validation.rb
+- lib/securial/config/validation/password_validation.rb
+- lib/securial/config/validation/response_validation.rb
+- lib/securial/config/validation/roles_validation.rb
+- lib/securial/config/validation/security_validation.rb
+- lib/securial/config/validation/session_validation.rb
 - lib/securial/engine.rb
+- lib/securial/engine_initializers.rb
+- lib/securial/error.rb
+- lib/securial/error/auth.rb
+- lib/securial/error/base_securial_error.rb
+- lib/securial/error/config.rb
 - lib/securial/factories/securial/role_assignments.rb
 - lib/securial/factories/securial/roles.rb
 - lib/securial/factories/securial/sessions.rb
@@ -278,31 +169,30 @@ files:
 - lib/securial/helpers.rb
 - lib/securial/helpers/normalizing_helper.rb
 - lib/securial/helpers/regex_helper.rb
-- lib/securial/inspectors.rb
-- lib/securial/inspectors/route_inspector.rb
-- lib/securial/key_transformer.rb
+- lib/securial/helpers/roles_helper.rb
 - lib/securial/logger.rb
 - lib/securial/logger/broadcaster.rb
 - lib/securial/logger/builder.rb
-- lib/securial/logger/colors.rb
-- lib/securial/middlewares.rb
-- lib/securial/middlewares/request_logger_tag.rb
-- lib/securial/middlewares/transform_request_keys.rb
-- lib/securial/middlewares/transform_response_keys.rb
-- lib/securial/security.rb
-- lib/securial/security/request_rate_limiter.rb
+- lib/securial/logger/formatter.rb
+- lib/securial/middleware.rb
+- lib/securial/middleware/request_tag_logger.rb
 - lib/securial/version.rb
-- lib/securial/version_checker.rb
 - lib/tasks/securial_tasks.rake
 homepage: https://github.com/AlyBadawy/Securial/wiki
 licenses:
 - MIT
 metadata:
-  release_date: '2025-06-01'
+  release_date: '2025-06-06'
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/AlyBadawy/Securial/wiki
   source_code_uri: https://github.com/AlyBadawy/Securial
   changelog_uri: https://github.com/AlyBadawy/Securial/blob/main/CHANGELOG.md
+post_install_message: "\n    ---\n    [SECURIAL] Thank you for installing Securial!\n\n
+  \   Securial is a mountable Rails engine that provides robust,\n    extensible authentication
+  and access control for Rails applications.\n      Please review the [changelog]
+  and [WIKI] for more info on the latest\n      changes and how to use this gem/engine:\n
+  \     [changelog]:  https://github.com/AlyBadawy/Securial/blob/main/CHANGELOG.md\n
+  \     [WIKI]:       https://github.com/AlyBadawy/Securial/wiki\n    ---\n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -310,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.4.1
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/app/views/securial/securial_mailer/reset_password.html.erb

@@ -1,5 +0,0 @@
-<p>
-  You can reset your password within the next <%= Securial.configuration.reset_password_token_expires_in.inspect %>.
-</p>
-
-<p>Your password reset token is: <%= @user.reset_password_token %></p>

data/app/views/securial/securial_mailer/reset_password.text.erb

@@ -1,4 +0,0 @@
-You can reset your password within the next <%= Securial.configuration.reset_password_token_expires_in.inspect %>.
-
-
-Your password reset token is: <%= @user.reset_password_token %>

data/lib/securial/auth/errors.rb

@@ -1,15 +0,0 @@
-module Securial
-  module Auth
-    module Errors
-      class BaseAuthError < StandardError
-        def backtrace; []; end
-      end
-
-      class AuthEncodeError < BaseAuthError; end
-      class AuthDecodeError < BaseAuthError; end
-
-      class AuthRevokedError < BaseAuthError; end
-      class AuthExpiredError < BaseAuthError; end
-    end
-  end
-end

data/lib/securial/config/errors.rb

@@ -1,20 +0,0 @@
-module Securial
-  module Config
-    module Errors
-      class BaseConfigError < StandardError
-        def backtrace; []; end
-      end
-
-      class ConfigAdminRoleError < BaseConfigError; end
-
-      class ConfigSessionExpirationDurationError < BaseConfigError; end
-      class ConfigSessionAlgorithmError < BaseConfigError; end
-      class ConfigSessionSecretError < BaseConfigError; end
-
-      class ConfigMailerSenderError < BaseConfigError; end
-      class ConfigPasswordError < BaseConfigError; end
-      class ConfigResponseError < BaseConfigError; end
-      class ConfigSecurityError < BaseConfigError; end
-    end
-  end
-end

data/lib/securial/inspectors/route_inspector.rb

@@ -1,52 +0,0 @@
-module Securial
-  module Inspectors
-    module RouteInspector
-      def self.print_routes(controller: nil)
-        filtered = Securial::Engine.routes.routes.select do |r|
-          ctrl = r.defaults[:controller]
-          controller.nil? || ctrl == "securial/#{controller}"
-        end
-
-        print_headers(filtered, controller)
-        print_details(filtered, controller)
-        true
-      end
-
-      class << self
-        private
-
-        # rubocop:disable Rails/Output
-        def print_headers(filtered, controller)
-          Securial.logger.debug "Securial engine routes:"
-          Securial.logger.debug "Total routes: #{filtered.size}"
-          Securial.logger.debug "Filtered by controller: #{controller}" if controller
-          Securial.logger.debug "Filtered routes: #{filtered.size}" if controller
-          Securial.logger.debug "-" * 120
-          Securial.logger.debug "#{'Verb'.ljust(8)} #{'Path'.ljust(45)} #{'Controller#Action'.ljust(40)} Name"
-          Securial.logger.debug "-" * 120
-        end
-
-        def print_details(filtered, controller) # rubocop:disable Rails/Output
-          if filtered.empty?
-            if controller
-              Securial.logger.debug "No routes found for controller: #{controller}"
-            else
-              Securial.logger.debug "No routes found for Securial engine"
-            end
-            Securial.logger.debug "-" * 120
-            return
-          end
-
-          Securial.logger.debug filtered.map { |r|
-            name = r.name || ""
-            verb = r.verb.to_s.ljust(8)
-            path = r.path.spec.to_s.sub(/\(\.:format\)/, "").ljust(45)
-            ctrl_action = "#{r.defaults[:controller]}##{r.defaults[:action]}"
-            "#{verb} #{path} #{ctrl_action.ljust(40)} #{name}"
-          }.join("\n")
-        end
-        # rubocop:enable Rails/Output
-      end
-    end
-  end
-end

data/lib/securial/inspectors.rb

@@ -1,8 +0,0 @@
-require "securial/inspectors/route_inspector"
-
-module Securial
-  module Inspectors
-    # This module serves as a namespace for inspectors.
-    # It requires the RouteInspector to provide route inspection capabilities.
-  end
-end

data/lib/securial/key_transformer.rb

@@ -1,32 +0,0 @@
-# lib/securial/key_transformer.rb
-module Securial
-  module KeyTransformer
-    def self.camelize(str, format)
-      return str unless str.is_a?(String)
-
-      case format
-      when :lowerCamelCase
-        str.camelize(:lower)
-      when :UpperCamelCase
-        str.camelize
-      else
-        str
-      end
-    end
-
-    def self.underscore(str)
-      str.to_s.underscore
-    end
-
-    def self.deep_transform_keys(obj, &block)
-      case obj
-      when Hash
-        obj.transform_keys(&block).transform_values { |v| deep_transform_keys(v, &block) }
-      when Array
-        obj.map { |e| deep_transform_keys(e, &block) }
-      else
-        obj
-      end
-    end
-  end
-end

data/lib/securial/logger/colors.rb

@@ -1,14 +0,0 @@
-module Securial
-  module Logger
-    COLORS = {
-      "DEBUG" => "\e[36m",   # cyan
-      "INFO" => "\e[32m",    # green
-      "WARN" => "\e[33m",    # yellow
-      "ERROR" => "\e[31m",   # red
-      "FATAL" => "\e[35m",   # magenta
-      "UNKNOWN" => "\e[37m", # white
-    }.freeze
-    CLEAR = "\e[0m"
-    SEVERITY_WIDTH = 5
-  end
-end