BmorricalDjangoWorkflows 2.0.3__tar.gz → 2.1.0__tar.gz

{bmorricaldjangoworkflows-2.0.3 → bmorricaldjangoworkflows-2.1.0}/BmorricalDjangoWorkflows.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BmorricalDjangoWorkflows
-Version: 2.0.3
+Version: 2.1.0
 Summary: Reusable Django Workflows
 Home-page: https://github.com/Bmorrical/django-workflows
 Author: Bradley Morrical
@@ -104,6 +104,7 @@ For the `mailgun` provider, also set:
 Optional:
 
 - `BCC_RECIPIENTS` as a comma-separated list
+- `EMAIL_REPLY_TO` as a single email or comma-separated list for reply handling
 - `EMAIL_LOG_RESPONSE_TEXT=true` to log response bodies at debug level
 
 Example:
@@ -115,6 +116,7 @@ EMAIL_FROM="My Company <no-reply@example.com>"
 EMAIL_DOMAIN="mg.example.com"
 EMAIL_API_KEY="key-example"
 BCC_RECIPIENTS="audit@example.com,ops@example.com"
+EMAIL_REPLY_TO="support@example.com"
 ```
 
 If `BCC_RECIPIENTS` is not set, no static BCC recipients are added.
@@ -129,6 +131,7 @@ If a consuming app previously used the Mailgun-specific names, update them as fo
 - `MAILGUN_API_KEY` -> `EMAIL_API_KEY`
 - `MAILGUN_DOMAIN` -> `EMAIL_DOMAIN`
 - `MAILGUN_BCC_RECIPIENTS` -> `BCC_RECIPIENTS`
+- no old equivalent -> `EMAIL_REPLY_TO`
 
 ### Built-In Defaults
 
@@ -141,6 +144,7 @@ If a consuming app does not define one of these values in `.env`, the package no
 - `DEVELOPMENT_MODE=False`
 - `DEFAULT_FROM_EMAIL=""`
 - `BCC_RECIPIENTS=""`
+- `EMAIL_REPLY_TO=""`
 - `EMAIL_LOG_RESPONSE_TEXT=False`
 
 Additional behavior:
@@ -154,9 +158,19 @@ Additional behavior:
 Practical implication:
 
 - Production apps using Mailgun should set `ENABLE_EMAIL_DELIVERY`, `EMAIL_FROM`, `EMAIL_API_KEY`, and `EMAIL_DOMAIN`.
+- If replies should go to a real inbox, also set `EMAIL_REPLY_TO`.
 - Local apps using Mailpit should usually set `EMAIL_DELIVERY_PROVIDER=mailpit`, `EMAIL_FROM`, and the Django SMTP settings shown below.
 - Apps that do not want this package to send email can omit everything and leave delivery disabled.
 
+Example for a branded sender with a monitored reply inbox:
+
+```bash
+EMAIL_FROM="Bourbonnais Township Highway Department <no-reply@mail.bthwy.org>"
+EMAIL_REPLY_TO="office@bthwy.org"
+```
+
+This keeps the authenticated sender in the `From` header while directing user replies to the `EMAIL_REPLY_TO` inbox.
+
 ## Django Email Backend Settings
 
 If a consuming app uses `EMAIL_DELIVERY_PROVIDER=smtp` or `EMAIL_DELIVERY_PROVIDER=mailpit`, it should configure Django's email backend in `settings.py`.
@@ -227,6 +241,7 @@ response = send_email(
 	html="<p>Thanks for joining.</p>",
 	cc="manager@example.com",
 	bcc=["audit@example.com"],
+	reply_to="support@example.com",
 	attachments=[("report.pdf", pdf_bytes, "application/pdf")],
 )
 
@@ -293,6 +308,10 @@ This is expected unless you set `BCC_RECIPIENTS`.
 
 ## Release
 
+Update code and ./VERSION
+
+Commit changes
+
 Create a release tag:
 
 ```bash

{bmorricaldjangoworkflows-2.0.3 → bmorricaldjangoworkflows-2.1.0}/BmorricalDjangoWorkflows.egg-info/SOURCES.txt

