FastAPI-UI-Auth 0.2.1a0__py3-none-any.whl → 0.2.3__py3-none-any.whl

{fastapi_ui_auth-0.2.1a0.dist-info → fastapi_ui_auth-0.2.3.dist-info}/METADATA

@@ -1,14 +1,13 @@
 Metadata-Version: 2.4
 Name: FastAPI-UI-Auth
-Version: 0.2.1a0
+Version: 0.2.3
 Summary: Python module to add username and password authentication to specific FastAPI routes
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: fastapi
-Requires-Dist: jinja2
+Requires-Dist: Jinja2
 Requires-Dist: pydantic
-Requires-Dist: python-dotenv
 Provides-Extra: dev
 Requires-Dist: websockets==15.0.*; extra == "dev"
 Requires-Dist: pre-commit==4.2.*; extra == "dev"

{fastapi_ui_auth-0.2.1a0.dist-info → fastapi_ui_auth-0.2.3.dist-info}/RECORD

@@ -1,18 +1,18 @@
-fastapi_ui_auth-0.2.1a0.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
+fastapi_ui_auth-0.2.3.dist-info/licenses/LICENSE,sha256=_sOIKJWdD2o1WwwDIwYB2qTP2nlSWqT5Tyg9jr1Xa4w,1070
 uiauth/__init__.py,sha256=s8r2Z0O9w3cuw7GcmRTOWY0NZC0KJXzBS9QsG9wUWsk,264
 uiauth/endpoints.py,sha256=CJteXsGQWfn--U6_VdVN8VhnPsf3HSefYX1NOzAhacM,2837
 uiauth/enums.py,sha256=WO0eBv3l9HHr1I_ZXtAifCgdL-db_tZj9ka7jnjiS5k,547
 uiauth/logger.py,sha256=z67PBMs4zWOfy-Gfm_41dj5Uulm-ChvZxB_jmYKKXeI,391
-uiauth/models.py,sha256=dH207dqVybK_qPzzm2RuMxZBamoFm8zO5tk7jmyGStM,3719
+uiauth/models.py,sha256=cU1VoPtHsB0A8DIvXSDpAZz2KtbOtQPB507cQ4MGeOw,4014
 uiauth/secure.py,sha256=ZOH6kT4BD56VqwaKdKocX7eSE8tqZcu-tK0QOmjY58k,1089
-uiauth/service.py,sha256=DJnK9PsBg9CnWiIqWRt7Aa7ZXncTUm5W8jZmA9UJK5Q,6659
+uiauth/service.py,sha256=sJG-RbiiO-qKtvaGrSsu_UfTndRPkdRn0AXWhGnjJmQ,7443
 uiauth/utils.py,sha256=DzXqxLpKHUDy1bxffg1cw0izqxcgmnCybSytywiPgbQ,6625
-uiauth/version.py,sha256=nJo0rYXinOLv3d1ZFH-u19fo0iIADpBZFIy8nNqi3wg,24
+uiauth/version.py,sha256=7YVXTLSKw_SIjam_Lv65ld1ty1jiyVmclya8_CjMMqY,18
 uiauth/templates/index.html,sha256=n8tOiKXEUI4zBh1YOQNlH5MKNMRTQ2adH0QIuvrEcv4,9071
 uiauth/templates/logout.html,sha256=JrWBJCbK1E4NfrNipMsLzfJ_-Fs2C6D4S0B6O7JNoek,3504
 uiauth/templates/session.html,sha256=EL4gajOED3IcOnrALMiJ2SzJl2at8GFfruTuExhgOVI,3040
 uiauth/templates/unauthorized.html,sha256=ahv78zLM04_Lu83LdX0Ua_toKeP5JZkYsTCWCrfCvHA,3002
-fastapi_ui_auth-0.2.1a0.dist-info/METADATA,sha256=1mPPvL2iv9mXJmUBsPmAA7IdXtOQKNggEiR5mBkAKoc,3524
-fastapi_ui_auth-0.2.1a0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fastapi_ui_auth-0.2.1a0.dist-info/top_level.txt,sha256=ra3nGTbDTgQ7eChlkngJ7xGXhSCeFTWMvb_b6q8uPVA,7
-fastapi_ui_auth-0.2.1a0.dist-info/RECORD,,
+fastapi_ui_auth-0.2.3.dist-info/METADATA,sha256=QeOE9sG3SJE5Tzqm7AoOe65z8QjgqcS_t_mSmFJHYBU,3493
+fastapi_ui_auth-0.2.3.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+fastapi_ui_auth-0.2.3.dist-info/top_level.txt,sha256=ra3nGTbDTgQ7eChlkngJ7xGXhSCeFTWMvb_b6q8uPVA,7
+fastapi_ui_auth-0.2.3.dist-info/RECORD,,

