fastapi-mongo-base 0.10.0__tar.gz → 0.10.2__tar.gz

{fastapi_mongo_base-0.10.0/src/fastapi_mongo_base.egg-info → fastapi_mongo_base-0.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 0.10.0
+Version: 0.10.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>
@@ -44,8 +44,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: httpx>=0.24.0
-Requires-Dist: pyjwt[crypto]
 Requires-Dist: singleton_package
+Requires-Dist: json-advanced
 Requires-Dist: fastapi>=0.65.0
 Requires-Dist: uvicorn[standard]>=0.13.0
 Provides-Extra: image

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-mongo-base"
-version = "0.10.0"
+version = "0.10.2"
 description = "A simple boilerplate application, including models and schemas and abstract router, for FastAPI with MongoDB"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -30,8 +30,8 @@ classifiers = [
 dependencies = [
   "pydantic>=2.0.0",
   "httpx>=0.24.0",
-  "pyjwt[crypto]",
   "singleton_package",
+  "json-advanced",
   "fastapi>=0.65.0",
   "uvicorn[standard]>=0.13.0"
 ]

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/src/fastapi_mongo_base/core/app_factory.py

@@ -4,7 +4,6 @@ from collections import deque
 from contextlib import asynccontextmanager
 
 import fastapi
-from fastapi.middleware.cors import CORSMiddleware
 from fastapi.staticfiles import StaticFiles
 
 from fastapi_mongo_base.core import db, exceptions
@@ -16,20 +15,13 @@ except ImportError:
 
 
 async def health(request: fastapi.Request):
-    return {
-        "status": "up",
-        "host": request.url.hostname,
-        # "project_name": settings.project_name,
-        # "host2": request.base_url.hostname,
-        # "original_host":request.headers.get("x-original-host", "!not found!"),
-        # "forwarded_host": request.headers.get("X-Forwarded-Host", "forwarded_host"),
-        # "forwarded_proto": request.headers.get("X-Forwarded-Proto", "forwarded_proto"),
-        # "forwarded_for": request.headers.get("X-Forwarded-For", "forwarded_for"),
-    }
+    return {"status": "up"}
 
 
 @asynccontextmanager
-async def lifespan(app: fastapi.FastAPI, worker=None, init_functions=[], settings: Settings = None):  # type: ignore
+async def lifespan(
+    *, app: fastapi.FastAPI, worker=None, init_functions=[], settings: Settings = None
+):
     """Initialize application services."""
     await db.init_mongo_db()
 
@@ -49,44 +41,18 @@ async def lifespan(app: fastapi.FastAPI, worker=None, init_functions=[], setting
     logging.info("Shutdown complete")
 
 
-def setup_exception_handlers(
-    app: fastapi.FastAPI,
-    usso_handler: bool = True,
-    ufaas_handler: bool = True,
-    **kwargs,
-):
+def setup_exception_handlers(*, app: fastapi.FastAPI, handlers: dict = None, **kwargs):
     exception_handlers = exceptions.EXCEPTION_HANDLERS
-    if usso_handler:
-        try:
-            from usso.fastapi.integration import (
-                EXCEPTION_HANDLERS as USSO_EXCEPTION_HANDLERS,
-            )
-
-            exception_handlers.update(USSO_EXCEPTION_HANDLERS)
-        except ImportError:
-            pass
-    if ufaas_handler:
-        try:
-            from ufaas.fastapi.integration import (
-                EXCEPTION_HANDLERS as UFAAS_EXCEPTION_HANDLERS,
-            )
-
-            exception_handlers.update(UFAAS_EXCEPTION_HANDLERS)
-        except ImportError:
-            pass
+    if handlers:
+        exception_handlers.update(handlers)
 
     for exc_class, handler in exception_handlers.items():
         app.exception_handler(exc_class)(handler)
 
 
-def setup_middlewares(
-    app: fastapi.FastAPI,
-    origins: list = None,
-    original_host_middleware: bool = False,
-    request_log_middleware: bool = False,
-    timer_middleware: bool = True,
-    **kwargs,
-):
+def setup_middlewares(*, app: fastapi.FastAPI, origins: list = None, **kwargs):
+    from fastapi.middleware.cors import CORSMiddleware
+
     if origins:
         app.add_middleware(
             CORSMiddleware,
@@ -96,20 +62,6 @@ def setup_middlewares(
             allow_headers=["*"],
         )
 
-    if original_host_middleware:
-        from ufaas_fastapi_business.core.middlewares import OriginalHostMiddleware
-
-        app.add_middleware(OriginalHostMiddleware)
-    if request_log_middleware:
-        from .middlewares import RequestLoggingMiddleware
-
-        app.add_middleware(RequestLoggingMiddleware)
-    if timer_middleware:
-        from .middlewares import TimerMiddleware
-
-        app.add_middleware(TimerMiddleware)
-
-
 def create_app(
     settings: Settings = None,
     *,
@@ -121,20 +73,12 @@ def create_app(
     lifespan_func=None,
     worker=None,
     init_functions: list = [],
-    contact={
-        "name": "Mahdi Kiani",
-        "url": "https://github.com/mahdikiani/FastAPILaunchpad",
-        "email": "mahdikiany@gmail.com",
-    },
+    contact=None,
     license_info={
         "name": "MIT License",
         "url": "https://github.com/mahdikiani/FastAPILaunchpad/blob/main/LICENSE",
     },
-    usso_handler: bool = True,
-    ufaas_handler: bool = True,
-    original_host_middleware: bool = False,
-    request_log_middleware: bool = False,
-    timer_middleware: bool = True,
+    exception_handlers: dict = None,
     log_route: bool = False,
     health_route: bool = True,
     **kwargs,
@@ -172,15 +116,8 @@ def create_app(
         openapi_url=openapi_url,
     )
 
-    setup_exception_handlers(app, usso_handler, ufaas_handler, **kwargs)
-    setup_middlewares(
-        app,
-        origins,
-        original_host_middleware,
-        request_log_middleware,
-        timer_middleware,
-        **kwargs,
-    )
+    setup_exception_handlers(app=app, handlers=exception_handlers, **kwargs)
+    setup_middlewares(app=app, origins=origins, **kwargs)
 
     async def logs():
         with open(settings.get_log_config()["info_log_path"], "rb") as f:

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/src/fastapi_mongo_base/core/config.py

@@ -56,21 +56,15 @@ class Settings(metaclass=Singleton):
                     "level": console_level,
                     "formatter": "standard",
                 },
-                "file": {
-                    "class": "logging.FileHandler",
-                    "level": file_level,
-                    "filename": cls.base_dir / "logs" / "info.log",
-                    "formatter": "standard",
-                },
             },
             "loggers": {
                 "": {
-                    "handlers": ["console", "file"],
+                    "handlers": ["console"],
                     "level": "INFO",
                     "propagate": True,
                 },
                 "httpx": {
-                    "handlers": ["console", "file"],
+                    "handlers": ["console"],
                     "level": "WARNING",
                     "propagate": False,
                 },
@@ -81,6 +75,8 @@ class Settings(metaclass=Singleton):
 
     @classmethod
     def config_logger(cls):
-        (cls.base_dir / "logs").mkdir(parents=True, exist_ok=True)
+        log_config = cls.get_log_config()
+        if log_config["handlers"].get("file"):
+            (cls.base_dir / "logs").mkdir(parents=True, exist_ok=True)
 
         logging.config.dictConfig(cls.get_log_config())

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/src/fastapi_mongo_base/core/db.py

@@ -21,7 +21,7 @@ async def init_mongo_db():
             cls
             for cls in basic.get_all_subclasses(BaseEntity)
             if not (
-                hasattr(cls, "Settings")
+                "Settings" in cls.__dict__
                 and getattr(cls.Settings, "__abstract__", False)
             )
         ],

fastapi_mongo_base-0.10.2/src/fastapi_mongo_base/core/middlewares.py

@@ -0,0 +1,14 @@
+import time
+
+from fastapi import Request
+from starlette.middleware.base import BaseHTTPMiddleware
+
+
+class TimerMiddleware(BaseHTTPMiddleware):
+    async def dispatch(self, request: Request, call_next):
+        start_time = time.time()
+        response = await call_next(request)
+        end_time = time.time()
+        response.headers["X-Delivery-Time"] = str(end_time - start_time)
+
+        return response

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/src/fastapi_mongo_base/models.py

@@ -3,16 +3,12 @@ import uuid
 from datetime import date, datetime
 from decimal import Decimal
 
+import json_advanced
 from beanie import Document, Insert, Replace, Save, SaveChanges, Update, before_event
 from beanie.odm.queries.find import FindMany
 from pydantic import ConfigDict
 from pymongo import ASCENDING, IndexModel
 
-try:
-    from json_advanced import loads
-except ImportError:
-    from json import loads
-
 try:
     from server.config import Settings
 except ImportError:
@@ -20,11 +16,10 @@ except ImportError:
 
 from .schemas import (
     BaseEntitySchema,
-    BusinessEntitySchema,
-    BusinessOwnedEntitySchema,
-    OwnedEntitySchema,
+    TenantScopedEntitySchema,
+    TenantUserEntitySchema,
+    UserOwnedEntitySchema,
 )
-from .tasks import TaskMixin
 
 
 class BaseEntity(BaseEntitySchema, Document):
@@ -68,7 +63,7 @@ class BaseEntity(BaseEntitySchema, Document):
         value = value.strip()
         try:
             if value.startswith("[") and value.endswith("]"):
-                parsed = loads(value)
+                parsed = json_advanced.loads(value)
                 if isinstance(parsed, list):
                     return list(set(parsed))
                 return [parsed]
@@ -341,7 +336,7 @@ class BaseEntity(BaseEntitySchema, Document):
         return item
 
 
-class OwnedEntity(OwnedEntitySchema, BaseEntity):
+class UserOwnedEntity(UserOwnedEntitySchema, BaseEntity):
 
     class Settings(BaseEntity.Settings):
         __abstract__ = True
@@ -349,62 +344,55 @@ class OwnedEntity(OwnedEntitySchema, BaseEntity):
         indexes = BaseEntity.Settings.indexes + [IndexModel([("user_id", ASCENDING)])]
 
     @classmethod
-    async def get_item(cls, uid, user_id, *args, **kwargs) -> "OwnedEntity":
+    async def get_item(cls, uid, user_id, *args, **kwargs) -> "UserOwnedEntity":
         if user_id == None and kwargs.get("ignore_user_id") != True:
             raise ValueError("user_id is required")
         return await super().get_item(uid, user_id=user_id, *args, **kwargs)
 
 
-class BusinessEntity(BusinessEntitySchema, BaseEntity):
+class TenantScopedEntity(TenantScopedEntitySchema, BaseEntity):
 
     class Settings(BaseEntity.Settings):
         __abstract__ = True
 
-        indexes = BaseEntity.Settings.indexes + [
-            IndexModel([("business_name", ASCENDING)])
-        ]
+        indexes = BaseEntity.Settings.indexes + [IndexModel([("tenant_id", ASCENDING)])]
 
     @classmethod
-    async def get_item(cls, uid, business_name, *args, **kwargs) -> "BusinessEntity":
-        if business_name == None:
-            raise ValueError("business_name is required")
-        return await super().get_item(uid, business_name=business_name, *args, **kwargs)
+    async def get_item(cls, uid, tenant_id, *args, **kwargs) -> "TenantScopedEntity":
+        if tenant_id == None:
+            raise ValueError("tenant_id is required")
+        return await super().get_item(uid, tenant_id=tenant_id, *args, **kwargs)
 
-    async def get_business(self):
+    async def get_tenant(self):
         raise NotImplementedError
-        from apps.business_mongo.models import Business
+        from apps.tenant_mongo.models import Tenant
 
-        return await Business.get_by_name(self.business_name)
+        return await Tenant.get_by_name(self.tenant_id)
 
 
-class BusinessOwnedEntity(BusinessOwnedEntitySchema, BaseEntity):
+class TenantUserEntity(TenantUserEntitySchema, BaseEntity):
 
-    class Settings(BusinessEntity.Settings):
+    class Settings(TenantScopedEntity.Settings):
         __abstract__ = True
 
-        indexes = BusinessEntity.Settings.indexes + [
+        indexes = TenantScopedEntity.Settings.indexes + [
             IndexModel([("user_id", ASCENDING)])
         ]
 
     @classmethod
     async def get_item(
-        cls, uid, business_name, user_id, *args, **kwargs
-    ) -> "BusinessOwnedEntity":
-        if business_name == None:
-            raise ValueError("business_name is required")
+        cls, uid, tenant_id, user_id, *args, **kwargs
+    ) -> "TenantUserEntity":
+        if tenant_id == None:
+            raise ValueError("tenant_id is required")
         # if user_id == None:
         #     raise ValueError("user_id is required")
         return await super().get_item(
-            uid, business_name=business_name, user_id=user_id, *args, **kwargs
+            uid, tenant_id=tenant_id, user_id=user_id, *args, **kwargs
         )
 
 
-class BaseEntityTaskMixin(BaseEntity, TaskMixin):
-    class Settings(BaseEntity.Settings):
-        __abstract__ = True
-
-
-class ImmutableBase(BaseEntity):
+class ImmutableMixin(BaseEntity):
     model_config = ConfigDict(frozen=True)
 
     class Settings(BaseEntity.Settings):
@@ -417,21 +405,3 @@ class ImmutableBase(BaseEntity):
     @classmethod
     async def delete_item(cls, item: "BaseEntity"):
         raise ValueError("Immutable items cannot be deleted")
-
-
-class ImmutableOwnedEntity(ImmutableBase, OwnedEntity):
-
-    class Settings(OwnedEntity.Settings):
-        __abstract__ = True
-
-
-class ImmutableBusinessEntity(ImmutableBase, BusinessEntity):
-
-    class Settings(BusinessEntity.Settings):
-        __abstract__ = True
-
-
-class ImmutableBusinessOwnedEntity(ImmutableBase, BusinessOwnedEntity):
-
-    class Settings(BusinessOwnedEntity.Settings):
-        __abstract__ = True

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/src/fastapi_mongo_base/schemas.py

@@ -10,13 +10,30 @@ except ImportError:
     from .core.config import Settings
 
 
-class CoreEntitySchema(BaseModel):
+class BaseEntitySchema(BaseModel):
+    uid: str = Field(
+        default_factory=str(uuid.uuid4),
+        json_schema_extra={"index": True, "unique": True},
+        description="Unique identifier for the entity",
+    )
     created_at: datetime = Field(
-        default_factory=datetime.now, json_schema_extra={"index": True}
+        default_factory=datetime.now,
+        json_schema_extra={"index": True},
+        description="Date and time the entity was created",
+    )
+    updated_at: datetime = Field(
+        default_factory=datetime.now,
+        json_schema_extra={"index": True},
+        description="Date and time the entity was last updated",
+    )
+    is_deleted: bool = Field(
+        default=False,
+        description="Whether the entity has been deleted",
+    )
+    meta_data: dict | None = Field(
+        default=None,
+        description="Additional metadata for the entity",
     )
-    updated_at: datetime = Field(default_factory=datetime.now)
-    is_deleted: bool = False
-    meta_data: dict | None = None
 
     def __hash__(self):
         return hash(self.model_dump_json())
@@ -48,19 +65,12 @@ class CoreEntitySchema(BaseModel):
     def expired(self, days: int = 3):
         return (datetime.now() - self.updated_at).days > days
 
-
-class BaseEntitySchema(CoreEntitySchema):
-    uid: str = Field(
-        default_factory=str(uuid.uuid4),
-        json_schema_extra={"index": True, "unique": True},
-    )
-
     @property
     def item_url(self):
         return f"https://{Settings.root_url}{Settings.base_path}/{self.__class__.__name__.lower()}s/{self.uid}"
 
 
-class OwnedEntitySchema(BaseEntitySchema):
+class UserOwnedEntitySchema(BaseEntitySchema):
     user_id: str
 
     @classmethod
@@ -72,27 +82,27 @@ class OwnedEntitySchema(BaseEntitySchema):
         return super().update_exclude_set() + ["user_id"]
 
 
-class BusinessEntitySchema(BaseEntitySchema):
-    business_name: str
+class TenantScopedEntitySchema(BaseEntitySchema):
+    tenant_id: str
 
     @classmethod
     def create_exclude_set(cls) -> list[str]:
-        return super().create_exclude_set() + ["business_name"]
+        return super().create_exclude_set() + ["tenant_id"]
 
     @classmethod
     def update_exclude_set(cls) -> list[str]:
-        return super().update_exclude_set() + ["business_name"]
+        return super().update_exclude_set() + ["tenant_id"]
 
 
-class BusinessOwnedEntitySchema(OwnedEntitySchema, BusinessEntitySchema):
+class TenantUserEntitySchema(TenantScopedEntitySchema, UserOwnedEntitySchema):
 
     @classmethod
     def create_exclude_set(cls) -> list[str]:
-        return list(set(super().create_exclude_set() + ["business_name", "user_id"]))
+        return list(set(super().create_exclude_set() + ["tenant_id", "user_id"]))
 
     @classmethod
     def update_exclude_set(cls) -> list[str]:
-        return list(set(super().update_exclude_set() + ["business_name", "user_id"]))
+        return list(set(super().update_exclude_set() + ["tenant_id", "user_id"]))
 
 
 T = TypeVar("T", bound=BaseEntitySchema)

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/src/fastapi_mongo_base/tasks.py

@@ -9,7 +9,7 @@ from pydantic import BaseModel, Field, field_serializer, field_validator
 from singleton import Singleton
 
 from .schemas import BaseEntitySchema
-from .utils import aionetwork, basic
+from .utils import basic
 
 
 class TaskStatusEnum(str, Enum):
@@ -117,7 +117,8 @@ class TaskMixin(BaseModel):
     task_references: TaskReferenceList | None = None
     task_start_at: datetime | None = None
     task_end_at: datetime | None = None
-    task_order_score: float = 0.0
+    task_order_score: int = 0
+    webhook_custom_headers: dict | None = None
     webhook_url: str | None = None
 
     @classmethod
@@ -166,8 +167,10 @@ class TaskMixin(BaseModel):
     async def emit_signals(cls, task_instance: "TaskMixin", *, sync=False, **kwargs):
 
         async def webhook_call(*args, **kwargs):
+            import httpx
+
             try:
-                await aionetwork.aio_request(*args, **kwargs)
+                await httpx.AsyncClient().post(*args, **kwargs)
             except Exception as e:
                 import traceback
 
@@ -204,7 +207,10 @@ class TaskMixin(BaseModel):
                 webhook_call(
                     method="post",
                     url=webhook_url,
-                    headers={"Content-Type": "application/json"},
+                    headers={
+                        "Content-Type": "application/json",
+                        **(task_instance.webhook_custom_headers or {}),
+                    },
                     data=json.dumps(task_dict),
                 )
             )

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2/src/fastapi_mongo_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-mongo-base
-Version: 0.10.0
+Version: 0.10.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>
@@ -44,8 +44,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: httpx>=0.24.0
-Requires-Dist: pyjwt[crypto]
 Requires-Dist: singleton_package
+Requires-Dist: json-advanced
 Requires-Dist: fastapi>=0.65.0
 Requires-Dist: uvicorn[standard]>=0.13.0
 Provides-Extra: image

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/src/fastapi_mongo_base.egg-info/SOURCES.txt

@@ -2,7 +2,6 @@ LICENSE.txt
 README.md
 pyproject.toml
 src/fastapi_mongo_base/__init__.py
-src/fastapi_mongo_base/cached.py
 src/fastapi_mongo_base/models.py
 src/fastapi_mongo_base/routes.py
 src/fastapi_mongo_base/schemas.py
@@ -20,10 +19,6 @@ src/fastapi_mongo_base/core/enums.py
 src/fastapi_mongo_base/core/exceptions.py
 src/fastapi_mongo_base/core/middlewares.py
 src/fastapi_mongo_base/utils/__init__.py
-src/fastapi_mongo_base/utils/aionetwork.py
 src/fastapi_mongo_base/utils/basic.py
 src/fastapi_mongo_base/utils/bsontools.py
-src/fastapi_mongo_base/utils/conditions.py
-src/fastapi_mongo_base/utils/imagetools.py
-src/fastapi_mongo_base/utils/ssh_handler.py
-src/fastapi_mongo_base/utils/texttools.py
+src/fastapi_mongo_base/utils/conditions.py

{fastapi_mongo_base-0.10.0 → fastapi_mongo_base-0.10.2}/src/fastapi_mongo_base.egg-info/requires.txt

@@ -1,7 +1,7 @@
 pydantic>=2.0.0
 httpx>=0.24.0
-pyjwt[crypto]
 singleton_package
+json-advanced
 fastapi>=0.65.0
 uvicorn[standard]>=0.13.0