securial 0.5.0 → 0.7.0

data/lib/securial/logger/colors.rb

@@ -0,0 +1,14 @@
+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

data/lib/securial/logger.rb

@@ -1,71 +1,8 @@
-require "logger"
-require "active_support/logger"
-require "active_support/tagged_logging"
+require_relative "logger/builder"
 
 module Securial
-  class Logger
-    def self.build
-      outputs = []
-
-      unless Securial.configuration.log_to_file == false
-        log_file = Rails.root.join("log", "securial.log").open("a")
-        log_file.sync = true
-        outputs << log_file
-      end
-
-      unless Securial.configuration.log_to_stdout == false
-        outputs << STDOUT
-      end
-
-      if outputs.empty?
-        null_logger = ::Logger.new(IO::NULL)
-        return ActiveSupport::TaggedLogging.new(null_logger)
-      end
-
-      logger = ActiveSupport::Logger.new(MultiIO.new(*outputs))
-      logger.level = resolve_log_level
-      logger.formatter = ::Logger::Formatter.new
-
-      ActiveSupport::TaggedLogging.new(logger)
-    end
-
-    def self.resolve_log_level
-      file_level = Securial.configuration.log_file_level
-      stdout_level = Securial.configuration.log_stdout_level
-
-      # Use the lower (more verbose) level of the two
-      levels = [file_level, stdout_level].compact.map do |lvl|
-        begin
-          ::Logger.const_get(lvl.to_s.upcase)
-        rescue NameError
-          nil
-        end
-      end.compact
-
-      levels.min || ::Logger::INFO
-    end
-
-    private
-
-    class MultiIO
-      def initialize(*targets)
-        @targets = targets
-      end
-
-      def write(*args)
-        @targets.each { |t| t.write(*args) }
-      end
-
-      def close
-        @targets.each do |t|
-          next if [STDOUT, STDERR].include?(t)
-          t.close
-        end
-      end
-
-      def flush
-        @targets.each { |t| t.flush if t.respond_to?(:flush) }
-      end
-    end
+  module Logger
+    # This module serves as a namespace for logging functionality.
+    # It requires the Logger::Builder to provide logger building capabilities.
   end
 end

data/lib/securial/middlewares/request_logger_tag.rb

@@ -0,0 +1,19 @@
+module Securial
+  module Middlewares
+    class RequestLoggerTag
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        request_id = env["action_dispatch.request_id"] || env["HTTP_X_REQUEST_ID"]
+        tags = ["Securial"]
+        tags << request_id if request_id
+
+        logger = Securial.logger || Rails.logger || ::Logger.new(IO::NULL)
+        tagged_logger = logger.is_a?(ActiveSupport::TaggedLogging) ? logger : ActiveSupport::TaggedLogging.new(logger)
+        tagged_logger.tagged(*tags) { @app.call(env) }
+      end
+    end
+  end
+end

data/lib/securial/middlewares/transform_request_keys.rb

@@ -0,0 +1,33 @@
+# lib/securial/middlewares/transform_request_keys.rb
+require "json"
+
+module Securial
+  module Middlewares
+    class TransformRequestKeys
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env["CONTENT_TYPE"]&.include?("application/json") && Securial.configuration.response_keys_format != :snake_case
+          req = Rack::Request.new(env)
+          if (req.body&.size || 0) > 0
+            raw = req.body.read
+            req.body.rewind
+            begin
+              parsed = JSON.parse(raw)
+              transformed = Securial::KeyTransformer.deep_transform_keys(parsed) do |key|
+                Securial::KeyTransformer.underscore(key)
+              end
+              env["rack.input"] = StringIO.new(JSON.dump(transformed))
+              env["rack.input"].rewind
+            rescue JSON::ParserError
+              # noop
+            end
+          end
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/securial/middlewares/transform_response_keys.rb

