scim2-client 0.1.5__tar.gz → 0.1.7__tar.gz

{scim2_client-0.1.5 → scim2_client-0.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scim2-client
-Version: 0.1.5
+Version: 0.1.7
 Summary: Pythonically build SCIM requests and parse SCIM responses
 License: MIT
 Keywords: scim,scim2,provisioning,httpx,api
@@ -20,7 +20,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Dist: httpx (>=0.27.0,<0.28.0)
-Requires-Dist: scim2-models (>=0.1.5,<0.2.0)
+Requires-Dist: scim2-models (>=0.1.8,<0.2.0)
 Description-Content-Type: text/markdown
 
 # scim2-client
@@ -67,9 +67,9 @@ assert user.meta.last_updated == datetime.datetime(
 )
 
 # Update resources
-user.display_name = "Babes Jensen"
+user.display_name = "Babs Jensen"
 user = scim.replace(user)
-assert user.display_name == "Babes Jensen"
+assert user.display_name == "Babs Jensen"
 assert user.meta.last_updated == datetime.datetime(
     2024, 4, 13, 12, 0, 30, tzinfo=datetime.timezone.utc
 )

{scim2_client-0.1.5 → scim2_client-0.1.7}/README.md

@@ -42,9 +42,9 @@ assert user.meta.last_updated == datetime.datetime(
 )
 
 # Update resources
-user.display_name = "Babes Jensen"
+user.display_name = "Babs Jensen"
 user = scim.replace(user)
-assert user.display_name == "Babes Jensen"
+assert user.display_name == "Babs Jensen"
 assert user.meta.last_updated == datetime.datetime(
     2024, 4, 13, 12, 0, 30, tzinfo=datetime.timezone.utc
 )

{scim2_client-0.1.5 → scim2_client-0.1.7}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "scim2-client"
-version = "0.1.5"
+version = "0.1.7"
 description = "Pythonically build SCIM requests and parse SCIM responses"
 authors = ["Yaal Coop <contact@yaal.coop>"]
 license = "MIT"
@@ -27,7 +27,7 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.9"
 httpx = "^0.27.0"
-scim2-models = "^0.1.5"
+scim2-models = "^0.1.8"
 
 [tool.poetry.group.doc]
 optional = true
@@ -38,10 +38,10 @@ pytest-coverage = "^0.0"
 pytest-httpserver = "^1.0.10"
 
 [tool.poetry.group.doc.dependencies]
+autodoc-pydantic = "^2.2.0"
+myst-parser = "^3.0.1"
 shibuya = "^2024.5.15"
 sphinx = "^7.3.7"
-myst-parser = "^3.0.1"
-autodoc-pydantic = "^2.2.0"
 
 [tool.coverage.run]
 source = [

{scim2_client-0.1.5 → scim2_client-0.1.7}/scim2_client/__init__.py

@@ -5,6 +5,7 @@ from .errors import ResponsePayloadValidationError
 from .errors import SCIMClientError
 from .errors import SCIMRequestError
 from .errors import SCIMResponseError
+from .errors import SCIMResponseErrorObject
 from .errors import UnexpectedContentFormat
 from .errors import UnexpectedContentType
 from .errors import UnexpectedStatusCode
@@ -14,6 +15,7 @@ __all__ = [
     "SCIMClientError",
     "SCIMRequestError",
     "SCIMResponseError",
+    "SCIMResponseErrorObject",
     "UnexpectedContentFormat",
     "UnexpectedContentType",
     "UnexpectedStatusCode",

{scim2_client-0.1.5 → scim2_client-0.1.7}/scim2_client/client.py

@@ -1,5 +1,6 @@
 import json
 import json.decoder
+import sys
 from typing import Dict
 from typing import List
 from typing import Optional
@@ -28,6 +29,7 @@ from .errors import ResponsePayloadValidationError
 from .errors import SCIMClientError
 from .errors import SCIMRequestError
 from .errors import SCIMResponseError
+from .errors import SCIMResponseErrorObject
 from .errors import UnexpectedContentFormat
 from .errors import UnexpectedContentType
 from .errors import UnexpectedStatusCode
@@ -61,12 +63,18 @@ class SCIMClient:
         404,
         500,
     ]
-    """Resource creation HTTP codes defined at :rfc:`RFC7644 §3.3
-    <7644#section-3.3>` and :rfc:`RFC7644 §3.12 <7644#section-3.12>`"""
+    """Resource creation HTTP codes.
+
+    As defined at :rfc:`RFC7644 §3.3 <7644#section-3.3>` and
+    :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
+    """
 
     QUERY_RESPONSE_STATUS_CODES: List[int] = [200, 400, 307, 308, 401, 403, 404, 500]
-    """Resource querying HTTP codes defined at :rfc:`RFC7644 §3.4.2
-    <7644#section-3.4.2>` and :rfc:`RFC7644 §3.12 <7644#section-3.12>`"""
+    """Resource querying HTTP codes.
+
+    As defined at :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2>` and
+    :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
+    """
 
     SEARCH_RESPONSE_STATUS_CODES: List[int] = [
         200,
@@ -81,8 +89,11 @@ class SCIMClient:
         500,
         501,
     ]
-    """Resource querying HTTP codes defined at :rfc:`RFC7644 §3.4.3
-    <7644#section-3.4.3>` and :rfc:`RFC7644 §3.12 <7644#section-3.12>`"""
+    """Resource querying HTTP codes.
+
+    As defined at :rfc:`RFC7644 §3.4.3 <7644#section-3.4.3>` and
+    :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
+    """
 
     DELETION_RESPONSE_STATUS_CODES: List[int] = [
         204,
@@ -96,8 +107,11 @@ class SCIMClient:
         500,
         501,
     ]
-    """Resource deletion HTTP codes defined at :rfc:`RFC7644 §3.6
-    <7644#section-3.6>` and :rfc:`RFC7644 §3.12 <7644#section-3.12>`"""
+    """Resource deletion HTTP codes.
+
+    As defined at :rfc:`RFC7644 §3.6 <7644#section-3.6>` and
+    :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
+    """
 
     REPLACEMENT_RESPONSE_STATUS_CODES: List[int] = [
         200,
@@ -112,8 +126,11 @@ class SCIMClient:
         500,
         501,
     ]
-    """Resource querying HTTP codes defined at :rfc:`RFC7644 §3.4.2
-    <7644#section-3.4.2>` and :rfc:`RFC7644 §3.12 <7644#section-3.12>`"""
+    """Resource querying HTTP codes.
+
+    As defined at :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2>` and
+    :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
+    """
 
     def __init__(self, client: Client, resource_types: Optional[Tuple[Type]] = None):
         self.client = client
@@ -146,6 +163,7 @@ class SCIMClient:
         expected_status_codes: List[int],
         expected_types: Optional[Type] = None,
         check_response_payload: bool = True,
+        raise_scim_errors: bool = False,
         scim_ctx: Optional[Context] = None,
     ):
         if expected_status_codes and response.status_code not in expected_status_codes:
@@ -178,10 +196,14 @@ class SCIMClient:
         if not check_response_payload:
             return response_payload
 
-        try:
-            return Error.model_validate(response_payload)
-        except ValidationError:
-            pass
+        if (
+            response_payload
+            and response_payload.get("schemas") == Error.model_fields["schemas"].default
+        ):
+            error = Error.model_validate(response_payload)
+            if raise_scim_errors:
+                raise SCIMResponseErrorObject(source=error)
+            return error
 
         if not expected_types:
             return response_payload
@@ -206,7 +228,7 @@ class SCIMClient:
             return actual_type.model_validate(response_payload, scim_ctx=scim_ctx)
         except ValidationError as exc:
             scim_exc = ResponsePayloadValidationError(source=response)
-            if hasattr(scim_exc, "add_note"):  # pragma: no cover
+            if sys.version_info >= (3, 11):  # pragma: no cover
                 scim_exc.add_note(str(exc))
             raise scim_exc from exc
 
@@ -216,6 +238,7 @@ class SCIMClient:
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         check_status_code: bool = True,
+        raise_scim_errors: bool = False,
         **kwargs,
     ) -> Union[AnyResource, Error, Dict]:
         """Perform a POST request to create, as defined in :rfc:`RFC7644 §3.3
@@ -228,6 +251,9 @@ class SCIMClient:
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
         :param check_status_code: Whether to validate that the response status code is valid.
+        :param raise_scim_errors: If :data:`True` and the server returned an
+            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
+            exception will be raised. If :data:`False` the error object is returned.
         :param kwargs: Additional parameters passed to the underlying HTTP request
             library.
 
@@ -252,7 +278,6 @@ class SCIMClient:
             which value will excluded from the request payload, and which values are expected in
             the response payload.
         """
