squash!: Apply PR suggestions

Author: rodmgwgu

openedx_authz/api/data.py

@@ -1110,7 +1110,7 @@ class SuperAdminAssignmentData:
     staff/superuser and their access is not derived from a specific role assignment.
     """
 
-    subject: SubjectData = None
+    user: "User" = None
     is_staff: bool = False
     is_superuser: bool = False
 

openedx_authz/api/users.py

@@ -54,7 +54,7 @@
     "get_user_role_assignments_filtered",
     "get_all_user_role_assignments_in_scope",
     "get_visible_role_assignments_for_user",
-    "get_visible_specific_user_role_assignments_for_user",
+    "get_visible_user_role_assignments_filtered_by_current_user",
     "is_user_allowed",
     "get_scopes_for_user_and_permission",
     "get_users_for_role_in_scope",
@@ -177,7 +177,7 @@ def get_user_role_assignments_for_role_in_scope(
     )
 
 
-def get_visible_specific_user_role_assignments_for_user(
+def get_visible_user_role_assignments_filtered_by_current_user(
     user_external_key: str,
     orgs: list[str] = None,
     roles: list[str] = None,
@@ -410,7 +410,7 @@ def get_superadmin_assignments(user_external_keys: list[str] | None = None) -> l
     for requested_user in requested_users:
         superadmin_assignments.append(
             SuperAdminAssignmentData(
-                subject=UserData(external_key=requested_user.username),
+                user=requested_user,
                 is_staff=requested_user.is_staff,
                 is_superuser=requested_user.is_superuser,
             )

openedx_authz/rest_api/v1/serializers.py

@@ -34,6 +34,21 @@ class ActionMixin(serializers.Serializer):  # pylint: disable=abstract-method
     action = serializers.CharField(max_length=255)
 
 
+class OrderMixin(serializers.Serializer):  # pylint: disable=abstract-method
+    """Mixin providing ordering field functionality."""
+
+    sort_by = serializers.ChoiceField(
+        required=False,
+        choices=[(e.value, e.name) for e in SortField],
+        default=SortField.USERNAME,
+    )
+    order = serializers.ChoiceField(
+        required=False,
+        choices=[(e.value, e.name) for e in SortOrder],
+        default=SortOrder.ASC,
+    )
+
+
 class PermissionValidationSerializer(ActionMixin, ScopeMixin):  # pylint: disable=abstract-method
     """Serializer for permission validation request."""
 
@@ -111,20 +126,10 @@ class RemoveUsersFromRoleWithScopeSerializer(
     users = CommaSeparatedListField(allow_blank=False)
 
 
-class ListUsersInRoleWithScopeSerializer(ScopeMixin):  # pylint: disable=abstract-method
+class ListUsersInRoleWithScopeSerializer(ScopeMixin, OrderMixin):  # pylint: disable=abstract-method
     """Serializer for listing users in a role with a scope."""
 
     roles = CommaSeparatedListField(required=False, default=[])
-    sort_by = serializers.ChoiceField(
-        required=False,
-        choices=[(e.value, e.name) for e in SortField],
-        default=SortField.USERNAME,
-    )
-    order = serializers.ChoiceField(
-        required=False,
-        choices=[(e.value, e.name) for e in SortOrder],
-        default=SortOrder.ASC,
-    )
     search = LowercaseCharField(required=False, default=None)
 
 
@@ -210,7 +215,7 @@ def get_roles(self, obj: api.RoleAssignmentData) -> list[str]:
         return [role.external_key for role in obj.roles]
 
 
-class ListTeamMembersSerializer(serializers.Serializer):  # pylint: disable=abstract-method
+class ListTeamMembersSerializer(OrderMixin):  # pylint: disable=abstract-method
     """
     Serializer for listing team members.
     This serializer is TeamMembersAPIView, which is used in the Admin Console.
@@ -219,16 +224,6 @@ class ListTeamMembersSerializer(serializers.Serializer):  # pylint: disable=abst
 
     scopes = CaseSensitiveCommaSeparatedListField(required=False, default=[])
     orgs = CaseSensitiveCommaSeparatedListField(required=False, default=[])
-    sort_by = serializers.ChoiceField(
-        required=False,
-        choices=[(e.value, e.name) for e in SortField],
-        default=SortField.USERNAME,
-    )
-    order = serializers.ChoiceField(
-        required=False,
-        choices=[(e.value, e.name) for e in SortOrder],
-        default=SortOrder.ASC,
-    )
     search = LowercaseCharField(required=False, default=None)
 
 
@@ -261,21 +256,17 @@ def get_assignation_count(self, obj: UserAssignments) -> int:
         return len(obj.assignments)
 
 
-class ListTeamMemberAssignmentsSerializer(serializers.Serializer):  # pylint: disable=abstract-method
+class ListTeamMemberAssignmentsSerializer(OrderMixin):  # pylint: disable=abstract-method
     """Serializer for listing team member assignments."""
 
     orgs = CaseSensitiveCommaSeparatedListField(required=False, default=[])
     roles = CaseSensitiveCommaSeparatedListField(required=False, default=[])
+    # Overriding sort_by from OrderMixin due to different choices and default value
     sort_by = serializers.ChoiceField(
         required=False,
         choices=[(e.value, e.name) for e in AssignmentSortField],
         default=AssignmentSortField.ROLE,
     )
-    order = serializers.ChoiceField(
-        required=False,
-        choices=[(e.value, e.name) for e in SortOrder],
-        default=SortOrder.ASC,
-    )
 
 
 class TeamMemberAssignmentSerializer(serializers.Serializer):  # pylint: disable=abstract-method

openedx_authz/rest_api/v1/views.py

@@ -21,7 +21,10 @@
 
 from openedx_authz import api
 from openedx_authz.api.data import RoleAssignmentData, SuperAdminAssignmentData
-from openedx_authz.api.users import get_superadmin_assignments, get_visible_specific_user_role_assignments_for_user
+from openedx_authz.api.users import (
+    get_superadmin_assignments,
+    get_visible_user_role_assignments_filtered_by_current_user,
+)
 from openedx_authz.api.utils import get_user_map
 from openedx_authz.constants import permissions
 from openedx_authz.rest_api.data import RoleOperationError, RoleOperationStatus
@@ -635,7 +638,7 @@ def get(self, request: HttpRequest, username: str) -> Response:
         # Retrieve superadmin assignments (django staff or superuser users), as they always have access to everything
         user_role_assignments += get_superadmin_assignments(user_external_keys=[username])
 
-        user_role_assignments += get_visible_specific_user_role_assignments_for_user(
+        user_role_assignments += get_visible_user_role_assignments_filtered_by_current_user(
             user_external_key=username,
             orgs=query_params.get("orgs"),
             roles=query_params.get("roles"),