stac-fastapi-core 4.0.0__py3-none-any.whl

stac_fastapi/core/__init__.py

@@ -0,0 +1 @@
+"""Core library."""

stac_fastapi/core/base_database_logic.py

@@ -0,0 +1,54 @@
+"""Base database logic."""
+
+import abc
+from typing import Any, Dict, Iterable, Optional
+
+
+class BaseDatabaseLogic(abc.ABC):
+    """
+    Abstract base class for database logic.
+
+    This class defines the basic structure and operations for database interactions.
+    Subclasses must provide implementations for these methods.
+    """
+
+    @abc.abstractmethod
+    async def get_all_collections(
+        self, token: Optional[str], limit: int
+    ) -> Iterable[Dict[str, Any]]:
+        """Retrieve a list of all collections from the database."""
+        pass
+
+    @abc.abstractmethod
+    async def get_one_item(self, collection_id: str, item_id: str) -> Dict:
+        """Retrieve a single item from the database."""
+        pass
+
+    @abc.abstractmethod
+    async def create_item(self, item: Dict, refresh: bool = False) -> None:
+        """Create an item in the database."""
+        pass
+
+    @abc.abstractmethod
+    async def delete_item(
+        self, item_id: str, collection_id: str, refresh: bool = False
+    ) -> None:
+        """Delete an item from the database."""
+        pass
+
+    @abc.abstractmethod
+    async def create_collection(self, collection: Dict, refresh: bool = False) -> None:
+        """Create a collection in the database."""
+        pass
+
+    @abc.abstractmethod
+    async def find_collection(self, collection_id: str) -> Dict:
+        """Find a collection in the database."""
+        pass
+
+    @abc.abstractmethod
+    async def delete_collection(
+        self, collection_id: str, refresh: bool = False
+    ) -> None:
+        """Delete a collection from the database."""
+        pass

stac_fastapi/core/base_settings.py

@@ -0,0 +1,12 @@
+"""Base settings."""
+
+from abc import ABC, abstractmethod
+
+
+class ApiBaseSettings(ABC):
+    """Abstract base class for API settings."""
+
+    @abstractmethod
+    def create_client(self):
+        """Create a database client."""
+        pass

stac_fastapi/core/basic_auth.py

@@ -0,0 +1,61 @@
+"""Basic Authentication Module."""
+
+import logging
+import secrets
+
+from fastapi import Depends, HTTPException, status
+from fastapi.security import HTTPBasic, HTTPBasicCredentials
+from typing_extensions import Annotated
+
+_LOGGER = logging.getLogger("uvicorn.default")
+_SECURITY = HTTPBasic()
+
+
+class BasicAuth:
+    """Apply basic authentication to the provided FastAPI application \
+    based on environment variables for username, password, and endpoints."""
+
+    def __init__(self, credentials: list) -> None:
+        """Generate basic_auth property."""
+        self.basic_auth = {}
+        for credential in credentials:
+            self.basic_auth[credential["username"]] = credential
+
+    async def __call__(
+        self,
+        credentials: Annotated[HTTPBasicCredentials, Depends(_SECURITY)],
+    ) -> str:
+        """Check if the provided credentials match the expected \
+            username and password stored in basic_auth.
+
+        Args:
+            credentials (HTTPBasicCredentials): The HTTP basic authentication credentials.
+
+        Returns:
+            str: The username if authentication is successful.
+
+        Raises:
+            HTTPException: If authentication fails due to incorrect username or password.
+        """
+        user = self.basic_auth.get(credentials.username)
+
+        if not user:
+            raise HTTPException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="Incorrect username or password",
+                headers={"WWW-Authenticate": "Basic"},
+            )
+
+        # Compare the provided username and password with the correct ones using compare_digest
+        if not secrets.compare_digest(
+            credentials.username.encode("utf-8"), user.get("username").encode("utf-8")
+        ) or not secrets.compare_digest(
+            credentials.password.encode("utf-8"), user.get("password").encode("utf-8")
+        ):
+            raise HTTPException(
+                status_code=status.HTTP_401_UNAUTHORIZED,
+                detail="Incorrect username or password",
+                headers={"WWW-Authenticate": "Basic"},
+            )
+
+        return credentials.username