-
         if not check_request_payload:
             payload = resource
             url = kwargs.pop("url", None)
@@ -272,7 +297,7 @@ class SCIMClient:
                     resource = resource_type.model_validate(resource)
                 except ValidationError as exc:
                     scim_exc = RequestPayloadValidationError(source=resource)
-                    if hasattr(scim_exc, "add_note"):  # pragma: no cover
+                    if sys.version_info >= (3, 11):  # pragma: no cover
                         scim_exc.add_note(str(exc))
                     raise scim_exc from exc
 
@@ -284,7 +309,7 @@ class SCIMClient:
             response = self.client.post(url, json=payload, **kwargs)
         except RequestError as exc:
             scim_exc = RequestNetworkError(source=payload)
-            if hasattr(scim_exc, "add_note"):  # pragma: no cover
+            if sys.version_info >= (3, 11):  # pragma: no cover
                 scim_exc.add_note(str(exc))
             raise scim_exc from exc
 
@@ -295,6 +320,7 @@ class SCIMClient:
             ),
             expected_types=([resource.__class__] if check_request_payload else None),
             check_response_payload=check_response_payload,
+            raise_scim_errors=raise_scim_errors,
             scim_ctx=Context.RESOURCE_CREATION_RESPONSE,
         )
 
@@ -306,6 +332,7 @@ class SCIMClient:
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         check_status_code: bool = True,
+        raise_scim_errors: bool = False,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, Dict]:
         """Perform a GET request to read resources, as defined in :rfc:`RFC7644
@@ -322,6 +349,9 @@ class SCIMClient:
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
         :param check_status_code: Whether to validate that the response status code is valid.
+        :param raise_scim_errors: If :data:`True` and the server returned an
+            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
+            exception will be raised. If :data:`False` the error object is returned.
         :param kwargs: Additional parameters passed to the underlying HTTP request library.
 
         :return:
@@ -368,7 +398,6 @@ class SCIMClient:
             which value will excluded from the request payload, and which values are expected in
             the response payload.
         """
