From a39549cd9433095df4bd3e05dcecd48738c4c4cd Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 03:29:41 -0700
Subject: [PATCH 01/14] authenticated decorator prototype

---
 CHANGELOG.md                          |  6 ++--
 src/django_idom/__init__.py           |  8 ++---
 src/django_idom/decorators.py         | 46 +++++++++++++++++++++++++++
 src/django_idom/hooks.py              | 11 ++-----
 src/django_idom/types.py              | 18 +++++++++++
 src/django_idom/websocket/consumer.py |  3 +-
 6 files changed, 76 insertions(+), 16 deletions(-)
 create mode 100644 src/django_idom/decorators.py
 create mode 100644 src/django_idom/types.py

diff --git a/CHANGELOG.md b/CHANGELOG.md
index a283c7d8..10e20d8e 100644
--- a/CHANGELOG.md
+++ b/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
 
diff --git a/src/django_idom/__init__.py b/src/django_idom/__init__.py
index 857f92e1..4c446318 100644
--- a/src/django_idom/__init__.py
+++ b/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"]
diff --git a/src/django_idom/decorators.py b/src/django_idom/decorators.py
new file mode 100644
index 00000000..e6fdd181
--- /dev/null
+++ b/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)
diff --git a/src/django_idom/hooks.py b/src/django_idom/hooks.py
index 5d088223..79ce1d16 100644
--- a/src/django_idom/hooks.py
+++ b/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(
diff --git a/src/django_idom/types.py b/src/django_idom/types.py
new file mode 100644
index 00000000..9df8249d
--- /dev/null
+++ b/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"
diff --git a/src/django_idom/websocket/consumer.py b/src/django_idom/websocket/consumer.py
index aa988afa..cdc3eb9f 100644
--- a/src/django_idom/websocket/consumer.py
+++ b/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__)

From 05e2ca72b25a1c8e1748973db1f582dd5afad954 Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 04:00:30 -0700
Subject: [PATCH 02/14] add tests

---
 src/django_idom/__init__.py             | 11 +++++++--
 src/django_idom/decorators.py           |  8 +++---
 tests/test_app/components.py            | 33 +++++++++++++++++++++++++
 tests/test_app/templates/base.html      |  2 ++
 tests/test_app/tests/test_components.py | 12 +++++++++
 5 files changed, 60 insertions(+), 6 deletions(-)