{fastapi_ui_auth-0.2.1a0.dist-info → fastapi_ui_auth-0.2.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (82.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

uiauth/models.py

@@ -1,6 +1,6 @@
 import os
 import pathlib
-from typing import Callable, Dict, List, Optional, Type
+from typing import Callable, Dict, Iterable, List, Optional, Type
 
 from fastapi.routing import APIRoute, APIWebSocketRoute
 from fastapi.templating import Jinja2Templates
@@ -11,38 +11,48 @@ from uiauth.enums import APIMethods
 templates = Jinja2Templates(directory=pathlib.Path(__file__).parent / "templates")
 
 
-def get_env(keys: List[str], default: Optional[str] = None) -> Optional[str]:
-    """Get environment variable value.
+class EnvConfig(BaseModel):
+    """Model for environment configuration.
+
+    >>> EnvConfig
+
+    """
+
+    username: str
+    password: str
+
+
+def get_cred(keys: Iterable[str], kwargs: Dict[str, str]) -> str | None:
+    """Helper function to retrieve credentials from kwargs or environment variables.
 
     Args:
-        keys: List of environment variable names to check.
-        default: Default value if the environment variable is not set.
+        keys: Iterable of keys to look for in kwargs and environment variables.
+        kwargs: Key-value pairs to search for credentials, takes precedence over environment variables.
 
     Returns:
-        Value of the environment variable or default value.
+        str | None:
+        The first found credential value or None if not found.
     """
     for key in keys:
-        if value := os.getenv(key):
+        if value := kwargs.get(key) or os.getenv(key):
             return value
-        if value := os.getenv(key.upper()):
-            return value
-        if value := os.getenv(key.lower()):
-            return value
-    return default
+    return None
 
 
-class EnvConfig(BaseModel):
-    """Configuration for environment variables.
-
-    >>> EnvConfig
+def env_loader(**kwargs) -> EnvConfig:
+    """Loads environment variables into the EnvConfig model.
 
     See Also:
         - Tries to resolve username and password through kwargs.
         - Uses environment variables as fallback.
-    """
 
-    username: str = Field(default_factory=lambda: get_env(("username", "user")))
-    password: str = Field(default_factory=lambda: get_env(("password", "pass")))
+    Returns:
+        EnvConfig:
+        An instance of EnvConfig with loaded environment variables.
+    """
+    username = get_cred(["username", "USERNAME", "user", "USER"], kwargs)
+    password = get_cred(["password", "PASSWORD", "pass", "PASS"], kwargs)
+    return EnvConfig(username=username, password=password)
 
 
 env = EnvConfig

uiauth/service.py

@@ -2,7 +2,6 @@ import logging
 from threading import Timer
 from typing import Dict, List
 
-import dotenv
 from fastapi import status
 from fastapi.applications import FastAPI
 from fastapi.exceptions import HTTPException
@@ -14,7 +13,6 @@ from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
 
 from uiauth import endpoints, enums, logger, models, utils
 
-dotenv.load_dotenv(dotenv_path=dotenv.find_dotenv(), override=True)
 BEARER_AUTH = HTTPBearer()
 
 
@@ -26,6 +24,9 @@ class FastAPIUIAuth:
 
     """
 
+    # TODO: Consume APIRoute or APIWebSocketRoute directly in params instead of creating them in the _secure method
+    #   Include stricter type validation (if that works)
+    #   Update samples and readme - major version change
     def __init__(
         self,
         app: FastAPI,
@@ -50,15 +51,28 @@ class FastAPIUIAuth:
             custom_logger: Custom logger instance, defaults to the custom logger.
         """
         models.env = models.EnvConfig(username=username, password=password)
-        assert fallback_path.startswith("/"), "Fallback path must start with '/'"
+        assert (
+            models.env.username and models.env.password
+        ), "Username and password must be provided either as arguments or environment variables"
+        assert isinstance(app, FastAPI), "App must be an instance of FastAPI"
 
         self.app = app
 
         if isinstance(params, list):
+            assert len(params) > 0, "No endpoints to register"
+            for param in params:
+                assert isinstance(
+                    param, models.Parameters
+                ), f"{param} must be an instance of models.Parameters"
             self.params = params
         elif isinstance(params, models.Parameters):
             self.params = [params]
+        else:
+            raise ValueError(
+                "Params must be an instance of Parameters or a list of Parameters"
+            )
 
+        assert fallback_path.startswith("/"), "Fallback path must start with '/'"
         models.fallback.path = fallback_path
         models.fallback.button = fallback_button
 

uiauth/version.py

@@ -1 +1 @@
-version = "0.2.1-alpha"
+version = "0.2.3"