scim2-client 0.3.2__py3-none-any.whl → 0.4.0__py3-none-any.whl

scim2_client/__init__.py

@@ -1,5 +1,5 @@
-from .client import BaseSCIMClient
 from .client import BaseSyncSCIMClient
+from .client import SCIMClient
 from .errors import RequestNetworkError
 from .errors import RequestPayloadValidationError
 from .errors import ResponsePayloadValidationError
@@ -12,7 +12,7 @@ from .errors import UnexpectedContentType
 from .errors import UnexpectedStatusCode
 
 __all__ = [
-    "BaseSCIMClient",
+    "SCIMClient",
     "BaseSyncSCIMClient",
     "SCIMClientError",
     "SCIMRequestError",

scim2_client/client.py

@@ -1,4 +1,6 @@
+import asyncio
 import sys
+from collections.abc import Collection
 from dataclasses import dataclass
 from typing import Optional
 from typing import Union
@@ -7,6 +9,7 @@ from pydantic import ValidationError
 from scim2_models import AnyResource
 from scim2_models import Context
 from scim2_models import Error
+from scim2_models import Extension
 from scim2_models import ListResponse
 from scim2_models import PatchOp
 from scim2_models import Resource
@@ -28,6 +31,7 @@ BASE_HEADERS = {
     "Accept": "application/scim+json",
     "Content-Type": "application/scim+json",
 }
+CONFIG_RESOURCES = (ResourceType, Schema, ServiceProviderConfig)
 
 
 @dataclass
@@ -39,15 +43,18 @@ class RequestPayload:
     expected_status_codes: Optional[list[int]] = None
 
 
-class BaseSCIMClient:
+class SCIMClient:
     """The base model for request clients.
 
     It goal is to parse the requests and responses and check if they comply with the SCIM specifications.
 
     This class can be inherited and used as a basis for request engine integration.
 
-    :param resource_models: A tuple of :class:`~scim2_models.Resource` types expected to be handled by the SCIM client.
+    :param resource_models: A collection of :class:`~scim2_models.Resource` models expected to be handled by the SCIM client.
         If a request payload describe a resource that is not in this list, an exception will be raised.
+    :param resource_types: A collection of :class:`~scim2_models.ResourceType` that will be used to guess the
+        server endpoints associated with the resources.
+    :param service_provider_config: An instance of :class:`~scim2_models.ServiceProviderConfig`.
     :param check_request_payload: If :data:`False`,
         :code:`resource` is expected to be a dict that will be passed as-is in the request.
         This value can be overwritten in methods.
@@ -144,40 +151,74 @@ class BaseSCIMClient:
 
     def __init__(
         self,
-        resource_models: Optional[tuple[type[Resource]]] = None,
+        resource_models: Optional[Collection[type[Resource]]] = None,
+        resource_types: Optional[Collection[ResourceType]] = None,
+        service_provider_config: Optional[ServiceProviderConfig] = None,
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         raise_scim_errors: bool = True,
     ):
-        self.resource_models = tuple(
-            set(resource_models or []) | {ResourceType, Schema, ServiceProviderConfig}
-        )
-        self.check_request_payload = True
-        self.check_response_payload = True
-        self.raise_scim_errors = True
+        self.resource_models = tuple(set(resource_models or []) | set(CONFIG_RESOURCES))
+        self.resource_types = resource_types
+        self.service_provider_config = service_provider_config
+        self.check_request_payload = check_request_payload
+        self.check_response_payload = check_response_payload
+        self.raise_scim_errors = raise_scim_errors
+
+    def get_resource_model(self, name: str) -> Optional[type[Resource]]:
+        """Get a registered model by its name or its schema."""
+        for resource_model in self.resource_models:
+            schema = resource_model.model_fields["schemas"].default[0]
+            if schema == name or schema.split(":")[-1] == name:
+                return resource_model
+        return None
 
     def check_resource_model(
         self, resource_model: type[Resource], payload=None
     ) -> None:
-        if resource_model not in self.resource_models:
+        if (
+            resource_model not in self.resource_models
+            and resource_model not in CONFIG_RESOURCES
+        ):
             raise SCIMRequestError(
                 f"Unknown resource type: '{resource_model}'", source=payload
             )
 
     def resource_endpoint(self, resource_model: Optional[type[Resource]]) -> str:
+        """Find the :attr:`~scim2_models.ResourceType.endpoint` associated with a given :class:`~scim2_models.Resource`.
+
+        Internally, it looks if any :paramref:`resource_type <scim2_client.SCIMClient.resource_models>`
+        of the client matches the resource_model by comparing schemas.
+        """
         if resource_model is None:
             return "/"
 
+        if resource_model in (ResourceType, Schema):
+            return f"/{resource_model.__name__}s"
+
         # This one takes no final 's'
         if resource_model is ServiceProviderConfig:
             return "/ServiceProviderConfig"
 
-        try:
-            first_bracket_index = resource_model.__name__.index("[")
-            root_name = resource_model.__name__[:first_bracket_index]
-        except ValueError:
-            root_name = resource_model.__name__
-        return f"/{root_name}s"
+        schema = resource_model.model_fields["schemas"].default[0]
+        for resource_type in self.resource_types or []:
+            if schema == resource_type.schema_:
+                return resource_type.endpoint
+
+        raise SCIMRequestError(f"No ResourceType is matching the schema: {schema}")
+
+    def register_naive_resource_types(self):
+        """Register a *naive* :class:`~scim2_models.ResourceType` for each :paramref:`resource_model <scim2_client.SCIMClient.resource_models>`.
+
+        This fills the :class:`~scim2_models.ResourceType` with generic values.
+        The endpoint is the resource name with a *s* suffix.
+        For instance, the :class:`~scim2_models.User` will have a `/Users` endpoint.
+        """
+        self.resource_types = [
+            ResourceType.from_resource(model)
+            for model in self.resource_models
+            if model not in CONFIG_RESOURCES
+        ]
 
     def check_response(
         self,
@@ -476,8 +517,32 @@ class BaseSCIMClient:
     ) -> Optional[Union[AnyResource, dict]]:
         raise NotImplementedError()
 
-
-class BaseSyncSCIMClient(BaseSCIMClient):
+    def build_resource_models(
+        self, resource_types: Collection[ResourceType], schemas: Collection[Schema]
+    ) -> tuple[type[Resource]]:
+        """Build models from server objects."""
+        resource_types_by_schema = {
+            resource_type.schema_: resource_type for resource_type in resource_types
+        }
+        schema_objs_by_schema = {schema_obj.id: schema_obj for schema_obj in schemas}
+
+        resource_models = []
+        for schema, resource_type in resource_types_by_schema.items():
+            schema_obj = schema_objs_by_schema[schema]
+            model = Resource.from_schema(schema_obj)
+            extensions = []
+            for ext_schema in resource_type.schema_extensions or []:
+                schema_obj = schema_objs_by_schema[ext_schema.schema_]
+                extension = Extension.from_schema(schema_obj)
+                extensions.append(extension)
+            if extensions:
+                model = model[tuple(extensions)]
+            resource_models.append(model)
+
+        return tuple(resource_models)
+
+
+class BaseSyncSCIMClient(SCIMClient):
     """Base class for synchronous request clients."""
 
     def create(
@@ -487,7 +552,7 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.CREATION_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.CREATION_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
@@ -495,11 +560,11 @@ class BaseSyncSCIMClient(BaseSCIMClient):
 
         :param resource: The resource to create
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`SCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request
             library.
 
@@ -535,7 +600,7 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.QUERY_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.QUERY_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
@@ -547,11 +612,11 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         :param resource_model: A :class:`~scim2_models.Resource` subtype or :data:`None`
         :param id: The SCIM id of an object to get, or :data:`None`
         :param search_request: An object detailing the search query parameters.
-        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`SCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request library.
 
         :return:
@@ -607,7 +672,7 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.SEARCH_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.SEARCH_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
@@ -616,11 +681,11 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         :param resource_models: Resource type or union of types expected
             to be read from the response.
         :param search_request: An object detailing the search query parameters.
-        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`SCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -655,7 +720,7 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.DELETION_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.DELETION_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
@@ -663,10 +728,10 @@ class BaseSyncSCIMClient(BaseSCIMClient):
 
         :param resource_model: The type of the resource to delete.
         :param id: The type id the resource to delete.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -693,7 +758,7 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
@@ -701,11 +766,11 @@ class BaseSyncSCIMClient(BaseSCIMClient):
 
         :param resource: The new resource to replace.
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`SCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -733,8 +798,17 @@ class BaseSyncSCIMClient(BaseSCIMClient):
         """
         raise NotImplementedError()
 
+    def discover(self):
+        """Dynamically discover the server models :class:`~scim2_models.Schema` and :class:`~scim2_models.ResourceType`."""
+        resource_types_response = self.query(ResourceType)
+        schemas_response = self.query(Schema)
+        self.service_provider_config = self.query(ServiceProviderConfig)
+        self.resource_types = resource_types_response.resources
+        schemas = schemas_response.resources
+        self.resource_models = self.build_resource_models(self.resource_types, schemas)
+
 
-class BaseAsyncSCIMClient(BaseSCIMClient):
+class BaseAsyncSCIMClient(SCIMClient):
     """Base class for asynchronous request clients."""
 
     async def create(
@@ -744,7 +818,7 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.CREATION_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.CREATION_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
@@ -752,11 +826,11 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
 
         :param resource: The resource to create
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`SCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request
             library.
 
@@ -792,7 +866,7 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.QUERY_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.QUERY_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
@@ -804,11 +878,11 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         :param resource_model: A :class:`~scim2_models.Resource` subtype or :data:`None`
         :param id: The SCIM id of an object to get, or :data:`None`
         :param search_request: An object detailing the search query parameters.
-        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`SCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying HTTP request library.
 
         :return:
@@ -864,7 +938,7 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.SEARCH_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.SEARCH_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
@@ -873,11 +947,11 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         :param resource_models: Resource type or union of types expected
             to be read from the response.
         :param search_request: An object detailing the search query parameters.
-        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`SCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -912,7 +986,7 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.DELETION_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.DELETION_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Optional[Union[Error, dict]]:
@@ -920,10 +994,10 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
 
         :param resource_model: The type of the resource to delete.
         :param id: The type id the resource to delete.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -950,7 +1024,7 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
         check_response_payload: Optional[bool] = None,
         expected_status_codes: Optional[
             list[int]
-        ] = BaseSCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
+        ] = SCIMClient.REPLACEMENT_RESPONSE_STATUS_CODES,
         raise_scim_errors: Optional[bool] = None,
         **kwargs,
     ) -> Union[AnyResource, Error, dict]:
@@ -958,11 +1032,11 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
 
         :param resource: The new resource to replace.
             If is a :data:`dict`, the resource type will be guessed from the schema.
-        :param check_request_payload: If set, overwrites :paramref:`BaseSCIMClient.check_request_payload`.
-        :param check_response_payload: If set, overwrites :paramref:`BaseSCIMClient.check_response_payload`.
+        :param check_request_payload: If set, overwrites :paramref:`SCIMClient.check_request_payload`.
+        :param check_response_payload: If set, overwrites :paramref:`SCIMClient.check_response_payload`.
         :param expected_status_codes: The list of expected status codes form the response.
             If :data:`None` any status code is accepted.
-        :param raise_scim_errors: If set, overwrites :paramref:`BaseSCIMClient.raise_scim_errors`.
+        :param raise_scim_errors: If set, overwrites :paramref:`SCIMClient.raise_scim_errors`.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -989,3 +1063,15 @@ class BaseAsyncSCIMClient(BaseSCIMClient):
             the response payload.
         """
         raise NotImplementedError()
+
+    async def discover(self):
+        """Dynamically discover the server models :class:`~scim2_models.Schema` and :class:`~scim2_models.ResourceType`."""
+        resources_task = asyncio.create_task(self.query(ResourceType))
+        schemas_task = asyncio.create_task(self.query(Schema))
+        spc_task = asyncio.create_task(self.query(ServiceProviderConfig))
+        resource_types_response = await resources_task
+        schemas_response = await schemas_task
+        self.service_provider_config = await spc_task
+        self.resource_types = resource_types_response.resources
+        schemas = schemas_response.resources
+        self.resource_models = self.build_resource_models(self.resource_types, schemas)

scim2_client/engines/werkzeug.py

@@ -1,3 +1,4 @@
+import json
 from contextlib import contextmanager
 from typing import Optional
 from typing import Union
@@ -13,6 +14,7 @@ from werkzeug.test import Client
 
 from scim2_client.client import BaseSyncSCIMClient
 from scim2_client.errors import SCIMClientError
+from scim2_client.errors import UnexpectedContentFormat
 
 
 @contextmanager
@@ -20,6 +22,9 @@ def handle_response_error(response):
     try:
         yield
 
+    except json.decoder.JSONDecodeError as exc:
+        raise UnexpectedContentFormat(source=response) from exc
+
     except SCIMClientError as exc:
         exc.source = response
         raise exc
@@ -58,6 +63,9 @@ class TestSCIMClient(BaseSyncSCIMClient):
         assert response_user.user_name == "foo"
     """
 
+    # avoid making Pytest believe this is a test class
+    __test__ = False
+
     def __init__(self, app, *args, scim_prefix: str = "", **kwargs):
         super().__init__(*args, **kwargs)
         self.client = Client(app)

scim2_client/errors.py

@@ -35,7 +35,7 @@ class RequestNetworkError(SCIMRequestError):
 
 
 class RequestPayloadValidationError(SCIMRequestError):
-    """Error raised when an invalid request payload has been passed to BaseSCIMClient.
+    """Error raised when an invalid request payload has been passed to SCIMClient.
 
     This error is raised when a :class:`pydantic.ValidationError` has been caught
     while validating the client request payload.

{scim2_client-0.3.2.dist-info → scim2_client-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-client
-Version: 0.3.2
+Version: 0.4.0
 Summary: Pythonically build SCIM requests and parse SCIM responses
 Project-URL: documentation, https://scim2-client.readthedocs.io
 Project-URL: repository, https://github.com/python-scim/scim2-client
@@ -234,7 +234,7 @@ Description-Content-Type: text/markdown
 A SCIM client Python library built upon [scim2-models](https://scim2-models.readthedocs.io) ,
 that pythonically build requests and parse responses,
 following the [RFC7643](https://datatracker.ietf.org/doc/html/rfc7643.html) and [RFC7644](https://datatracker.ietf.org/doc/html/rfc7644.html) specifications.
-You can use whatever request engine you prefer to perform network requests, but scim2-models comes with [httpx](https://github.com/encode/httpx) support.
+You can use whatever request engine you prefer to perform network requests, but scim2-client comes with [httpx](https://github.com/encode/httpx) support.
 
 It aims to be used in SCIM client applications, or in unit tests for SCIM server applications.
 
@@ -253,21 +253,24 @@ pip install scim2-client[httpx]
 
 ## Usage
 
-Check the [tutorial](https://scim2-client.readthedocs.io/en/latest/tutorial.html) and the [reference](https://scim2-client.readthedocs.io/en/latest/reference.html) for more details.
+Check the [tutorial](https://scim2-client.readthedocs.io/en/latest/tutorial.html)
+and the [reference](https://scim2-client.readthedocs.io/en/latest/reference.html) for more details.
 
 Here is an example of usage:
 
 ```python
 import datetime
 from httpx import Client
-from scim2_models import User, EnterpriseUser, Group, Error
+from scim2_models import Error
 from scim2_client.engines.httpx import SyncSCIMClient
 
 client = Client(base_url="https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
-scim = SyncSCIMClient(client, resource_types=(User[EnterpriseUser], Group))
+scim = SyncSCIMClient(client)
+scim.discover()
+User = scim.get_resource_model("User")
 
 # Query resources
-user = scim.query(User[EnterpriseUser], "2819c223-7f76-453a-919d-413861904646")
+user = scim.query(User, "2819c223-7f76-453a-919d-413861904646")
 assert user.user_name == "bjensen@example.com"
 assert user.meta.last_updated == datetime.datetime(
     2024, 4, 13, 12, 0, 0, tzinfo=datetime.timezone.utc

scim2_client-0.4.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+scim2_client/__init__.py,sha256=l0pyBLiTpFA68ao98PqQLT_Xx0mw8BHumwrIHYCWa_M,845
+scim2_client/client.py,sha256=oS5ZVvQ-z9wfY-xjGTXxVjZZ9tAb8BvEAXH_eBdhBGE,44077
+scim2_client/errors.py,sha256=FVmRXsaZLn1VZhJ3dSDs4IqycuU92AEun9JWWMseVO8,4397
+scim2_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scim2_client/engines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scim2_client/engines/httpx.py,sha256=L39ZZHjqe43uIQpgh_r_maqM2gkf3_Rk6d8MeNe57gk,17781
+scim2_client/engines/werkzeug.py,sha256=vWBITiF0FMEy1NXBBDCc5Y49CzQuztPURh2yurFyyMo,10096
+scim2_client-0.4.0.dist-info/METADATA,sha256=_fzzrIeYimg6g6sTq3ltewSWJFUHqootg-zsxJ5el-c,16961
+scim2_client-0.4.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+scim2_client-0.4.0.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+scim2_client-0.4.0.dist-info/RECORD,,

scim2_client-0.3.2.dist-info/RECORD

@@ -1,11 +0,0 @@
-scim2_client/__init__.py,sha256=KpNDJW9e2WseqSsQ6FltkQzemHM52NACfpJTd3eSIuY,853
-scim2_client/client.py,sha256=C45mWwWlesXv7zdANmDf9psz3JczV02cI7Pc6becg3M,39742
-scim2_client/errors.py,sha256=mxjUvarjvX3797w2NzdLqc6zxCQZlOga8cYABWpUAXM,4401
-scim2_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scim2_client/engines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scim2_client/engines/httpx.py,sha256=L39ZZHjqe43uIQpgh_r_maqM2gkf3_Rk6d8MeNe57gk,17781
-scim2_client/engines/werkzeug.py,sha256=s7BV8CEbLewnkF0EAsF-3J3khOhaT7CkEN9v230ZA8w,9838
-scim2_client-0.3.2.dist-info/METADATA,sha256=Zu2tIFT443yoDOKu2AjAtBSWxRB1x9WXqpf1GM0Af0w,16997
-scim2_client-0.3.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-scim2_client-0.3.2.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-scim2_client-0.3.2.dist-info/RECORD,,