scim2-client 0.3.2__tar.gz → 0.3.3__tar.gz

{scim2_client-0.3.2 → scim2_client-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-client
-Version: 0.3.2
+Version: 0.3.3
 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

{scim2_client-0.3.2 → scim2_client-0.3.3}/doc/changelog.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+[0.3.3] - 2024-11-29
+--------------------
+
+Added
+^^^^^
+- :class:`~scim2_client.engines.werkzeug.TestSCIMClient` raise a
+  :class:`~scim2_client.UnexpectedContentFormat` exception when response is not JSON.
+
 [0.3.2] - 2024-11-29
 --------------------
 
@@ -32,12 +40,12 @@ Fixed
 Added
 ^^^^^
 - The `Unknown resource type` request error keeps a reference to the faulty payload.
-- New `werkzeug` request engine for application development purpose.
-- New `AsyncSCIMClient` request engine. :issue:`1`
+- New :class:`~scim2_client.engines.werkzeug.TestSCIMClient` request engine for application development purpose.
+- New :class:`~scim2_client.engines.httpx.AsyncSCIMClient` request engine. :issue:`1`
 
 Changed
 ^^^^^^^
-- Separate httpx network code and SCIM code in separate file as a basis for async support (and maybe other request engines).
+- Separate httpx network code and SCIM code in separate file as a basis for async support (and other request engines).
 
 [0.2.2] - 2024-11-12
 --------------------

{scim2_client-0.3.2 → scim2_client-0.3.3}/doc/tutorial.rst

@@ -17,15 +17,15 @@ In addition to your SCIM server root endpoint, you will probably want to provide
     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, resource_models=(User[EnterpriseUser], Group))
 
-You need to give to indicate to :class:`~scim2_client.SCIMClient` all the different :class:`~scim2_models.Resource` types that you will need to manipulate with the :code:`resource_types` parameter.
+You need to give to indicate to :class:`~scim2_client.BaseSCIMClient` all the different :class:`~scim2_models.Resource` types that you will need to manipulate with the :code:`resource_models` parameter.
 This is needed so scim2-client will be able to guess which resource type to instante when an arbitrary payload is met.
 
 .. todo::
 
     We plan to implement the automatic discovery of SCIM server resources,
-    so they can dynamically be used without explicitly passing them with the :code:`resource_types` parameter.
+    so they can dynamically be used without explicitly passing them with the :code:`resource_models` parameter.
 
 Performing actions
 ==================
@@ -33,11 +33,11 @@ Performing actions
 scim2-client allows your application to interact with a SCIM server as described in :rfc:`RFC7644 §3 <7644#section-3>`, so you can read and manage the resources.
 The following actions are available:
 
-- :meth:`~scim2_client.BaseSCIMClient.create`
-- :meth:`~scim2_client.BaseSCIMClient.query`
-- :meth:`~scim2_client.BaseSCIMClient.replace`
-- :meth:`~scim2_client.BaseSCIMClient.delete`
-- :meth:`~scim2_client.BaseSCIMClient.search`
+- :meth:`~scim2_client.BaseSyncSCIMClient.create`
+- :meth:`~scim2_client.BaseSyncSCIMClient.query`
+- :meth:`~scim2_client.BaseSyncSCIMClient.replace`
+- :meth:`~scim2_client.BaseSyncSCIMClient.delete`
+- :meth:`~scim2_client.BaseSyncSCIMClient.search`
 
 Have a look at the :doc:`reference` to see usage examples and the exhaustive set of parameters, but generally it looks like this:
 
@@ -64,16 +64,16 @@ By default, the data passed to the :class:`SCIM client <scim2_client.BaseSCIMCli
 However sometimes you want to accept invalid inputs and outputs.
 To achieve this, all the methods provide the following parameters, all are :data:`True` by default:
 
-- :code:`check_request_payload`:
+- :paramref:`~scim2_client.BaseSCIMClient.check_request_payload`:
   If :data:`True` (the default) a :class:`~pydantic.ValidationError` will be raised if the input does not respect the SCIM standard.
   If :data:`False`, input is expected to be a :data:`dict` that will be passed as-is in the request.
-- :code:`check_response_payload`:
+- :paramref:`~scim2_client.BaseSCIMClient.check_response_payload`:
   If :data:`True` (the default) a :class:`~pydantic.ValidationError` will be raised if the server response does not respect the SCIM standard.
   If :data:`False` the server response is returned as-is.
 - :code:`expected_status_codes`: The list of expected status codes in the response.
   If :data:`None` any status code is accepted.
   If an unexpected status code is returned, a :class:`~scim2_client.errors.UnexpectedStatusCode` exception is raised.
-- :code:`raise_scim_errors`: If :data:`True` (the default) and the server returned an :class:`~scim2_models.Error` object, a :class:`~scim2_client.SCIMResponseErrorObject` exception will be raised.
+- :paramref:`~scim2_client.BaseSCIMClient.raise_scim_errors`: If :data:`True` (the default) 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.
 
 

{scim2_client-0.3.2 → scim2_client-0.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "scim2-client"
-version = "0.3.2"
+version = "0.3.3"
 description = "Pythonically build SCIM requests and parse SCIM responses"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE.md"}

{scim2_client-0.3.2 → scim2_client-0.3.3}/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

{scim2_client-0.3.2 → scim2_client-0.3.3}/tests/engines/test_werkzeug.py

@@ -2,9 +2,12 @@ import pytest
 from scim2_models import ResourceType
 from scim2_models import SearchRequest
 from scim2_models import User
+from werkzeug.wrappers import Request
+from werkzeug.wrappers import Response
 
 from scim2_client.engines.werkzeug import TestSCIMClient
 from scim2_client.errors import SCIMResponseErrorObject
+from scim2_client.errors import UnexpectedContentFormat
 
 scim2_server = pytest.importorskip("scim2_server")
 from scim2_server.backend import InMemoryBackend  # noqa: E402
@@ -61,3 +64,15 @@ def test_werkzeug_engine(scim_client):
     scim_client.delete(User, response_user.id)
     with pytest.raises(SCIMResponseErrorObject):
         scim_client.query(User, response_user.id)
+
+
+def test_no_json():
+    """Test that pages that do not return JSON raise an UnexpectedContentFormat error."""
+
+    @Request.application
+    def application(request):
+        return Response("Hello, World!", content_type="application/scim+json")
+
+    client = TestSCIMClient(app=application, resource_models=(User,))
+    with pytest.raises(UnexpectedContentFormat):
+        client.query(url="/")