@@ -12,8 +12,11 @@ django_workflows/__init__.py
 django_workflows/services/__init__.py
 django_workflows/services/email.py
 django_workflows/users/__init__.py
+django_workflows/users/urls.py
+django_workflows/users/views.py
 django_workflows/users/services/__init__.py
 django_workflows/users/services/auth_flow.py
 tests/__init__.py
 tests/test_auth_flow.py
-tests/test_email.py
+tests/test_email.py
+tests/test_user_views.py

{bmorricaldjangoworkflows-2.0.3 → bmorricaldjangoworkflows-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BmorricalDjangoWorkflows
-Version: 2.0.3
+Version: 2.1.0
 Summary: Reusable Django Workflows
 Home-page: https://github.com/Bmorrical/django-workflows
 Author: Bradley Morrical
@@ -104,6 +104,7 @@ For the `mailgun` provider, also set:
 Optional:
 
 - `BCC_RECIPIENTS` as a comma-separated list
+- `EMAIL_REPLY_TO` as a single email or comma-separated list for reply handling
 - `EMAIL_LOG_RESPONSE_TEXT=true` to log response bodies at debug level
 
 Example:
@@ -115,6 +116,7 @@ EMAIL_FROM="My Company <no-reply@example.com>"
 EMAIL_DOMAIN="mg.example.com"
 EMAIL_API_KEY="key-example"
 BCC_RECIPIENTS="audit@example.com,ops@example.com"
+EMAIL_REPLY_TO="support@example.com"
 ```
 
 If `BCC_RECIPIENTS` is not set, no static BCC recipients are added.
@@ -129,6 +131,7 @@ If a consuming app previously used the Mailgun-specific names, update them as fo
 - `MAILGUN_API_KEY` -> `EMAIL_API_KEY`
 - `MAILGUN_DOMAIN` -> `EMAIL_DOMAIN`
 - `MAILGUN_BCC_RECIPIENTS` -> `BCC_RECIPIENTS`
+- no old equivalent -> `EMAIL_REPLY_TO`
 
 ### Built-In Defaults
 
@@ -141,6 +144,7 @@ If a consuming app does not define one of these values in `.env`, the package no
 - `DEVELOPMENT_MODE=False`
 - `DEFAULT_FROM_EMAIL=""`
 - `BCC_RECIPIENTS=""`
+- `EMAIL_REPLY_TO=""`
 - `EMAIL_LOG_RESPONSE_TEXT=False`
 
 Additional behavior:
@@ -154,9 +158,19 @@ Additional behavior:
 Practical implication:
 
 - Production apps using Mailgun should set `ENABLE_EMAIL_DELIVERY`, `EMAIL_FROM`, `EMAIL_API_KEY`, and `EMAIL_DOMAIN`.
+- If replies should go to a real inbox, also set `EMAIL_REPLY_TO`.
 - Local apps using Mailpit should usually set `EMAIL_DELIVERY_PROVIDER=mailpit`, `EMAIL_FROM`, and the Django SMTP settings shown below.
 - Apps that do not want this package to send email can omit everything and leave delivery disabled.
 
+Example for a branded sender with a monitored reply inbox:
+
+```bash
+EMAIL_FROM="Bourbonnais Township Highway Department <no-reply@mail.bthwy.org>"
+EMAIL_REPLY_TO="office@bthwy.org"
+```
+
+This keeps the authenticated sender in the `From` header while directing user replies to the `EMAIL_REPLY_TO` inbox.
+
 ## Django Email Backend Settings
 
 If a consuming app uses `EMAIL_DELIVERY_PROVIDER=smtp` or `EMAIL_DELIVERY_PROVIDER=mailpit`, it should configure Django's email backend in `settings.py`.
@@ -227,6 +241,7 @@ response = send_email(
 	html="<p>Thanks for joining.</p>",
 	cc="manager@example.com",
 	bcc=["audit@example.com"],
+	reply_to="support@example.com",
 	attachments=[("report.pdf", pdf_bytes, "application/pdf")],
 )
 
@@ -293,6 +308,10 @@ This is expected unless you set `BCC_RECIPIENTS`.
 
 ## Release
 
+Update code and ./VERSION
+
+Commit changes
+
 Create a release tag:
 
 ```bash

{bmorricaldjangoworkflows-2.0.3 → bmorricaldjangoworkflows-2.1.0}/README.md

@@ -80,6 +80,7 @@ For the `mailgun` provider, also set:
 Optional:
 
 - `BCC_RECIPIENTS` as a comma-separated list
+- `EMAIL_REPLY_TO` as a single email or comma-separated list for reply handling
 - `EMAIL_LOG_RESPONSE_TEXT=true` to log response bodies at debug level
 
 Example:
@@ -91,6 +92,7 @@ EMAIL_FROM="My Company <no-reply@example.com>"
 EMAIL_DOMAIN="mg.example.com"
 EMAIL_API_KEY="key-example"
 BCC_RECIPIENTS="audit@example.com,ops@example.com"
+EMAIL_REPLY_TO="support@example.com"
 ```
 
 If `BCC_RECIPIENTS` is not set, no static BCC recipients are added.
@@ -105,6 +107,7 @@ If a consuming app previously used the Mailgun-specific names, update them as fo
 - `MAILGUN_API_KEY` -> `EMAIL_API_KEY`
 - `MAILGUN_DOMAIN` -> `EMAIL_DOMAIN`
 - `MAILGUN_BCC_RECIPIENTS` -> `BCC_RECIPIENTS`
+- no old equivalent -> `EMAIL_REPLY_TO`
 
 ### Built-In Defaults
 
@@ -117,6 +120,7 @@ If a consuming app does not define one of these values in `.env`, the package no
 - `DEVELOPMENT_MODE=False`
 - `DEFAULT_FROM_EMAIL=""`
 - `BCC_RECIPIENTS=""`
+- `EMAIL_REPLY_TO=""`
 - `EMAIL_LOG_RESPONSE_TEXT=False`
 
 Additional behavior:
@@ -130,9 +134,19 @@ Additional behavior:
 Practical implication:
 
 - Production apps using Mailgun should set `ENABLE_EMAIL_DELIVERY`, `EMAIL_FROM`, `EMAIL_API_KEY`, and `EMAIL_DOMAIN`.
+- If replies should go to a real inbox, also set `EMAIL_REPLY_TO`.
 - Local apps using Mailpit should usually set `EMAIL_DELIVERY_PROVIDER=mailpit`, `EMAIL_FROM`, and the Django SMTP settings shown below.
 - Apps that do not want this package to send email can omit everything and leave delivery disabled.
 
+Example for a branded sender with a monitored reply inbox:
+
+```bash
+EMAIL_FROM="Bourbonnais Township Highway Department <no-reply@mail.bthwy.org>"
+EMAIL_REPLY_TO="office@bthwy.org"
+```
+
+This keeps the authenticated sender in the `From` header while directing user replies to the `EMAIL_REPLY_TO` inbox.
+
 ## Django Email Backend Settings
 
 If a consuming app uses `EMAIL_DELIVERY_PROVIDER=smtp` or `EMAIL_DELIVERY_PROVIDER=mailpit`, it should configure Django's email backend in `settings.py`.
@@ -203,6 +217,7 @@ response = send_email(
 	html="<p>Thanks for joining.</p>",
 	cc="manager@example.com",
 	bcc=["audit@example.com"],
+	reply_to="support@example.com",
 	attachments=[("report.pdf", pdf_bytes, "application/pdf")],
 )
 
@@ -269,6 +284,10 @@ This is expected unless you set `BCC_RECIPIENTS`.
 
 ## Release
 
+Update code and ./VERSION
+
+Commit changes
+
 Create a release tag:
 
 ```bash

bmorricaldjangoworkflows-2.1.0/VERSION

@@ -0,0 +1 @@
+2.1.0

{bmorricaldjangoworkflows-2.0.3 → bmorricaldjangoworkflows-2.1.0}/django_workflows/services/email.py

@@ -19,6 +19,7 @@ EMAIL_DOMAIN = os.getenv("EMAIL_DOMAIN", "")
 DEVELOPMENT_MODE = (os.getenv("DEVELOPMENT_MODE") or "").lower() == "true"
 EMAIL_DELIVERY_PROVIDER = (os.getenv("EMAIL_DELIVERY_PROVIDER") or "").lower()
 BCC_RECIPIENTS = os.getenv("BCC_RECIPIENTS", "")
+EMAIL_REPLY_TO = os.getenv("EMAIL_REPLY_TO", "")
 LOG_EMAIL_RESPONSE_TEXT = (os.getenv("EMAIL_LOG_RESPONSE_TEXT") or "").lower() == "true"
 
 
@@ -112,6 +113,12 @@ def _build_bcc_recipients(bcc: RecipientInput) -> List[str]:
     return deduped_bcc
 
 
+def _build_reply_to(reply_to: RecipientInput) -> List[str]:
+    configured_reply_to = _recipients_to_list(globals().get("EMAIL_REPLY_TO", ""))
+    passed_reply_to = _recipients_to_list(reply_to)
+    return _filter_valid_emails(configured_reply_to + passed_reply_to, field_name="reply_to")
+
+
 def _send_via_mailgun(
     to: Union[str, Sequence[str]],
     subject: str,
@@ -119,6 +126,7 @@ def _send_via_mailgun(
     attachments: Optional[Sequence[Attachment]] = None,
     cc: RecipientInput = None,
     bcc: RecipientInput = None,
+    reply_to: RecipientInput = None,
 ) -> Optional[requests.Response]:
     if not _has_mailgun_transport_config():
         return None
@@ -137,6 +145,10 @@ def _send_via_mailgun(
         "html": html,
     }
 
+    reply_to_list = _build_reply_to(reply_to)
+    if reply_to_list:
+        data["h:Reply-To"] = ", ".join(reply_to_list)
+
     if cc is not None:
         cc_list = _filter_valid_emails(_recipients_to_list(cc), field_name="cc")
         if cc_list:
@@ -174,6 +186,7 @@ def _send_via_smtp(
     attachments: Optional[Sequence[Attachment]] = None,
     cc: RecipientInput = None,
     bcc: RecipientInput = None,
+    reply_to: RecipientInput = None,
 ) -> Optional[DeliveryResult]:
     to_list = _filter_valid_emails(_recipients_to_list(to), field_name="to")
     if not to_list:
@@ -182,6 +195,7 @@ def _send_via_smtp(
 
     cc_list = _filter_valid_emails(_recipients_to_list(cc), field_name="cc") if cc is not None else []
     bcc_list = _build_bcc_recipients(bcc)
+    reply_to_list = _build_reply_to(reply_to)
 
     message = EmailMultiAlternatives(
         subject=subject,
@@ -190,6 +204,7 @@ def _send_via_smtp(
         to=to_list,
         cc=cc_list,
         bcc=bcc_list,
+        reply_to=reply_to_list,
     )
     message.attach_alternative(html, "text/html")
 
@@ -255,6 +270,7 @@ def send_email(
     attachments: Optional[Sequence[Attachment]] = None,
     cc: RecipientInput = None,
     bcc: RecipientInput = None,
+    reply_to: RecipientInput = None,
     enabled: Any = None,
 ) -> EmailDeliveryResponse:
     """Send an email using the configured delivery transport.
@@ -267,6 +283,8 @@ def send_email(
         cc: Optional CC recipient(s). Accepts a string (single or comma-separated) or an iterable of emails.
         bcc: Optional additional BCC recipient(s). Accepts a string (single or comma-separated) or an iterable.
             Note: `BCC_RECIPIENTS` (if defined) are always included when sending.
+        reply_to: Optional reply-to recipient(s). Accepts a string (single or comma-separated) or an iterable.
+            Note: `EMAIL_REPLY_TO` (if defined) is always included when sending.
         enabled: Optional application-level override. Truthy values force delivery,
             falsey values disable delivery, and `None` uses the configured transport.
     """
@@ -283,6 +301,7 @@ def send_email(
             attachments=attachments,
             cc=cc,
             bcc=bcc,
+            reply_to=reply_to,
         )
 
     if delivery_provider in {"mailpit", "smtp"}:
@@ -293,6 +312,7 @@ def send_email(
             attachments=attachments,
             cc=cc,
             bcc=bcc,
+            reply_to=reply_to,
         )
 
     logger.info("Email delivery is disabled. Email not sent.")

{bmorricaldjangoworkflows-2.0.3 → bmorricaldjangoworkflows-2.1.0}/django_workflows/users/services/auth_flow.py

@@ -149,6 +149,120 @@ def _get_user_meta_model() -> Type[Any]:
             f"Unable to import WORKFLOWS['USER_META_MODEL']: {model_path!r}"
         ) from exc
 
+
+def _get_group_model() -> Type[Any]:
+    from django.contrib.auth.models import Group
+
+    return Group
+
+
+def _normalize_group_names(value: Any) -> list[str]:
+    if value is None:
+        return []
+
+    if isinstance(value, str):
+        candidates = value.split(",")
+    elif isinstance(value, (list, tuple, set)):
+        candidates = []
+        for item in value:
+            if isinstance(item, str):
+                candidates.extend(item.split(","))
+            elif item is not None:
+                candidates.append(str(item))
+    else:
+        candidates = [str(value)]
+
+    normalized: list[str] = []
+    seen: set[str] = set()
+    for candidate in candidates:
+        name = candidate.strip()
+        if name and name not in seen:
+            seen.add(name)
+            normalized.append(name)
+
+    return normalized
+
+
+def _get_existing_groups(group_names: Any) -> list[Any]:
+    normalized_names = _normalize_group_names(group_names)
+    if not normalized_names:
+        return []
+
+    Group = _get_group_model()
+    return list(Group.objects.filter(name__in=normalized_names))
+
+
+def _add_existing_groups_to_user(*, user: Any, group_names: Any) -> list[str]:
+    groups = _get_existing_groups(group_names)
+    group_manager = getattr(user, "groups", None)
+
+    if not groups or group_manager is None or not hasattr(group_manager, "add"):
+        return []
+
+    group_manager.add(*groups)
+    return [group.name for group in groups]
+
+
+def _coerce_bool(value: Any) -> bool:
+    if isinstance(value, bool):
+        return value
+
+    if isinstance(value, str):
+        normalized = value.strip().lower()
+        if normalized in {"1", "true", "yes", "on"}:
+            return True
+        if normalized in {"0", "false", "no", "off"}:
+            return False
+
+    raise ValueError("Boolean value required.")
+
+
+def _get_force_password_reset(user: Any) -> bool:
+    UserMeta = _get_user_meta_model()
+
+    try:
+        meta = UserMeta.objects.get(user=user)
+        return bool(getattr(meta, "force_password_reset", False))
+    except UserMeta.DoesNotExist:
+        return False
+
+
+def get_user_details(user: Any) -> dict[str, Any]:
+    return {
+        "id": user.id,
+        "username": user.username,
+        "email": user.email,
+        "first_name": user.first_name,
+        "last_name": user.last_name,
+        "is_active": bool(getattr(user, "is_active", False)),
+        "force_password_reset": _get_force_password_reset(user),
+        "groups": [group.name for group in user.groups.all()],
+    }
+
+
+def list_users(*, exclude_groups: Any = None) -> list[dict[str, Any]]:
+    User = get_user_model()
+    excluded_group_names = set(_normalize_group_names(exclude_groups))
+    users = list(User.objects.all())
+    users.sort(key=lambda user: getattr(user, "id", 0))
+
+    if excluded_group_names:
+        filtered_users = []
+        for user in users:
+            user_group_names = {group.name for group in user.groups.all()}
+            if user_group_names.intersection(excluded_group_names):
+                continue
+            filtered_users.append(user)
+        users = filtered_users
+
+    return [get_user_details(user) for user in users]
+
+
+@dataclass(frozen=True)
+class UserUpdateResult:
+    success: bool
+    message: str
+
 class VerifyCodeResult(Enum):
     SUCCESS = "success"
     INVALID = "invalid"
@@ -177,7 +291,14 @@ class ChangePasswordResult:
     message: str
 
 
-def register_user_and_send_verification_email(email: str, first_name: str, last_name: str, password: str) -> ServiceResult:
+def register_user_and_send_verification_email(
+    email: str,
+    first_name: str,
+    last_name: str,
+    password: str,
+    group: Any = None,
+    groups: Any = None,
+) -> ServiceResult:
     """
     Registers a new user and sends a verification email.
     """
@@ -219,6 +340,13 @@ def register_user_and_send_verification_email(email: str, first_name: str, last_
             meta.verify_time = timezone.now()
             meta.save()
 
+            requested_groups = _normalize_group_names(groups)
+            if group is not None:
+                requested_groups.extend(
+                    name for name in _normalize_group_names(group) if name not in requested_groups
+                )
+            _add_existing_groups_to_user(user=user, group_names=requested_groups)
+
             message = (
                 f"Hello {first_name} {last_name},<br><br>"
                 f"Your account verification code is: <strong>{verification_code}</strong><br /><br />"
@@ -273,6 +401,70 @@ def register_user_and_send_verification_email(email: str, first_name: str, last_
         message="Registration successful. Please check your email for the verification code.",
     )
 
+
+def update_user(user: Any, data: dict[str, Any]) -> UserUpdateResult:
+    processed_update = False
+    user_fields_updated = False
+
+    email_value = data.get("email")
+    username_value = data.get("username")
+    if email_value is not None or username_value is not None:
+        next_email = email_value if email_value is not None else username_value
+        user.username = next_email
+        user.email = next_email
+        processed_update = True
+        user_fields_updated = True
+
+    if "first_name" in data:
+        user.first_name = data["first_name"]
+        processed_update = True
+        user_fields_updated = True
+    if "last_name" in data:
+        user.last_name = data["last_name"]
+        processed_update = True
+        user_fields_updated = True
+    if "password" in data:
+        user.set_password(data["password"])
+        processed_update = True
+        user_fields_updated = True
+    if "is_active" in data:
+        try:
+            user.is_active = _coerce_bool(data["is_active"])
+        except ValueError:
+            return UserUpdateResult(
+                success=False,
+                message="is_active must be a boolean value.",
+            )
+        processed_update = True
+        user_fields_updated = True
+
+    requested_groups = []
+    if "groups" in data:
+        requested_groups.extend(_normalize_group_names(data.get("groups")))
+        processed_update = True
+    if "group" in data:
+        requested_groups.extend(
+            name for name in _normalize_group_names(data.get("group")) if name not in requested_groups
+        )
+        processed_update = True
+    if requested_groups:
+        _add_existing_groups_to_user(user=user, group_names=requested_groups)
+
+    if user_fields_updated:
+        user.save()
+
+    if not processed_update:
+        return UserUpdateResult(
+            success=False,
+            message="No valid fields provided.",
+        )
+
+    logger.info("User updated for %s", user.email)
+    return UserUpdateResult(
+        success=True,
+        message="User updated successfully.",
+    )
+
 def send_forgot_password_code(email: str) -> ServiceResult:
     """
     Generates and sends a password reset code.

bmorricaldjangoworkflows-2.1.0/django_workflows/users/urls.py

@@ -0,0 +1,19 @@
+from django.urls import path
+
+from django_workflows.users.views import (
+    ChangePasswordView,
+    ForgotPasswordView,
+    UserCreateView,
+    UserDetailView,
+    UserListView,
+    VerifyCodeView,
+)
+
+urlpatterns = [
+    path("user/", UserDetailView.as_view(), name="user-detail"),
+    path("users/", UserListView.as_view(), name="user-list"),
+    path("forgot-password/", ForgotPasswordView.as_view(), name="forgot-password"),
+    path("verify-code/", VerifyCodeView.as_view(), name="verify-code"),
+    path("change-password/", ChangePasswordView.as_view(), name="change-password"),
+    path("register/", UserCreateView.as_view(), name="register"),
+]