fix: support for scim2_models 0.1.8

Author: azmeuk

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.4.7'
+    rev: 'v0.5.0'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
@@ -19,7 +19,3 @@ repos:
     rev: v1.7.5
     hooks:
       - id: docformatter
-  - repo: https://github.com/rtts/djhtml
-    rev: 3.0.6
-    hooks:
-      - id: djhtml

doc/changelog.rst

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+Fixed
+^^^^^
+- Support for scim2-models 0.1.8
+
 [0.1.6] - 2024-06-05
 --------------------
 

poetry.lock

@@ -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 = [

pyproject.toml

@@ -63,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,
@@ -83,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,
@@ -98,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,
@@ -114,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
@@ -181,13 +196,14 @@ def check_response(
         if not check_response_payload:
             return response_payload
 
-        try:
+        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
-        except ValidationError:
-            pass
 
         if not expected_types:
             return response_payload
@@ -262,7 +278,6 @@ def create(
             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)
@@ -383,7 +398,6 @@ def query(
             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)
 
@@ -487,7 +501,6 @@ def search(
             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
 
@@ -558,7 +571,6 @@ def delete(
             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)
@@ -628,7 +640,6 @@ def replace(
             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)

scim2_client/client.py

@@ -17,7 +17,6 @@
 
 def test_create_user(httpserver):
     """Nominal case for a User creation object."""
-
     httpserver.expect_request("/Users", method="POST").respond_with_json(
         {
             "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
@@ -61,7 +60,6 @@ def test_create_user(httpserver):
 def test_create_dict_user(httpserver):
     """Nominal case for a User creation object, when passing a dict instead of
     a resource."""
-
     httpserver.expect_request("/Users", method="POST").respond_with_json(
         {
             "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
@@ -107,7 +105,6 @@ def test_create_dict_user(httpserver):
 
 def test_create_dict_user_bad_schema(httpserver):
     """Test when passing a resource dict with an unknown or invalid schema."""
-
     httpserver.expect_request("/Users", method="POST").respond_with_json(
         {
             "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
@@ -139,7 +136,6 @@ def test_create_dict_user_bad_schema(httpserver):
 
 def test_dont_check_response_payload(httpserver):
     """Test the check_response_payload_attribute."""
-
     httpserver.expect_request("/Users", method="POST").respond_with_json(
         {"foo": "bar"}, status=201
     )
@@ -157,7 +153,6 @@ def test_dont_check_request_payload(httpserver):
 
     TODO: Actually check that the payload is sent through the network
     """
-
     httpserver.expect_request("/Users", method="POST").respond_with_json(
         {
             "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
@@ -202,7 +197,6 @@ def test_dont_check_request_payload(httpserver):
 
 def test_conflict(httpserver):
     """Nominal case for a User creation object."""
-
     httpserver.expect_request("/Users", method="POST").respond_with_json(
         {
             "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
@@ -228,7 +222,6 @@ def test_conflict(httpserver):
 
 def test_no_200(httpserver):
     """User creation object should return 201 codes and no 200."""
-
     httpserver.expect_request("/Users", method="POST").respond_with_json(
         {
             "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
@@ -257,7 +250,6 @@ def test_no_200(httpserver):
 @pytest.mark.parametrize("code", [400, 401, 403, 404, 500])
 def test_errors(httpserver, code):
     """Test error cases defined in RFC7644."""
-
     httpserver.expect_request("/Users", method="POST").respond_with_json(
         {
             "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
@@ -283,7 +275,6 @@ def test_errors(httpserver, code):
 def test_invalid_resource_type(httpserver):
     """Test that resource_types passed to the method must be part of
     SCIMClient.resource_types."""
-
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
     with pytest.raises(SCIMRequestError, match=r"Unknown resource type"):
@@ -292,7 +283,6 @@ def test_invalid_resource_type(httpserver):
 
 def test_request_validation_error(httpserver):
     """Test that incorrect input raise a RequestPayloadValidationError."""
-
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
     with pytest.raises(
@@ -308,7 +298,6 @@ def test_request_validation_error(httpserver):
 
 def test_request_network_error(httpserver):
     """Test that httpx exceptions are transformed in RequestNetworkError."""
-
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
     user_request = User(user_name="[email protected]")

tests/test_create.py

@@ -11,7 +11,6 @@
 
 def test_delete_user(httpserver):
     """Nominal case for a User deletion."""
-
     httpserver.expect_request(
         "/Users/2819c223-7f76-453a-919d-413861904646", method="DELETE"
     ).respond_with_data(status=204, content_type="application/scim+json")
@@ -25,7 +24,6 @@ def test_delete_user(httpserver):
 @pytest.mark.parametrize("code", [400, 401, 403, 404, 412, 500, 501])
 def test_errors(httpserver, code):
     """Test error cases defined in RFC7644."""
-
     httpserver.expect_request(
         "/Users/2819c223-7f76-453a-919d-413861904646", method="DELETE"
     ).respond_with_json(
@@ -51,7 +49,6 @@ def test_errors(httpserver, code):
 def test_invalid_resource_type(httpserver):
     """Test that resource_types passed to the method must be part of
     SCIMClient.resource_types."""
-
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
     with pytest.raises(SCIMRequestError, match=r"Unknown resource type"):
@@ -60,7 +57,6 @@ def test_invalid_resource_type(httpserver):
 
 def test_dont_check_response_payload(httpserver):
     """Test the check_response_payload attribute."""
-
     httpserver.expect_request(
         "/Users/2819c223-7f76-453a-919d-413861904646", method="DELETE"
     ).respond_with_json(
@@ -86,7 +82,6 @@ def test_dont_check_response_payload(httpserver):
 
 def test_request_network_error(httpserver):
     """Test that httpx exceptions are transformed in RequestNetworkError."""
-
     client = Client(base_url=f"http://localhost:{httpserver.port}")
     scim_client = SCIMClient(client, resource_types=(User,))
     with pytest.raises(