fixed failing test

Author: eadwinCode

ellar/cache/service.py

@@ -60,7 +60,7 @@ def has_key(self, key: str, version: str = None, backend: str = None) -> bool:
         return _backend.has_key(key, version=version)
 
 
-@injectable  # type: ignore
+@injectable
 class CacheService(_CacheServiceSync, ICacheService):
     """
     A Cache Backend Service that wraps Ellar cache backends

ellar/common/__init__.py

@@ -12,6 +12,7 @@
     exception_handler,
     extra_args,
     file,
+    interceptors,
     middleware,
     openapi_info,
     render,
@@ -42,6 +43,7 @@
     IHTTPHostContext,
     IModuleSetup,
     IModuleTemplateLoader,
+    InterceptorConsumer,
     IResponseModel,
     IWebSocketContextFactory,
     IWebSocketHostContext,
@@ -52,6 +54,7 @@
     BaseHttpAuth,
     ControllerBase,
     ControllerType,
+    EllarInterceptor,
     GuardCanActivate,
 )
 from .params.decorators import (
@@ -191,6 +194,9 @@
     "IModuleSetup",
     "IResponseModel",
     "IModuleTemplateLoader",
+    "InterceptorConsumer",
+    "EllarInterceptor",
+    "interceptors",
 ]
 
 

ellar/common/constants.py

@@ -54,6 +54,7 @@
 ROUTE_OPENAPI_PARAMETERS = "ROUTE_OPENAPI_PARAMETERS"
 
 OPERATION_ENDPOINT_KEY = "OPERATION_ENDPOINT"
+ROUTE_INTERCEPTORS = "ROUTE_INTERCEPTORS"
 CONTROLLER_OPERATION_HANDLER_KEY = "CONTROLLER_OPERATION_HANDLER"
 CONTROLLER_CLASS_KEY = "CONTROLLER_CLASS_KEY"
 

ellar/common/decorators/__init__.py

@@ -7,6 +7,7 @@
 from .file import file
 from .guards import UseGuards
 from .html import render, template_filter, template_global
+from .interceptor import interceptors
 from .middleware import middleware
 from .modules import Module
 from .openapi import openapi_info
@@ -28,6 +29,7 @@
     "openapi_info",
     "Module",
     "extra_args",
+    "interceptors",
 ]
 
 

ellar/common/decorators/interceptor.py

@@ -0,0 +1,22 @@
+import typing as t
+
+from ellar.common.constants import ROUTE_INTERCEPTORS
+
+from .base import set_metadata as set_meta
+
+if t.TYPE_CHECKING:  # pragma: no cover
+    from ellar.common import EllarInterceptor
+
+
+def interceptors(
+    *args: t.Union[t.Type["EllarInterceptor"], "EllarInterceptor"]
+) -> t.Callable:
+    """
+    =========FUNCTION DECORATOR ==============
+
+    Programmatically adds extra route function parameter.
+    see https://github.com/eadwinCode/ellar/blob/main/tests/test_routing/test_extra_args.py for usages
+    :param args: Collection EllarInterceptor
+    :return:
+    """
+    return set_meta(ROUTE_INTERCEPTORS, list(args))

ellar/common/interfaces/__init__.py

@@ -9,6 +9,7 @@
     IWebSocketHostContext,
 )
 from .exceptions import IExceptionHandler, IExceptionMiddlewareService
+from .interceptor_consumer import InterceptorConsumer
 from .module import IModuleSetup
 from .response_model import IResponseModel
 from .templating import IModuleTemplateLoader
@@ -27,4 +28,5 @@
     "IModuleSetup",
     "IResponseModel",
     "IModuleTemplateLoader",
+    "InterceptorConsumer",
 ]

ellar/common/interfaces/interceptor_consumer.py

@@ -0,0 +1,15 @@
+import typing as t
+from abc import ABC, abstractmethod
+
+from .context import IExecutionContext
+
+if t.TYPE_CHECKING:  # pragma: no cover
+    from ellar.common.routing import RouteOperationBase
+
+
+class InterceptorConsumer(ABC):
+    @abstractmethod
+    async def execute(
+        self, context: IExecutionContext, route_operation: "RouteOperationBase"
+    ) -> t.Any:
+        """implementation goes here"""

ellar/common/models/__init__.py

@@ -1,5 +1,6 @@
 from .controller import ControllerBase, ControllerType
 from .guard import BaseAPIKey, BaseAuthGuard, BaseHttpAuth, GuardCanActivate
+from .interceptor import EllarInterceptor
 
 __all__ = [
     "ControllerBase",
@@ -8,4 +9,5 @@
     "BaseAPIKey",
     "BaseHttpAuth",
     "GuardCanActivate",
+    "EllarInterceptor",
 ]

ellar/common/models/interceptor.py

@@ -0,0 +1,12 @@
+import typing as t
+from abc import ABC, abstractmethod
+
+from ..interfaces import IExecutionContext
+
+
+class EllarInterceptor(ABC):
+    @abstractmethod
+    async def intercept(
+        self, context: IExecutionContext, next_interceptor: t.Callable[..., t.Coroutine]
+    ) -> t.Any:
+        """implementation comes here"""

ellar/common/responses/models/json.py

@@ -29,7 +29,9 @@ def create_response(
             t.Type[JSONResponse],
             context.get_app().config.DEFAULT_JSON_CLASS or self._response_type,
         )
-        response_args, headers = self.get_context_response(context=context)
+        response_args, headers = self.get_context_response(
+            context=context, status_code=status_code
+        )
         serializer_filter = reflect.get_metadata(
             SERIALIZER_FILTER_KEY, context.get_handler()
         )