refactor: remove unused role assignment functions and update API views for consistency

Author: BryanttV

openedx_authz/api/roles.py

@@ -382,39 +382,6 @@ def get_all_subject_role_assignments_in_scope(scope: ScopeData) -> list[RoleAssi
     return list(role_assignments_per_subject.values())
 
 
-def get_all_subject_role_assignments_in_scope_v2(
-    scope: ScopeData,
-) -> list[SubjectRoleAssignmentData]:
-    """Get all the subjects assigned to any role in a specific scope.
-
-    Args:
-        scope: The scope to filter subjects (e.g., 'library:123' or '*' for global).
-
-    Returns:
-        list[SubjectRoleAssignmentData]: A list of subjects assigned to roles in the specified scope.
-    """
-    roles_in_scope = get_all_roles_in_scope(scope)
-
-    subject_roles_map = {}
-    for subject, role, _ in roles_in_scope:
-        if subject not in subject_roles_map:
-            subject_roles_map[subject] = []
-        subject_roles_map[subject].append(role)
-
-    role_assignments = []
-    for subject_key, role_keys in subject_roles_map.items():
-        subject = SubjectData(namespaced_key=subject_key)
-        roles = [RoleData(namespaced_key=role_key) for role_key in role_keys]
-        role_assignments.append(
-            SubjectRoleAssignmentData(
-                subject=subject,
-                roles=roles,
-            )
-        )
-
-    return role_assignments
-
-
 def get_subjects_for_role(role: RoleData) -> list[SubjectData]:
     """Get all the subjects assigned to a specific role.
 

openedx_authz/api/users.py

@@ -24,7 +24,6 @@
     batch_assign_role_to_subjects_in_scope,
     batch_unassign_role_from_subjects_in_scope,
     get_all_subject_role_assignments_in_scope,
-    get_all_subject_role_assignments_in_scope_v2,
     get_subject_role_assignments,
     get_subject_role_assignments_for_role_in_scope,
     get_subject_role_assignments_in_scope,
@@ -42,7 +41,6 @@
     "get_user_role_assignments_for_role_in_scope",
     "get_all_user_role_assignments_in_scope",
     "user_has_permission",
-    "get_all_user_role_assignments_in_scope_v2",
     "get_users_for_role",
 ]
 
@@ -175,29 +173,6 @@ def get_all_user_role_assignments_in_scope(
     )
 
 
-def get_all_user_role_assignments_in_scope_v2(scope_external_key: str) -> list[SubjectRoleAssignmentData]:
-    """Get all user role assignments in a specific scope.
-
-    Args:
-        scope (str): Scope in which to retrieve the user role assignments.
-
-    Returns:
-        list[SubjectRoleAssignmentData]: A list of user role assignments and all their metadata in the specified scope.
-    """
-    user_role_assignments = []
-    role_assignments = get_all_subject_role_assignments_in_scope_v2(ContentLibraryData(external_key=scope_external_key))
-
-    for role_assignment in role_assignments:
-        user_role_assignments.append(
-            SubjectRoleAssignmentData(
-                subject=UserData(namespaced_key=role_assignment.subject.namespaced_key),
-                roles=role_assignment.roles,
-            )
-        )
-
-    return user_role_assignments
-
-
 def user_has_permission(
     user_external_key: str,
     action_external_key: str,

openedx_authz/rest_api/v1/serializers.py

@@ -2,6 +2,7 @@
 
 from rest_framework import serializers
 
+from openedx_authz.api.data import RoleAssignmentData
 from openedx_authz.rest_api.enums import SortField, SortOrder
 from openedx_authz.rest_api.utils import get_user_by_username_or_email
 from openedx_authz.rest_api.v1.fields import CommaSeparatedListField, LowercaseCharField
@@ -88,21 +89,21 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._user_cache = {}
 
-    def _get_user(self, obj):
+    def _get_user(self, obj: RoleAssignmentData):
         """Cache user lookups to avoid duplicate DB queries."""
         username = obj.subject.username
         if username not in self._user_cache:
             self._user_cache[username] = get_user_by_username_or_email(username)
         return self._user_cache[username]
 
-    def get_username(self, obj):
+    def get_username(self, obj: RoleAssignmentData):
         return obj.subject.username
 
-    def get_full_name(self, obj):
+    def get_full_name(self, obj: RoleAssignmentData):
         return self._get_user(obj).profile.name
 
-    def get_email(self, obj):
+    def get_email(self, obj: RoleAssignmentData):
         return self._get_user(obj).email
 
-    def get_roles(self, obj):
+    def get_roles(self, obj: RoleAssignmentData):
         return [role.external_key for role in obj.roles]

openedx_authz/rest_api/v1/views.py

@@ -107,7 +107,7 @@ 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_v2(serializer.validated_data["scope"])
+        user_role_assignments = api.get_all_user_role_assignments_in_scope(serializer.validated_data["scope"])
 
         paginator = self.pagination_class()
         paginated_assignments = paginator.paginate_queryset(user_role_assignments, request)
@@ -218,7 +218,7 @@ def get(self, request: HttpRequest) -> Response:
         serializer = ListRolesWithScopeSerializer(data=request.query_params)
         serializer.is_valid(raise_exception=True)
 
-        scope = api.ContentLibraryData(namespaced_key=serializer.validated_data["scope"])
+        scope = api.ScopeData(namespaced_key=serializer.validated_data["scope"])
         roles = api.get_role_definitions_in_scope(scope)
 
         response_data = []