jamlib 3.1.0__tar.gz → 3.1.2__tar.gz

{jamlib-3.1.0/src/jamlib.egg-info → jamlib-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jamlib
-Version: 3.1.0
+Version: 3.1.2
 Summary: Simple and universal library for authorization.
 Author-email: Makridenko Adrian <adrianmakridenko@duck.com>, Ksenia Travnikova <kseniatravnikova@duck.com>
 License: Apache-2.0
@@ -30,7 +30,7 @@ Classifier: Framework :: FastAPI
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: cryptography>=46.0.5
+Requires-Dist: cryptography>=48.0.0
 Provides-Extra: cli
 Requires-Dist: click>=8.3.1; extra == "cli"
 Provides-Extra: redis

{jamlib-3.1.0 → jamlib-3.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "jamlib"
-version = "3.1.0"
+version = "3.1.2"
 description = "Simple and universal library for authorization."
 authors = [
     {name = "Makridenko Adrian",email = "adrianmakridenko@duck.com"},
@@ -23,7 +23,7 @@ keywords = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "cryptography>=46.0.5",
+    "cryptography>=48.0.0",
 ]
 
 classifiers = [

{jamlib-3.1.0 → jamlib-3.1.2}/src/jam/__base__.py

@@ -1,16 +1,21 @@
 # -*- coding: utf-8 -*-
 
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
 import gc
+import os
 from typing import Any, Literal
 
-from jam.encoders import BaseEncoder, JsonEncoder
+from jam.__base_encoder__ import BaseEncoder
+from jam.encoders import JsonEncoder
 from jam.exceptions import JamConfigurationError
 from jam.jwt.__base__ import BaseJWT
 from jam.logger import BaseLogger, JamLogger
 from jam.oauth2.__base__ import BaseOAuth2Client
 from jam.otp.__base__ import BaseOTP, OTPConfig
 from jam.paseto.__base__ import BasePASETO
+from jam.plugins.__base__ import BasePlugin
 from jam.sessions.__base__ import BaseSessionModule
 from jam.utils.config_maker import __config_maker__, __module_loader__
 
@@ -30,15 +35,17 @@ class BaseJam(ABC):
             "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
         ] = "INFO",
         serializer: BaseEncoder | type[BaseEncoder] = JsonEncoder,
+        plugins: list[type[BasePlugin]] = [],
     ) -> None:
         """Initialize instance.
 
         Args:
-                config (Union[str, dict[str, Any]]): Configuration
-                pointer (str): Pointer
-                logger (BaseLogger): Logger
-                log_level (Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]): Log level
-                serializer (Union[BaseEncoder, type[BaseBrowser]]): Serializer
+            config (Union[str, dict[str, Any]]): Configuration
+            pointer (str): Pointer
+            logger (BaseLogger): Logger
+            log_level (Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]): Log level
+            serializer (Union[BaseEncoder, type[BaseBrowser]]): Serializer
+            plugins (list[type[BasePlugin]]): List of plugins
 
         Returns:
                 None
@@ -54,6 +61,8 @@ class BaseJam(ABC):
 
         self._logger = logger(log_level)
         self._serializer = serializer
+        self._plugins = []
+
         self.jwt: BaseJWT | None = None
         self.session: BaseSessionModule | None = None
         self.oauth2: dict[str, BaseOAuth2Client] | None = None
@@ -71,6 +80,9 @@ class BaseJam(ABC):
             "BaseJam initialization complete. Modules loaded:\n"
             f" jwt={self.jwt is not None}, session={self.session is not None}, oauth2={self.oauth2 is not None}"
         )
+        if os.getenv("JAM_ENABLE_PLUGINS", "0") == "1":
+            self._logger.warning("Experimental plugins are enabled!")
+            self.__setup_plugins(plugins)
         gc.collect()
 
     def __build_main_config(
@@ -188,6 +200,40 @@ class BaseJam(ABC):
             case _:
                 raise JamConfigurationError(message="Unknown OTP type.")
 
+    def __setup_plugins(self, plugins: list[type[BasePlugin]]) -> None:
+        """Setup plugins."""
+        for plugin in plugins:
+            self._logger.debug(f"Setup plugin: {plugin.name}")
+            from jam.utils.version_check import __is_compatible__
+
+            if not __is_compatible__(None, plugin.jam_requires):
+                continue
+
+            _plugin = plugin(self)
+            _plugin.setup()
+            self._plugins.append(_plugin)
+
+    def emit(self, event: str, **kwargs) -> Any:
+        """Emit event.
+
+        Args:
+            event (str): Event name,
+            **kwargs: Event data
+        """
+        for plugin in self._plugins:
+            handler = getattr(plugin, f"on_{event}", None)
+
+            if handler:
+                try:
+                    result = handler(**kwargs)
+                    if isinstance(result, dict):
+                        kwargs.update(result)
+
+                except Exception as e:
+                    self._logger.error(f"Plugin:{plugin.name} | error: {e}")
+
+        return kwargs
+
     @abstractmethod
     def jwt_make_payload(
         self, exp: int | None, data: dict[str, Any]

{jamlib-3.1.0 → jamlib-3.1.2}/src/jam/__init__.py

@@ -12,5 +12,5 @@ from jam.encoders import JsonEncoder
 from jam.instance import Jam
 
 
-__version__ = "3.0.0"
+__version__ = "3.1.2"
 __all__ = ["Jam", "JsonEncoder", "BaseJam", "BaseEncoder"]

{jamlib-3.1.0 → jamlib-3.1.2}/src/jam/logger.py

@@ -10,7 +10,14 @@ class BaseLogger(ABC):
     """Interface for logging."""
 
     _LOG_NAME: str = "jam"
-    log_level: Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"] = "INFO"
+
+    def __init__(
+        self,
+        log_level: Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]
+        | str = "INFO",
+    ):
+        """Initialize the logger."""
+        self.log_level = log_level
 
     @abstractmethod
     def info(self, message: str) -> None:

jamlib-3.1.2/src/jam/plugins/__base__.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+
+from abc import ABC
+
+
+class BasePlugin(ABC):
+    """Base plugin for Jam.
+
+    !!! Warning
+            Plugins are experimental and may not be stable.
+
+            For usage, JAM_ENABLE_PLUGINS must be set to 1.
+
+    Example:
+        ```python
+        from jam import Jam
+        from jam.plugins import BasePlugin
+
+
+        class MyPlugin(BasePlugin)
+            name = "MyPlugin"
+
+            def on_before_jwt_create(self, **kwargs):
+                print("JWT CREATED")
+
+        jam = Jam(
+            config="config.toml",
+            plugins=[MyPlugin]
+        )
+        ```
+    """
+
+    name: str = "base_plugin"
+    jam_requires: str = "3.2.0"
+    config: bool = False
+
+    def __init__(self, jam, config: dict | None = None) -> None:
+        """Initialize the plugin.
+
+        Args:
+            jam (BaseJam): The Jam instance.
+            config (dict | None): Plugin configuration.
+        """
+        self._jam = jam
+        self._config = config or {}
+
+    def setup(self) -> None:
+        """Called when plugin is initialized."""
+        pass
+
+    def emit(self, event: str, **kwargs) -> None:
+        """Emit event.
+
+        Args:
+            event (str): Event name
+            **kwargs: Event data
+        """
+        self._jam.emit(event, **kwargs)

jamlib-3.1.2/src/jam/plugins/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+
+"""Jam plugin system."""
+
+from .__base__ import BasePlugin
+
+
+__all__ = [
+    "BasePlugin",
+]

jamlib-3.1.2/src/jam/utils/version_check.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+
+from importlib.metadata import version
+
+from packaging.version import Version
+
+
+def __is_compatible__(
+    income_version: str | None, required_version: str
+) -> bool:
+    """Checks if the income version is compatible with the required version."""
+    current = Version(income_version or version("jamlib"))
+    required = Version(required_version)
+
+    if current.major != required.major:
+        return False
+
+    return current >= required

{jamlib-3.1.0 → jamlib-3.1.2/src/jamlib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jamlib
-Version: 3.1.0
+Version: 3.1.2
 Summary: Simple and universal library for authorization.
 Author-email: Makridenko Adrian <adrianmakridenko@duck.com>, Ksenia Travnikova <kseniatravnikova@duck.com>
 License: Apache-2.0
@@ -30,7 +30,7 @@ Classifier: Framework :: FastAPI
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: cryptography>=46.0.5
+Requires-Dist: cryptography>=48.0.0
 Provides-Extra: cli
 Requires-Dist: click>=8.3.1; extra == "cli"
 Provides-Extra: redis

{jamlib-3.1.0 → jamlib-3.1.2}/src/jamlib.egg-info/SOURCES.txt

@@ -78,6 +78,8 @@ src/jam/paseto/v1.py
 src/jam/paseto/v2.py
 src/jam/paseto/v3.py
 src/jam/paseto/v4.py
+src/jam/plugins/__base__.py
+src/jam/plugins/__init__.py
 src/jam/sessions/__base__.py
 src/jam/sessions/__init__.py
 src/jam/sessions/json.py
@@ -95,6 +97,7 @@ src/jam/utils/otp_keys.py
 src/jam/utils/rsa.py
 src/jam/utils/salt_hash.py
 src/jam/utils/symmetric.py
+src/jam/utils/version_check.py
 src/jam/utils/xchacha20poly1305.py
 src/jam/utils/xor.py
 src/jamlib.egg-info/PKG-INFO

{jamlib-3.1.0 → jamlib-3.1.2}/src/jamlib.egg-info/requires.txt

@@ -1,4 +1,4 @@
-cryptography>=46.0.5
+cryptography>=48.0.0
 
 [cli]
 click>=8.3.1