@@ -0,0 +1,52 @@
+require "json"
+
+module Securial
+  module Middlewares
+    class TransformResponseKeys
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        status, headers, response = @app.call(env)
+
+        if json_response?(headers)
+          body = extract_body(response)
+
+          if body.present?
+            format = Securial.configuration.response_keys_format
+
+            # Only transform if not snake_case
+            if format != :snake_case
+              begin
+                transformed = Securial::KeyTransformer.deep_transform_keys(JSON.parse(body)) do |key|
+                  Securial::KeyTransformer.camelize(key, format)
+                end
+
+                new_body = [JSON.generate(transformed)]
+                headers["Content-Length"] = new_body.first.bytesize.to_s
+                return [status, headers, new_body]
+              rescue JSON::ParserError
+                # If not valid JSON, fall through and return original response
+              end
+            end
+          end
+        end
+
+        [status, headers, response]
+      end
+
+      private
+
+      def json_response?(headers)
+        headers["Content-Type"]&.include?("application/json")
+      end
+
+      def extract_body(response)
+        response_body = ""
+        response.each { |part| response_body << part }
+        response_body
+      end
+    end
+  end
+end

data/lib/securial/middlewares.rb

@@ -0,0 +1,10 @@
+require_relative "middlewares/transform_request_keys"
+require_relative "middlewares/transform_response_keys"
+require_relative "middlewares/request_logger_tag"
+
+module Securial
+  module Middleware
+    # This module serves as a namespace for middlewares.
+    # It requires the necessary middleware files to provide functionality.
+  end
+end

data/lib/securial/security/request_rate_limiter.rb

@@ -0,0 +1,68 @@
+require "rack/attack"
+require "securial/config"
+require "securial/logger"
+
+module Securial
+  module Security
+    module RequestRateLimiter
+      module_function
+
+      def apply! # rubocop:disable Metrics/MethodLength
+        resp_status = Securial.configuration.rate_limit_response_status
+        resp_message = Securial.configuration.rate_limit_response_message
+        # Throttle login attempts by IP
+        Rack::Attack.throttle("securial/logins/ip",
+                              limit: ->(_req) { Securial.configuration.rate_limit_requests_per_minute },
+                              period: 1.minute
+        ) do |req|
+          if req.path.include?("sessions/login") && req.post?
+            req.ip
+          end
+        end
+
+        # Throttle login attempts by username/email
+        Rack::Attack.throttle("securial/logins/email",
+                              limit: ->(_req) { Securial.configuration.rate_limit_requests_per_minute },
+                              period: 1.minute
+        ) do |req|
+          if req.path.include?("sessions/login") && req.post?
+            req.params["email_address"].to_s.downcase.strip
+          end
+        end
+
+        # Throttle password reset requests by IP
+        Rack::Attack.throttle("securial/password_resets/ip",
+                              limit: ->(_req) { Securial.configuration.rate_limit_requests_per_minute },
+                              period: 1.minute
+        ) do |req|
+          if req.path.include?("password/forgot") && req.post?
+            req.ip
+          end
+        end
+
+        # Throttle password reset requests by email
+        Rack::Attack.throttle("securial/password_resets/email",
+                              limit: ->(_req) { Securial.configuration.rate_limit_requests_per_minute },
+                              period: 1.minute
+        ) do |req|
+          if req.path.include?("password/forgot") && req.post?
+            req.params["email_address"].to_s.downcase.strip
+          end
+        end
+
+        # Custom response for throttled requests
+        Rack::Attack.throttled_responder = lambda do |request|
+          retry_after = (request.env["rack.attack.match_data"] || {})[:period]
+          [
+            resp_status,
+            {
+              "Content-Type" => "application/json",
+              "Retry-After" => retry_after.to_s,
+            },
+            [{ error: resp_message }.to_json]
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/securial/security.rb

@@ -0,0 +1,8 @@
+require "securial/security/request_rate_limiter"
+
+module Securial
+  module Security
+    # This module serves as a namespace for security-related functionality.
+    # It can be extended with additional security features in the future.
+  end
+end

data/lib/securial/version.rb

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

data/lib/securial/version_checker.rb

@@ -0,0 +1,31 @@
+require "net/http"
+require "json"
+
+module Securial
+  module VersionChecker
+    module_function
+
+    def check_latest_version
+      begin
+        rubygems_api_url = "https://rubygems.org/api/v1/versions/securial/latest.json"
+        uri = URI(rubygems_api_url)
+        http = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 5)
+        response = http.request(Net::HTTP::Get.new(uri))
+        latest = JSON.parse(response.body)["version"]
+
+        current = Securial::VERSION
+        if Gem::Version.new(latest) > Gem::Version.new(current)
+          Securial.logger.info "A newer version (#{latest}) of Securial is available. You are using #{current}."
+          Securial.logger.info "Please consider updating!"
+          Securial.logger.debug "You can update Securial by running the following command in your terminal:"
+          Securial.logger.debug "`bundle update securial`"
+        else
+          Securial.logger.info "You are using the latest version of Securial (#{current})."
+          Securial.logger.debug "No updates available at this time."
+        end
+      rescue => e
+        Securial.logger.debug("Version check failed: #{e.message}")
+      end
+    end
+  end
+end

