[FC-0099] fix: add constants and improve test class

CHANGELOG.rst

@@ -16,6 +16,14 @@ Unreleased
 
 *
 
+0.10.1 - 2025-10-28
+********************
+
+Fixed
+=====
+
+* Fix constants and test class to be able to use it outside this app.
+
 0.10.0 - 2025-10-28
 *******************
 

openedx_authz/__init__.py

@@ -4,6 +4,6 @@
 
 import os
 
-__version__ = "0.10.0"
+__version__ = "0.10.1"
 
 ROOT_DIRECTORY = os.path.dirname(os.path.abspath(__file__))

openedx_authz/constants/permissions.py

@@ -0,0 +1,51 @@
+"""
+Default permission constants.
+"""
+from openedx_authz.api.data import ActionData, PermissionData
+
+# Content Library Permissions
+VIEW_LIBRARY = PermissionData(
+    action=ActionData(external_key="view_library"),
+    effect="allow",
+)
+MANAGE_LIBRARY_TAGS = PermissionData(
+    action=ActionData(external_key="manage_library_tags"),
+    effect="allow",
+)
+DELETE_LIBRARY = PermissionData(
+    action=ActionData(external_key="delete_library"),
+    effect="allow",
+)
+EDIT_LIBRARY_CONTENT = PermissionData(
+    action=ActionData(external_key="edit_library_content"),
+    effect="allow",
+)
+PUBLISH_LIBRARY_CONTENT = PermissionData(
+    action=ActionData(external_key="publish_library_content"),
+    effect="allow",
+)
+REUSE_LIBRARY_CONTENT = PermissionData(
+    action=ActionData(external_key="reuse_library_content"),
+    effect="allow",
+)
+VIEW_LIBRARY_TEAM = PermissionData(
+    action=ActionData(external_key="view_library_team"),
+    effect="allow",
+)
+MANAGE_LIBRARY_TEAM = PermissionData(
+    action=ActionData(external_key="manage_library_team"),
+    effect="allow",
+)
+
+CREATE_LIBRARY_COLLECTION = PermissionData(
+    action=ActionData(external_key="create_library_collection"),
+    effect="allow",
+)
+EDIT_LIBRARY_COLLECTION = PermissionData(
+    action=ActionData(external_key="edit_library_collection"),
+    effect="allow",
+)
+DELETE_LIBRARY_COLLECTION = PermissionData(
+    action=ActionData(external_key="delete_library_collection"),
+    effect="allow",
+)

openedx_authz/constants/roles.py

@@ -0,0 +1,58 @@
+"""
+Default roles and their associated permissions.
+"""
+
+from openedx_authz.api.data import RoleData
+from openedx_authz.constants import permissions
+
+# Library Roles and Permissions
+
+# Define the associated permissions for each role
+
+LIBRARY_ADMIN_PERMISSIONS = [
+    permissions.VIEW_LIBRARY,
+    permissions.MANAGE_LIBRARY_TAGS,
+    permissions.DELETE_LIBRARY,
+    permissions.EDIT_LIBRARY_CONTENT,
+    permissions.PUBLISH_LIBRARY_CONTENT,
+    permissions.REUSE_LIBRARY_CONTENT,
+    permissions.VIEW_LIBRARY_TEAM,
+    permissions.MANAGE_LIBRARY_TEAM,
+    permissions.CREATE_LIBRARY_COLLECTION,
+    permissions.EDIT_LIBRARY_COLLECTION,
+    permissions.DELETE_LIBRARY_COLLECTION,
+]
+
+LIBRARY_AUTHOR_PERMISSIONS = [
+    permissions.VIEW_LIBRARY,
+    permissions.MANAGE_LIBRARY_TAGS,
+    permissions.EDIT_LIBRARY_CONTENT,
+    permissions.PUBLISH_LIBRARY_CONTENT,
+    permissions.REUSE_LIBRARY_CONTENT,
+    permissions.VIEW_LIBRARY_TEAM,
+    permissions.CREATE_LIBRARY_COLLECTION,
+    permissions.EDIT_LIBRARY_COLLECTION,
+    permissions.DELETE_LIBRARY_COLLECTION,
+]
+
+LIBRARY_CONTRIBUTOR_PERMISSIONS = [
+    permissions.VIEW_LIBRARY,
+    permissions.MANAGE_LIBRARY_TAGS,
+    permissions.EDIT_LIBRARY_CONTENT,
+    permissions.REUSE_LIBRARY_CONTENT,
+    permissions.VIEW_LIBRARY_TEAM,
+    permissions.CREATE_LIBRARY_COLLECTION,
+    permissions.EDIT_LIBRARY_COLLECTION,
+    permissions.DELETE_LIBRARY_COLLECTION,
+]
+
+LIBRARY_USER_PERMISSIONS = [
+    permissions.VIEW_LIBRARY,
+    permissions.REUSE_LIBRARY_CONTENT,
+    permissions.VIEW_LIBRARY_TEAM,
+]
+
+LIBRARY_ADMIN = RoleData(external_key="library_admin", permissions=LIBRARY_ADMIN_PERMISSIONS)
+LIBRARY_AUTHOR = RoleData(external_key="library_author", permissions=LIBRARY_AUTHOR_PERMISSIONS)
+LIBRARY_CONTRIBUTOR = RoleData(external_key="library_contributor", permissions=LIBRARY_CONTRIBUTOR_PERMISSIONS)
+LIBRARY_USER = RoleData(external_key="library_user", permissions=LIBRARY_USER_PERMISSIONS)

