[FC-0099] refactor: update content library permissions to use namespaced identifiers (#142)

Author: BryanttV

CHANGELOG.rst

@@ -14,6 +14,19 @@ Change Log
 Unreleased
 **********
 
+*
+
+0.16.0 - 2025-11-13
+********************
+
+Changed
+=======
+
+* **BREAKING**: Update permission format to include app namespace prefix.
+
+Added
+=====
+
 * Register ``CasbinRule`` model in the Django admin.
 * Register ``ExtendedCasbinRule`` model in the Django admin as an inline model of ``CasbinRule``.
 

docs/concepts/core_roles_and_permissions/content_library_roles.rst

@@ -28,46 +28,46 @@ The following permissions are associated with the content library roles:
 Library Permissions
 =======================
 
-- **View the library** (``view_library``): Allows users to view the content library.
-- **Manage library tags** (``manage_library_tags``): Allows users to manage the tags associated with library items.
-- **Delete the library** (``delete_library``): Allows users to delete the entire content library.
+- **View the library** (``content_libraries.view_library``): Allows users to view the content library.
+- **Manage library tags** (``content_libraries.manage_library_tags``): Allows users to manage the tags associated with library items.
+- **Delete the library** (``content_libraries.delete_library``): Allows users to delete the entire content library.
 
 
 Library Content Permissions
 ===============================
 
-- **Edit library content** (``edit_library_content``): Allows users to edit existing content within the library.
-- **Publish library content** (``publish_library_content``): Allows users to publish content to or from the library.
-- **Reuse library content** (``reuse_library_content``): Allows users to reuse content from the library in other contexts.
+- **Edit library content** (``content_libraries.edit_library_content``): Allows users to edit existing content within the library.
+- **Publish library content** (``content_libraries.publish_library_content``): Allows users to publish content to or from the library.
+- **Reuse library content** (``content_libraries.reuse_library_content``): Allows users to reuse content from the library in other contexts.
 
 
 Library Team Permissions
 =============================
 
-- **View the library team** (``view_library_team``): Allows users to view the list of users or roles associated with the library.
-- **Manage the library team** (``manage_library_team``): Allows users to add, remove, or change the roles of users in the library team.
+- **View the library team** (``content_libraries.view_library_team``): Allows users to view the list of users or roles associated with the library.
+- **Manage the library team** (``content_libraries.manage_library_team``): Allows users to add, remove, or change the roles of users in the library team.
 
 
 Library Collections Permissions
 ===================================
 
-- **Create library collections** (``create_library_collection``): Allows users to create new collections within the library.
-- **Edit library collections** (``edit_library_collection``): Allows users to modify existing collections within the library.
-- **Delete library collections** (``delete_library_collection``): Allows users to delete collections within the library.
+- **Create library collections** (``content_libraries.create_library_collection``): Allows users to create new collections within the library.
+- **Edit library collections** (``content_libraries.edit_library_collection``): Allows users to modify existing collections within the library.
+- **Delete library collections** (``content_libraries.delete_library_collection``): Allows users to delete collections within the library.
 
 Permissions Inheritance
 ========================
 
-* **Managing library tags** (``manage_library_tags``) implies **editing library content** (``edit_library_content``).
-* **Deleting the library** (``delete_library``) implies **editing library content** (``edit_library_content``).
-* **Publishing library content** (``publish_library_content``) implies **editing library content** (``edit_library_content``).
-* **Editing library content** (``edit_library_content``) implies **viewing the library** (``view_library``).
-* **Reusing library content** (``reuse_library_content``) implies **viewing the library** (``view_library``).
-* **Publishing library content** (``publish_library_content``) implies **viewing the library** (``view_library``).
-* **Managing the library team** (``manage_library_team``) implies **viewing the library team** (``view_library_team``).
-* **Deleting a library collection** (``delete_library_collection``) implies **editing a library collection** (``edit_library_collection``).
-* **Creating a library collection** (``create_library_collection``) implies **editing a library collection** (``edit_library_collection``).
-* **Editing a library collection** (``edit_library_collection``) implies **viewing the library** (``view_library``).
+* **Managing library tags** (``content_libraries.manage_library_tags``) implies **editing library content** (``content_libraries.edit_library_content``).
+* **Deleting the library** (``content_libraries.delete_library``) implies **editing library content** (``content_libraries.edit_library_content``).
+* **Publishing library content** (``content_libraries.publish_library_content``) implies **editing library content** (``content_libraries.edit_library_content``).
+* **Editing library content** (``content_libraries.edit_library_content``) implies **viewing the library** (``content_libraries.view_library``).
+* **Reusing library content** (``content_libraries.reuse_library_content``) implies **viewing the library** (``content_libraries.view_library``).
+* **Publishing library content** (``content_libraries.publish_library_content``) implies **viewing the library** (``content_libraries.view_library``).
+* **Managing the library team** (``content_libraries.manage_library_team``) implies **viewing the library team** (``content_libraries.view_library_team``).
+* **Deleting a library collection** (``content_libraries.delete_library_collection``) implies **editing a library collection** (``content_libraries.edit_library_collection``).
+* **Creating a library collection** (``content_libraries.create_library_collection``) implies **editing a library collection** (``content_libraries.edit_library_collection``).
+* **Editing a library collection** (``content_libraries.edit_library_collection``) implies **viewing the library** (``content_libraries.view_library``).
 
 
 Roles and Permissions Summary Table
@@ -76,25 +76,29 @@ Roles and Permissions Summary Table
 .. table:: Matrix of Content Library Roles and Permissions
    :widths: auto
 
-   ============================= ================= ================ ===================== ==============
-   Permissions                   Library Admin     Library Author   Library Contributor   Library User
-   ============================= ================= ================ ===================== ==============
+   ============================================= ================= ================ ===================== ==============
+   Permissions                                   Library Admin     Library Author   Library Contributor   Library User
+   ============================================= ================= ================ ===================== ==============
    **Library**
-   view_library                  ✅                 ✅                ✅                      ✅
-   manage_library_tags           ✅                 ✅                ✅                      ❌
-   delete_library                ✅                 ❌                ❌                      ❌
+   --------------------------------------------- ----------------- ---------------- --------------------- --------------
+   content_libraries.view_library                ✅                ✅               ✅                    ✅
+   content_libraries.manage_library_tags         ✅                ✅               ✅                    ❌
+   content_libraries.delete_library              ✅                ❌               ❌                    ❌
    **Content**
-   edit_library_content          ✅                 ✅                ✅                      ❌
-   publish_library_content       ✅                 ✅                ❌                      ❌
-   reuse_library_content         ✅                 ✅                ✅                      ✅
+   --------------------------------------------- ----------------- ---------------- --------------------- --------------
+   content_libraries.edit_library_content        ✅                ✅               ✅                    ❌
+   content_libraries.publish_library_content     ✅                ✅               ❌                    ❌
+   content_libraries.reuse_library_content       ✅                ✅               ✅                    ✅
    **Team**
-   view_library_team             ✅                 ✅                ✅                      ✅
-   manage_library_team           ✅                 ❌                ❌                      ❌
+   --------------------------------------------- ----------------- ---------------- --------------------- --------------
+   content_libraries.view_library_team           ✅                ✅               ✅                    ✅
+   content_libraries.manage_library_team         ✅                ❌               ❌                    ❌
    **Collections**
-   create_library_collection     ✅                 ✅                ✅                      ❌
-   edit_library_collection       ✅                 ✅                ✅                      ❌
-   delete_library_collection     ✅                 ✅                ✅                      ❌
-   ============================= ================= ================ ===================== ==============
+   --------------------------------------------- ----------------- ---------------- --------------------- --------------
+   content_libraries.create_library_collection   ✅                ✅               ✅                    ❌
+   content_libraries.edit_library_collection     ✅                ✅               ✅                    ❌
+   content_libraries.delete_library_collection   ✅                ✅               ✅                    ❌
+   ============================================= ================= ================ ===================== ==============
 
 
 **Maintenance chart**

openedx_authz/__init__.py

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

openedx_authz/api/data.py

@@ -600,31 +600,32 @@ class ActionData(AuthZData):
 
     Attributes:
         NAMESPACE: 'act' for actions.
-        external_key: The action identifier (e.g., 'read', 'write', 'delete_library').
-        namespaced_key: The action identifier with namespace (e.g., 'act^read', 'act^delete_library').
-        name: Property that returns a human-readable action name (e.g., 'Read', 'Delete Library').
+        external_key: The action identifier (e.g., 'content_libraries.view_library').
+        namespaced_key: The action identifier with namespace (e.g., 'act^content_libraries.view_library').
+        name: Property that returns a human-readable action name (e.g., 'Content Libraries > View Library').
 
     Examples:
-        >>> action = ActionData(external_key='delete_library')
+        >>> action = ActionData(external_key='content_libraries.delete_library')
         >>> action.namespaced_key
-        'act^delete_library'
+        'act^content_libraries.delete_library'
         >>> action.name
-        'Delete Library'
+        'Content Libraries > Delete Library'
     """
 
     NAMESPACE: ClassVar[str] = "act"
 
     @property
     def name(self) -> str:
-        """The human-readable name of the action (e.g., 'Delete Library', 'Edit Content').
+        """The human-readable name of the action (e.g., 'Content Libraries > Delete Library').
 
         This property transforms the external_key into a human-readable display name
-        by replacing underscores with spaces and capitalizing each word.
+        by replacing dots with ' > ' and capitalizing each word.
 
         Returns:
-            str: The human-readable action name (e.g., 'Delete Library').
+            str: The human-readable action name (e.g., 'Content Libraries > Delete Library').
         """
-        return self.external_key.replace("_", " ").title()
+        parts = self.external_key.split(".")
+        return " > ".join(part.replace("_", " ").title() for part in parts)
 
     def __str__(self):
         """Human readable string representation of the action."""
@@ -665,7 +666,7 @@ def identifier(self) -> str:
         """Get the permission identifier.
 
         Returns:
-            str: The permission identifier (e.g., 'delete_library').
+            str: The permission identifier (e.g., 'content_libraries.delete_library').
         """
         return self.action.external_key
 
@@ -753,7 +754,8 @@ def get_permission_identifiers(self) -> list[str]:
         """Get the technical identifiers for all permissions in this role.
 
         Returns:
-            list[str]: Permission identifiers (e.g., ['delete_library', 'edit_content']).
+            list[str]: Permission identifiers
+                (e.g., ['content_libraries.delete_library', 'content_libraries.edit_library_content']).
         """
         return [permission.identifier for permission in self.permissions]
 

openedx_authz/constants/permissions.py

@@ -5,48 +5,51 @@
 from openedx_authz.api.data import ActionData, PermissionData
 
 # Content Library Permissions
+
+CONTENT_LIBRARIES_NAMESPACE = "content_libraries"
+
 VIEW_LIBRARY = PermissionData(
-    action=ActionData(external_key="view_library"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.view_library"),
     effect="allow",
 )
 MANAGE_LIBRARY_TAGS = PermissionData(
-    action=ActionData(external_key="manage_library_tags"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.manage_library_tags"),
     effect="allow",
 )
 DELETE_LIBRARY = PermissionData(
-    action=ActionData(external_key="delete_library"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.delete_library"),
     effect="allow",
 )
 EDIT_LIBRARY_CONTENT = PermissionData(
-    action=ActionData(external_key="edit_library_content"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.edit_library_content"),
     effect="allow",
 )
 PUBLISH_LIBRARY_CONTENT = PermissionData(
-    action=ActionData(external_key="publish_library_content"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.publish_library_content"),
     effect="allow",
 )
 REUSE_LIBRARY_CONTENT = PermissionData(
-    action=ActionData(external_key="reuse_library_content"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.reuse_library_content"),
     effect="allow",
 )
 VIEW_LIBRARY_TEAM = PermissionData(
-    action=ActionData(external_key="view_library_team"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.view_library_team"),
     effect="allow",
 )
 MANAGE_LIBRARY_TEAM = PermissionData(
-    action=ActionData(external_key="manage_library_team"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.manage_library_team"),
     effect="allow",
 )
 
 CREATE_LIBRARY_COLLECTION = PermissionData(
-    action=ActionData(external_key="create_library_collection"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.create_library_collection"),
     effect="allow",
 )
 EDIT_LIBRARY_COLLECTION = PermissionData(
-    action=ActionData(external_key="edit_library_collection"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.edit_library_collection"),
     effect="allow",
 )
 DELETE_LIBRARY_COLLECTION = PermissionData(
-    action=ActionData(external_key="delete_library_collection"),
+    action=ActionData(external_key=f"{CONTENT_LIBRARIES_NAMESPACE}.delete_library_collection"),
     effect="allow",
 )