diff --git a/src/django_idom/__init__.py b/src/django_idom/__init__.py
index 4c446318..41fbe032 100644
--- a/src/django_idom/__init__.py
+++ b/src/django_idom/__init__.py
@@ -1,7 +1,14 @@
-from django_idom import components, hooks
+from django_idom import components, decorators, 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", "AuthLevel", "IdomWebsocket", "hooks", "components"]
+__all__ = [
+    "IDOM_WEBSOCKET_PATH",
+    "AuthLevel",
+    "IdomWebsocket",
+    "hooks",
+    "components",
+    "decorators",
+]
diff --git a/src/django_idom/decorators.py b/src/django_idom/decorators.py
index e6fdd181..2dd26375 100644
--- a/src/django_idom/decorators.py
+++ b/src/django_idom/decorators.py
@@ -9,9 +9,9 @@
 
 def authenticated(
     component: Union[Callable, None] = None,
-    auth_level: str = AuthLevel.user,
+    auth_level: str = AuthLevel.active_user,
     fallback: Union[ComponentType, VdomDict, None] = None,
-) -> ComponentType | VdomDict | Callable | None:
+) -> Callable:
     """If the user is authenticated, the decorated component will be rendered.
     Otherwise, the fallback component will be rendered.
 
@@ -38,9 +38,9 @@ def _wrapped_func(*args, **kwargs):
 
         return _wrapped_func
 
-    # Return when used as @authenticated
+    # Return when used as @authenticated(...)
     if component is None:
         return decorator
 
-    # Return when used as @authenticated(...)
+    # Return when used as @authenticated
     return decorator(component)
diff --git a/tests/test_app/components.py b/tests/test_app/components.py
index a2491c17..4ad6b5d1 100644
--- a/tests/test_app/components.py
+++ b/tests/test_app/components.py
@@ -95,3 +95,36 @@ def django_js():
         ),
         idom.html.hr(),
     )
+
+
+@idom.component
+@django_idom.decorators.authenticated(
+    fallback=idom.html.div(
+        {"id": "unauthorized-user-fallback"},
+        "unauthorized_user: Success. User was blocked from accessing this component.",
+        idom.html.hr(),
+    )
+)
+def unauthorized_user():
+    return idom.html.div(
+        {"id": "unauthorized-user"},
+        "unauthorized_user: Fail",
+        idom.html.hr(),
+    )
+
+
+@idom.component
+@django_idom.decorators.authenticated(
+    auth_level="anonymous",
+    fallback=idom.html.div(
+        {"id": "authorized-user-fallback"},
+        "authorized_user: Fail.",
+        idom.html.hr(),
+    ),
+)
+def authorized_user():
+    return idom.html.div(
+        {"id": "authorized-user"},
+        "authorized_user: Success. User was not blocked from accessing this component.",
+        idom.html.hr(),
+    )
diff --git a/tests/test_app/templates/base.html b/tests/test_app/templates/base.html
index e6960c14..28c8a815 100644
--- a/tests/test_app/templates/base.html
+++ b/tests/test_app/templates/base.html
@@ -21,6 +21,8 @@ <h1>IDOM Test Page</h1>
   <div>{% component "test_app.components.use_location" %}</div>
   <div>{% component "test_app.components.django_css" %}</div>
   <div>{% component "test_app.components.django_js" %}</div>
+  <div>{% component "test_app.components.unauthorized_user" %}</div>
+  <div>{% component "test_app.components.authorized_user" %}</div>
 </body>
 
 </html>
diff --git a/tests/test_app/tests/test_components.py b/tests/test_app/tests/test_components.py
index 8ed89efa..7cf3d22d 100644
--- a/tests/test_app/tests/test_components.py
+++ b/tests/test_app/tests/test_components.py
@@ -69,6 +69,18 @@ def test_static_js(self):
             element = self.driver.find_element_by_id("django-js")
             self.assertEqual(element.get_attribute("data-success"), "true")
 
+        def test_unauthorized_user(self):
+            element = self.driver.find_element_by_id("unauthorized-user")
+            self.assertIsNotNone(element)
+            element = self.driver.find_element_by_id("unauthorized-user-fallback")
+            self.assertIsNone(element)
+
+        def test_authorized_user(self):
+            element = self.driver.find_element_by_id("authorized-user")
+            self.assertIsNone(element)
+            element = self.driver.find_element_by_id("authorized-user-fallback")
+            self.assertIsNotNone(element)
+
 
 def make_driver(page_load_timeout, implicit_wait_timeout):
     options = webdriver.ChromeOptions()

From 771b4d35030c08f43fab9004107fba00acca3523 Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 05:14:39 -0700
Subject: [PATCH 03/14] initial draft of docs

---
 docs/features/decorators.md   | 26 ++++++++++++++++++++++++++
 mkdocs.yml                    |  1 +
 src/django_idom/decorators.py |  8 ++++----
 src/django_idom/types.py      | 11 +++++++++--
 tests/test_app/components.py  |  4 ++--
 5 files changed, 42 insertions(+), 8 deletions(-)
 create mode 100644 docs/features/decorators.md

diff --git a/docs/features/decorators.md b/docs/features/decorators.md
new file mode 100644
index 00000000..bc2af15e
--- /dev/null
+++ b/docs/features/decorators.md
@@ -0,0 +1,26 @@
+## Auth Required
+
+You can limit access to a component via an `auth_level` by using this decorator.
+
+Common uses of this decorator are to hide components from `AnonymousUser`, or only render a component to `staff` or `superuser` members.
+
+This decorator can be used with or without paranthesis.
+
+```python title="components.py"
+from django_idom.decorators import auth_required
+from django_idom.hooks import use_websocket
+from idom import component, html
+
+@component
+@auth_required
+def my_component():
+    return html.div("This won't render if I'm not logged in!")
+```
+
+??? example "See Interface"
+
+    | Name | Type | Description | Default |
+    | --- | --- | --- | --- |
+    | auth_level | `str` | The user's auth level. This value can be... <br><br> - One of the predefined `django_idom.AuthLevel` values. <br> - A string for a custom user attribute to check. This is checked in the form of `UserModel.is_<auth_level>`. | `AuthLevel.active` |
+    | fallback | `ComponentType`, `VdomDict`, `None` | The component or VDOM (`idom.html` snippet) to render if the user is not authenticated. | `None` |
+
diff --git a/mkdocs.yml b/mkdocs.yml
index 9cf9d38b..2a7562f1 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -11,6 +11,7 @@ nav:
     - Exclusive Features:
           - Components: features/components.md
           - Hooks: features/hooks.md
+          - Decorators: features/decorators.md
           - Template Tag: features/templatetag.md
           - Settings: features/settings.md
     - Contribute:
diff --git a/src/django_idom/decorators.py b/src/django_idom/decorators.py
index 2dd26375..d34e1eae 100644
--- a/src/django_idom/decorators.py
+++ b/src/django_idom/decorators.py
@@ -7,9 +7,9 @@
 from django_idom.types import AuthLevel
 
 
-def authenticated(
+def auth_required(
     component: Union[Callable, None] = None,
-    auth_level: str = AuthLevel.active_user,
+    auth_level: str = AuthLevel.active,
     fallback: Union[ComponentType, VdomDict, None] = None,
 ) -> Callable:
     """If the user is authenticated, the decorated component will be rendered.
