add access levels and public groups

Author: MBueschelberger

dsms/core/configuration.py

@@ -43,7 +43,33 @@ class Loglevel(Enum):
     WARNING = logging.WARNING
 
 
-class Configuration(BaseSettings):
+class BaseConfiguration(BaseSettings):
+    """Base Configuration for DSMS-SDK"""
+
+    label_internally_public: str = Field(
+        "Internally Public",
+        description="Label to use for KItems marked as `internally_public`.",
+    )
+
+    label_externally_public: str = Field(
+        "Externally Public",
+        description="Label to use for KItems marked as `externally_public`.",
+    )
+
+    id_internally_public: str = Field(
+        "dsms:internally-public",
+        description="ID to use for KItems marked as `internally_public`.",
+    )
+
+    id_externally_public: str = Field(
+        "dsms:externally-public",
+        description="ID to use for KItems marked as `externally_public`.",
+    )
+
+    model_config = ConfigDict(use_enum_values=True)
+
+
+class Configuration(BaseConfiguration):
     """General config for DSMS-SDK"""
 
     host_url: AnyUrl = Field(

dsms/knowledge/groups/__init__.py

@@ -0,0 +1,6 @@
+"""DSMS User Groups Module."""
+
+from .models import Group, GroupList, GroupListBase
+from .public import INTERNALLY_PUBLIC_GROUP, EXTERNALLY_PUBLIC_GROUP
+
+__all__ = ["Group", "GroupList", "GroupListBase", "INTERNALLY_PUBLIC_GROUP", "EXTERNALLY_PUBLIC_GROUP"]

dsms/knowledge/groups.py dsms/knowledge/groups/models.pydsms/knowledge/groups.py renamed to dsms/knowledge/groups/models.py

@@ -1,6 +1,5 @@
 """DSMS User Groups Module."""
 
-from enum import Enum
 from typing import List, Optional
 
 import yaml
@@ -9,13 +8,6 @@
 from dsms.core.session import Session
 
 
-class PublicGroupType(str, Enum):
-    """Enumeration for Public Group Types."""
-
-    INTERNAL = "dsms:internally-public"
-    EXTERNAL = "dsms:externally-public"
-
-
 class User(BaseModel):
     """User Model"""
 
@@ -76,3 +68,7 @@ def _flatten(groups: List[Group]):
 
 
 Group.model_rebuild()
+interally_public = Group(id="dsms:internally_public", name="Internally Public")
+externally_public = Group(
+    id="dsms:externally_public", name="Externally Public"
+)

dsms/knowledge/groups/public.py

@@ -0,0 +1,31 @@
+"""DSMS Public User Groups Module."""
+
+from .models import Group
+
+from dsms.core.session import Session
+from dsms.core.configuration import BaseConfiguration
+
+
+if not Session.dsms:
+    config = BaseConfiguration()
+else:
+    config = Session.dsms.config
+
+# The internally/externally public group objects will generally 
+# be served by the user-service, but we define them here for uniquely 
+# setting the ids and names in a common place.
+# They can be adapted through environment variables anyway.
+# A common place is needed because the group objects are used in various places
+# such as internally within the knowledge service, the user service, and the SDK itself.
+# If the IDs and names of these public groups are only delivered in the user service,
+# we cannot distinguish them from the ones which come from keycloak - indicating only organizational groups.
+
+INTERNALLY_PUBLIC_GROUP = Group(
+    id=config.id_internally_public,
+    name=config.label_internally_public,
+)
+
+EXTERNALLY_PUBLIC_GROUP = Group(
+    id=config.id_externally_public,
+    name=config.label_externally_public,
+)

dsms/knowledge/properties/access.py

@@ -52,22 +52,18 @@ def get_operations(cls, role: Role) -> List[OperationType]:
     def min_access_level(cls, operation: OperationType) -> Role:
         """Get minimum role required for an operation"""
         return min(
-            [
-                role.value
-                for role in Role
-                if operation in cls.get_operations(role)
-            ]
+            role.value
+            for role in Role
+            if operation in cls.get_operations(role)
         )
 
     @classmethod
     def max_access_level(cls, operation: OperationType) -> Role:
         """Get maximum role required for an operation"""
         return max(
-            [
-                role.value
-                for role in Role
-                if operation in cls.get_operations(role)
-            ]
+            role.value
+            for role in Role
+            if operation in cls.get_operations(role)
         )