Refactored guards and versioning decorator to work for both class and route functions

Author: eadwinCode

ellar/common/__init__.py

@@ -5,12 +5,13 @@
 
 from .decorators import (
     Controller,
+    Guards,
     Module,
+    Version,
     command,
     exception_handler,
     extra_args,
     file,
-    guards,
     middleware,
     on_shutdown,
     on_startup,
@@ -20,7 +21,6 @@
     set_metadata,
     template_filter,
     template_global,
-    version,
 )
 from .routing import (
     Body,
@@ -57,13 +57,13 @@
     "ModuleRouter",
     "render",
     "Module",
-    "guards",
+    "Guards",
     "Param",
     "ParamTypes",
     "set_metadata",
     "Controller",
     "openapi_info",
-    "version",
+    "Version",
     "delete",
     "get",
     "head",

ellar/common/decorators/__init__.py

@@ -6,20 +6,20 @@
 from .exception import exception_handler
 from .extra_args import extra_args
 from .file import file
-from .guards import guards
+from .guards import Guards
 from .html import render, template_filter, template_global
 from .middleware import middleware
 from .modules import Module
 from .openapi import openapi_info
 from .request import on_shutdown, on_startup
 from .serializer import serializer_filter
-from .versioning import version
+from .versioning import Version
 
 __all__ = [
     "serializer_filter",
     "Controller",
-    "version",
-    "guards",
+    "Version",
+    "Guards",
     "template_filter",
     "template_global",
     "file",

ellar/common/decorators/controller.py

@@ -9,11 +9,9 @@
     CONTROLLER_METADATA,
     CONTROLLER_OPERATION_HANDLER_KEY,
     CONTROLLER_WATERMARK,
-    GUARDS_KEY,
     NOT_SET,
     OPERATION_ENDPOINT_KEY,
     REFLECT_TYPE,
-    VERSIONING_KEY,
 )
 from ellar.core import ControllerBase
 from ellar.core.controller import ControllerType
@@ -22,9 +20,6 @@
 from ellar.di import RequestScope, injectable
 from ellar.reflect import reflect
 
-if t.TYPE_CHECKING:  # pragma: no cover
-    from ellar.core.guard import GuardCanActivate
-
 
 def get_route_functions(
     cls: t.Type,
@@ -79,8 +74,6 @@ def Controller(
     external_doc_description: str = None,
     external_doc_url: str = None,
     name: str = None,
-    version: t.Union[t.Tuple, str] = (),
-    guards: t.List[t.Union[t.Type["GuardCanActivate"], "GuardCanActivate"]] = None,
     include_in_schema: bool = True,
 ) -> t.Union[t.Type[ControllerBase], t.Callable[..., t.Any], t.Any]:  # pragma: no cover
     """
@@ -109,8 +102,6 @@ def Controller(
     external_doc_description: str = None,
     external_doc_url: str = None,
     name: str = None,
-    version: t.Union[t.Tuple, str] = (),
-    guards: t.List[t.Union[t.Type["GuardCanActivate"], "GuardCanActivate"]] = None,
     include_in_schema: bool = True,
 ) -> t.Union[t.Type[ControllerBase], t.Callable[..., t.Any], t.Any]:
     """
@@ -121,8 +112,6 @@ def Controller(
     :param external_doc_description: OPENAPI External Doc Description
     :param external_doc_url: OPENAPI External Document URL
     :param name: route name prefix for url reversing, eg name:route_name default=controller_name
-    :param version: default URL versioning for all defined route in a controller
-    :param guards: default guard for all routes defined under this controller
     :param include_in_schema: include controller in OPENAPI schema
     :return: t.Type[ControllerBase]
     """
@@ -144,8 +133,6 @@ def Controller(
         ),
         path=_prefix,
         name=name,
-        version=set([version] if isinstance(version, str) else version),
-        guards=guards or [],
         include_in_schema=include_in_schema,
     )
 
@@ -190,9 +177,6 @@ def _decorator(cls: t.Type) -> t.Type[ControllerBase]:
             for key in CONTROLLER_METADATA.keys:
                 reflect.define_metadata(key, kwargs[key], _controller_type)
 
-            reflect.define_metadata(VERSIONING_KEY, kwargs.version, _controller_type)
-            reflect.define_metadata(GUARDS_KEY, kwargs.guards, _controller_type)
-
         if new_cls:
             # if we forced cls to inherit from ControllerBase, we need to block it from been processed
             setattr(cls, "__CONTROLLER_WATERMARK__", True)

ellar/common/decorators/guards.py

@@ -8,11 +8,11 @@
     from ellar.core.guard import GuardCanActivate
 
 
-def guards(
+def Guards(
     *_guards: t.Union[t.Type["GuardCanActivate"], "GuardCanActivate"]
 ) -> t.Callable:
     """
-    =========ROUTE FUNCTION DECORATOR ==============
+    =========CONTROLLER AND ROUTE FUNCTION DECORATOR ==============
 
     Defines list of guards for a route function
     :param _guards: Guard Type or Instance

ellar/common/decorators/versioning.py

@@ -5,9 +5,9 @@
 from .base import set_metadata as set_meta
 
 
-def version(*_version: str) -> t.Callable:
+def Version(*_version: str) -> t.Callable:
     """
-     ========= ROUTE FUNCTION DECORATOR ==============
+     ========= CONTROLLER AND ROUTE FUNCTION DECORATOR ==============
 
      Defines route function version
     :param _version: allowed versions

ellar/core/guard/base.py

@@ -15,7 +15,7 @@ class GuardCanActivate(ABC, metaclass=ABCMeta):
         t.Type[HTTPException], t.Type[APIException]
     ] = HTTPException
     status_code: int = HTTP_403_FORBIDDEN
-    detail: str = "Not authenticated"
+    detail: str = "Forbidden"
 
     @abstractmethod
     async def can_activate(self, context: IExecutionContext) -> bool:

ellar/core/routing/router/module.py

@@ -42,7 +42,6 @@ def controller_router_factory(
     app = Router()
     app.routes = RouteCollection(routes)  # type:ignore
 
-    reflect.get_metadata_or_raise_exception(VERSIONING_KEY, controller)
     include_in_schema = reflect.get_metadata_or_raise_exception(
         CONTROLLER_METADATA.INCLUDE_IN_SCHEMA, controller
     )

tests/test_common/test_decorators/test_controller.py

@@ -1,6 +1,6 @@
 import pytest
 
-from ellar.common import Controller, set_metadata
+from ellar.common import Controller, Guards, Version, set_metadata
 from ellar.constants import CONTROLLER_METADATA, GUARDS_KEY, NOT_SET, VERSIONING_KEY
 from ellar.core import ControllerBase
 from ellar.core.exceptions import ImproperConfiguration
@@ -12,12 +12,12 @@
     prefix="/decorator",
     description="Some description",
     external_doc_description="external",
-    guards=[],
-    version=("v1",),
     tag="dec",
     external_doc_url="https://example.com",
     name="test",
 )
+@Version("v1")
+@Guards()
 class ControllerDecorationTest:
     pass
 
@@ -51,8 +51,8 @@ def test_controller_decoration_default():
         "external_doc_description": None,
         "external_doc_url": None,
     }
-    assert reflect.get_metadata(GUARDS_KEY, ControllerDefaultTest) == []
-    assert reflect.get_metadata(VERSIONING_KEY, ControllerDefaultTest) == set()
+    assert reflect.get_metadata(GUARDS_KEY, ControllerDefaultTest) is None
+    assert reflect.get_metadata(VERSIONING_KEY, ControllerDefaultTest) is None
     assert (
         reflect.get_metadata(CONTROLLER_METADATA.PATH, ControllerDefaultTest)
         == "/defaulttest"

tests/test_common/test_decorators/test_guards.py

@@ -1,4 +1,4 @@
-from ellar.common import guards
+from ellar.common import Guards
 from ellar.constants import GUARDS_KEY
 from ellar.core import ExecutionContext
 from ellar.core.connection import Request
@@ -16,12 +16,12 @@ async def can_activate(self, context: ExecutionContext) -> bool:
         return False  # pragma: no cover
 
 
-@guards(SomeGuard)
+@Guards(SomeGuard)
 def endpoint(request: Request):
     return "foo"  # pragma: no cover
 
 
-@guards(SomeGuard, SomeGuard2)
+@Guards(SomeGuard, SomeGuard2)
 def endpoint2(request: Request):
     return "foo"  # pragma: no cover
 

tests/test_common/test_decorators/test_versioning.py

@@ -1,9 +1,9 @@
-from ellar.common import version
+from ellar.common import Version
 from ellar.constants import VERSIONING_KEY
 from ellar.reflect import reflect
 
 
-@version(1, 2, 3)
+@Version(1, 2, 3)
 def endpoint_versioning_func():
     pass  # pragma: no cover