-
         if resource_type and check_request_payload:
             self.check_resource_type(resource_type)
 
@@ -409,7 +438,7 @@ class SCIMClient:
             response = self.client.get(url, params=payload, **kwargs)
         except RequestError as exc:
             scim_exc = RequestNetworkError(source=payload)
-            if hasattr(scim_exc, "add_note"):  # pragma: no cover
+            if sys.version_info >= (3, 11):  # pragma: no cover
                 scim_exc.add_note(str(exc))
             raise scim_exc from exc
 
@@ -420,6 +449,7 @@ class SCIMClient:
             ),
             expected_types=expected_types,
             check_response_payload=check_response_payload,
+            raise_scim_errors=raise_scim_errors,
             scim_ctx=Context.RESOURCE_QUERY_RESPONSE,
         )
 
@@ -429,6 +459,7 @@ class SCIMClient:
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         check_status_code: bool = True,
+        raise_scim_errors: bool = False,
         **kwargs,
     ) -> Union[AnyResource, ListResponse[AnyResource], Error, Dict]:
         """Perform a POST search request to read all available resources, as
@@ -442,6 +473,9 @@ class SCIMClient:
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
         :param check_status_code: Whether to validate that the response status code is valid.
+        :param raise_scim_errors: If :data:`True` and the server returned an
+            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
+            exception will be raised. If :data:`False` the error object is returned.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -467,7 +501,6 @@ class SCIMClient:
             which value will excluded from the request payload, and which values are expected in
             the response payload.
         """
-
         if not check_request_payload:
             payload = search_request
 
@@ -486,7 +519,7 @@ class SCIMClient:
             response = self.client.post(url, json=payload)
         except RequestError as exc:
             scim_exc = RequestNetworkError(source=payload)
-            if hasattr(scim_exc, "add_note"):  # pragma: no cover
+            if sys.version_info >= (3, 11):  # pragma: no cover
                 scim_exc.add_note(str(exc))
             raise scim_exc from exc
 
@@ -497,6 +530,7 @@ class SCIMClient:
             ),
             expected_types=[ListResponse[Union[self.resource_types]]],
             check_response_payload=check_response_payload,
+            raise_scim_errors=raise_scim_errors,
             scim_ctx=Context.RESOURCE_QUERY_RESPONSE,
         )
 
@@ -506,6 +540,7 @@ class SCIMClient:
         id: str,
         check_response_payload: bool = True,
         check_status_code: bool = True,
