dbca-utils 2.1.3__tar.gz → 2.1.5__tar.gz

{dbca_utils-2.1.3 → dbca_utils-2.1.5}/PKG-INFO

@@ -1,11 +1,10 @@
 Metadata-Version: 2.4
 Name: dbca-utils
-Version: 2.1.3
+Version: 2.1.5
 Summary: Utilities for DBCA Django apps
 Author-Email: Rocky Chen <rocky.chen@dbca.wa.gov.au>, Ashley Felton <ashley.felton@dbca.wa.gov.au>
 License-Expression: Apache-2.0
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 4.0
 Classifier: Framework :: Django :: 4.2
 Classifier: Framework :: Django :: 5.0
 Classifier: Framework :: Django :: 5.2
@@ -25,26 +24,24 @@ Project-URL: Repository, https://github.com/dbca-wa/dbca-utils.git
 Project-URL: Changelog, https://github.com/dbca-wa/dbca-utils/blob/master/CHANGELOG.md
 Project-URL: GitHub, https://github.com/dbca-wa/dbca-utils
 Requires-Python: <4.0,>=3.10
-Requires-Dist: django<6,>=4
-Requires-Dist: markupsafe==3.0.2
+Requires-Dist: django<6,>=4.2
+Requires-Dist: markupsafe==3.0.3
 Description-Content-Type: text/markdown
 
 # Overview
 
 DBCA Django utility classes and functions.
 
-## Development
+## Requirements
 