data/lib/securial.rb

@@ -1,20 +1,31 @@
 require "securial/version"
 require "securial/engine"
+require "securial/logger"
 
 require "jbuilder"
 
 module Securial
   class << self
-    attr_writer :configuration
+    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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: securial
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Aly Badawy
 bindir: bin
 cert_chain: []
-date: 2025-05-28 00:00:00.000000000 Z
+date: 2025-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,61 +80,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !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: coveralls-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: rack-attack
   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
+        version: '6.7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.7'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -150,117 +108,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 - !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: overcommit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.67'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.67'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.75'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.75'
-- !ruby/object:Gem::Dependency
-  name: rubocop-config-prettier
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.13
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '3.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '3.40'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rails
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.32'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.32'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rails-omakase
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '6.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '6.4'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -289,34 +191,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.5'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
 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
@@ -373,11 +247,11 @@ files:
 - db/migrate/20250517155521_create_securial_users.rb
 - db/migrate/20250518122749_create_securial_role_assignments.rb
 - db/migrate/20250519075407_create_securial_sessions.rb
-- db/migrate/20250524210207_add_password_reset_fields_to_securial_users.rb
 - lib/generators/factory_bot/model/model_generator.rb
 - lib/generators/factory_bot/templates/factory.erb
 - lib/generators/securial/install/install_generator.rb
 - lib/generators/securial/install/templates/securial_initializer.erb
+- lib/generators/securial/install/views_generator.rb
 - lib/generators/securial/jbuilder/jbuilder_generator.rb
 - lib/generators/securial/jbuilder/templates/_resource.json.erb
 - lib/generators/securial/jbuilder/templates/index.json.erb
@@ -388,7 +262,11 @@ files:
 - lib/generators/securial/scaffold/templates/routes.erb
 - lib/generators/securial/scaffold/templates/routing_spec.erb
 - lib/securial.rb
-- lib/securial/config/_index.rb
+- lib/securial/auth.rb
+- lib/securial/auth/auth_encoder.rb
+- lib/securial/auth/errors.rb
+- lib/securial/auth/session_creator.rb
+- lib/securial/config.rb
 - lib/securial/config/configuration.rb
 - lib/securial/config/errors.rb
 - lib/securial/config/validation.rb
@@ -397,23 +275,30 @@ files:
 - lib/securial/factories/securial/roles.rb
 - lib/securial/factories/securial/sessions.rb
 - lib/securial/factories/securial/users.rb
-- lib/securial/helpers/_index.rb
+- lib/securial/helpers.rb
 - lib/securial/helpers/normalizing_helper.rb
 - lib/securial/helpers/regex_helper.rb
-- lib/securial/inspectors/_index.rb
+- lib/securial/inspectors.rb
 - lib/securial/inspectors/route_inspector.rb
+- lib/securial/key_transformer.rb
 - lib/securial/logger.rb
-- lib/securial/middleware/request_logger_tag.rb
-- lib/securial/sessions/_index.rb
-- lib/securial/sessions/errors.rb
-- lib/securial/sessions/session_encoder.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/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-05-28'
+  release_date: '2025-06-01'
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/AlyBadawy/Securial/wiki
   source_code_uri: https://github.com/AlyBadawy/Securial

data/db/migrate/20250524210207_add_password_reset_fields_to_securial_users.rb

@@ -1,6 +0,0 @@
-class AddPasswordResetFieldsToSecurialUsers < ActiveRecord::Migration[8.0]
-  def change
-    add_column :securial_users, :reset_password_token, :string
-    add_column :securial_users, :reset_password_token_created_at, :datetime
-  end
-end

data/lib/securial/config/_index.rb

@@ -1,3 +0,0 @@
-require_relative "./configuration"
-require_relative "./validation"
-require_relative "./errors"

data/lib/securial/helpers/_index.rb

@@ -1,2 +0,0 @@
-require_relative "normalizing_helper"
-require_relative "regex_helper"