jwt_auth_engine 1.0.0

data/lib/jwt_auth_engine/engine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+
+module JwtAuthEngine
+  # Rails engine entrypoint and namespace isolation configuration.
+  class Engine < ::Rails::Engine
+    isolate_namespace JwtAuthEngine
+  end
+end

data/lib/jwt_auth_engine/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module JwtAuthEngine
+  class Error < StandardError; end
+
+  class AuthModelNotFound < Error; end
+  class InvalidAuthModel < Error; end
+
+  class InvalidToken < Error; end
+  class TokenExpired < Error; end
+  class InvalidTokenType < Error; end
+
+  class MissingSecretKey < Error; end
+end

data/lib/jwt_auth_engine/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JwtAuthEngine
+  VERSION = '1.0.0'
+end

data/lib/jwt_auth_engine.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative 'jwt_auth_engine/version'
+require_relative 'jwt_auth_engine/engine'
+require_relative 'jwt_auth_engine/errors'
+require_relative 'jwt_auth_engine/constants'
+require_relative 'jwt_auth_engine/configuration'
+
+# Public configuration and model-resolution API for the auth engine.
+module JwtAuthEngine
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def auth_model_class
+      configured_auth_model = configuration.auth_model.to_s
+      return @resolved_auth_model_class if cached_auth_model_class?(configured_auth_model)
+
+      resolve_and_cache_auth_model(configured_auth_model)
+    end
+
+    def auth_model_name
+      auth_model_class.name.underscore.to_sym
+    end
+
+    def identifier_field
+      configuration.identifier_field.to_sym
+    end
+
+    def password_field
+      configuration.password_field.to_sym
+    end
+
+    def password_digest_field
+      :"#{password_field}_digest"
+    end
+
+    def current_password_field
+      :"current_#{password_field}"
+    end
+
+    def new_password_field
+      :"new_#{password_field}"
+    end
+
+    def auth_model_token_payload_key
+      :"#{auth_model_name}_#{auth_model_class.primary_key}"
+    end
+
+    private
+
+    def cached_auth_model_class?(configured_auth_model)
+      defined?(@resolved_auth_model_class) && @resolved_auth_model_name == configured_auth_model
+    end
+
+    def resolve_and_cache_auth_model(configured_auth_model)
+      klass = configured_auth_model.constantize
+      ensure_valid_auth_model!(klass)
+
+      @resolved_auth_model_name = configured_auth_model
+      @resolved_auth_model_class = klass
+    rescue NameError
+      raise AuthModelNotFound,
+            "Configured auth_model '#{configuration.auth_model}' could not be constantized"
+    end
+
+    def ensure_valid_auth_model!(klass)
+      return if klass < ActiveRecord::Base
+
+      raise InvalidAuthModel,
+            "Configured auth_model '#{configuration.auth_model}' must inherit from ActiveRecord::Base"
+    end
+  end
+end

data/sig/jwt_auth_engine.rbs

@@ -0,0 +1,4 @@
+module JwtAuthEngine
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: jwt_auth_engine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Abhishek Kushwaha
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.18
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.18
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+description: Provides plug-and-play JWT authentication endpoints for Rails API apps
+  using your host auth model.
+email:
+- abhiskush@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- app/controllers/concerns/jwt_auth_engine/authenticatable.rb
+- app/controllers/concerns/jwt_auth_engine/rescuable.rb
+- app/controllers/concerns/jwt_auth_engine/response_renderable.rb
+- app/controllers/concerns/jwt_auth_engine/serializable.rb
+- app/controllers/concerns/jwt_auth_engine/tokenizable.rb
+- app/controllers/jwt_auth_engine/application_controller.rb
+- app/controllers/jwt_auth_engine/passwords_controller.rb
+- app/controllers/jwt_auth_engine/ping_controller.rb
+- app/controllers/jwt_auth_engine/profiles_controller.rb
+- app/controllers/jwt_auth_engine/registrations_controller.rb
+- app/controllers/jwt_auth_engine/sessions_controller.rb
+- app/controllers/jwt_auth_engine/tokens_controller.rb
+- app/services/jwt_auth_engine/base_service.rb
+- app/services/jwt_auth_engine/change_password_service.rb
+- app/services/jwt_auth_engine/login_service.rb
+- app/services/jwt_auth_engine/refresh_token_service.rb
+- app/services/jwt_auth_engine/signup_service.rb
+- app/services/jwt_auth_engine/token_service.rb
+- config/routes.rb
+- lib/generators/jwt_auth_engine/install/install_generator.rb
+- lib/generators/jwt_auth_engine/install/templates/add_jwt_auth_engine_columns_migration.rb.tt
+- lib/generators/jwt_auth_engine/install/templates/auth_model_concern.rb.tt
+- lib/generators/jwt_auth_engine/install/templates/jwt_auth_engine_initializer.rb.tt
+- lib/jwt_auth_engine.rb
+- lib/jwt_auth_engine/configuration.rb
+- lib/jwt_auth_engine/constants.rb
+- lib/jwt_auth_engine/engine.rb
+- lib/jwt_auth_engine/errors.rb
+- lib/jwt_auth_engine/version.rb
+- sig/jwt_auth_engine.rbs
+homepage: https://github.com/abhiskush/jwt_auth_engine
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/abhiskush/jwt_auth_engine
+  source_code_uri: https://github.com/abhiskush/jwt_auth_engine
+  changelog_uri: https://github.com/abhiskush/jwt_auth_engine/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/abhiskush/jwt_auth_engine/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A Rails engine gem for JWT-based authentication using BCrypt.
+test_files: []