fastapi-ext-pkg 0.2.0__tar.gz → 0.4.0__tar.gz

{fastapi_ext_pkg-0.2.0 → fastapi_ext_pkg-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi-ext-pkg
-Version: 0.2.0
+Version: 0.4.0
 Summary: A well-tailored utility set for FastAPI.
 Author-email: Dotz Developers <devs-dotz@dotz.com>
 Project-URL: Repository, https://github.com/DotzInc/fastapi-ext-pkg
@@ -19,6 +19,7 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: fastapi
+Requires-Dist: httpx
 
 # FastAPI Extension Package
 

{fastapi_ext_pkg-0.2.0 → fastapi_ext_pkg-0.4.0}/fastapi_ext_pkg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi-ext-pkg
-Version: 0.2.0
+Version: 0.4.0
 Summary: A well-tailored utility set for FastAPI.
 Author-email: Dotz Developers <devs-dotz@dotz.com>
 Project-URL: Repository, https://github.com/DotzInc/fastapi-ext-pkg
@@ -19,6 +19,7 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: fastapi
+Requires-Dist: httpx
 
 # FastAPI Extension Package
 

{fastapi_ext_pkg-0.2.0 → fastapi_ext_pkg-0.4.0}/fastapi_ext_pkg.egg-info/SOURCES.txt

@@ -6,5 +6,11 @@ fastapi_ext_pkg.egg-info/dependency_links.txt
 fastapi_ext_pkg.egg-info/requires.txt
 fastapi_ext_pkg.egg-info/top_level.txt
 fastapi_extras/__init__.py
+fastapi_extras/databases/__init__.py
+fastapi_extras/databases/redis.py
 fastapi_extras/middlewares/__init__.py
-fastapi_extras/middlewares/remove_path.py
+fastapi_extras/middlewares/remove_path.py
+fastapi_extras/orm/__init__.py
+fastapi_extras/orm/sqlalchemy.py
+fastapi_extras/security/__init__.py
+fastapi_extras/security/auth.py

{fastapi_ext_pkg-0.2.0 → fastapi_ext_pkg-0.4.0}/fastapi_ext_pkg.egg-info/requires.txt

@@ -1 +1,2 @@
 fastapi
+httpx

fastapi_ext_pkg-0.4.0/fastapi_extras/databases/redis.py

@@ -0,0 +1,27 @@
+from typing import Any, AsyncGenerator, Optional, Union
+
+import redis.asyncio as redis
+from pydantic import RedisDsn
+
+
+class Redis(redis.Redis):
+    async def get(self, key: str, *args: Any, **kwargs: Any) -> Optional[str]:
+        return await super().get(key, *args, **kwargs)
+
+    async def set(
+        self, key: str, value: str, ttl: Optional[int] = None, *args: Any, **kwargs: Any
+    ) -> None:
+        await super().set(key, value, ttl, *args, **kwargs)
+
+
+class RedisManager:
+    def __init__(self, url: Union[RedisDsn, str]):
+        self.pool = redis.ConnectionPool.from_url(str(url))
+
+    async def __call__(self) -> AsyncGenerator[Redis, None]:
+        cli = Redis(connection_pool=self.pool)
+
+        try:
+            yield cli
+        finally:
+            await cli.aclose()

{fastapi_ext_pkg-0.2.0 → fastapi_ext_pkg-0.4.0}/fastapi_extras/middlewares/remove_path.py

@@ -1,15 +1,17 @@
+import re
+
 from starlette.types import ASGIApp, Receive, Scope, Send
 
 
 class RemovePathMiddleware:
     def __init__(self, app: ASGIApp, path: str = "") -> None:
         self.app = app
-        self.path = path if not path.endswith("/") else path[:-1]
+        self.path = path.strip()
 
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
-        if scope["type"] != "http":
+        if scope["type"] != "http" or self.path == "":
             return await self.app(scope, receive, send)
 
-        scope["path"] = scope["path"].replace(self.path, "", 1)
+        scope["path"] = re.sub(f"^({self.path})(/.*)?$", r"\g<2>", scope["path"])
 
         await self.app(scope, receive, send)

fastapi_ext_pkg-0.4.0/fastapi_extras/orm/sqlalchemy.py

@@ -0,0 +1,27 @@
+from typing import Any, Generator, Union
+
+from pydantic import AnyUrl
+from sqlalchemy import create_engine
+from sqlalchemy.orm import Session, sessionmaker
+
+
+class Database:
+    def __init__(
+        self,
+        database_url: Union[str, AnyUrl],
+        autocommit: bool = False,
+        autoflush: bool = False,
+        **kwargs: Any,
+    ) -> None:
+        self.engine = create_engine(str(database_url), **kwargs)
+        self.sessionmaker = sessionmaker(
+            autocommit=autocommit, autoflush=autoflush, bind=self.engine
+        )
+
+    def __call__(self) -> Generator[Session, None, None]:
+        session = self.sessionmaker()
+
+        try:
+            yield session
+        finally:
+            session.close()

fastapi_ext_pkg-0.4.0/fastapi_extras/security/auth.py

@@ -0,0 +1,97 @@
+import hashlib
+import json
+import logging
+import typing
+from typing import Any, AsyncGenerator, Awaitable, Callable, Optional, Protocol, Union
+
+import httpx
+from fastapi import Depends, HTTPException, Request, status
+from fastapi.security import APIKeyCookie, APIKeyHeader, APIKeyQuery
+from pydantic import AnyHttpUrl
+from typing_extensions import Annotated
+
+logger = logging.getLogger(__name__)
+
+UNAUTHORIZED = HTTPException(status_code=status.HTTP_401_UNAUTHORIZED, detail="Invalid credentials")
+DEFAULT_SCHEME = APIKeyHeader(name="Authorization")
+DEFAULT_CACHE_TTL = 60  # seconds
+
+
+def DEFAULT_CACHE_GEN() -> None:
+    pass
+
+
+@typing.runtime_checkable
+class Cache(Protocol):
+    async def get(self, key: str) -> Optional[str]: ...
+    async def set(self, key: str, value: str, ttl: Optional[int] = None) -> None: ...
+
+
+APIKeyScheme = Union[APIKeyCookie, APIKeyHeader, APIKeyQuery]
+Authorizer = Callable[[Request, str, Optional[Cache]], Awaitable[Any]]
+CacheGenerator = Callable[..., Union[Cache, AsyncGenerator[Cache, None], None]]
+
+
+def keygen(seed: str, prefix: str = "") -> str:
+    hash = hashlib.sha256(seed.encode()).hexdigest()
+    return f"{prefix}{hash}"
+
+
+def remote_authorization(
+    url: Union[str, AnyHttpUrl],
+    *,
+    scheme: APIKeyScheme = DEFAULT_SCHEME,
+    cache_gen: CacheGenerator = DEFAULT_CACHE_GEN,
+    cache_ttl: int = DEFAULT_CACHE_TTL,
+    **kwargs: Any,
+) -> Authorizer:
+    assert isinstance(scheme, (APIKeyCookie, APIKeyHeader, APIKeyQuery)), "Invalid APIKeyScheme"
+    # TODO: validate cachegen argument using introspection and type annotations
+
+    async def authorizer(
+        request: Request,
+        token: Annotated[str, Depends(scheme)],
+        cache: Annotated[Optional[Cache], Depends(cache_gen)],
+    ) -> Any:
+        key = keygen(token, prefix="authorizer:")
+        cached = await cache.get(key) if cache else None
+
+        if cached:
+            cached = json.loads(cached)
+
+        if cached and isinstance(cached, dict):
+            if not cached.get("authorized"):
+                raise UNAUTHORIZED
+
+            request.scope["authorizer"] = cached.get("context")
+            return request.scope["authorizer"]
+
+        info = {
+            "method": request.method,
+            "path": request.url.path,
+            "query_params": dict(request.query_params),
+            "headers": dict(request.headers),
+            "cookies": request.cookies,
+        }
+
+        async with httpx.AsyncClient() as client:
+            try:
+                response = await client.post(str(url), json=info, **kwargs)
+            except httpx.HTTPError as http_error:
+                logger.error(http_error)
+                raise UNAUTHORIZED
+            else:
+                authorized = response.status_code == status.HTTP_200_OK
+                context = response.json()
+
+                if cache:
+                    value = json.dumps({"authorized": authorized, "context": context})
+                    await cache.set(key, value, cache_ttl)
+
+                if not authorized:
+                    raise UNAUTHORIZED
+
+                request.scope["authorizer"] = context
+                return request.scope["authorizer"]
+
+    return authorizer

{fastapi_ext_pkg-0.2.0 → fastapi_ext_pkg-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-ext-pkg"
-version = "0.2.0"
+version = "0.4.0"
 description = "A well-tailored utility set for FastAPI."
 readme = {file = "README.md", content-type = "text/markdown"}
 authors = [
@@ -25,7 +25,7 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
 ]
 requires-python = ">=3.8"
-dependencies = ["fastapi"]
+dependencies = ["fastapi", "httpx"]
 
 [project.urls]
 Repository = "https://github.com/DotzInc/fastapi-ext-pkg"
@@ -53,3 +53,7 @@ quote-style = "double"
 indent-style = "space"
 skip-magic-trailing-comma = false
 line-ending = "auto"
+
+[tool.pytest.ini_options]
+addopts = "--disable-warnings -x"
+testpaths = ["tests/"]