+        raise_scim_errors: bool = False,
         **kwargs,
     ) -> Optional[Union[Error, Dict]]:
         """Perform a DELETE request to create, as defined in :rfc:`RFC7644 §3.6
@@ -516,6 +551,9 @@ class SCIMClient:
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
         :param check_status_code: Whether to validate that the response status code is valid.
+        :param raise_scim_errors: If :data:`True` and the server returned an
+            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
+            exception will be raised. If :data:`False` the error object is returned.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -533,7 +571,6 @@ class SCIMClient:
             response = scim.delete(User, "foobar")
             # 'response' may be None, or an Error object
         """
-
         self.check_resource_type(resource_type)
         delete_url = self.resource_endpoint(resource_type) + f"/{id}"
         url = kwargs.pop("url", delete_url)
@@ -542,7 +579,7 @@ class SCIMClient:
             response = self.client.delete(url, **kwargs)
         except RequestError as exc:
             scim_exc = RequestNetworkError()
-            if hasattr(scim_exc, "add_note"):  # pragma: no cover
+            if sys.version_info >= (3, 11):  # pragma: no cover
                 scim_exc.add_note(str(exc))
             raise scim_exc from exc
 
@@ -552,6 +589,7 @@ class SCIMClient:
                 self.DELETION_RESPONSE_STATUS_CODES if check_status_code else None
             ),
             check_response_payload=check_response_payload,
+            raise_scim_errors=raise_scim_errors,
         )
 
     def replace(
@@ -560,6 +598,7 @@ class SCIMClient:
         check_request_payload: bool = True,
         check_response_payload: bool = True,
         check_status_code: bool = True,
+        raise_scim_errors: bool = False,
         **kwargs,
     ) -> Union[AnyResource, Error, Dict]:
         """Perform a PUT request to replace a resource, as defined in
@@ -572,6 +611,9 @@ class SCIMClient:
         :param check_response_payload: Whether to validate that the response payload is valid.
             If set, the raw payload will be returned.
         :param check_status_code: Whether to validate that the response status code is valid.
+        :param raise_scim_errors: If :data:`True` and the server returned an
+            :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject`
+            exception will be raised. If :data:`False` the error object is returned.
         :param kwargs: Additional parameters passed to the underlying
             HTTP request library.
 
@@ -598,7 +640,6 @@ class SCIMClient:
             which value will excluded from the request payload, and which values are expected in
             the response payload.
         """
-
         if not check_request_payload:
             payload = resource
             url = kwargs.pop("url", None)
@@ -619,7 +660,7 @@ class SCIMClient:
                     resource = resource_type.model_validate(resource)
                 except ValidationError as exc:
                     scim_exc = RequestPayloadValidationError(source=resource)
-                    if hasattr(scim_exc, "add_note"):  # pragma: no cover
+                    if sys.version_info >= (3, 11):  # pragma: no cover
                         scim_exc.add_note(str(exc))
                     raise scim_exc from exc
 
@@ -637,7 +678,7 @@ class SCIMClient:
             response = self.client.put(url, json=payload, **kwargs)
         except RequestError as exc:
             scim_exc = RequestNetworkError(source=payload)
-            if hasattr(scim_exc, "add_note"):  # pragma: no cover
+            if sys.version_info >= (3, 11):  # pragma: no cover
                 scim_exc.add_note(str(exc))
             raise scim_exc from exc
 
@@ -648,6 +689,7 @@ class SCIMClient:
             ),
             expected_types=([resource.__class__] if check_request_payload else None),
             check_response_payload=check_response_payload,
+            raise_scim_errors=raise_scim_errors,
             scim_ctx=Context.RESOURCE_REPLACEMENT_RESPONSE,
         )
 

{scim2_client-0.1.5 → scim2_client-0.1.7}/scim2_client/errors.py

@@ -60,6 +60,20 @@ class SCIMResponseError(SCIMClientError):
     validation."""
 
 
+class SCIMResponseErrorObject(SCIMResponseError):
+    """The server response returned a :class:`scim2_models.Error` object.
+
+    Those errors are only raised when the :code:`raise_scim_errors` parameter is :data:`True`.
+    """
+
+    def __init__(self, *args, **kwargs):
+        message = kwargs.pop(
+            "message",
+            f"The server returned a SCIM Error object: {kwargs['source'].detail}",
+        )
+        super().__init__(message, *args, **kwargs)
+
+
 class UnexpectedStatusCode(SCIMResponseError):
     """Error raised when a server returned an unexpected status code for a
     given :class:`~scim2_models.Context`."""