scim2-client 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

scim2_client/client.py

@@ -1,11 +1,7 @@
 import json
 import json.decoder
 import sys
-from typing import Dict
-from typing import List
 from typing import Optional
-from typing import Tuple
-from typing import Type
 from typing import Union
 
 from httpx import Client
@@ -52,7 +48,7 @@ class SCIMClient:
         :class:`~scim2_models.ResourceType`, :class:`~scim2_models.Schema` and :class:`scim2_models.ServiceProviderConfig` are pre-loaded by default.
     """
 
-    CREATION_RESPONSE_STATUS_CODES: List[int] = [
+    CREATION_RESPONSE_STATUS_CODES: list[int] = [
         201,
         409,
         307,
@@ -69,14 +65,14 @@ class SCIMClient:
     :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
     """
 
-    QUERY_RESPONSE_STATUS_CODES: List[int] = [200, 400, 307, 308, 401, 403, 404, 500]
+    QUERY_RESPONSE_STATUS_CODES: list[int] = [200, 400, 307, 308, 401, 403, 404, 500]
     """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] = [
+    SEARCH_RESPONSE_STATUS_CODES: list[int] = [
         200,
         307,
         308,
@@ -95,7 +91,7 @@ class SCIMClient:
     :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
     """
 
-    DELETION_RESPONSE_STATUS_CODES: List[int] = [
+    DELETION_RESPONSE_STATUS_CODES: list[int] = [
         204,
         307,
         308,
@@ -113,7 +109,7 @@ class SCIMClient:
     :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
     """
 
-    REPLACEMENT_RESPONSE_STATUS_CODES: List[int] = [
+    REPLACEMENT_RESPONSE_STATUS_CODES: list[int] = [
         200,
         307,
         308,
@@ -132,7 +128,7 @@ class SCIMClient:
     :rfc:`RFC7644 §3.12 <7644#section-3.12>`.
     """
 
-    def __init__(self, client: Client, resource_types: Optional[Tuple[Type]] = None):
+    def __init__(self, client: Client, resource_types: Optional[tuple[type]] = None):
         self.client = client
         self.resource_types = tuple(
             set(resource_types or []) | {ResourceType, Schema, ServiceProviderConfig}
@@ -142,7 +138,7 @@ class SCIMClient:
         if resource_type not in self.resource_types:
             raise SCIMRequestError(f"Unknown resource type: '{resource_type}'")
 
-    def resource_endpoint(self, resource_type: Type):
+    def resource_endpoint(self, resource_type: type):
         if resource_type is None:
             return "/"
 
@@ -160,8 +156,8 @@ class SCIMClient:
     def check_response(
         self,
         response: Response,
-        expected_status_codes: List[int],
-        expected_types: Optional[Type] = None,
+        expected_status_codes: list[int],
+        expected_types: Optional[type] = None,
         check_response_payload: bool = True,
         raise_scim_errors: bool = True,
         scim_ctx: Optional[Context] = None,
@@ -175,11 +171,9 @@ class SCIMClient:
         # SCIM are known to informally use "application/json".
         # https://datatracker.ietf.org/doc/html/rfc7644.html#section-8.1
 
+        actual_content_type = response.headers.get("content-type", "").split(";").pop(0)
         expected_response_content_types = ("application/scim+json", "application/json")
-        if (
-            response.headers.get("content-type").split(";").pop(0)
-            not in expected_response_content_types
-        ):
+        if actual_content_type not in expected_response_content_types:
             raise UnexpectedContentType(source=response)
 
         # In addition to returning an HTTP response code, implementers MUST return
@@ -219,7 +213,7 @@ class SCIMClient:
             expected = ", ".join([type.__name__ for type in expected_types])
             try:
                 schema = ", ".join(response_payload["schemas"])
-                message = f"Expected type {expected} but got unknow resource with schemas: {schema}"
+                message = f"Expected type {expected} but got unknown resource with schemas: {schema}"
             except KeyError:
                 message = (
                     f"Expected type {expected} but got undefined object with no schema"
@@ -237,15 +231,14 @@ class SCIMClient:
 
     def create(
         self,
-        resource: Union[AnyResource, Dict],
+        resource: Union[AnyResource, dict],
         check_request_payload: bool = True,
         check_response_payload: bool = True,
-        expected_status_codes: Optional[List[int]] = CREATION_RESPONSE_STATUS_CODES,
+        expected_status_codes: Optional[list[int]] = CREATION_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = True,
         **kwargs,
-    ) -> Union[AnyResource, Error, Dict]:
-        """Perform a POST request to create, as defined in :rfc:`RFC7644 §3.3
-        <7644#section-3.3>`.
+    ) -> Union[AnyResource, Error, dict]:
+        """Perform a POST request to create, as defined in :rfc:`RFC7644 §3.3 <7644#section-3.3>`.
 
         :param resource: The resource to create
             If is a :data:`dict`, the resource type will be guessed from the schema.
@@ -328,17 +321,16 @@ class SCIMClient:
 
     def query(
         self,
-        resource_type: Optional[Type] = None,
+        resource_type: Optional[type] = None,
         id: Optional[str] = None,
-        search_request: Optional[Union[SearchRequest, Dict]] = None,
+        search_request: Optional[Union[SearchRequest, dict]] = None,
         check_request_payload: bool = True,
         check_response_payload: bool = True,
-        expected_status_codes: Optional[List[int]] = QUERY_RESPONSE_STATUS_CODES,
+        expected_status_codes: Optional[list[int]] = QUERY_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = True,
         **kwargs,
-    ) -> Union[AnyResource, ListResponse[AnyResource], Error, Dict]:
-        """Perform a GET request to read resources, as defined in :rfc:`RFC7644
-        §3.4.2 <7644#section-3.4.2>`.
+    ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
+        """Perform a GET request to read resources, as defined in :rfc:`RFC7644 §3.4.2 <7644#section-3.4.2>`.
 
         - If `id` is not :data:`None`, the resource with the exact id will be reached.
         - If `id` is :data:`None`, all the resources with the given type will be reached.
@@ -459,12 +451,11 @@ class SCIMClient:
         search_request: Optional[SearchRequest] = None,
         check_request_payload: bool = True,
         check_response_payload: bool = True,
-        expected_status_codes: Optional[List[int]] = SEARCH_RESPONSE_STATUS_CODES,
+        expected_status_codes: Optional[list[int]] = SEARCH_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = True,
         **kwargs,
-    ) -> Union[AnyResource, ListResponse[AnyResource], Error, Dict]:
-        """Perform a POST search request to read all available resources, as
-        defined in :rfc:`RFC7644 §3.4.3 <7644#section-3.4.3>`.
+    ) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
+        """Perform a POST search request to read all available resources, as defined in :rfc:`RFC7644 §3.4.3 <7644#section-3.4.3>`.
 
         :param resource_types: Resource type or union of types expected
             to be read from the response.
@@ -536,15 +527,14 @@ class SCIMClient:
 
     def delete(
         self,
-        resource_type: Type,
+        resource_type: type,
         id: str,
         check_response_payload: bool = True,
-        expected_status_codes: Optional[List[int]] = DELETION_RESPONSE_STATUS_CODES,
+        expected_status_codes: Optional[list[int]] = DELETION_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = True,
         **kwargs,
-    ) -> Optional[Union[Error, Dict]]:
-        """Perform a DELETE request to create, as defined in :rfc:`RFC7644 §3.6
-        <7644#section-3.6>`.
+    ) -> Optional[Union[Error, dict]]:
+        """Perform a DELETE request to create, as defined in :rfc:`RFC7644 §3.6 <7644#section-3.6>`.
 
         :param resource_type: The type of the resource to delete.
         :param id: The type id the resource to delete.
@@ -593,15 +583,14 @@ class SCIMClient:
 
     def replace(
         self,
-        resource: Union[AnyResource, Dict],
+        resource: Union[AnyResource, dict],
         check_request_payload: bool = True,
         check_response_payload: bool = True,
-        expected_status_codes: Optional[List[int]] = REPLACEMENT_RESPONSE_STATUS_CODES,
+        expected_status_codes: Optional[list[int]] = REPLACEMENT_RESPONSE_STATUS_CODES,
         raise_scim_errors: bool = True,
         **kwargs,
-    ) -> Union[AnyResource, Error, Dict]:
-        """Perform a PUT request to replace a resource, as defined in
-        :rfc:`RFC7644 §3.5.1 <7644#section-3.5.1>`.
+    ) -> Union[AnyResource, Error, dict]:
+        """Perform a PUT request to replace a resource, as defined in :rfc:`RFC7644 §3.5.1 <7644#section-3.5.1>`.
 
         :param resource: The new resource to replace.
             If is a :data:`dict`, the resource type will be guessed from the schema.
@@ -630,8 +619,7 @@ class SCIMClient:
 
             user = scim.query(User, "my-used-id")
             user.display_name = "Fancy New Name"
-            response = scim.update(user)
-            # 'response' may be a User or an Error object
+            updated_user = scim.replace(user)
 
         .. tip::
 
@@ -692,6 +680,6 @@ class SCIMClient:
         )
 
     def modify(
-        self, resource: Union[AnyResource, Dict], op: PatchOp, **kwargs
-    ) -> Optional[Union[AnyResource, Dict]]:
+        self, resource: Union[AnyResource, dict], op: PatchOp, **kwargs
+    ) -> Optional[Union[AnyResource, dict]]:
         raise NotImplementedError()

scim2_client/errors.py

@@ -25,7 +25,7 @@ class SCIMRequestError(SCIMClientError):
 class RequestNetworkError(SCIMRequestError):
     """Error raised when a network error happened during request.
 
-    This error is raised when a :class:`httpx.RequestError` has been catched while performing a request.
+    This error is raised when a :class:`httpx.RequestError` has been caught while performing a request.
     The original :class:`~httpx.RequestError` is available with :attr:`~BaseException.__cause__`.
     """
 
@@ -35,29 +35,32 @@ class RequestNetworkError(SCIMRequestError):
 
 
 class RequestPayloadValidationError(SCIMRequestError):
-    """Error raised when an invalid request payload has been passed to
-    SCIMClient.
+    """Error raised when an invalid request payload has been passed to SCIMClient.
 
-    This error is raised when a :class:`pydantic.ValidationError` has been catched
+    This error is raised when a :class:`pydantic.ValidationError` has been caught
     while validating the client request payload.
     The original :class:`~pydantic.ValidationError` is available with :attr:`~BaseException.__cause__`.
 
     .. code-block:: python
 
         try:
-            scim.create({"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"], "active": "not-a-bool"})
+            scim.create(
+                {
+                    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+                    "active": "not-a-bool",
+                }
+            )
         except RequestPayloadValidationError as exc:
             print("Original validation error cause", exc.__cause__)
     """
 
     def __init__(self, *args, **kwargs):
-        message = kwargs.pop("message", "Server response payload validation error")
+        message = kwargs.pop("message", "Server request payload validation error")
         super().__init__(message, *args, **kwargs)
 
 
 class SCIMResponseError(SCIMClientError):
-    """Base exception for errors happening during response payload
-    validation."""
+    """Base exception for errors happening during response payload validation."""
 
 
 class SCIMResponseErrorObject(SCIMResponseError):
@@ -75,8 +78,7 @@ class SCIMResponseErrorObject(SCIMResponseError):
 
 
 class UnexpectedStatusCode(SCIMResponseError):
-    """Error raised when a server returned an unexpected status code for a
-    given :class:`~scim2_models.Context`."""
+    """Error raised when a server returned an unexpected status code for a given :class:`~scim2_models.Context`."""
 
     def __init__(self, *args, **kwargs):
         message = kwargs.pop(
@@ -87,8 +89,7 @@ class UnexpectedStatusCode(SCIMResponseError):
 
 
 class UnexpectedContentType(SCIMResponseError):
-    """Error raised when a server returned an unexpected `Content-Type` header
-    in a response."""
+    """Error raised when a server returned an unexpected `Content-Type` header in a response."""
 
     def __init__(self, *args, **kwargs):
         content_type = kwargs["source"].headers.get("content-type", "")
@@ -105,10 +106,9 @@ class UnexpectedContentFormat(SCIMResponseError):
 
 
 class ResponsePayloadValidationError(SCIMResponseError):
-    """Error raised when the server returned a payload that cannot be
-    validated.
+    """Error raised when the server returned a payload that cannot be validated.
 
-    This error is raised when a :class:`pydantic.ValidationError` has been catched
+    This error is raised when a :class:`pydantic.ValidationError` has been caught
     while validating the server response payload.
     The original :class:`~pydantic.ValidationError` is available with :attr:`~BaseException.__cause__`.
 

scim2_client-0.2.1.dist-info/METADATA

@@ -0,0 +1,291 @@
+Metadata-Version: 2.3
+Name: scim2-client
+Version: 0.2.1
+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
+Project-URL: changelog, https://scim2-client.readthedocs.io/en/latest/changelog.html
+Project-URL: funding, https://github.com/sponsors/python-scim
+Author-email: Yaal Coop <contact@yaal.coop>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE.md
+Keywords: api,httpx,provisioning,rfc7643,rfc7644,scim,scim2
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: scim2-models>=0.2.0
+Description-Content-Type: text/markdown
+
+# scim2-client
+
+A SCIM client Python library built upon [scim2-models](https://scim2-models.readthedocs.io) and [httpx](https://github.com/encode/httpx),
+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.
+
+It aims to be used in SCIM client applications, or in unit tests for SCIM server applications.
+
+## What's SCIM anyway?
+
+SCIM stands for System for Cross-domain Identity Management, and it is a provisioning protocol.
+Provisioning is the action of managing a set of resources across different services, usually users and groups.
+SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect.
+It allows users and groups creations, modifications and deletions to be synchronized between applications.
+
+## Installation
+
+```shell
+pip install scim2-client
+```
+
+## 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.
+
+Here is an example of usage:
+
+```python
+import datetime
+from httpx import Client
+from scim2_models import User, EnterpriseUser, Group, Error
+from scim2_client import SCIMClient
+
+client = Client(base_url=f"https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
+scim = SCIMClient(client, resource_types=(User[EnterpriseUser], Group))
+
+# Query resources
+user = scim.query(User[EnterpriseUser], "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
+)
+
+# Update resources
+user.display_name = "Babs Jensen"
+user = scim.replace(user)
+assert user.display_name == "Babs Jensen"
+assert user.meta.last_updated == datetime.datetime(
+    2024, 4, 13, 12, 0, 30, tzinfo=datetime.timezone.utc
+)
+
+# Create resources
+payload = User(user_name="bjensen@example.com")
+response = scim.create(user)
+assert isinstance(response, Error)
+assert response.detail == "One or more of the attribute values are already in use or are reserved."
+```
+
+scim2-client belongs in a collection of SCIM tools developed by [Yaal Coop](https://yaal.coop),
+with [scim2-models](https://github.com/python-scim/scim2-models),
+[scim2-tester](https://github.com/python-scim/scim2-tester) and
+[scim2-cli](https://github.com/python-scim/scim2-cli)

scim2_client-0.2.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+scim2_client/__init__.py,sha256=vgrTJZIqJLZc72XCJwYKrSCGUDkMZTJjCJiZkHERZGs,780
+scim2_client/client.py,sha256=I3_CjI9njNbzOux6abwWkMYfT1q40SvnkQuYlifMdJQ,27107
+scim2_client/errors.py,sha256=XH5e8zx3a1228GJjxugEgwO-shYAZWQx6LK_yZyX53E,4495
+scim2_client-0.2.1.dist-info/METADATA,sha256=pGhr3ZzcA_O85rQsMfJ97vBdK9_FZehK5m2qZfceMhA,16767
+scim2_client-0.2.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+scim2_client-0.2.1.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+scim2_client-0.2.1.dist-info/RECORD,,

{scim2_client-0.2.0.dist-info → scim2_client-0.2.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any

scim2_client-0.2.1.dist-info/licenses/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

scim2_client-0.2.0.dist-info/METADATA

@@ -1,88 +0,0 @@
-Metadata-Version: 2.1
-Name: scim2-client
-Version: 0.2.0
-Summary: Pythonically build SCIM requests and parse SCIM responses
-License: MIT
-Keywords: scim,scim2,provisioning,httpx,api
-Author: Yaal Coop
-Author-email: contact@yaal.coop
-Requires-Python: >=3.9,<4.0
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Dist: httpx (>=0.24.0)
-Requires-Dist: scim2-models (>=0.2.0,<0.3.0)
-Description-Content-Type: text/markdown
-
-# scim2-client
-
-A SCIM client Python library built upon [scim2-models](https://scim2-models.readthedocs.io) and [httpx](https://github.com/encode/httpx),
-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.
-
-It aims to be used in SCIM client applications, or in unit tests for SCIM server applications.
-
-## What's SCIM anyway?
-
-SCIM stands for System for Cross-domain Identity Management, and it is a provisioning protocol.
-Provisioning is the action of managing a set of resources across different services, usually users and groups.
-SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect.
-It allows users and groups creations, modifications and deletions to be synchronized between applications.
-
-## Installation
-
-```shell
-pip install scim2-client
-```
-
-## 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.
-
-Here is an example of usage:
-
-```python
-import datetime
-from httpx import Client
-from scim2_models import User, EnterpriseUser, Group, Error
-from scim2_client import SCIMClient
-
-client = Client(base_url=f"https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
-scim = SCIMClient(client, resource_types=(User[EnterpriseUser], Group))
-
-# Query resources
-user = scim.query(User[EnterpriseUser], "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
-)
-
-# Update resources
-user.display_name = "Babs Jensen"
-user = scim.replace(user)
-assert user.display_name == "Babs Jensen"
-assert user.meta.last_updated == datetime.datetime(
-    2024, 4, 13, 12, 0, 30, tzinfo=datetime.timezone.utc
-)
-
-# Create resources
-payload = User(user_name="bjensen@example.com")
-response = scim.create(user)
-assert isinstance(response, Error)
-assert response.detail == "One or more of the attribute values are already in use or are reserved."
-```
-
-scim2-client belongs in a collection of SCIM tools developed by [Yaal Coop](https://yaal.coop),
-with [scim2-models](https://github.com/yaal-coop/scim2-models),
-[scim2-tester](https://github.com/yaal-coop/scim2-tester) and
-[scim2-cli](https://github.com/yaal-coop/scim2-cli)
-

scim2_client-0.2.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-scim2_client/__init__.py,sha256=vgrTJZIqJLZc72XCJwYKrSCGUDkMZTJjCJiZkHERZGs,780
-scim2_client/client.py,sha256=hFcpUG2jYtNb5e178lsf4-SubXb0opO9JgegR6Q-JZQ,27278
-scim2_client/errors.py,sha256=Lu_4lPlbryqWYGLPmH2iWaVmlay8S4PrH6lUPIvcisA,4430
-scim2_client-0.2.0.dist-info/METADATA,sha256=b5Q_wytHLRpCPga0hwYTVKgMmX0o9mFXuStQYtzNf50,3497
-scim2_client-0.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-scim2_client-0.2.0.dist-info/RECORD,,