openedx_authz/rest_api/v1/views.py

@@ -15,6 +15,7 @@
 from rest_framework.views import APIView
 
 from openedx_authz import api
+from openedx_authz.constants import permissions
 from openedx_authz.rest_api.data import RoleOperationError, RoleOperationStatus
 from openedx_authz.rest_api.decorators import authz_permissions, view_auth_classes
 from openedx_authz.rest_api.utils import (
@@ -250,7 +251,7 @@ class RoleUserAPIView(APIView):
             status.HTTP_401_UNAUTHORIZED: "The user is not authenticated or does not have the required permissions",
         },
     )
-    @authz_permissions(["view_library_team"])
+    @authz_permissions([permissions.VIEW_LIBRARY.identifier])
     def get(self, request: HttpRequest) -> Response:
         """Retrieve all users with role assignments within a specific scope."""
         serializer = ListUsersInRoleWithScopeSerializer(data=request.query_params)
@@ -277,7 +278,7 @@ def get(self, request: HttpRequest) -> Response:
             status.HTTP_401_UNAUTHORIZED: "The user is not authenticated or does not have the required permissions",
         },
     )
-    @authz_permissions(["manage_library_team"])
+    @authz_permissions([permissions.MANAGE_LIBRARY_TEAM.identifier])
     def put(self, request: HttpRequest) -> Response:
         """Assign multiple users to a specific role within a scope."""
         serializer = AddUsersToRoleWithScopeSerializer(data=request.data)
@@ -324,7 +325,7 @@ def put(self, request: HttpRequest) -> Response:
             status.HTTP_401_UNAUTHORIZED: "The user is not authenticated or does not have the required permissions",
         },
     )
-    @authz_permissions(["manage_library_team"])
+    @authz_permissions([permissions.MANAGE_LIBRARY_TEAM.identifier])
     def delete(self, request: HttpRequest) -> Response:
         """Remove multiple users from a specific role within a scope."""
         serializer = RemoveUsersFromRoleWithScopeSerializer(data=request.query_params)
@@ -427,7 +428,7 @@ class RoleListView(APIView):
             status.HTTP_401_UNAUTHORIZED: "The user is not authenticated or does not have the required permissions",
         },
     )
-    @authz_permissions(["view_library_team"])
+    @authz_permissions([permissions.VIEW_LIBRARY.identifier])
     def get(self, request: HttpRequest) -> Response:
         """Retrieve all roles and their permissions for a specific scope."""
         serializer = ListRolesWithScopeSerializer(data=request.query_params)

openedx_authz/tests/api/test_data.py

@@ -17,6 +17,7 @@
     SubjectData,
     UserData,
 )
+from openedx_authz.constants import permissions, roles
 
 
 @ddt
@@ -372,7 +373,7 @@ def test_user_data_str_and_repr(self, external_key, expected_str, expected_repr)
     @data(
         ("read", "Read", "act^read"),
         ("write", "Write", "act^write"),
-        ("delete_library", "Delete Library", "act^delete_library"),
+        (permissions.DELETE_LIBRARY.identifier, "Delete Library", "act^delete_library"),
         ("edit_content", "Edit Content", "act^edit_content"),
     )
     @unpack
@@ -413,7 +414,7 @@ def test_scope_data_str_and_repr(self, external_key, expected_str, expected_repr
 
     @data(
         ("instructor", "Instructor", "role^instructor"),
-        ("library_admin", "Library Admin", "role^library_admin"),
+        (roles.LIBRARY_ADMIN.external_key, "Library Admin", "role^library_admin"),
         ("course_staff", "Course Staff", "role^course_staff"),
     )
     @unpack
@@ -454,7 +455,7 @@ def test_role_data_str_with_permissions(self):
         ("read", "allow", "Read - allow", "act^read => allow"),
         ("write", "deny", "Write - deny", "act^write => deny"),
         (
-            "delete_library",
+            permissions.DELETE_LIBRARY.identifier,
             "allow",
             "Delete Library - allow",
             "act^delete_library => allow",
@@ -485,7 +486,7 @@ def test_role_assignment_data_str(self):
         """
         user = UserData(external_key="john_doe")
         role1 = RoleData(external_key="instructor")
-        role2 = RoleData(external_key="library_admin")
+        role2 = RoleData(external_key=roles.LIBRARY_ADMIN.external_key)
         scope = ContentLibraryData(external_key="lib:DemoX:CSPROB")
         assignment = RoleAssignmentData(subject=user, roles=[role1, role2], scope=scope)
 
@@ -502,7 +503,7 @@ def test_role_assignment_data_repr(self):
         """
         user = UserData(external_key="john_doe")
         role1 = RoleData(external_key="instructor")
-        role2 = RoleData(external_key="library_admin")
+        role2 = RoleData(external_key=roles.LIBRARY_ADMIN.external_key)
         scope = ContentLibraryData(external_key="lib:DemoX:CSPROB")
         assignment = RoleAssignmentData(subject=user, roles=[role1, role2], scope=scope)