scim2-client 0.1.0__tar.gz → 0.1.1__tar.gz

{scim2_client-0.1.0 → scim2_client-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scim2-client
-Version: 0.1.0
+Version: 0.1.1
 Summary: Pythonically build SCIM requests and parse SCIM responses
 License: MIT
 Keywords: scim,scim2,provisioning,httpx,api
@@ -20,12 +20,14 @@ 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.0,<0.2.0)
+Requires-Dist: scim2-models (>=0.1.1,<0.2.0)
 Description-Content-Type: text/markdown
 
 # scim2-client
 
-A SCIM client 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.
+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.
 ## Installation
 
 ```shell

{scim2_client-0.1.0 → scim2_client-0.1.1}/README.md

@@ -1,6 +1,8 @@
 # scim2-client
 
-A SCIM client 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.
+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.
 ## Installation
 
 ```shell

{scim2_client-0.1.0 → scim2_client-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "scim2-client"
-version = "0.1.0"
+version = "0.1.1"
 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.0"
+scim2-models = "^0.1.1"
 
 [tool.poetry.group.doc]
 optional = true

{scim2_client-0.1.0 → scim2_client-0.1.1}/scim2_client/client.py

@@ -10,6 +10,7 @@ from httpx import Client
 from httpx import Response
 from pydantic import ValidationError
 from scim2_models import AnyResource
+from scim2_models import Context
 from scim2_models import Error
 from scim2_models import ListResponse
 from scim2_models import PatchOp
@@ -44,6 +45,7 @@ class SCIMClient:
         response: Response,
         expected_status_codes: List[int],
         expected_type: Optional[Type] = None,
+        scim_ctx: Optional[Context] = None,
     ):
         if response.status_code not in expected_status_codes:
             raise UnexpectedStatusCode(response)
@@ -77,7 +79,8 @@ class SCIMClient:
             pass
 
         if expected_type:
-            return expected_type.model_validate(response_payload)
+            return expected_type.model_validate(response_payload, scim_ctx=scim_ctx)
+
         return response_payload
 
     def create(self, resource: AnyResource, **kwargs) -> Union[AnyResource, Error]:
@@ -95,7 +98,7 @@ class SCIMClient:
 
         self.check_resource_type(resource.__class__)
         url = self.resource_endpoint(resource.__class__)
-        dump = resource.model_dump(exclude_none=True, by_alias=True, mode="json")
+        dump = resource.model_dump(scim_ctx=Context.RESOURCE_CREATION_REQUEST)
         response = self.client.post(url, json=dump, **kwargs)
 
         expected_status_codes = [
@@ -113,7 +116,12 @@ class SCIMClient:
             404,
             500,
         ]
-        return self.check_response(response, expected_status_codes, resource.__class__)
+        return self.check_response(
+            response,
+            expected_status_codes,
+            resource.__class__,
+            scim_ctx=Context.RESOURCE_CREATION_RESPONSE,
+        )
 
     def query(
         self,
@@ -142,7 +150,8 @@ class SCIMClient:
         self.check_resource_type(resource_type)
         payload = (
             search_request.model_dump(
-                by_alias=True, exclude_none=True, exclude_unset=True, mode="json"
+                exclude_unset=True,
+                scim_ctx=Context.RESOURCE_QUERY_REQUEST,
             )
             if search_request
             else None
@@ -171,7 +180,12 @@ class SCIMClient:
             500,
         ]
         response = self.client.get(url, params=payload, **kwargs)
-        return self.check_response(response, expected_status_codes, expected_type)
+        return self.check_response(
+            response,
+            expected_status_codes,
+            expected_type,
+            scim_ctx=Context.RESOURCE_QUERY_RESPONSE,
+        )
 
     def query_all(
         self,
@@ -196,7 +210,7 @@ class SCIMClient:
 
         payload = (
             search_request.model_dump(
-                by_alias=True, exclude_none=True, exclude_unset=True, mode="json"
+                exclude_unset=True, scim_ctx=Context.RESOURCE_QUERY_REQUEST
             )
             if search_request
             else None
@@ -220,7 +234,10 @@ class SCIMClient:
         ]
 
         return self.check_response(
-            response, expected_status_codes, ListResponse[Union[self.resource_types]]
+            response,
+            expected_status_codes,
+            ListResponse[Union[self.resource_types]],
+            scim_ctx=Context.RESOURCE_QUERY_RESPONSE,
         )
 
     def search(
@@ -244,7 +261,7 @@ class SCIMClient:
 
         payload = (
             search_request.model_dump(
-                by_alias=True, exclude_none=True, exclude_unset=True, mode="json"
+                exclude_unset=True, scim_ctx=Context.RESOURCE_QUERY_RESPONSE
             )
             if search_request
             else None
@@ -269,7 +286,10 @@ class SCIMClient:
             501,
         ]
         return self.check_response(
-            response, expected_status_codes, ListResponse[Union[self.resource_types]]
+            response,
+            expected_status_codes,
+            ListResponse[Union[self.resource_types]],
+            scim_ctx=Context.RESOURCE_QUERY_RESPONSE,
         )
 
     def delete(self, resource_type: Type, id: str, **kwargs) -> Optional[Error]:
@@ -323,7 +343,7 @@ class SCIMClient:
         if not resource.id:
             raise Exception("Resource must have an id")
 
-        dump = resource.model_dump(exclude_none=True, by_alias=True, mode="json")
+        dump = resource.model_dump(scim_ctx=Context.RESOURCE_REPLACEMENT_REQUEST)
         url = self.resource_endpoint(resource.__class__) + f"/{resource.id}"
         response = self.client.put(url, json=dump, **kwargs)
 
@@ -344,7 +364,12 @@ class SCIMClient:
             500,
             501,
         ]
-        return self.check_response(response, expected_status_codes, resource.__class__)
+        return self.check_response(
+            response,
+            expected_status_codes,
+            resource.__class__,
+            scim_ctx=Context.RESOURCE_REPLACEMENT_RESPONSE,
+        )
 
     def modify(
         self, resource: AnyResource, op: PatchOp, **kwargs