BmorricalDjangoWorkflows 2.1.3__tar.gz → 2.1.4__tar.gz

{bmorricaldjangoworkflows-2.1.3 → bmorricaldjangoworkflows-2.1.4}/BmorricalDjangoWorkflows.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BmorricalDjangoWorkflows
-Version: 2.1.3
+Version: 2.1.4
 Summary: Reusable Django Workflows
 Home-page: https://github.com/Bmorrical/django-workflows
 Author: Bradley Morrical
@@ -78,6 +78,7 @@ WORKFLOWS = {
 	# Optional settings with defaults shown.
 	"COMPANY_NAME": "My Company",
 	"ENABLE_EMAIL_DELIVERY": False,
+	"FORGOT_PASSWORD_URL": "https://app.example.com/forgot-password",
 	"RESET_CODE_TTL_MINUTES": 10,
 	"MAX_VERIFY_ATTEMPTS": 3,
 }
@@ -86,8 +87,21 @@ WORKFLOWS = {
 Notes:
 
 - `USER_META_MODEL` must be a dotted import path such as `myapp.models.UserMeta`.
+- `FORGOT_PASSWORD_URL` is used in the admin-created account email to link users into the host app's forgot-password flow.
+- Host apps will usually source `FORGOT_PASSWORD_URL` from an environment variable in their own settings module.
 - If `ENABLE_EMAIL_DELIVERY` is true, configure the email transport environment variables used by the mail service.
 
+Example host-project wiring:
+
+```python
+import os
+
+WORKFLOWS = {
+	"USER_META_MODEL": "users.models_user_meta.UserMeta",
+	"FORGOT_PASSWORD_URL": os.getenv("FORGOT_PASSWORD_URL", ""),
+}
+```
+
 ## Email Delivery Environment Variables
 
 When email delivery is enabled, set:

{bmorricaldjangoworkflows-2.1.3 → bmorricaldjangoworkflows-2.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BmorricalDjangoWorkflows
-Version: 2.1.3
+Version: 2.1.4
 Summary: Reusable Django Workflows
 Home-page: https://github.com/Bmorrical/django-workflows
 Author: Bradley Morrical
@@ -78,6 +78,7 @@ WORKFLOWS = {
 	# Optional settings with defaults shown.
 	"COMPANY_NAME": "My Company",
 	"ENABLE_EMAIL_DELIVERY": False,
+	"FORGOT_PASSWORD_URL": "https://app.example.com/forgot-password",
 	"RESET_CODE_TTL_MINUTES": 10,
 	"MAX_VERIFY_ATTEMPTS": 3,
 }
@@ -86,8 +87,21 @@ WORKFLOWS = {
 Notes:
 
 - `USER_META_MODEL` must be a dotted import path such as `myapp.models.UserMeta`.
+- `FORGOT_PASSWORD_URL` is used in the admin-created account email to link users into the host app's forgot-password flow.
+- Host apps will usually source `FORGOT_PASSWORD_URL` from an environment variable in their own settings module.
 - If `ENABLE_EMAIL_DELIVERY` is true, configure the email transport environment variables used by the mail service.
 
+Example host-project wiring:
+
+```python
+import os
+
+WORKFLOWS = {
+	"USER_META_MODEL": "users.models_user_meta.UserMeta",
+	"FORGOT_PASSWORD_URL": os.getenv("FORGOT_PASSWORD_URL", ""),
+}
+```
+
 ## Email Delivery Environment Variables
 
 When email delivery is enabled, set:

{bmorricaldjangoworkflows-2.1.3 → bmorricaldjangoworkflows-2.1.4}/README.md

@@ -54,6 +54,7 @@ WORKFLOWS = {
 	# Optional settings with defaults shown.
 	"COMPANY_NAME": "My Company",
 	"ENABLE_EMAIL_DELIVERY": False,
+	"FORGOT_PASSWORD_URL": "https://app.example.com/forgot-password",
 	"RESET_CODE_TTL_MINUTES": 10,
 	"MAX_VERIFY_ATTEMPTS": 3,
 }
@@ -62,8 +63,21 @@ WORKFLOWS = {
 Notes:
 
 - `USER_META_MODEL` must be a dotted import path such as `myapp.models.UserMeta`.
+- `FORGOT_PASSWORD_URL` is used in the admin-created account email to link users into the host app's forgot-password flow.
+- Host apps will usually source `FORGOT_PASSWORD_URL` from an environment variable in their own settings module.
 - If `ENABLE_EMAIL_DELIVERY` is true, configure the email transport environment variables used by the mail service.
 
+Example host-project wiring:
+
+```python
+import os
+
+WORKFLOWS = {
+	"USER_META_MODEL": "users.models_user_meta.UserMeta",
+	"FORGOT_PASSWORD_URL": os.getenv("FORGOT_PASSWORD_URL", ""),
+}
+```
+
 ## Email Delivery Environment Variables
 
 When email delivery is enabled, set:

bmorricaldjangoworkflows-2.1.4/VERSION

@@ -0,0 +1 @@
+2.1.4

{bmorricaldjangoworkflows-2.1.3 → bmorricaldjangoworkflows-2.1.4}/django_workflows/users/services/auth_flow.py

@@ -26,6 +26,7 @@ _ALLOWED_CODE_CHARS = [
 ]
 _LOG_DEV_CODES_SETTING = "LOG_VERIFICATION_CODES_IN_DEBUG"
 _EMAIL_DELIVERY_ENABLED_SETTING = "ENABLE_EMAIL_DELIVERY"
+_FORGOT_PASSWORD_URL_SETTING = "FORGOT_PASSWORD_URL"
 
 
 def generate_verification_code(*, length: int = 6) -> str:
@@ -314,6 +315,32 @@ def _get_force_password_reset(user: Any) -> bool:
         return False
 
 
+def _build_admin_setup_email_message(
+    *,
+    first_name: str,
+    last_name: str,
+    company_name: str,
+    forgot_password_url: Any,
+) -> str:
+    forgot_password_instructions = (
+        'Use the "Forgot Password" flow to establish your password and login.<br><br>'
+    )
+    normalized_forgot_password_url = str(forgot_password_url or "").strip()
+
+    if normalized_forgot_password_url:
+        forgot_password_instructions = (
+            f'Click the link <a href="{normalized_forgot_password_url}">{normalized_forgot_password_url}</a> to use the '
+            '"Forgot Password" flow to establish your password and login.<br><br>'
+        )
+
+    return (
+        f"Hello {first_name} {last_name},<br><br>"
+        'You have been added as a registered user by an administrator. '
+        f"{forgot_password_instructions}"
+        f"Thank you!<br><br>{company_name}"
+    )
+
+
 def get_user_details(user: Any) -> dict[str, Any]:
     return {
         "id": user.id,
@@ -505,6 +532,7 @@ def admin_register_user_and_send_setup_email(
     User = get_user_model()
 
     company_name = _get_workflow_setting("COMPANY_NAME", "")
+    forgot_password_url = _get_workflow_setting(_FORGOT_PASSWORD_URL_SETTING, "")
     enable_email_delivery = _is_enabled(
         _get_workflow_setting(_EMAIL_DELIVERY_ENABLED_SETTING, False)
     )
@@ -537,11 +565,11 @@ def admin_register_user_and_send_setup_email(
             )
             _sync_user_groups(user=user, groups=validated_groups)
 
-            message = (
-                f"Hello {first_name} {last_name},<br><br>"
-                'You have been added as a registered user by an administrator. '
-                'Use the "Forgot Password" flow to establish your password and login.<br><br>'
-                f"Thank you!<br><br>{company_name}"
+            message = _build_admin_setup_email_message(
+                first_name=first_name,
+                last_name=last_name,
+                company_name=company_name,
+                forgot_password_url=forgot_password_url,
             )
     except IntegrityError:
         logger.exception("Admin registration failed due to IntegrityError for email=%s", email)

{bmorricaldjangoworkflows-2.1.3 → bmorricaldjangoworkflows-2.1.4}/tests/test_auth_flow.py

@@ -47,6 +47,7 @@ class AuthFlowTests(TestCase):
         defaults = {
             "COMPANY_NAME": "Acme Co",
             "ENABLE_EMAIL_DELIVERY": False,
+            "FORGOT_PASSWORD_URL": "",
             "RESET_CODE_TTL_MINUTES": 10,
             "MAX_VERIFY_ATTEMPTS": 3,
         }
@@ -75,6 +76,35 @@ class AuthFlowTests(TestCase):
         self.assertIsInstance(password, str)
         self.assertTrue(password)
 
+    def test_build_admin_setup_email_message_includes_forgot_password_link_when_configured(self):
+        message = auth_flow._build_admin_setup_email_message(
+            first_name="New",
+            last_name="User",
+            company_name="Reusable Inc",
+            forgot_password_url="https://app.example.com/forgot-password",
+        )
+
+        self.assertIn(
+            'Click the link <a href="https://app.example.com/forgot-password">https://app.example.com/forgot-password</a> to use the '
+            '"Forgot Password" flow to establish your password and login.<br><br>',
+            message,
+        )
+        self.assertIn("Reusable Inc", message)
+
+    def test_build_admin_setup_email_message_falls_back_when_url_missing(self):
+        message = auth_flow._build_admin_setup_email_message(
+            first_name="New",
+            last_name="User",
+            company_name="Reusable Inc",
+            forgot_password_url=" ",
+        )
+
+        self.assertIn(
+            'Use the "Forgot Password" flow to establish your password and login.<br><br>',
+            message,
+        )
+        self.assertNotIn("href=", message)
+
     @patch.object(auth_flow.logger, "isEnabledFor", return_value=True)
     @patch.object(auth_flow.logger, "debug")
     @patch.object(auth_flow, "_get_workflow_setting", return_value=True)
@@ -757,6 +787,7 @@ class AuthFlowTests(TestCase):
         mock_get_setting.side_effect = self._settings_getter(
             ENABLE_EMAIL_DELIVERY=True,
             COMPANY_NAME="Reusable Inc",
+            FORGOT_PASSWORD_URL="https://app.example.com/forgot-password",
         )
         mock_send_email.return_value = SimpleNamespace(status_code=200, text="ok")
 
@@ -807,7 +838,7 @@ class AuthFlowTests(TestCase):
         self.assertEqual(kwargs["to"], ["new@example.com"])
         self.assertEqual(kwargs["subject"], "Your account has been created")
         self.assertIn(
-            'You have been added as a registered user by an administrator. Use the "Forgot Password" flow to establish your password and login.',
+            'You have been added as a registered user by an administrator. Click the link <a href="https://app.example.com/forgot-password">https://app.example.com/forgot-password</a> to use the "Forgot Password" flow to establish your password and login.',
             kwargs["html"],
         )
         self.assertIn("Reusable Inc", kwargs["html"])

bmorricaldjangoworkflows-2.1.3/VERSION

@@ -1 +0,0 @@
-2.1.3