fastapi-mongo-base 1.5.0__tar.gz → 1.5.2__tar.gz

{fastapi_mongo_base-1.5.0/src/fastapi_mongo_base.egg-info → fastapi_mongo_base-1.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 1.5.0
+Version: 1.5.2
 Summary: A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB
 Author-email: Mahdi Kiani <mahdikiany@gmail.com>
 Maintainer-email: Mahdi Kiani <mahdikiany@gmail.com>

{fastapi_mongo_base-1.5.0 → fastapi_mongo_base-1.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-mongo-base"
-version = "1.5.0"
+version = "1.5.2"
 description = "A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB"
 readme = "README.md"
 requires-python = ">=3.10"

{fastapi_mongo_base-1.5.0 → fastapi_mongo_base-1.5.2}/src/fastapi_mongo_base/errors/__init__.py

@@ -11,15 +11,15 @@ from .handlers import (
 )
 from .http import (
     AlreadyExistsError,
-    APIError,
+    BadRequestError,
     ConflictError,
     ForbiddenError,
     GoneError,
-    HTTPClientError,
     LockedError,
     NotFoundError,
     PaymentRequiredError,
     ServerError,
+    UnauthorizedError,
 )
 from .mongodb import (
     DocumentAlreadyExistsError,
@@ -55,9 +55,9 @@ from .responses import (
 __all__ = [
     "COMMON_ERROR_RESPONSES",
     "EXCEPTION_HANDLERS",
-    "APIError",
     "APIErrorResponseModel",
     "AlreadyExistsError",
+    "BadRequestError",
     "BaseHTTPException",
     "ConflictError",
     "DocumentAlreadyExistsError",
@@ -65,7 +65,6 @@ __all__ = [
     "DocumentNotFoundError",
     "ForbiddenError",
     "GoneError",
-    "HTTPClientError",
     "InternalErrorResponseModel",
     "LockedError",
     "MongoDBConnectionError",
@@ -84,6 +83,7 @@ __all__ = [
     "ResourceNotFoundError",
     "ResourcePaymentRequiredError",
     "ServerError",
+    "UnauthorizedError",
     "ValidationErrorResponseModel",
     "ValidationReason",
     "base_http_exception_handler",

{fastapi_mongo_base-1.5.0 → fastapi_mongo_base-1.5.2}/src/fastapi_mongo_base/errors/base.py

@@ -25,8 +25,8 @@ class BaseHTTPException(HTTPException):
 
     def __init__(
         self,
-        status_code: int,
-        error_code: str,
+        status_code: int | None = None,
+        error_code: str | None = None,
         detail: str | None = None,
         message: dict | None = None,
         **kwargs: object,
@@ -42,8 +42,8 @@ class BaseHTTPException(HTTPException):
             **kwargs: Additional error data.
 
         """
-        self.status_code = status_code
-        self.error_code = error_code
+        self.status_code = status_code or self.status_code
+        self.error_code = error_code or self.error_code
         if message is None:
             if self.message_en and self.message_fa:
                 self.message = localized(self.message_en, self.message_fa)
@@ -55,4 +55,4 @@ class BaseHTTPException(HTTPException):
             self.message = message
         self.detail = detail or str(self.message.get("en"))
         self.data = kwargs
-        super().__init__(status_code, detail=detail)
+        super().__init__(self.status_code, detail=self.detail)

fastapi_mongo_base-1.5.2/src/fastapi_mongo_base/errors/exceptions.py

@@ -0,0 +1,25 @@
+"""Exceptions for the fastapi-mongo-base package."""
+
+from .base import BaseHTTPException
+from .http import (
+    AlreadyExistsError,
+    BadRequestError,
+    ConflictError,
+    ForbiddenError,
+    NotFoundError,
+    PaymentRequiredError,
+    ServerError,
+    UnauthorizedError,
+)
+
+__all__ = [
+    "AlreadyExistsError",
+    "BadRequestError",
+    "BaseHTTPException",
+    "ConflictError",
+    "ForbiddenError",
+    "NotFoundError",
+    "PaymentRequiredError",
+    "ServerError",
+    "UnauthorizedError",
+]

{fastapi_mongo_base-1.5.0 → fastapi_mongo_base-1.5.2}/src/fastapi_mongo_base/errors/http.py

@@ -28,7 +28,34 @@ class ServerError(BaseHTTPException):
         )
 
 
-class NotFoundError(ServerError):
+class BadRequestError(BaseHTTPException):
+    """Raised when a request is invalid."""
+
+    status_code = 400
+    error_code = "bad_request"
+    message_en = "Bad request"
+    message_fa = "درخواست نامعتبر"
+
+
+class UnauthorizedError(BaseHTTPException):
+    """Raised when a request is unauthorized."""
+
+    status_code = 401
+    error_code = "unauthorized"
+    message_en = "Unauthorized"
+    message_fa = "دسترسی غیر مجاز"
+
+
+class ForbiddenError(BaseHTTPException):
+    """Raised when a request is forbidden."""
+
+    status_code = 403
+    error_code = "permission_denied"
+    message_en = "Permission denied"
+    message_fa = "دسترسی غیر مجاز"
+
+
+class NotFoundError(BaseHTTPException):
     """Raised when a requested entity is not found."""
 
     status_code = 404
@@ -37,7 +64,7 @@ class NotFoundError(ServerError):
     message_fa = "یافت نشد"
 
 
-class AlreadyExistsError(ServerError):
+class AlreadyExistsError(BaseHTTPException):
     """Raised when an entity already exists."""
 
     status_code = 409
@@ -46,7 +73,7 @@ class AlreadyExistsError(ServerError):
     message_fa = "نمونه‌ی مشابه وجود دارد"
 
 
-class ConflictError(ServerError):
+class ConflictError(BaseHTTPException):
     """Raised when a request conflicts with current state."""
 
     status_code = 409
@@ -55,7 +82,7 @@ class ConflictError(ServerError):
     message_fa = "اطلاعات ارسال شده تداخل دارد"
 
 
-class PaymentRequiredError(ServerError):
+class PaymentRequiredError(BaseHTTPException):
     """Raised when payment is required before access."""
 
     status_code = 402
@@ -64,16 +91,7 @@ class PaymentRequiredError(ServerError):
     message_fa = "برای دسترسی، پرداخت لازم است"
 
 
-class ForbiddenError(ServerError):
-    """Raised when the caller lacks permission."""
-
-    status_code = 403
-    error_code = "permission_denied"
-    message_en = "Permission denied"
-    message_fa = "دسترسی غیر مجاز"
-
-
-class GoneError(ServerError):
+class GoneError(BaseHTTPException):
     """Raised when an entity is no longer available."""
 
     status_code = 410
@@ -82,15 +100,10 @@ class GoneError(ServerError):
     message_fa = "در دسترس نیست"
 
 
-class LockedError(ServerError):
+class LockedError(BaseHTTPException):
     """Raised when an entity is locked."""
 
     status_code = 423
     error_code = "resource_locked"
     message_en = "Resource locked"
     message_fa = "قفل شده است"
-
-
-# Backward-compatible aliases from earlier refactors.
-HTTPClientError = ServerError
-APIError = ServerError

{fastapi_mongo_base-1.5.0 → fastapi_mongo_base-1.5.2}/src/fastapi_mongo_base/tasks.py

@@ -158,7 +158,30 @@ class TaskReferenceList(BaseModel):
                 ])
 
 
-class TaskMixin(BaseModel):
+class TaskCreateFieldsMixin(BaseModel):
+    """Common optional fields accepted when creating async tasks."""
+
+    user_id: str | None = Field(
+        None,
+        description="Target user id (omitted = authenticated user)",
+    )
+    webhook_url: str | None = Field(
+        None,
+        description="URL to notify when the task completes",
+    )
+    webhook_custom_headers: dict | None = Field(
+        None,
+        description="Custom headers to send in webhook requests",
+    )
+    meta_data: dict | None = Field(
+        None,
+        description=(
+            "Client metadata stored on the task and echoed in webhooks"
+        ),
+    )
+
+
+class TaskMixin(TaskCreateFieldsMixin):
     """Mixin class for entities with task processing capabilities."""
 
     task_status: TaskStatusEnum = TaskStatusEnum.draft
@@ -169,8 +192,6 @@ class TaskMixin(BaseModel):
     task_start_at: datetime | None = None
     task_end_at: datetime | None = None
     task_order_score: int = 0
-    webhook_custom_headers: dict | None = None
-    webhook_url: str | None = None
 
     @property
     def webhook_exclude_fields(self) -> set[str] | None:

{fastapi_mongo_base-1.5.0 → fastapi_mongo_base-1.5.2/src/fastapi_mongo_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 1.5.0
+Version: 1.5.2
 Summary: A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB
 Author-email: Mahdi Kiani <mahdikiany@gmail.com>
 Maintainer-email: Mahdi Kiani <mahdikiany@gmail.com>

{fastapi_mongo_base-1.5.0 → fastapi_mongo_base-1.5.2}/src/fastapi_mongo_base.egg-info/SOURCES.txt

@@ -38,6 +38,7 @@ src/fastapi_mongo_base/db/redis.py
 src/fastapi_mongo_base/db/sql.py
 src/fastapi_mongo_base/errors/__init__.py
 src/fastapi_mongo_base/errors/base.py
+src/fastapi_mongo_base/errors/exceptions.py
 src/fastapi_mongo_base/errors/handlers.py
 src/fastapi_mongo_base/errors/http.py
 src/fastapi_mongo_base/errors/mongodb.py

{fastapi_mongo_base-1.5.0 → fastapi_mongo_base-1.5.2}/tests/test_http_errors.py

@@ -4,7 +4,7 @@ import pytest
 from fastapi import HTTPException
 
 from src.fastapi_mongo_base.errors.base import BaseHTTPException
-from src.fastapi_mongo_base.errors.http import HTTPClientError, ServerError
+from src.fastapi_mongo_base.errors.http import ServerError
 from src.fastapi_mongo_base.errors.resource import (
     AlreadyExistsError,
     ConflictError,
@@ -108,7 +108,7 @@ LEGACY_ALIASES = [
     HTTP_ERROR_CASES,
 )
 def test_api_error_class_messages(
-    exc_cls: type[ServerError],
+    exc_cls: type[BaseHTTPException],
     status_code: int,
     error_code: str,
     message_en: str,
@@ -126,7 +126,7 @@ def test_api_error_class_messages(
     HTTP_ERROR_CASES,
 )
 def test_api_error_detail_and_bilingual_message(
-    exc_cls: type[ServerError],
+    exc_cls: type[BaseHTTPException],
     status_code: int,
     error_code: str,
     message_en: str,
@@ -146,9 +146,11 @@ def test_api_error_detail_and_bilingual_message(
 @pytest.mark.parametrize(
     "exc_cls", ALL_HTTP_ERROR_CLASSES[1:], ids=lambda c: c.__name__
 )
-def test_api_errors_inherit_from_api_error(exc_cls: type[ServerError]) -> None:
+def test_api_errors_inherit_from_api_error(
+    exc_cls: type[BaseHTTPException],
+) -> None:
     """Every specialized API error extends APIError."""
-    assert issubclass(exc_cls, ServerError)
+    assert issubclass(exc_cls, BaseHTTPException)
 
 
 def test_api_error_inheritance() -> None:
@@ -167,7 +169,7 @@ def test_api_error_inheritance() -> None:
     ids=[case.id for case in HTTP_ERROR_CASES],
 )
 def test_api_error_custom_detail_preserves_bilingual_message(
-    exc_cls: type[ServerError],
+    exc_cls: type[BaseHTTPException],
     message_en: str,
     message_fa: str,
 ) -> None:
@@ -189,13 +191,8 @@ def test_api_error_extra_data() -> None:
 
 @pytest.mark.parametrize(("legacy", "canonical"), LEGACY_ALIASES)
 def test_legacy_resource_error_aliases(
-    legacy: type[ServerError],
-    canonical: type[ServerError],
+    legacy: type[BaseHTTPException],
+    canonical: type[BaseHTTPException],
 ) -> None:
     """Resource* names remain aliases of the canonical API errors."""
     assert legacy is canonical
-
-
-def test_http_client_error_alias() -> None:
-    """HTTPClientError remains an alias of APIError."""
-    assert HTTPClientError is ServerError