-The recommended way to set up this project for development is using
-[uv](https://docs.astral.sh/uv/)
-to install and manage a Python virtual environment.
-With uv installed, install the required Python version (see `pyproject.toml`). Example:
+- Python 3.10 or later
+- Django 4.2 or later
 
-    uv python install 3.12
+## Development
 
-Change into the project directory and run:
+Dependencies for this project are managed using [uv](https://docs.astral.sh/uv/).
+With uv installed, change into the project directory and run:
 
-    uv python pin 3.12
     uv sync
 
 Activate the virtualenv like so:
@@ -61,17 +58,15 @@ Run unit tests using `pytest` (or `tox`, to test against multiple Python version
 Tagged releases are built and pushed to PyPI automatically using a GitHub
 workflow in the project. Update the project version in `pyproject.toml` and
 tag the required commit with the same value to trigger a release. Packages
-can also be built and uploaded manually, if desired.
-
-Build the project locally using uv, [publish to the PyPI registry](https://docs.astral.sh/uv/guides/publish/#publishing-your-package)
-using the same tool if you require:
+can also be built and uploaded manually to PyPI using [uv](https://docs.astral.sh/uv/guides/publish/#publishing-your-package),
+if required:
 
     uv build
     uv publish
 
 ## Installation
 
-1. Install via pip/etc.: `pip install dbca-utils`
+1. Install via uv/pip/etc.: `pip install dbca-utils`
 
 ## SSO Login Middleware
 

{dbca_utils-2.1.3 → dbca_utils-2.1.5}/README.md

@@ -2,18 +2,16 @@
 
 DBCA Django utility classes and functions.
 
-## Development
+## Requirements
 
-The recommended way to set up this project for development is using
-[uv](https://docs.astral.sh/uv/)
-to install and manage a Python virtual environment.
-With uv installed, install the required Python version (see `pyproject.toml`). Example:
+- Python 3.10 or later
+- Django 4.2 or later
 
-    uv python install 3.12
+## Development
 
-Change into the project directory and run:
+Dependencies for this project are managed using [uv](https://docs.astral.sh/uv/).
+With uv installed, change into the project directory and run:
 
-    uv python pin 3.12
     uv sync
 
 Activate the virtualenv like so:
@@ -30,17 +28,15 @@ Run unit tests using `pytest` (or `tox`, to test against multiple Python version
 Tagged releases are built and pushed to PyPI automatically using a GitHub
 workflow in the project. Update the project version in `pyproject.toml` and
 tag the required commit with the same value to trigger a release. Packages
-can also be built and uploaded manually, if desired.
-
-Build the project locally using uv, [publish to the PyPI registry](https://docs.astral.sh/uv/guides/publish/#publishing-your-package)
-using the same tool if you require:
+can also be built and uploaded manually to PyPI using [uv](https://docs.astral.sh/uv/guides/publish/#publishing-your-package),
+if required:
 
     uv build
     uv publish
 
 ## Installation
 
-1. Install via pip/etc.: `pip install dbca-utils`
+1. Install via uv/pip/etc.: `pip install dbca-utils`
 
 ## SSO Login Middleware
 

{dbca_utils-2.1.3 → dbca_utils-2.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dbca-utils"
-version = "2.1.3"
+version = "2.1.5"
 description = "Utilities for DBCA Django apps"
 authors = [
     { name = "Rocky Chen", email = "rocky.chen@dbca.wa.gov.au" },
@@ -10,7 +10,6 @@ readme = "README.md"
 license = "Apache-2.0"
 classifiers = [
     "Framework :: Django",
-    "Framework :: Django :: 4.0",
     "Framework :: Django :: 4.2",
     "Framework :: Django :: 5.0",
     "Framework :: Django :: 5.2",
@@ -28,8 +27,8 @@ classifiers = [
 ]
 requires-python = ">=3.10,<4.0"
 dependencies = [
-    "django>=4,<6",
-    "markupsafe==3.0.2",
+    "django>=4.2,<6",
+    "markupsafe==3.0.3",
 ]
 
 [project.urls]
@@ -40,10 +39,10 @@ GitHub = "https://github.com/dbca-wa/dbca-utils"
 
 [dependency-groups]
 dev = [
-    "pytest-django>=4.11.0",
-    "pytest-sugar>=1.0.0",
-    "tox>=4.25.0",
-    "tox-uv>=1.25.0",
+    "pytest-django>=4.11.1",
+    "pytest-sugar>=1.1.1",
+    "tox>=4.31.0",
+    "tox-uv>=1.29.0",
 ]
 
 [build-system]

{dbca_utils-2.1.3 → dbca_utils-2.1.5}/src/dbca_utils/middleware.py

@@ -5,6 +5,7 @@ from django.contrib.auth.middleware import AuthenticationMiddleware, get_user
 from django.utils import timezone
 from django.utils.deprecation import MiddlewareMixin
 from django.utils.functional import SimpleLazyObject
+from django.utils.html import strip_tags
 from markupsafe import escape
 
 from dbca_utils.utils import env
@@ -86,9 +87,9 @@ class SSOLoginMiddleware(MiddlewareMixin):
     """Django middleware to process HTTP requests containing headers set by the Auth2
     SSO service, specificially:
     - `HTTP_REMOTE_USER`
+    - `HTTP_X_EMAIL`
     - `HTTP_X_LAST_NAME`
     - `HTTP_X_FIRST_NAME`
-    - `HTTP_X_EMAIL`
     The middleware assesses requests containing these headers, and (having deferred user
     authentication to the upstream service), retrieves the local Django User and logs
     the user in automatically.
@@ -123,21 +124,24 @@ class SSOLoginMiddleware(MiddlewareMixin):
         if not request.user.is_authenticated:
             attributemap = {
                 "username": "HTTP_REMOTE_USER",
+                "email": "HTTP_X_EMAIL",
                 "last_name": "HTTP_X_LAST_NAME",
                 "first_name": "HTTP_X_FIRST_NAME",
-                "email": "HTTP_X_EMAIL",
             }
+            attributes = {"email": "", "username": ""}
 
-            for key, value in attributemap.items():
-                if value in request.META:
-                    attributemap[key] = request.META[value]
+            for key, meta_value in attributemap.items():
+                if meta_value in request.META:
+                    attributes[key] = request.META[meta_value]
 
             # Sanitise first_name and last_name values, because end-users have control over these
             # values and could conceivably inject malicious values into them (e.g. a XSS attack).
-            if "first_name" in attributemap:
-                attributemap["first_name"] = str(escape(attributemap["first_name"]))
-            if "last_name" in attributemap:
-                attributemap["last_name"] = str(escape(attributemap["last_name"]))
+            if "first_name" in attributes:
+                attributes["first_name"] = strip_tags(attributes["first_name"])
+                attributes["first_name"] = str(escape(attributes["first_name"]))
+            if "last_name" in attributes:
+                attributes["last_name"] = strip_tags(attributes["last_name"])
+                attributes["last_name"] = str(escape(attributes["last_name"]))
 
             # Optional setting: projects may define accepted user email domains either as
             # a list of strings, or a single string.
@@ -147,20 +151,26 @@ class SSOLoginMiddleware(MiddlewareMixin):
                 else:
                     allowed_email_suffixes = settings.ALLOWED_EMAIL_SUFFIXES
                 # If the user email suffix is not in the allowed list, return a 404 response.
-                if not any([attributemap["email"].lower().endswith(suffix) for suffix in allowed_email_suffixes]):
+                if not any([attributes["email"].lower().endswith(suffix) for suffix in allowed_email_suffixes]):
                     return http.HttpResponseForbidden()
 
             # Check for an existing User instance.
-            if attributemap["email"] and User.objects.filter(email__iexact=attributemap["email"]).exists():
-                user = User.objects.filter(email__iexact=attributemap["email"])[0]
-            elif User.__name__ != "EmailUser" and User.objects.filter(username__iexact=attributemap["username"]).exists():
-                user = User.objects.filter(username__iexact=attributemap["username"])[0]
+            if attributes["email"] and User.objects.filter(email__iexact=attributes["email"]).exists():
+                user = User.objects.filter(email__iexact=attributes["email"]).first()
+            elif User.__name__ != "EmailUser" and User.objects.filter(username__iexact=attributes["username"]).exists():
+                user = User.objects.filter(username__iexact=attributes["username"]).first()
             else:
                 user = User(last_login=timezone.localtime())
 
             # Set the user's details from the supplied information.
-            user.__dict__.update(attributemap)
-            user.save()
+            user_has_changed = False
+            for attr, value in attributes.items():
+                if getattr(user, attr) != value:
+                    setattr(user, attr, value)
+                    user_has_changed = True
+            if user_has_changed:
+                user.save()
+
             user.backend = "django.contrib.auth.backends.ModelBackend"
 
             # Log the user in.

dbca_utils-2.1.5/tests/templates/tests/test_model_list.html

@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>{{ TITLE }}</title>
+  </head>
+  <body>
+    <div>Authenticated: {{ user.is_authenticated }}</div>
+    <div>Email: {{ user.email }}</div>
+    <div>Name: {{ user.get_full_name }}</div>
+    <ul>
+      {% for object in object_list %}
+      <li>{{ object.name }}, {{ object.created|date:"r" }}</li>
+      {% endfor %}
+    </ul>
+  </body>
+</html>

{dbca_utils-2.1.3 → dbca_utils-2.1.5}/tests/tests.py

@@ -26,7 +26,7 @@ os.environ["TEST_TUPLE"] = "('a', 'b', 'c')"
 os.environ["TEST_BOOL"] = "False"
 
 
-class TestUtils(TestCase):
+class UtilsTest(TestCase):
     def test_env_returns_str(self):
         test_str = env("TEST_STR")
         self.assertTrue(isinstance(test_str, str))
@@ -68,14 +68,12 @@ class TestUtils(TestCase):
         self.assertTrue(isinstance(test_str, str))
 
 
-class TestModelTests(TestCase):
+class ModelTest(TestCase):
     client = Client()
     model = TestModel
 
     def setUp(self):
-        self.user = User.objects.create_user(
-            username="test", email="test@email.com", password="secret"
-        )
+        self.user = User.objects.create_user(username="test", email="test@email.com", password="secret")
         self.test_model = TestModel.objects.create(name=TEST_NAME)
         self.client.login(username="test", password="secret")
 
@@ -109,3 +107,53 @@ class TestModelTests(TestCase):
         self.assertEqual(response.status_code, 200)
         self.assertContains(response, TEST_VAR)
         self.assertContains(response, TEST_NAME)
+
+
+class SSOLoginMiddlewareTest(TestCase):
+    client = Client()
+
+    def setUp(self):
+        self.user = User.objects.create_user(username="testuser", email="testuser@email.com")
+        # Ensure that the client starts logged out.
+        self.client.logout()
+
+    def test_sso_login(self):
+        """Test that requests having the required META headers will automatically sign in users."""
+        url = reverse("test_model_list")
+        response = self.client.get(
+            url,
+            HTTP_REMOTE_USER="testuser",
+            HTTP_X_EMAIL="testuser@email.com",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "Authenticated: True")
+
+    def test_user_properties_update(self):
+        """Test that requests with relevant META headers will update user properties."""
+        url = reverse("test_model_list")
+
+        response = self.client.get(
+            url,
+            HTTP_REMOTE_USER="testuser",
+            HTTP_X_EMAIL="testuser@email.com",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "Authenticated: True")
+        user = User.objects.get(email="testuser@email.com")
+        self.assertEqual(user.first_name, "")
+        self.assertEqual(user.last_name, "")
+
+        # Simulate a name change via SSO.
+        self.client.logout()
+        response = self.client.get(
+            url,
+            HTTP_REMOTE_USER="testuser",
+            HTTP_X_EMAIL="testuser@email.com",
+            HTTP_X_FIRST_NAME="Test",
+            HTTP_X_LAST_NAME="User",
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "Name: Test User")
+        user = User.objects.get(email="testuser@email.com")
+        self.assertEqual(user.first_name, "Test")
+        self.assertEqual(user.last_name, "User")

dbca_utils-2.1.3/tests/templates/tests/test_model_list.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-    <head>
-        <meta charset="UTF-8">
-        <title>{{ TITLE }}</title>
-    </head>
-    <body>
-        <ul>
-            {% for object in object_list %}<li>{{ object.name }}, {{ object.created|date:"r" }}</li>{% endfor %}
-        </ul>
-    </body>
-</html>