refactor: add default values in serializers

Author: BryanttV

openedx_authz/rest_api/v1/serializers.py

@@ -51,10 +51,14 @@ class RemoveUserFromRoleWithScopeSerializer(RoleMixin, ScopeMixin):  # pylint: d
 class ListUsersInRoleWithScopeSerializer(ScopeMixin):  # pylint: disable=abstract-method
     """Serializer for listing users in a role with a scope."""
 
-    roles = CommaSeparatedListField(required=False)
-    sort_by = serializers.ChoiceField(required=False, choices=[(e.value, e.name) for e in SortField])
-    order = serializers.ChoiceField(required=False, choices=[(e.value, e.name) for e in SortOrder])
-    search = LowercaseCharField(required=False)
+    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)
 
 
 class ListRolesWithScopeSerializer(ScopeMixin):  # pylint: disable=abstract-method
@@ -77,8 +81,8 @@ class ListRolesWithScopeResponseSerializer(serializers.Serializer):  # pylint: d
     user_count = serializers.IntegerField()
 
 
-class RoleAssignmentSerializer(serializers.Serializer):  # pylint: disable=abstract-method
-    """Serializer for a role assignment."""
+class UserRoleAssignmentSerializer(serializers.Serializer):  # pylint: disable=abstract-method
+    """Serializer for a user role assignment."""
 
     username = serializers.SerializerMethodField()
     full_name = serializers.SerializerMethodField()

openedx_authz/rest_api/v1/views.py

@@ -15,7 +15,6 @@
 from rest_framework.views import APIView
 
 from openedx_authz import api
-from openedx_authz.rest_api.enums import SortField, SortOrder
 from openedx_authz.rest_api.utils import filter_users, get_user_by_username_or_email, sort_users, view_auth_classes
 from openedx_authz.rest_api.v1.paginators import AuthZAPIViewPagination
 from openedx_authz.rest_api.v1.serializers import (
@@ -26,7 +25,7 @@
     PermissionValidationResponseSerializer,
     PermissionValidationSerializer,
     RemoveUserFromRoleWithScopeSerializer,
-    RoleAssignmentSerializer,
+    UserRoleAssignmentSerializer,
 )
 
 logger = logging.getLogger(__name__)
@@ -107,22 +106,16 @@ def get(self, request: HttpRequest) -> Response:
         """Retrieve all users with role assignments within a specific scope."""
         serializer = ListUsersInRoleWithScopeSerializer(data=request.query_params)
         serializer.is_valid(raise_exception=True)
-        user_role_assignments = api.get_all_user_role_assignments_in_scope(serializer.validated_data["scope"])
+        query_params = serializer.validated_data
 
-        paginator = self.pagination_class()
-        paginated_assignments = paginator.paginate_queryset(user_role_assignments, request)
-
-        response_serializer = RoleAssignmentSerializer(paginated_assignments, many=True)
-
-        sort_by = serializer.validated_data.get("sort_by", SortField.USERNAME)
-        order = serializer.validated_data.get("order", SortOrder.ASC)
-        search = serializer.validated_data.get("search")
-        roles = serializer.validated_data.get("roles")
-
-        filtered_users = filter_users(response_serializer.data, search, roles)
-        user_role_assignments = sort_users(filtered_users, sort_by, order)
+        user_role_assignments = api.get_all_user_role_assignments_in_scope(query_params["scope"])
+        response_data = UserRoleAssignmentSerializer(user_role_assignments, many=True).data
+        filtered_users = filter_users(response_data, query_params["search"], query_params["roles"])
+        user_role_assignments = sort_users(filtered_users, query_params["sort_by"], query_params["order"])
 
-        return paginator.get_paginated_response(user_role_assignments)
+        paginator = self.pagination_class()
+        paginated_response_data = paginator.paginate_queryset(user_role_assignments, request)
+        return paginator.get_paginated_response(paginated_response_data)
 
     @apidocs.schema(
         body=AddUserToRoleWithScopeSerializer,
@@ -224,7 +217,7 @@ def get(self, request: HttpRequest) -> Response:
         response_data = []
         for role in roles:
             users = api.get_users_for_role(role.external_key)
-            permissions = [perm.action.external_key for perm in role.permissions] if role.permissions else []
+            permissions = [perm.action.external_key for perm in role.permissions]
             response_data.append(
                 {
                     "role": role.external_key,
@@ -233,8 +226,8 @@ def get(self, request: HttpRequest) -> Response:
                 }
             )
 
+        serializer = ListRolesWithScopeResponseSerializer(response_data, many=True)
+
         paginator = self.pagination_class()
         paginated_response_data = paginator.paginate_queryset(response_data, request)
-
-        serializer = ListRolesWithScopeResponseSerializer(paginated_response_data, many=True)
-        return paginator.get_paginated_response(serializer.data)
+        return paginator.get_paginated_response(paginated_response_data)