task/29: Add basic schemas & add health handler in user-app (#11)

sapphire/common/api/schemas/__init__.py

@@ -0,0 +1,10 @@
+from .base import BaseResponse, OKResponse
+from .enums import ResponseStatus
+from .health import HealthResponse
+
+__all__ = [
+    "ResponseStatus",
+    "OKResponse",
+    "BaseResponse",
+    "HealthResponse",
+]

sapphire/common/api/schemas/base.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel
+
+from .enums import ResponseStatus
+
+
+class BaseResponse(BaseModel):
+    status: ResponseStatus
+
+
+class OKResponse(BaseModel):
+    status: ResponseStatus = ResponseStatus.OK

sapphire/common/api/schemas/enums.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class ResponseStatus(Enum):
+    OK = "ok"
+    ERROR = "error"

sapphire/common/api/schemas/health.py

@@ -0,0 +1,6 @@
+from .base import BaseResponse
+
+
+class HealthResponse(BaseResponse):
+    version: str
+    name: str

sapphire/common/broker/service.py

@@ -8,10 +8,10 @@
 
 class BaseBrokerService(ServiceMixin):
     def __init__(
-            self,
-            servers: Iterable[str],
-            topics: Iterable[str],
-            handlers: Iterable[BaseBrokerHandler],
+        self,
+        servers: Iterable[str],
+        topics: Iterable[str],
+        handlers: Iterable[BaseBrokerHandler],
     ):
         self._handlers = handlers
 

sapphire/common/database/service.py

@@ -17,7 +17,7 @@ def get_alembic_config_path(self) -> pathlib.Path:
 
     def get_alembic_config(self) -> AlembicConfig:
         migrations_path = self.get_alembic_config_path()
-        
+
         config = AlembicConfig()
         config.set_main_option("script_location", str(migrations_path))
         config.set_main_option("sqlalchemy.url", self._dsn)
@@ -28,4 +28,6 @@ def migrate(self):
         alembic_command.upgrade(self.get_alembic_config(), "head")
 
     def create_migration(self, message: str | None = None):
-        alembic_command.revision(self.get_alembic_config(), message=message, autogenerate=True)
+        alembic_command.revision(
+            self.get_alembic_config(), message=message, autogenerate=True
+        )

sapphire/common/functions.py

@@ -0,0 +1,9 @@
+from functools import reduce
+
+
+def get_nested(storage: dict, *keys):
+    return reduce(
+        lambda value, key: value.get(key, {}) if isinstance(value, dict) else None,
+        keys,
+        storage,
+    )

sapphire/users/api/v1beta/health.py

@@ -1,2 +1,18 @@
-async def health():
-    pass
+import os
+import pathlib
+import tomllib
+
+from sapphire.common.api.schemas import HealthResponse, ResponseStatus
+from sapphire.common.functions import get_nested
+
+
+async def health() -> HealthResponse:
+    path_to_toml_file = pathlib.Path(os.curdir).absolute() / "pyproject.toml"
+    with open(path_to_toml_file, "rb") as toml_file:
+        pyproject_data = tomllib.load(toml_file)
+
+    return HealthResponse(
+        status=ResponseStatus.OK,
+        version=get_nested(pyproject_data, "tool", "poetry", "version"),
+        name="users",
+    )