django-pfx 1.7.6.dev9__tar.gz → 1.7.6.dev11__tar.gz

{django_pfx-1.7.6.dev9 → django_pfx-1.7.6.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.6.dev9
+Version: 1.7.6.dev11
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.7.6.dev9 → django_pfx-1.7.6.dev11}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-pfx
-Version: 1.7.6.dev9
+Version: 1.7.6.dev11
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.7.6.dev9 → django_pfx-1.7.6.dev11}/django_pfx.egg-info/SOURCES.txt

@@ -250,6 +250,7 @@ tests/tests/test_user_websocket.py
 tests/tests/test_version_check.py
 tests/tests/test_view_decorators.py
 tests/tests/test_view_fields.py
+tests/tests/test_ws_cookie_middleware.py
 tests_base_user/__init__.py
 tests_base_user/urls.py
 tests_base_user/views.py

{django_pfx-1.7.6.dev9 → django_pfx-1.7.6.dev11}/django_pfx.egg-info/scm_file_list.json

@@ -241,6 +241,7 @@
     "tests/tests/test_version_check.py",
     "tests/tests/test_view_decorators.py",
     "tests/tests/test_view_fields.py",
+    "tests/tests/test_ws_cookie_middleware.py",
     "tests/urls.py",
     "tests/views.py",
     "tests_base_user/__init__.py",

{django_pfx-1.7.6.dev9 → django_pfx-1.7.6.dev11}/django_pfx.egg-info/scm_version.json

@@ -1,7 +1,7 @@
 {
   "tag": "1.7.5",
-  "distance": 9,
-  "node": "g7626d2f586fb8dbaa121ce3d2676a0e0c185f7fe",
+  "distance": 11,
+  "node": "g113691e9ec664f316585c0c5af016df1001e5e02",
   "dirty": false,
   "branch": "HEAD",
   "node_date": "2026-09-01"

django_pfx-1.7.6.dev11/pfx/pfxcore/middleware/ws_cookie_authentication_middleware.py

@@ -0,0 +1,60 @@
+import logging
+
+from django.contrib.auth.models import AnonymousUser
+from django.core.exceptions import ImproperlyConfigured
+from django.http import parse_cookie
+
+from pfx.pfxcore.middleware.authentication import JWTTokenDecodeMixin
+
+logger = logging.getLogger(__name__)
+
+try:
+    from channels.db import database_sync_to_async
+    from channels.middleware import BaseMiddleware
+except ImportError as e:
+    # Channels is only needed by the projects serving websockets, but
+    # naming any middleware of `pfx.pfxcore.middleware` makes Django
+    # import the whole package: this module has to stay importable
+    # without it. The error is raised when the middleware is used.
+    CHANNELS_IMPORT_ERROR = e
+    database_sync_to_async = None
+    BaseMiddleware = object
+else:
+    CHANNELS_IMPORT_ERROR = None
+
+
+class WSCookieAuthenticationMiddleware(JWTTokenDecodeMixin, BaseMiddleware):
+    def __init__(self, *args, **kwargs):
+        if CHANNELS_IMPORT_ERROR:
+            raise ImproperlyConfigured(
+                f'Missing channels: {CHANNELS_IMPORT_ERROR}\n'
+                "PFX CONFIGURATION ERROR: You have to install channels "
+                "to use [pfx.pfxcore.middleware."
+                f"{self.__class__.__name__}]:\n"
+                "pip install channels\n"
+                "(and a websocket server, for instance with "
+                "`pip install channels[daphne]`)"
+            ) from CHANNELS_IMPORT_ERROR
+        super().__init__(*args, **kwargs)
+
+    async def __call__(self, scope, receive, send):
+        if scope.get("user") is not None:
+            return await super().__call__(scope, receive, send)
+
+        headers = dict(scope.get("headers", []))
+        cookies = {}
+        if b"cookie" in headers:
+            cookies = parse_cookie(headers[b"cookie"].decode())
+
+        key = cookies.get("token")
+        if key:
+            try:
+                user, __, __ = await database_sync_to_async(
+                    self.decode_jwt)(key)
+            except Exception as e:
+                logger.exception(e, exc_info=True)
+                user = AnonymousUser()
+        else:
+            user = AnonymousUser()
+        scope['user'] = user
+        return await super().__call__(scope, receive, send)

{django_pfx-1.7.6.dev9 → django_pfx-1.7.6.dev11}/tests/tests/__init__.py

@@ -39,3 +39,4 @@ from .test_user_queryset import TestUserQuerySet
 from .test_user_websocket import TestUserWebsocket
 from .test_view_decorators import ViewDecoratorTest
 from .test_view_fields import ViewFieldTest
+from .test_ws_cookie_middleware import TestWSCookieMiddleware

django_pfx-1.7.6.dev11/tests/tests/test_ws_cookie_middleware.py

@@ -0,0 +1,30 @@
+import logging
+from unittest.mock import patch
+
+from django.core.exceptions import ImproperlyConfigured
+from django.test import TestCase
+
+from pfx.pfxcore.middleware import WSCookieAuthenticationMiddleware
+from pfx.pfxcore.middleware import ws_cookie_authentication_middleware as mod
+
+logger = logging.getLogger(__name__)
+
+
+class TestWSCookieMiddleware(TestCase):
+    """Channels is an optional dependency: naming any middleware of
+    `pfx.pfxcore.middleware` makes Django import the whole package, so a
+    project serving no websocket must not need it installed."""
+
+    def test_module_is_importable_without_channels(self):
+        # The module is already imported: reaching this point at all
+        # means the package did not require channels at import time.
+        self.assertIsNone(mod.CHANNELS_IMPORT_ERROR)
+
+    def test_middleware_reports_the_missing_dependency(self):
+        error = ImportError("No module named 'channels'")
+        with patch.object(mod, 'CHANNELS_IMPORT_ERROR', error):
+            with self.assertRaises(ImproperlyConfigured) as ctx:
+                WSCookieAuthenticationMiddleware(lambda *a: None)
+        message = str(ctx.exception)
+        self.assertIn("No module named 'channels'", message)
+        self.assertIn('pip install channels', message)

django_pfx-1.7.6.dev9/pfx/pfxcore/middleware/ws_cookie_authentication_middleware.py

@@ -1,35 +0,0 @@
-import logging
-
-from django.contrib.auth.models import AnonymousUser
-from django.http import parse_cookie
-
-from channels.db import database_sync_to_async
-from channels.middleware import BaseMiddleware
-
-from pfx.pfxcore.middleware.authentication import JWTTokenDecodeMixin
-
-logger = logging.getLogger(__name__)
-
-
-class WSCookieAuthenticationMiddleware(JWTTokenDecodeMixin, BaseMiddleware):
-    async def __call__(self, scope, receive, send):
-        if scope.get("user") is not None:
-            return await super().__call__(scope, receive, send)
-
-        headers = dict(scope.get("headers", []))
-        cookies = {}
-        if b"cookie" in headers:
-            cookies = parse_cookie(headers[b"cookie"].decode())
-
-        key = cookies.get("token")
-        if key:
-            try:
-                user, __, __ = await database_sync_to_async(
-                    self.decode_jwt)(key)
-            except Exception as e:
-                logger.exception(e, exc_info=True)
-                user = AnonymousUser()
-        else:
-            user = AnonymousUser()
-        scope['user'] = user
-        return await super().__call__(scope, receive, send)