BmorricalDjangoWorkflows 2.0.4__tar.gz → 2.1.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BmorricalDjangoWorkflows
-Version: 2.0.4
+Version: 2.1.0
 Summary: Reusable Django Workflows
 Home-page: https://github.com/Bmorrical/django-workflows
 Author: Bradley Morrical
@@ -308,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.4 → 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.4 → bmorricaldjangoworkflows-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: BmorricalDjangoWorkflows
-Version: 2.0.4
+Version: 2.1.0
 Summary: Reusable Django Workflows
 Home-page: https://github.com/Bmorrical/django-workflows
 Author: Bradley Morrical
@@ -308,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.4 → bmorricaldjangoworkflows-2.1.0}/README.md

@@ -284,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.4 → 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"),
+]

bmorricaldjangoworkflows-2.1.0/django_workflows/users/views.py

@@ -0,0 +1,189 @@
+import logging
+
+from rest_framework import status
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from django_workflows.users.services.auth_flow import (
+    change_password,
+    get_user_details,
+    list_users,
+    register_user_and_send_verification_email,
+    send_forgot_password_code,
+    update_user,
+    verify_reset_code,
+)
+
+logger = logging.getLogger(__name__)
+
+
+class AnonymousWorkflowView(APIView):
+    authentication_classes = []
+    permission_classes = []
+
+
+# Route: POST /forgot-password/
+# Body params: email, optional company honeypot field
+class ForgotPasswordView(AnonymousWorkflowView):
+    def post(self, request):
+        data = request.data
+
+        if data.get("company") is not None and str(data.get("company")).strip():
+            logger.warning(
+                "Honeypot triggered for password reset: company=%s",
+                data.get("company"),
+            )
+            return Response(
+                {"detail": "Password reset blocked."},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        email = data.get("email")
+        if not email:
+            logger.error("ForgotPasswordView: Email is required.")
+            return Response(
+                {"detail": "Email is required."},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        result = send_forgot_password_code(email)
+        return Response({"detail": result.message}, status=status.HTTP_200_OK)
+
+
+# Route: POST /register/
+# Body params: firstName, lastName, email, password, optional group, optional groups, optional company honeypot field
+class UserCreateView(AnonymousWorkflowView):
+    def post(self, request):
+        data = request.data
+
+        if data.get("company") is not None and str(data.get("company")).strip():
+            logger.warning(
+                "Honeypot triggered for registration: company=%s",
+                data.get("company"),
+            )
+            return Response(
+                {"detail": "Bot detected. Registration blocked."},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        required_fields = ["firstName", "lastName", "password", "email"]
+        missing_fields = [field for field in required_fields if field not in data]
+        if missing_fields:
+            logger.error("Registration missing fields: %s", missing_fields)
+            return Response(
+                {"detail": f"Missing required field(s): {', '.join(missing_fields)}"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        result = register_user_and_send_verification_email(
+            first_name=data.get("firstName"),
+            last_name=data.get("lastName"),
+            email=data.get("email"),
+            password=data.get("password"),
+            group=data.get("group"),
+            groups=data.get("groups"),
+        )
+
+        if not result.success:
+            response_status = status.HTTP_409_CONFLICT
+            if result.message != "A user with this email already exists.":
+                response_status = status.HTTP_400_BAD_REQUEST
+
+            return Response({"detail": result.message}, status=response_status)
+
+        return Response({"detail": result.message}, status=status.HTTP_201_CREATED)
+
+
+# Route: POST /verify-code/
+# Body params: email, code, optional company honeypot field
+class VerifyCodeView(AnonymousWorkflowView):
+    def post(self, request):
+        data = request.data
+
+        if data.get("company") is not None and str(data.get("company")).strip():
+            logger.warning(
+                "Honeypot triggered for verification: company=%s",
+                data.get("company"),
+            )
+            return Response(
+                {"detail": "Verification blocked."},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        email = data.get("email")
+        code = data.get("code")
+        if not email or not code:
+            return Response(
+                {"detail": "Email and code are required."},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        result = verify_reset_code(email=email, code=code)
+        return Response(result.payload, status=result.status_code)
+
+
+# Route: POST /change-password/
+# Body params: email, password, passwordVerify, optional company honeypot field
+class ChangePasswordView(AnonymousWorkflowView):
+    def post(self, request):
+        data = request.data
+
+        if data.get("company") is not None and str(data.get("company")).strip():
+            logger.warning(
+                "Honeypot triggered for change password: company=%s",
+                data.get("company"),
+            )
+            return Response(
+                {"detail": "Bot detected. Change password blocked."},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        result = change_password(
+            email=data.get("email"),
+            password=data.get("password"),
+            password_verify=data.get("passwordVerify"),
+        )
+
+        if not result.success:
+            return Response(
+                {"detail": result.message},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        return Response({"detail": result.message}, status=status.HTTP_200_OK)
+
+
+# Route: GET /users/
+# Query params: optional exclude_group as comma-separated group names
+class UserListView(APIView):
+    permission_classes = [IsAuthenticated]
+
+    def get(self, request):
+        users = list_users(exclude_groups=request.query_params.get("exclude_group"))
+        logger.info("UserListView: Fetched %s users", len(users))
+        return Response(users, status=status.HTTP_200_OK)
+
+
+# Route: GET /user/
+# Route: PATCH /user/
+# PATCH body params: username, email, first_name, last_name, password, is_active, optional group, optional groups
+class UserDetailView(APIView):
+    permission_classes = [IsAuthenticated]
+
+    def get(self, request):
+        data = get_user_details(request.user)
+        logger.info("UserDetailView: Fetched details for user %s", request.user.email)
+        return Response(data, status=status.HTTP_200_OK)
+
+    def patch(self, request):
+        result = update_user(request.user, request.data)
+
+        if result.success:
+            return Response(
+                {"detail": result.message},
+                status=status.HTTP_200_OK,
+            )
+
+        logger.error("UserDetailView: %s for user %s", result.message, request.user.email)
+        return Response({"detail": result.message}, status=status.HTTP_400_BAD_REQUEST)