authenticated decorator prototype

Author: Archmonger

CHANGELOG.md

@@ -9,7 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 <!--attr-end-->
 
 <!--
-Types of changes are to be listed in this order
+Using the following categories, list your changes in this order:
     - "Added" for new features.
     - "Changed" for changes in existing functionality.
     - "Deprecated" for soon-to-be removed features.
@@ -22,7 +22,9 @@ Types of changes are to be listed in this order
 
 ## [Unreleased]
 
--   Nothing (yet)
+### Added
+
+-   `authenticated` decorator to prevent your components from rendered to unauthenticated users.
 
 ## [1.1.0] - 2022-07-01
 

src/django_idom/__init__.py

@@ -1,7 +1,7 @@
-from . import components, hooks
-from .websocket.consumer import IdomWebsocket
-from .websocket.paths import IDOM_WEBSOCKET_PATH
+from django_idom import components, hooks
+from django_idom.types import AuthLevel, IdomWebsocket
+from django_idom.websocket.paths import IDOM_WEBSOCKET_PATH
 
 
 __version__ = "1.1.0"
-__all__ = ["IDOM_WEBSOCKET_PATH", "IdomWebsocket", "hooks", "components"]
+__all__ = ["IDOM_WEBSOCKET_PATH", "AuthLevel", "IdomWebsocket", "hooks", "components"]

src/django_idom/decorators.py

@@ -0,0 +1,46 @@
+from functools import wraps
+from typing import Callable, Union
+
+from idom.core.types import ComponentType, VdomDict
+
+from django_idom.hooks import use_websocket
+from django_idom.types import AuthLevel
+
+
+def authenticated(
+    component: Union[Callable, None] = None,
+    auth_level: str = AuthLevel.user,
+    fallback: Union[ComponentType, VdomDict, None] = None,
+) -> ComponentType | VdomDict | Callable | None:
+    """If the user is authenticated, the decorated component will be rendered.
+    Otherwise, the fallback component will be rendered.
+
+    This decorator can be used with or without paranthesis.
+
+    Args:
+        auth_level: The user's auth level. This value can be
+           - One of the predefined `django_idom.AuthLevel` values
+           - A string for a custom user attribute to check (ex. `UserModel.is_<auth_level>`).
+        fallback: The component to render if the user is not authenticated.
+    """
+
+    def decorator(component):
+        @wraps(component)
+        def _wrapped_func(*args, **kwargs):
+            websocket = use_websocket()
+
+            if getattr(websocket.scope["user"], f"is_{auth_level}", False):
+                return component(*args, **kwargs)
+
+            if callable(fallback):
+                return fallback(*args, **kwargs)
+            return fallback
+
+        return _wrapped_func
+
+    # Return when used as @authenticated
+    if component is None:
+        return decorator
+
+    # Return when used as @authenticated(...)
+    return decorator(component)

src/django_idom/hooks.py

@@ -1,16 +1,9 @@
-from dataclasses import dataclass
-from typing import Awaitable, Callable, Dict, Optional, Type, Union
+from typing import Dict, Type, Union
 
 from idom.backend.types import Location
 from idom.core.hooks import Context, create_context, use_context
 
-
-@dataclass
-class IdomWebsocket:
-    scope: dict
-    close: Callable[[Optional[int]], Awaitable[None]]
-    disconnect: Callable[[int], Awaitable[None]]
-    view_id: str
+from django_idom.types import IdomWebsocket
 
 
 WebsocketContext: Type[Context[Union[IdomWebsocket, None]]] = create_context(

src/django_idom/types.py

@@ -0,0 +1,18 @@
+from dataclasses import dataclass
+from typing import Awaitable, Callable, Optional
+
+
+@dataclass
+class IdomWebsocket:
+    scope: dict
+    close: Callable[[Optional[int]], Awaitable[None]]
+    disconnect: Callable[[int], Awaitable[None]]
+    view_id: str
+
+
+@dataclass
+class AuthLevel:
+    user: str = "authenticated"
+    active_user: str = "active"
+    staff: str = "staff"
+    superuser: str = "superuser"

src/django_idom/websocket/consumer.py

@@ -12,7 +12,8 @@
 from idom.core.serve import serve_json_patch
 
 from django_idom.config import IDOM_REGISTERED_COMPONENTS
-from django_idom.hooks import IdomWebsocket, WebsocketContext
+from django_idom.hooks import WebsocketContext
+from django_idom.types import IdomWebsocket
 
 
 _logger = logging.getLogger(__name__)