@@ -19,9 +19,9 @@ def authenticated(
 
     Args:
         auth_level: The user's auth level. This value can be
-           - One of the predefined `django_idom.AuthLevel` values
+           - 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.
+        fallback: The component or VDOM (`idom.html` snippet) to render if the user is not authenticated.
     """
 
     def decorator(component):
diff --git a/src/django_idom/types.py b/src/django_idom/types.py
index 9df8249d..53f5246c 100644
--- a/src/django_idom/types.py
+++ b/src/django_idom/types.py
@@ -12,7 +12,14 @@ class IdomWebsocket:
 
 @dataclass
 class AuthLevel:
-    user: str = "authenticated"
-    active_user: str = "active"
+    authenticated: str = "authenticated"
+    """Anyone logged in with a registered account."""
+
+    active: str = "active"
+    """Any account that has not been deactivated."""
+
     staff: str = "staff"
+    """Any account that is a staff member."""
+
     superuser: str = "superuser"
+    """Any account that is a superuser."""
diff --git a/tests/test_app/components.py b/tests/test_app/components.py
index 4ad6b5d1..4ea906ed 100644
--- a/tests/test_app/components.py
+++ b/tests/test_app/components.py
@@ -98,7 +98,7 @@ def django_js():
 
 
 @idom.component
-@django_idom.decorators.authenticated(
+@django_idom.decorators.auth_required(
     fallback=idom.html.div(
         {"id": "unauthorized-user-fallback"},
         "unauthorized_user: Success. User was blocked from accessing this component.",
@@ -114,7 +114,7 @@ def unauthorized_user():
 
 
 @idom.component
-@django_idom.decorators.authenticated(
+@django_idom.decorators.auth_required(
     auth_level="anonymous",
     fallback=idom.html.div(
         {"id": "authorized-user-fallback"},

From ea7c340f26b7bd58a58d92ab0b9672ed1e5eb3d4 Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 06:08:06 -0700
Subject: [PATCH 04/14] AuthAttribute

---
 docs/features/decorators.md   |  8 ++++----
 src/django_idom/__init__.py   |  4 ++--
 src/django_idom/decorators.py | 16 ++++++++--------
 src/django_idom/types.py      |  7 +++++--
 tests/test_app/components.py  |  2 +-
 5 files changed, 20 insertions(+), 17 deletions(-)

diff --git a/docs/features/decorators.md b/docs/features/decorators.md
index bc2af15e..d6ab961f 100644
--- a/docs/features/decorators.md
+++ b/docs/features/decorators.md
@@ -1,10 +1,10 @@
 ## Auth Required
 
-You can limit access to a component via an `auth_level` by using this decorator.
+You can limit access to a component to a specific `auth_attribute` by using this decorator.
 
-Common uses of this decorator are to hide components from `AnonymousUser`, or only render a component to `staff` or `superuser` members.
+Common uses of this decorator are to hide components from `AnonymousUser`, or render a component to only `staff` or `superuser` members.
 
-This decorator can be used with or without paranthesis.
+This decorator can be used with or without parentheses.
 
 ```python title="components.py"
 from django_idom.decorators import auth_required
@@ -21,6 +21,6 @@ def my_component():
 
     | Name | Type | Description | Default |
     | --- | --- | --- | --- |
-    | auth_level | `str` | The user's auth level. This value can be... <br><br> - One of the predefined `django_idom.AuthLevel` values. <br> - A string for a custom user attribute to check. This is checked in the form of `UserModel.is_<auth_level>`. | `AuthLevel.active` |
+    | auth_attribute | `str` | The field to check within the user object. This value can be... <br><br> - One of the predefined `django_idom.AuthAttribute` values. <br> - A string for a custom user attribute to check. This is checked in the form of `UserModel.is_<auth_attribute>`. | `AuthAttribute.active` |
     | fallback | `ComponentType`, `VdomDict`, `None` | The component or VDOM (`idom.html` snippet) to render if the user is not authenticated. | `None` |
 
diff --git a/src/django_idom/__init__.py b/src/django_idom/__init__.py
index 41fbe032..c15f5b3c 100644
--- a/src/django_idom/__init__.py
+++ b/src/django_idom/__init__.py
@@ -1,12 +1,12 @@
 from django_idom import components, decorators, hooks
-from django_idom.types import AuthLevel, IdomWebsocket
+from django_idom.types import AuthAttribute, IdomWebsocket
 from django_idom.websocket.paths import IDOM_WEBSOCKET_PATH
 
 
 __version__ = "1.1.0"
 __all__ = [
     "IDOM_WEBSOCKET_PATH",
-    "AuthLevel",
+    "AuthAttribute",
     "IdomWebsocket",
     "hooks",
     "components",
diff --git a/src/django_idom/decorators.py b/src/django_idom/decorators.py
index d34e1eae..6038da72 100644
--- a/src/django_idom/decorators.py
+++ b/src/django_idom/decorators.py
@@ -4,23 +4,23 @@
 from idom.core.types import ComponentType, VdomDict
 
 from django_idom.hooks import use_websocket
-from django_idom.types import AuthLevel
+from django_idom.types import AuthAttribute
 
 
 def auth_required(
     component: Union[Callable, None] = None,
-    auth_level: str = AuthLevel.active,
+    auth_attribute: str = AuthAttribute.active,
     fallback: Union[ComponentType, VdomDict, None] = None,
 ) -> Callable:
-    """If the user is authenticated, the decorated component will be rendered.
+    """If the user passes authentication criteria, the decorated component will be rendered.
     Otherwise, the fallback component will be rendered.
 
-    This decorator can be used with or without paranthesis.
+    This decorator can be used with or without parentheses.
 
     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>`).
+        auth_attribute: The field to check within the user object. This value can be
+           - One of the predefined `django_idom.AuthAttribute` values.
+           - A string for a custom user attribute to check (ex. `UserModel.is_<auth_attribute>`).
         fallback: The component or VDOM (`idom.html` snippet) to render if the user is not authenticated.
     """
 
@@ -29,7 +29,7 @@ def decorator(component):
         def _wrapped_func(*args, **kwargs):
             websocket = use_websocket()
 
-            if getattr(websocket.scope["user"], f"is_{auth_level}", False):
+            if getattr(websocket.scope["user"], f"is_{auth_attribute}", False):
                 return component(*args, **kwargs)
 
             if callable(fallback):
diff --git a/src/django_idom/types.py b/src/django_idom/types.py
index 53f5246c..d9b4a83e 100644
--- a/src/django_idom/types.py
+++ b/src/django_idom/types.py
@@ -11,12 +11,15 @@ class IdomWebsocket:
 
 
 @dataclass
-class AuthLevel:
+class AuthAttribute:
+    anonymous: str = "anonymous"
+    """Individuals that are not logged in."""
+
     authenticated: str = "authenticated"
     """Anyone logged in with a registered account."""
 
     active: str = "active"
-    """Any account that has not been deactivated."""
+    """A registered account that has not been deactivated."""
 
     staff: str = "staff"
     """Any account that is a staff member."""
diff --git a/tests/test_app/components.py b/tests/test_app/components.py
index 4ea906ed..8bc1f455 100644
--- a/tests/test_app/components.py
+++ b/tests/test_app/components.py
@@ -115,7 +115,7 @@ def unauthorized_user():
 
 @idom.component
 @django_idom.decorators.auth_required(
-    auth_level="anonymous",
+    auth_attribute="anonymous",
     fallback=idom.html.div(
         {"id": "authorized-user-fallback"},
         "authorized_user: Fail.",

From 4b592b23d204426c1c9df724222ccb8d217fab0c Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 13:08:11 -0700
Subject: [PATCH 05/14] attempt fixing tests

---
 tests/test_app/tests/test_components.py | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/tests/test_app/tests/test_components.py b/tests/test_app/tests/test_components.py
index 7cf3d22d..815a4929 100644
--- a/tests/test_app/tests/test_components.py
+++ b/tests/test_app/tests/test_components.py
@@ -71,15 +71,15 @@ def test_static_js(self):
 
         def test_unauthorized_user(self):
             element = self.driver.find_element_by_id("unauthorized-user")
-            self.assertIsNotNone(element)
-            element = self.driver.find_element_by_id("unauthorized-user-fallback")
             self.assertIsNone(element)
+            element = self.driver.find_element_by_id("unauthorized-user-fallback")
+            self.assertIsNotNone(element)
 
         def test_authorized_user(self):
             element = self.driver.find_element_by_id("authorized-user")
-            self.assertIsNone(element)
-            element = self.driver.find_element_by_id("authorized-user-fallback")
             self.assertIsNotNone(element)
+            element = self.driver.find_element_by_id("authorized-user-fallback")
+            self.assertIsNone(element)
 
 
 def make_driver(page_load_timeout, implicit_wait_timeout):

From cd43920a770b3468664f78a8475df0c282dba72a Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 13:14:48 -0700
Subject: [PATCH 06/14] assertRaises

---
 tests/test_app/tests/test_components.py | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/tests/test_app/tests/test_components.py b/tests/test_app/tests/test_components.py
index 815a4929..7b1f0518 100644
--- a/tests/test_app/tests/test_components.py
+++ b/tests/test_app/tests/test_components.py
@@ -3,6 +3,7 @@
 
 from channels.testing import ChannelsLiveServerTestCase
 from selenium import webdriver
+from selenium.common.exceptions import NoSuchElementException
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support import expected_conditions
 from selenium.webdriver.support.wait import WebDriverWait
@@ -70,16 +71,22 @@ def test_static_js(self):
             self.assertEqual(element.get_attribute("data-success"), "true")
 
         def test_unauthorized_user(self):
-            element = self.driver.find_element_by_id("unauthorized-user")
-            self.assertIsNone(element)
+            self.assertRaises(
+                NoSuchElementException,
+                self.driver.find_element_by_id,
+                "unauthorized-user",
+            )
             element = self.driver.find_element_by_id("unauthorized-user-fallback")
             self.assertIsNotNone(element)
 
         def test_authorized_user(self):
+            self.assertRaises(
+                NoSuchElementException,
+                self.driver.find_element_by_id,
+                "authorized-user-fallback",
+            )
             element = self.driver.find_element_by_id("authorized-user")
             self.assertIsNotNone(element)
-            element = self.driver.find_element_by_id("authorized-user-fallback")
-            self.assertIsNone(element)
 
 
 def make_driver(page_load_timeout, implicit_wait_timeout):

From 6f5812cacc81160e6ccfeda51fa03e9403aff6c5 Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 14:11:48 -0700
Subject: [PATCH 07/14] more docs and interface revision

---
 docs/features/decorators.md   | 84 ++++++++++++++++++++++++++++++++++-
 src/django_idom/__init__.py   |  3 +-
 src/django_idom/decorators.py |  4 +-
 src/django_idom/types.py      | 10 ++---
 tests/test_app/components.py  |  2 +-
 5 files changed, 93 insertions(+), 10 deletions(-)

diff --git a/docs/features/decorators.md b/docs/features/decorators.md
index d6ab961f..8d700dfb 100644
--- a/docs/features/decorators.md
+++ b/docs/features/decorators.md
@@ -19,8 +19,90 @@ def my_component():
 
 ??? example "See Interface"
 
+    <font size="4">**Parameters**</font>
+
     | Name | Type | Description | Default |
     | --- | --- | --- | --- |
-    | auth_attribute | `str` | The field to check within the user object. This value can be... <br><br> - One of the predefined `django_idom.AuthAttribute` values. <br> - A string for a custom user attribute to check. This is checked in the form of `UserModel.is_<auth_attribute>`. | `AuthAttribute.active` |
+    | auth_attribute | `str` | The field to check within the user object. This value can be... <br><br> - One of the predefined `django_idom.AuthAttribute` values. <br> - A string for a custom user attribute to check. This is checked in the form of `UserModel.<auth_attribute>`. | `AuthAttribute.active` |
     | fallback | `ComponentType`, `VdomDict`, `None` | The component or VDOM (`idom.html` snippet) to render if the user is not authenticated. | `None` |
 
+    <font size="4">**Returns**</font>
+
+    | Type | Description |
+    | --- | --- |
+    | `Component` | An IDOM component. |
+    | `VdomDict` | An `idom.html` snippet. |
+    | `None` | No component render. |
+
+??? question "How do I render a different component if authentication fails?"
+
+    ```python title="components.py"
+    from django_idom.decorators import auth_required
+    from django_idom.hooks import use_websocket
+    from idom import component, html
+
+    @component
+    def my_component_fallback():
+        return html.div("I'm not logged in!")
+
+    @component
+    @auth_required(fallback=my_component_fallback)
+    def my_component():
+        return html.div("This won't render if I'm not logged in!")
+    ```
+
+??? question "How do I render a simple `idom.html` snippet if authentication fails?"
+
+    ```python title="components.py"
+    from django_idom.decorators import auth_required
+    from django_idom.hooks import use_websocket
+    from idom import component, html
+
+    @component
+    @auth_required(fallback=html.div("I'm not logged in!"))
+    def my_component():
+        return html.div("This won't render if I'm not logged in!")
+    ```
+
+??? question "How can I check if a user `is_staff`?"
+
+    ```python title="components.py"
+    from django_idom.decorators import auth_required
+    from django_idom.hooks import use_websocket
+    from django_idom import AuthAttribute
+    from idom import component, html
+
+
+    @component
+    @auth_required(auth_attribute=AuthAttribute.staff)
+    def my_component():
+        return html.div("This won't render if I'm not logged in!")
+    ```
+
+??? question "How can I check for a custom attribute?"
+
+    You will need to be using a [custom user model](https://docs.djangoproject.com/en/dev/topics/auth/customizing/#specifying-a-custom-user-model) within your Django instance.
+
+    For example, if your user model has the field `is_really_cool` ...
+
+    ```python
+    from django.contrib.auth.models import AbstractBaseUser
+
+    class CustomUserModel(AbstractBaseUser):
+        @property
+        def is_really_cool(self):
+            return self.name == "Groot"
+    ```
+
+    ... then you would do the following within your decorator:
+
+    ```python title="components.py"
+    from django_idom.decorators import auth_required
+    from django_idom.hooks import use_websocket
+    from idom import component, html
+
+    @component
+    @auth_required(auth_attribute="is_really_cool")
+    def my_component():
+        return html.div("This won't render if I'm not logged in!")
+    ```
diff --git a/src/django_idom/__init__.py b/src/django_idom/__init__.py
index c15f5b3c..88fa6c60 100644
--- a/src/django_idom/__init__.py
+++ b/src/django_idom/__init__.py
@@ -1,4 +1,4 @@
-from django_idom import components, decorators, hooks
+from django_idom import components, decorators, hooks, types
 from django_idom.types import AuthAttribute, IdomWebsocket
 from django_idom.websocket.paths import IDOM_WEBSOCKET_PATH
 
@@ -7,6 +7,7 @@
 __all__ = [
     "IDOM_WEBSOCKET_PATH",
     "AuthAttribute",
+    "types",
     "IdomWebsocket",
     "hooks",
     "components",
diff --git a/src/django_idom/decorators.py b/src/django_idom/decorators.py
index 6038da72..94e6cdb0 100644
--- a/src/django_idom/decorators.py
+++ b/src/django_idom/decorators.py
@@ -20,7 +20,7 @@ def auth_required(
     Args:
         auth_attribute: The field to check within the user object. This value can be
            - One of the predefined `django_idom.AuthAttribute` values.
-           - A string for a custom user attribute to check (ex. `UserModel.is_<auth_attribute>`).
+           - A string for a custom user attribute to check (ex. `UserModel.<auth_attribute>`).
         fallback: The component or VDOM (`idom.html` snippet) to render if the user is not authenticated.
     """
 
@@ -29,7 +29,7 @@ def decorator(component):
         def _wrapped_func(*args, **kwargs):
             websocket = use_websocket()
 
-            if getattr(websocket.scope["user"], f"is_{auth_attribute}", False):
+            if getattr(websocket.scope["user"], auth_attribute, False):
                 return component(*args, **kwargs)
 
             if callable(fallback):
diff --git a/src/django_idom/types.py b/src/django_idom/types.py
index d9b4a83e..df1bfa70 100644
--- a/src/django_idom/types.py
+++ b/src/django_idom/types.py
@@ -12,17 +12,17 @@ class IdomWebsocket:
 
 @dataclass
 class AuthAttribute:
-    anonymous: str = "anonymous"
+    anonymous: str = "is_anonymous"
     """Individuals that are not logged in."""
 
-    authenticated: str = "authenticated"
+    authenticated: str = "is_authenticated"
     """Anyone logged in with a registered account."""
 
-    active: str = "active"
+    active: str = "is_active"
     """A registered account that has not been deactivated."""
 
-    staff: str = "staff"
+    staff: str = "is_staff"
     """Any account that is a staff member."""
 
-    superuser: str = "superuser"
+    superuser: str = "is_superuser"
     """Any account that is a superuser."""
diff --git a/tests/test_app/components.py b/tests/test_app/components.py
index 8bc1f455..4e7b1f22 100644
--- a/tests/test_app/components.py
+++ b/tests/test_app/components.py
@@ -115,7 +115,7 @@ def unauthorized_user():
 
 @idom.component
 @django_idom.decorators.auth_required(
-    auth_attribute="anonymous",
+    auth_attribute="is_anonymous",
     fallback=idom.html.div(
         {"id": "authorized-user-fallback"},
         "authorized_user: Fail.",

From b8b1685149ae303371d4e9c8b655c4460afe08bc Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 14:50:22 -0700
Subject: [PATCH 08/14] remove AuthAttribute

---
 docs/features/decorators.md   | 25 +++++++++++++------------
 docs/stylesheets/extra.css    |  2 +-
 src/django_idom/__init__.py   |  3 +--
 src/django_idom/decorators.py | 10 ++++------
 src/django_idom/types.py      | 20 +-------------------
 5 files changed, 20 insertions(+), 40 deletions(-)

diff --git a/docs/features/decorators.md b/docs/features/decorators.md
index 8d700dfb..4d1999da 100644
--- a/docs/features/decorators.md
+++ b/docs/features/decorators.md
@@ -2,7 +2,9 @@
 
 You can limit access to a component to a specific `auth_attribute` by using this decorator.
 
-Common uses of this decorator are to hide components from `AnonymousUser`, or render a component to only `staff` or `superuser` members.
+By default, this decorator checks if the user is logged in, and his/her account has not been deactivated.
+
+Common uses of this decorator are to hide components from [`AnonymousUser`](https://docs.djangoproject.com/en/dev/ref/contrib/auth/#django.contrib.auth.models.AnonymousUser), or render a component only if the user [`is_staff`](https://docs.djangoproject.com/en/dev/ref/contrib/auth/#django.contrib.auth.models.User.is_staff) or [`is_superuser`](https://docs.djangoproject.com/en/dev/ref/contrib/auth/#django.contrib.auth.models.User.is_superuser).
 
 This decorator can be used with or without parentheses.
 
@@ -14,7 +16,7 @@ from idom import component, html
 @component
 @auth_required
 def my_component():
-    return html.div("This won't render if I'm not logged in!")
+    return html.div("I am logged in!")
 ```
 
 ??? example "See Interface"
@@ -23,8 +25,8 @@ def my_component():
 
     | Name | Type | Description | Default |
     | --- | --- | --- | --- |
-    | auth_attribute | `str` | The field to check within the user object. This value can be... <br><br> - One of the predefined `django_idom.AuthAttribute` values. <br> - A string for a custom user attribute to check. This is checked in the form of `UserModel.<auth_attribute>`. | `AuthAttribute.active` |
-    | fallback | `ComponentType`, `VdomDict`, `None` | The component or VDOM (`idom.html` snippet) to render if the user is not authenticated. | `None` |
+    | auth_attribute | `str` | The value to check within the user object. This is checked in the form of `UserModel.<auth_attribute>`. | `#!python "is_active"` |
+    | fallback | `ComponentType`, `VdomDict`, `None` | The `component` or `idom.html` snippet to render if the user is not authenticated. | `None` |
 
     <font size="4">**Returns**</font>
 
@@ -43,12 +45,12 @@ def my_component():
 
     @component
     def my_component_fallback():
-        return html.div("I'm not logged in!")
+        return html.div("I am NOT logged in!")
 
     @component
     @auth_required(fallback=my_component_fallback)
     def my_component():
-        return html.div("This won't render if I'm not logged in!")
+        return html.div("I am logged in!")
     ```
 
 ??? question "How do I render a simple `idom.html` snippet if authentication fails?"
@@ -59,9 +61,9 @@ def my_component():
     from idom import component, html
 
     @component
-    @auth_required(fallback=html.div("I'm not logged in!"))
+    @auth_required(fallback=html.div("I am NOT logged in!"))
     def my_component():
-        return html.div("This won't render if I'm not logged in!")
+        return html.div("I am logged in!")
     ```
 
 ??? question "How can I check if a user `is_staff`?"
@@ -69,14 +71,13 @@ def my_component():
     ```python title="components.py"
     from django_idom.decorators import auth_required
     from django_idom.hooks import use_websocket
-    from django_idom import AuthAttribute
     from idom import component, html
 
 
     @component
-    @auth_required(auth_attribute=AuthAttribute.staff)
+    @auth_required(auth_attribute="is_staff")
     def my_component():
-        return html.div("This won't render if I'm not logged in!")
+        return html.div("I am logged in!")
     ```
 
 ??? question "How can I check for a custom attribute?"
@@ -104,5 +105,5 @@ def my_component():
     @component
     @auth_required(auth_attribute="is_really_cool")
     def my_component():
-        return html.div("This won't render if I'm not logged in!")
+        return html.div("I am logged in!")
     ```
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
index 2f8c7dab..6b30153f 100644
--- a/docs/stylesheets/extra.css
+++ b/docs/stylesheets/extra.css
@@ -8,5 +8,5 @@
 }
 
 .md-typeset :is(.admonition, details) {
-	margin: 1em 0;
+	margin: 0.55em 0;
 }
diff --git a/src/django_idom/__init__.py b/src/django_idom/__init__.py
index 88fa6c60..631913a9 100644
--- a/src/django_idom/__init__.py
+++ b/src/django_idom/__init__.py
@@ -1,12 +1,11 @@
 from django_idom import components, decorators, hooks, types
-from django_idom.types import AuthAttribute, IdomWebsocket
+from django_idom.types import IdomWebsocket
 from django_idom.websocket.paths import IDOM_WEBSOCKET_PATH
 
 
 __version__ = "1.1.0"
 __all__ = [
     "IDOM_WEBSOCKET_PATH",
-    "AuthAttribute",
     "types",
     "IdomWebsocket",
     "hooks",
diff --git a/src/django_idom/decorators.py b/src/django_idom/decorators.py
index 94e6cdb0..f097e6b7 100644
--- a/src/django_idom/decorators.py
+++ b/src/django_idom/decorators.py
@@ -4,12 +4,11 @@
 from idom.core.types import ComponentType, VdomDict
 
 from django_idom.hooks import use_websocket
-from django_idom.types import AuthAttribute
 
 
 def auth_required(
     component: Union[Callable, None] = None,
-    auth_attribute: str = AuthAttribute.active,
+    auth_attribute: str = "is_active",
     fallback: Union[ComponentType, VdomDict, None] = None,
 ) -> Callable:
     """If the user passes authentication criteria, the decorated component will be rendered.
@@ -18,9 +17,8 @@ def auth_required(
     This decorator can be used with or without parentheses.
 
     Args:
-        auth_attribute: The field to check within the user object. This value can be
-           - One of the predefined `django_idom.AuthAttribute` values.
-           - A string for a custom user attribute to check (ex. `UserModel.<auth_attribute>`).
+        auth_attribute: The value to check within the user object.
+            This is checked in the form of `UserModel.<auth_attribute>`.
         fallback: The component or VDOM (`idom.html` snippet) to render if the user is not authenticated.
     """
 
@@ -29,7 +27,7 @@ def decorator(component):
         def _wrapped_func(*args, **kwargs):
             websocket = use_websocket()
 
-            if getattr(websocket.scope["user"], auth_attribute, False):
+            if getattr(websocket.scope["user"], auth_attribute):
                 return component(*args, **kwargs)
 
             if callable(fallback):
diff --git a/src/django_idom/types.py b/src/django_idom/types.py
index df1bfa70..2e9a8e02 100644
--- a/src/django_idom/types.py
+++ b/src/django_idom/types.py
@@ -7,22 +7,4 @@ class IdomWebsocket:
     scope: dict
     close: Callable[[Optional[int]], Awaitable[None]]
     disconnect: Callable[[int], Awaitable[None]]
-    view_id: str
-
-
-@dataclass
-class AuthAttribute:
-    anonymous: str = "is_anonymous"
-    """Individuals that are not logged in."""
-
-    authenticated: str = "is_authenticated"
-    """Anyone logged in with a registered account."""
-
-    active: str = "is_active"
-    """A registered account that has not been deactivated."""
-
-    staff: str = "is_staff"
-    """Any account that is a staff member."""
-
-    superuser: str = "is_superuser"
-    """Any account that is a superuser."""
+    view_id: str
\ No newline at end of file

From 8d13bb14f8942efdd8efc9784ec3b3c74633b223 Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 14:54:20 -0700
Subject: [PATCH 09/14] format

---
 src/django_idom/types.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/django_idom/types.py b/src/django_idom/types.py
index 2e9a8e02..1b1fc7d4 100644
--- a/src/django_idom/types.py
+++ b/src/django_idom/types.py
@@ -7,4 +7,4 @@ class IdomWebsocket:
     scope: dict
     close: Callable[[Optional[int]], Awaitable[None]]
     disconnect: Callable[[int], Awaitable[None]]
-    view_id: str
\ No newline at end of file
+    view_id: str

From 16825d7995fcff6fc8436ac84e87a083224fd67b Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Sun, 3 Jul 2022 14:56:49 -0700
Subject: [PATCH 10/14] fix changelog

---
 CHANGELOG.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 10e20d8e..e4f20e0e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -24,7 +24,7 @@ Using the following categories, list your changes in this order:
 
 ### Added
 
--   `authenticated` decorator to prevent your components from rendered to unauthenticated users.
+-   `auth_required` decorator to prevent your components from rendered to unauthenticated users.
 
 ## [1.1.0] - 2022-07-01
 

From 8c5b7d9fe4e116e4d4b0b44160d0fb9c26592c6e Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Wed, 6 Jul 2022 01:48:19 -0700
Subject: [PATCH 11/14] comment update

---
 src/django_idom/decorators.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/django_idom/decorators.py b/src/django_idom/decorators.py
index f097e6b7..0659938a 100644
--- a/src/django_idom/decorators.py
+++ b/src/django_idom/decorators.py
@@ -36,9 +36,9 @@ def _wrapped_func(*args, **kwargs):
 
         return _wrapped_func
 
-    # Return when used as @authenticated(...)
+    # Return for @authenticated(...)
     if component is None:
         return decorator
 
-    # Return when used as @authenticated
+    # Return for @authenticated
     return decorator(component)

From 7718cd70301a198a14c593a685629da79cae22c3 Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Thu, 7 Jul 2022 14:14:46 -0700
Subject: [PATCH 12/14] add more text

---
 docs/features/decorators.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/features/decorators.md b/docs/features/decorators.md
index 4d1999da..65dd6bd5 100644
--- a/docs/features/decorators.md
+++ b/docs/features/decorators.md
@@ -38,6 +38,8 @@ def my_component():
 
 ??? question "How do I render a different component if authentication fails?"
 
+    You can use a component within the `fallback` argument, as seen below.
+
     ```python title="components.py"
     from django_idom.decorators import auth_required
     from django_idom.hooks import use_websocket
@@ -55,6 +57,8 @@ def my_component():
 
 ??? question "How do I render a simple `idom.html` snippet if authentication fails?"
 
+    You can use a `idom.html` snippet within the `fallback` argument, as seen below.
+
     ```python title="components.py"
     from django_idom.decorators import auth_required
     from django_idom.hooks import use_websocket
@@ -68,6 +72,8 @@ def my_component():
 
 ??? question "How can I check if a user `is_staff`?"
 
+    You can set the `auth_attribute` utilize `UserModel.is_staff`, as seen blow.
+
     ```python title="components.py"
     from django_idom.decorators import auth_required
     from django_idom.hooks import use_websocket

From f2a86d7ee849554d2ed8108395654ff23b0e6c1f Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Thu, 7 Jul 2022 14:15:33 -0700
Subject: [PATCH 13/14] wordsmith

---
 docs/features/decorators.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/features/decorators.md b/docs/features/decorators.md
index 65dd6bd5..91f24491 100644
--- a/docs/features/decorators.md
+++ b/docs/features/decorators.md
@@ -38,7 +38,7 @@ def my_component():
 
 ??? question "How do I render a different component if authentication fails?"
 
-    You can use a component within the `fallback` argument, as seen below.
+    You can use a component with the `fallback` argument, as seen below.
 
     ```python title="components.py"
     from django_idom.decorators import auth_required
@@ -57,7 +57,7 @@ def my_component():
 
 ??? question "How do I render a simple `idom.html` snippet if authentication fails?"
 
-    You can use a `idom.html` snippet within the `fallback` argument, as seen below.
+    You can use a `idom.html` snippet with the `fallback` argument, as seen below.
 
     ```python title="components.py"
     from django_idom.decorators import auth_required
@@ -72,7 +72,7 @@ def my_component():
 
 ??? question "How can I check if a user `is_staff`?"
 
-    You can set the `auth_attribute` utilize `UserModel.is_staff`, as seen blow.
+    You can set the `auth_attribute` to use `is_staff`, as seen blow.
 
     ```python title="components.py"
     from django_idom.decorators import auth_required

From e69a10ca0a6b5895c425516677e5756154510b9f Mon Sep 17 00:00:00 2001
From: Archmonger <16909269+Archmonger@users.noreply.github.com>
Date: Tue, 12 Jul 2022 22:54:37 -0700
Subject: [PATCH 14/14] Minor changes

---
 docs/features/decorators.md  | 6 +++---
 tests/test_app/components.py | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/features/decorators.md b/docs/features/decorators.md
index 91f24491..17707eff 100644
--- a/docs/features/decorators.md
+++ b/docs/features/decorators.md
@@ -1,6 +1,6 @@
 ## Auth Required
 
-You can limit access to a component to a specific `auth_attribute` by using this decorator.
+You can limit access to a component to users with a specific `auth_attribute` by using this decorator.
 
 By default, this decorator checks if the user is logged in, and his/her account has not been deactivated.
 
@@ -72,7 +72,7 @@ def my_component():
 
 ??? question "How can I check if a user `is_staff`?"
 
-    You can set the `auth_attribute` to use `is_staff`, as seen blow.
+    You can set the `auth_attribute` to `is_staff`, as seen blow.
 
     ```python title="components.py"
     from django_idom.decorators import auth_required
@@ -98,7 +98,7 @@ def my_component():
     class CustomUserModel(AbstractBaseUser):
         @property
         def is_really_cool(self):
-            return self.name == "Groot"
+            return True
     ```
 
     ... then you would do the following within your decorator:
diff --git a/tests/test_app/components.py b/tests/test_app/components.py
index 4e7b1f22..f9c9cb90 100644
--- a/tests/test_app/components.py
+++ b/tests/test_app/components.py
@@ -101,7 +101,7 @@ def django_js():
 @django_idom.decorators.auth_required(
     fallback=idom.html.div(
         {"id": "unauthorized-user-fallback"},
-        "unauthorized_user: Success. User was blocked from accessing this component.",
+        "unauthorized_user: Success",
         idom.html.hr(),
     )
 )
@@ -118,13 +118,13 @@ def unauthorized_user():
     auth_attribute="is_anonymous",
     fallback=idom.html.div(
         {"id": "authorized-user-fallback"},
-        "authorized_user: Fail.",
+        "authorized_user: Fail",
         idom.html.hr(),
     ),
 )
 def authorized_user():
     return idom.html.div(
         {"id": "authorized-user"},
-        "authorized_user: Success. User was not blocked from accessing this component.",
+        "authorized_user: Success",
         idom.html.hr(),
     )