securial 0.4.2

data/lib/securial/route_inspector.rb

@@ -0,0 +1,50 @@
+module Securial
+  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::ENGINE_LOGGER.debug "Securial engine routes:"
+        Securial::ENGINE_LOGGER.debug "Total routes: #{filtered.size}"
+        Securial::ENGINE_LOGGER.debug "Filtered by controller: #{controller}" if controller
+        Securial::ENGINE_LOGGER.debug "Filtered routes: #{filtered.size}" if controller
+        Securial::ENGINE_LOGGER.debug "-" * 120
+        Securial::ENGINE_LOGGER.debug "#{'Verb'.ljust(8)} #{'Path'.ljust(45)} #{'Controller#Action'.ljust(40)} Name"
+        Securial::ENGINE_LOGGER.debug "-" * 120
+      end
+
+      def print_details(filtered, controller) # rubocop:disable Rails/Output
+        if filtered.empty?
+          if controller
+            Securial::ENGINE_LOGGER.debug "No routes found for controller: #{controller}"
+          else
+            Securial::ENGINE_LOGGER.debug "No routes found for Securial engine"
+          end
+          Securial::ENGINE_LOGGER.debug "-" * 120
+          return
+        end
+
+        Securial::ENGINE_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

data/lib/securial/version.rb

@@ -0,0 +1,3 @@
+module Securial
+  VERSION = "0.4.2"
+end

data/lib/securial.rb

@@ -0,0 +1,94 @@
+require "securial/version"
+require "securial/engine"
+
+require "jbuilder"
+
+module Securial
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+      validate_admin_role!
+      validate_session_expiry_duration!
+      validate_session_algorithm!
+      validate_session_secret!
+      validate_mailer_sender!
+      validate_password_config!
+    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
+
+    def validate_admin_role!
+      error_message = "The admin role cannot be 'account' or 'accounts' as it conflicts with the default routes."
+
+      if configuration.admin_role.to_s.pluralize.downcase == "accounts"
+        Securial::ENGINE_LOGGER.error(error_message)
+        raise Securial::ConfigErrors::ConfigAdminRoleError, error_message
+      end
+    end
+
+    def validate_session_expiry_duration!
+      if configuration.session_expiration_duration.nil?
+        error_message = "Session expiration duration is not set."
+        Securial::ENGINE_LOGGER.error(error_message)
+        raise Securial::ConfigErrors::ConfigSessionExpirationDurationError, error_message
+      end
+      if configuration.session_expiration_duration.class != ActiveSupport::Duration
+        error_message = "Session expiration duration must be an ActiveSupport::Duration."
+        Securial::ENGINE_LOGGER.error(error_message)
+        raise Securial::ConfigErrors::ConfigSessionExpirationDurationError, error_message
+      end
+      if configuration.session_expiration_duration <= 0
+        Securial::ENGINE_LOGGER.error("Session expiration duration must be greater than 0.")
+        raise Securial::ConfigErrors::ConfigSessionExpirationDurationError, "Session expiration duration must be greater than 0."
+      end
+    end
+
+    def validate_session_algorithm!
+      valid_algorithms = [:hs256, :hs384, :hs512]
+      unless valid_algorithms.include?(configuration.session_algorithm)
+        error_message = "Invalid session algorithm. Valid options are: #{valid_algorithms.join(', ')}."
+        Securial::ENGINE_LOGGER.error(error_message)
+        raise Securial::ConfigErrors::ConfigSessionAlgorithmError, error_message
+      end
+    end
+
+    def validate_session_secret!
+      if configuration.session_secret.blank?
+        error_message = "Session secret is not set."
+        Securial::ENGINE_LOGGER.error(error_message)
+        raise Securial::ConfigErrors::ConfigSessionSecretError, error_message
+      end
+    end
+
+    def validate_mailer_sender!
+      if configuration.mailer_sender.blank?
+        error_message = "Mailer sender is not set."
+        Securial::ENGINE_LOGGER.error(error_message)
+        raise Securial::ConfigErrors::ConfigMailerSenderError, error_message
+      end
+      if configuration.mailer_sender !~  URI::MailTo::EMAIL_REGEXP
+        error_message = "Mailer sender is not a valid email address."
+        Securial::ENGINE_LOGGER.error(error_message)
+        raise Securial::ConfigErrors::ConfigMailerSenderError, error_message
+      end
+    end
+
+    def validate_password_config!
+      if configuration.password_reset_email_subject.blank?
+        error_message = "Password reset email subject is not set."
+        Securial::ENGINE_LOGGER.error(error_message)
+        raise Securial::ConfigErrors::ConfigMailerSenderError, error_message
+      end
+    end
+  end
+end

