scim2-server 0.6.1__tar.gz → 0.6.2__tar.gz

{scim2_server-0.6.1 → scim2_server-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-server
-Version: 0.6.1
+Version: 0.6.2
 Summary: SCIM server core for any storage and web framework
 Keywords: scim,scim2,provisioning,rfc7643,rfc7644
 Author: Yaal Coop, Christian Friedrich Coors
@@ -217,7 +217,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Environment :: Web Environment
 Classifier: Programming Language :: Python
 Classifier: Operating System :: OS Independent
-Requires-Dist: scim2-models>=0.10.3
+Requires-Dist: scim2-models>=0.10.6
 Requires-Dist: pytest>=9.1.1 ; extra == 'testing'
 Requires-Python: >=3.11
 Project-URL: repository, https://github.com/python-scim/scim2-server

{scim2_server-0.6.1 → scim2_server-0.6.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "scim2-server"
-version = "0.6.1"
+version = "0.6.2"
 description = "SCIM server core for any storage and web framework"
 readme = "README.md"
 keywords = [
@@ -28,7 +28,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 requires-python = ">= 3.11"
-dependencies = ["scim2-models>=0.10.3"]
+dependencies = ["scim2-models>=0.10.6"]
 
 [[project.authors]]
 name = "Yaal Coop"

{scim2_server-0.6.1 → scim2_server-0.6.2}/pyproject.toml.orig

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "scim2-server"
-version = "0.6.1"
+version = "0.6.2"
 description = "SCIM server core for any storage and web framework"
 authors = [
     {name="Yaal Coop", email="contact@yaal.coop"},
@@ -29,7 +29,7 @@ classifiers = [
 
 requires-python = ">= 3.11"
 dependencies = [
-    "scim2-models>=0.10.3",
+    "scim2-models>=0.10.6",
 ]
 
 [project.optional-dependencies]

{scim2_server-0.6.1 → scim2_server-0.6.2}/scim2_server/service.py

@@ -5,6 +5,7 @@ from typing import Any
 from typing import TypeVar
 from typing import Union
 from typing import cast
+from urllib.parse import urlsplit
 
 from pydantic import ValidationError
 from pydantic_core import from_json
@@ -28,7 +29,9 @@ from scim2_models import NotFoundException
 from scim2_models import NotImplementedException
 from scim2_models import Patch
 from scim2_models import PatchOp
+from scim2_models import Path
 from scim2_models import PayloadTooLargeException
+from scim2_models import Reference
 from scim2_models import Resource
 from scim2_models import ResourceType
 from scim2_models import ResponseParameters
@@ -512,11 +515,28 @@ class ScimService:
             f"{base_url.rstrip('/')}/{resource_type.endpoint.strip('/')}/{resource_id}"
         )
 
+    def reference_location(self, base_url: str, reference: str) -> str:
+        """Return the URL of a reference to a resource.
+
+        A reference relative to the SCIM root, such as ``Users/2819c223``,
+        becomes the location of the resource
+        (:rfc:`RFC 7643 §2.3.7 <7643#section-2.3.7>`). Absolute references
+        are kept.
+        """
+        if urlsplit(reference).scheme or reference.startswith("/"):
+            return reference
+        endpoint, _, resource_id = reference.rpartition("/")
+        resource_type = self.get_resource_type_by_endpoint(endpoint)
+        if resource_type is None or not resource_id:
+            return f"{base_url.rstrip('/')}/{reference}"
+        return self.resource_location(base_url, resource_type, resource_id)
+
     def publish(self, base_url: str, resource: Resource[Any]) -> Resource[Any]:
         """Return a copy of a stored resource in the form sent to the client.
 
-        Its location is set, and its version is left out when the service does
-        not support ETags.
+        Its location is set, its references to other resources become URLs
+        with :meth:`reference_location`, and its version is left out when the
+        service does not support ETags.
         """
         assert resource.meta is not None
         assert resource.id is not None
@@ -527,9 +547,41 @@ class ScimService:
         }
         if not self.etag_supported:
             update["version"] = None
-        return resource.model_copy(
-            update={"meta": resource.meta.model_copy(update=update)}
-        )
+        published = resource.model_copy(deep=True)
+        published.meta = resource.meta.model_copy(update=update)
+        self._publish_references(base_url, published)
+        return published
+
+    def _publish_references(self, base_url: str, resource: Resource[Any]) -> None:
+        """Replace in place the references of a resource to other resources by their URLs."""
+
+        def locate(reference: Any) -> Any:
+            if isinstance(reference, list):
+                return [locate(item) for item in reference]
+            if reference is None:
+                return None
+            return self.reference_location(base_url, reference)
+
+        for path in parametrize(Path, type(resource)).iter_paths(
+            target_type=[Reference]
+        ):
+            binding = path.resolve()
+            assert binding is not None
+            target_type = cast(type[Reference[Any]], binding.target_type)
+            reference_types = set(target_type.__reference_types__)
+            if not reference_types or reference_types & {"external", "uri"}:
+                continue
+
+            if binding.sub_field_name is None:
+                path.set(resource, locate(path.get(resource)), strict=False)
+                continue
+
+            head = f"{path.schema}:{path.parts[0]}" if path.schema else path.parts[0]
+            entries = Path(head).get(resource)
+            for entry in entries if isinstance(entries, list) else [entries]:
+                if entry is not None:
+                    reference = getattr(entry, binding.sub_field_name)
+                    setattr(entry, binding.sub_field_name, locate(reference))
 
     @staticmethod
     def resource_response(

{scim2_server-0.6.1 → scim2_server-0.6.2}/scim2_server/storage.py

@@ -26,7 +26,9 @@ class ScimStorage(ABC):
       stored resource, and the resources it receives are not changed either.
     - It fills ``id``, ``meta.resourceType``, ``meta.created``,
       ``meta.lastModified`` and ``meta.version``. It leaves ``meta.location``
-      to the server, which knows the URLs.
+      to the server, which knows the URLs. For the same reason, a reference
+      to another resource, such as ``members.$ref``, can be relative to the
+      SCIM root, such as ``Users/2819c223``. The server returns its URL.
     - The version changes whenever the resource changes. An update that
       changes nothing may keep it.
     - A resource that does not exist raises