add usecase

lib/dto.py

@@ -0,0 +1,12 @@
+from typing import TypeVar
+from pydantic import BaseModel
+
+
+class BaseDTO(BaseModel):
+    status: bool
+    errorCode: int
+    errorName: str
+    errorMessage: str
+
+
+TBaseDTO = TypeVar("TBaseDTO", bound=BaseDTO)

lib/presenter.py

@@ -20,7 +20,7 @@ class BasePresenter(
     """
     Abstract base class for presenters.
 
-    :param response: The presenter response object to use.
+    @param response: The presenter response object to use.
     :type response: TPresenterResponse
     """
 

lib/primary_ports.py

@@ -12,8 +12,8 @@ class BaseInputPort(BaseAbstractClass, Generic[TBaseRequestModel]):
     """
     Abstract base class for input ports.
 
-    :param requestModel: The request model to use.
-    :type requestModel: TBaseRequestModel
+    @param requestModel: The request model to use.
+    @type requestModel: TBaseRequestModel
     """
 
     def __init__(self) -> None:
@@ -25,6 +25,19 @@ def execute(self, requestModel: TBaseRequestModel) -> None:
 
 
 class BaseOutputPort(BaseAbstractClass, Generic[TBaseResponseModel, TBaseErrorResponseModel]):
+    """
+    Abstract base class for output ports.
+
+    @type-arg TBaseResponseModel: The response model to use.
+    @type-arg TBaseErrorResponseModel: The error response model to use.
+    @method presentSuccess: Present the success response.
+    @param responseModel: The response model to use.
+    @type responseModel: TBaseResponseModel
+    @method presentError: Present the error response.
+    @param errorModel: The error model to use.
+    @type errorModel: TBaseErrorResponseModel
+    """
+
     def __init__(self) -> None:
         super().__init__()
 

lib/usecase.py

@@ -0,0 +1,61 @@
+from abc import abstractmethod
+from typing import Generic
+from lib.dto import TBaseDTO
+from lib.primary_ports import BaseInputPort, BaseOutputPort
+from lib.usecase_models import (
+    BaseErrorResponseModel,
+    TBaseAuthenticatedRequestModel,
+    TBaseErrorResponseModel,
+    TBaseRequestModel,
+    TBaseResponseModel,
+)
+
+
+class BaseUseCase(
+    BaseInputPort[TBaseRequestModel | TBaseAuthenticatedRequestModel],
+    Generic[TBaseRequestModel, TBaseAuthenticatedRequestModel, TBaseResponseModel, TBaseErrorResponseModel],
+):
+    def __init__(self, presenter: BaseOutputPort[TBaseResponseModel, TBaseErrorResponseModel]) -> None:
+        super().__init__()
+        self.presenter: BaseOutputPort[TBaseResponseModel, TBaseErrorResponseModel] = presenter
+
+    @abstractmethod
+    def validate_request_model(self, requestModel: TBaseRequestModel | TBaseAuthenticatedRequestModel) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def execute(self, requestModel: TBaseRequestModel | TBaseAuthenticatedRequestModel) -> None:
+        raise NotImplementedError
+
+
+class BaseSingleDTOUseCase(
+    BaseUseCase[TBaseRequestModel, TBaseAuthenticatedRequestModel, TBaseResponseModel, TBaseErrorResponseModel],
+    Generic[TBaseRequestModel, TBaseAuthenticatedRequestModel, TBaseResponseModel, TBaseErrorResponseModel, TBaseDTO],
+):
+    def __init__(self, presenter: BaseOutputPort[TBaseResponseModel, TBaseErrorResponseModel]) -> None:
+        super().__init__(presenter)
+
+    @abstractmethod
+    def make_dto_request(self, requestModel: TBaseRequestModel | TBaseAuthenticatedRequestModel) -> TBaseDTO:
+        raise NotImplementedError
+
+    @abstractmethod
+    def handle_dto_error(self, dto: TBaseDTO) -> TBaseErrorResponseModel:
+        raise NotImplementedError
+
+    @abstractmethod
+    def processDTO(self, dto: TBaseDTO) -> TBaseResponseModel | TBaseErrorResponseModel:
+        raise NotImplementedError
+
+    def execute(self, requestModel: TBaseRequestModel | TBaseAuthenticatedRequestModel) -> None:
+        self.validate_request_model(requestModel)
+        dto: TBaseDTO = self.make_dto_request(requestModel)
+        if dto.status == False:
+            errorModel: TBaseErrorResponseModel = self.handle_dto_error(dto)
+            self.presenter.presentError(errorModel)
+        else:
+            responseModel: TBaseResponseModel | TBaseErrorResponseModel = self.processDTO(dto)
+            if responseModel.status == False:
+                self.presenter.presentError(responseModel)  # type: ignore  # TODO: try to fix this, line 46 cannot change
+            else:
+                self.presenter.presentSuccess(responseModel)  # type: ignore  # TODO: try to fix this, line 46 cannot change

lib/usecase_models.py

@@ -22,5 +22,6 @@ class BaseErrorResponseModel(BaseModel):
 
 
 TBaseRequestModel = TypeVar("TBaseRequestModel", bound=BaseRequestModel)
+TBaseAuthenticatedRequestModel = TypeVar("TBaseAuthenticatedRequestModel", bound=BaseAuthenticatedRequestModel)
 TBaseResponseModel = TypeVar("TBaseResponseModel", bound=BaseResponseModel)
 TBaseErrorResponseModel = TypeVar("TBaseErrorResponseModel", bound=BaseErrorResponseModel)