data/lib/tasks/securial_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :securial do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,435 @@
+--- !ruby/object:Gem::Specification
+name: securial
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+platform: ruby
+authors:
+- Aly Badawy
+bindir: bin
+cert_chain: []
+date: 2025-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: 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
+  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: 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: 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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.32'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !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'
+- !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
+  apps.
+email:
+- 1198568+AlyBadawy@users.noreply.github.com
+executables:
+- securial
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/concerns/securial/identity.rb
+- app/controllers/securial/accounts_controller.rb
+- app/controllers/securial/application_controller.rb
+- app/controllers/securial/passwords_controller.rb
+- app/controllers/securial/role_assignments_controller.rb
+- app/controllers/securial/roles_controller.rb
+- app/controllers/securial/sessions_controller.rb
+- app/controllers/securial/status_controller.rb
+- app/controllers/securial/users_controller.rb
+- app/jobs/securial/application_job.rb
+- app/mailers/securial/application_mailer.rb
+- app/mailers/securial/securial_mailer.rb
+- app/models/concerns/securial/password_resettable.rb
+- app/models/securial/application_record.rb
+- app/models/securial/current.rb
+- app/models/securial/role.rb
+- app/models/securial/role_assignment.rb
+- app/models/securial/session.rb
+- app/models/securial/user.rb
+- app/views/layouts/securial/mailer.html.erb
+- app/views/layouts/securial/mailer.text.erb
+- app/views/securial/accounts/show.json.jbuilder
+- app/views/securial/passwords/_password.json.jbuilder
+- app/views/securial/passwords/index.json.jbuilder
+- app/views/securial/passwords/show.json.jbuilder
+- app/views/securial/role_assignments/show.json.jbuilder
+- 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/sessions/_session.json.jbuilder
+- app/views/securial/sessions/index.json.jbuilder
+- app/views/securial/sessions/show.json.jbuilder
+- app/views/securial/status/show.json.jbuilder
+- app/views/securial/users/_securial_user.json.jbuilder
+- app/views/securial/users/index.json.jbuilder
+- 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/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/jbuilder/jbuilder_generator.rb
+- lib/generators/securial/jbuilder/templates/_resource.json.erb
+- lib/generators/securial/jbuilder/templates/index.json.erb
+- lib/generators/securial/jbuilder/templates/show.json.erb
+- lib/generators/securial/scaffold/scaffold_generator.rb
+- lib/generators/securial/scaffold/templates/controller.erb
+- lib/generators/securial/scaffold/templates/request_spec.erb
+- lib/generators/securial/scaffold/templates/routes.erb
+- lib/generators/securial/scaffold/templates/routing_spec.erb
+- lib/securial.rb
+- lib/securial/configuration.rb
+- lib/securial/engine.rb
+- lib/securial/errors/config_errors.rb
+- lib/securial/errors/session_errors.rb
+- lib/securial/factories/securial/role_assignments.rb
+- lib/securial/factories/securial/roles.rb
+- lib/securial/factories/securial/sessions.rb
+- lib/securial/factories/securial/users.rb
+- lib/securial/helpers/auth_helper.rb
+- lib/securial/helpers/normalizing_helper.rb
+- lib/securial/helpers/regex_helper.rb
+- lib/securial/logger.rb
+- lib/securial/middleware/request_logger_tag.rb
+- lib/securial/route_inspector.rb
+- lib/securial/version.rb
+- lib/tasks/securial_tasks.rake
+homepage: https://github.com/AlyBadawy/Securial/wiki
+licenses:
+- MIT
+metadata:
+  release_date: '2025-05-27'
+  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
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Authentication and access control Rails engine for your API.
+test_files: []