refactor: use scim2-client to perform basic requests

Author: azmeuk

poetry.lock

@@ -27,7 +27,7 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.10"
 click = "^8.1.7"
-requests = "^2.32.2"
+scim2-client = "^0.1.4"
 sphinx-click-rst-to-ansi-formatter = "^0.1.0"
 
 [tool.poetry.group.doc]

pyproject.toml

@@ -1,129 +1,49 @@
 import json
 
 import click
-import requests
+from httpx import Client
+from scim2_client import SCIMClient
+from scim2_models import EnterpriseUser
+from scim2_models import Group
+from scim2_models import User
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
-DOC_URL = "https://scim2-cli.readthedocs.io/"
-BASE_HEADERS = {
-    "Accept": "application/scim+json",
-    "Content-Type": "application/scim+json",
-}
+from .create import create_cli
+from .delete import delete_cli
+from .query import query_cli
+from .replace import replace_cli
+from .search import search_cli
+from .utils import DOC_URL
 
 
 @click.group(cls=make_rst_to_ansi_formatter(DOC_URL, group=True))
 @click.argument("url")
 @click.pass_context
 def cli(ctx, url):
     """SCIM application development CLI."""
+
     ctx.ensure_object(dict)
     ctx.obj["URL"] = url
-
-    if not click.get_text_stream("stdin").isatty():  # pragma: no cover
-        stdin = click.get_text_stream("stdin").read().strip()
-        ctx.obj["STDIN"] = json.loads(stdin)
-
-
-@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
-@click.pass_context
-def get(ctx):
-    """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request.
-
-    Data passed in JSON format to stdin is sent as request arguments:
-
-    .. code-block:: bash
-
-        echo '{"foo": "bar"}' | scim https://scim.example get
-    """
-
-    response = requests.get(
-        ctx.obj["URL"],
-        params=ctx.obj.get("STDIN"),
-        headers=BASE_HEADERS,
-        allow_redirects=True,
-    )
-    click.echo(response.text)
-
-
-@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
-@click.pass_context
-def post(ctx):
-    """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request.
-
-    Data passed in JSON format to stdin is sent as request payload:
-
-    .. code-block:: bash
-
-        echo '{"foo": "bar"}' | scim https://scim.example post
-    """
-
-    response = requests.post(
-        ctx.obj["URL"],
-        json=ctx.obj.get("STDIN"),
-        headers=BASE_HEADERS,
-        allow_redirects=True,
-    )
-    click.echo(response.text)
-
-
-@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
-@click.pass_context
-def put(ctx):
-    """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1>`_ request.
-
-    Data passed in JSON format to stdin is sent as request payload:
-
-    .. code-block:: bash
-
-        echo '{"foo": "bar"}' | scim https://scim.example put
-    """
-
-    response = requests.put(
-        ctx.obj["URL"],
-        json=ctx.obj.get("STDIN"),
-        headers=BASE_HEADERS,
-        allow_redirects=True,
+    client = Client(base_url=ctx.obj["URL"])
+    ctx.obj["client"] = SCIMClient(
+        client, resource_types=(User, User[EnterpriseUser], Group)
     )
-    click.echo(response.text)
-
-
-@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
-@click.pass_context
-def patch(ctx):
-    """Perform a `SCIM PATCH <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.2>`_ request.
-
-    Data passed in JSON format to stdin is sent as request payload:
-
-    .. code-block:: bash
-
-        echo '{"foo": "bar"}' | scim https://scim.example patch
-    """
+    ctx.obj["resource_types"] = {
+        resource_type.__name__.lower(): resource_type
+        for resource_type in ctx.obj["client"].resource_types
+    }
 
-    response = requests.patch(
-        ctx.obj["URL"],
-        json=ctx.obj.get("STDIN"),
-        headers=BASE_HEADERS,
-        allow_redirects=True,
-    )
-    click.echo(response.text)
-
-
-@cli.command(cls=make_rst_to_ansi_formatter(DOC_URL))
-@click.pass_context
-def delete(ctx):
-    """Perform a `SCIM DELETE <https://www.rfc-editor.org/rfc/rfc7644#section-3.6>`_ request.
-
-    Data passed in JSON format to stdin is sent as request payload:
-
-    .. code-block:: bash
-
-        echo '{"foo": "bar"}' | scim https://scim.example delete
-    """
-
-    response = requests.delete(
-        ctx.obj["URL"],
-        json=ctx.obj.get("STDIN"),
-        headers=BASE_HEADERS,
-        allow_redirects=True,
-    )
-    click.echo(response.text)
+    if not click.get_text_stream("stdin").isatty():  # pragma: no cover
+        if stdin := click.get_text_stream("stdin").read().strip():
+            try:
+                ctx.obj["stdin"] = json.loads(stdin)
+            except json.JSONDecodeError as exc:
+                message = f"Invalid JSON input.\n{exc}"
+                raise click.ClickException(message) from exc
+
+
+cli.add_command(create_cli)
+cli.add_command(query_cli)
+cli.add_command(replace_cli)
+cli.add_command(delete_cli)
+cli.add_command(search_cli)

scim2_cli/__init__.py

@@ -0,0 +1,48 @@
+import click
+import httpx
+from click import ClickException
+from pydantic import ValidationError
+from scim2_client import SCIMClientError
+from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
+
+from .utils import DOC_URL
+from .utils import formatted_payload
+
+
+@click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="create")
+@click.pass_context
+@click.option(
+    "--indent/--no-indent",
+    is_flag=True,
+    default=True,
+    help="Indent JSON response payloads.",
+)
+def create_cli(ctx, indent):
+    """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request
+    on resources endpoint.
+
+    Input data is expected to be passed in JSON format to stdin:
+
+    .. code-block:: bash
+
+        echo '{"userName": "bjensen@example.com", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"]}' | scim https://scim.example create user
+
+    """
+
+    payload = ctx.obj.get("stdin")
+    if not payload:
+        raise ClickException("Input data is missing")
+
+    try:
+        response = ctx.obj["client"].create(payload)
+
+    except (httpx.HTTPError, SCIMClientError) as exc:
+        raise ClickException(exc) from exc
+
+    except ValidationError as exc:
+        payload = formatted_payload(exc.response_payload, indent)
+        message = f"The server response is invalid:\n{payload}\n{exc}"
+        raise ClickException(message) from exc
+
+    payload = formatted_payload(response.model_dump(), indent)
+    click.echo(payload)

scim2_cli/create.py

@@ -0,0 +1,45 @@
+import click
+import httpx
+from click import ClickException
+from scim2_client import SCIMClientError
+from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
+
+from .utils import DOC_URL
+from .utils import formatted_payload
+
+
+@click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="delete")
+@click.argument("resource-type", required=True)
+@click.argument("id", required=True)
+@click.option(
+    "--indent/--no-indent",
+    is_flag=True,
+    default=True,
+    help="Indent JSON response payloads.",
+)
+@click.pass_context
+def delete_cli(ctx, resource_type, id, indent):
+    """Perform a `SCIM DELETE query <https://www.rfc-editor.org/rfc/rfc7644#section-3.6>`_ request.
+
+    .. code-block:: bash
+
+        scim https://scim.example delete user 1234
+    """
+
+    try:
+        resource_type = ctx.obj["resource_types"][resource_type]
+    except KeyError:
+        ok_values = ", ".join(ctx.obj["resource_types"])
+        raise ClickException(
+            f"Unknown resource type '{resource_type}'. Available values are: {ok_values}'"
+        )
+
+    try:
+        response = ctx.obj["client"].delete(resource_type, id)
+
+    except (httpx.HTTPError, SCIMClientError) as exc:
+        raise ClickException(exc) from exc
+
+    if response:
+        payload = formatted_payload(response.model_dump(), indent)
+        click.echo(payload)

scim2_cli/delete.py

@@ -0,0 +1,132 @@
+from typing import List
+from typing import Optional
+
+import click
+import httpx
+from click import ClickException
+from pydantic import ValidationError
+from scim2_client import SCIMClientError
+from scim2_models import SearchRequest
+from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
+
+from .utils import DOC_URL
+from .utils import formatted_payload
+
+
+@click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="query")
+@click.pass_context
+@click.argument("resource_type", required=False)
+@click.argument("id", required=False)
+@click.option(
+    "--attribute",
+    multiple=True,
+    help="A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default.",
+)
+@click.option(
+    "--excluded-attribute",
+    multiple=True,
+    help="A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return.",
+)
+@click.option(
+    "--start-index",
+    type=int,
+    help="An integer indicating the 1-based index of the first query result.",
+)
+@click.option(
+    "--count",
+    type=int,
+    help="An integer indicating the desired maximum number of query results per page.",
+)
+@click.option(
+    "--filter", help="The filter string used to request a subset of resources."
+)
+@click.option(
+    "--sort-by",
+    help="A string indicating the attribute whose value SHALL be used to order the returned responses.",
+)
+@click.option(
+    "--sort-order",
+    help="A string indicating the order in which the “sortBy” parameter is applied.",
+)
+@click.option(
+    "--indent/--no-indent",
+    is_flag=True,
+    default=True,
+    help="Indent JSON response payloads.",
+)
+def query_cli(
+    ctx,
+    resource_type: Optional[str],
+    id: Optional[str],
+    attribute: List[str],
+    excluded_attribute: List[str],
+    start_index: int,
+    count: int,
+    filter: str,
+    sort_by: str,
+    sort_order: str,
+    indent: bool,
+):
+    """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request
+    on the :code:`RESOURCE_TYPE` endpoint.
+
+    - If :code:`RESOURCE_TYPE` is :code:`user` and :code:`id` is `1234`, then the request will made on the :code:`/Users/1234` endpoint.
+    - If :code:`RESOURCE_TYPE` is :code:`user` and :code:`id` is not set, then the request will made on the :code:`/Users` endpoint.
+    - If :code:`RESOURCE_TYPE` is not set, then the request will made on the :code:`/` endpoint.
+
+    Data passed in JSON format to stdin is sent as request arguments and all the other query arguments are ignored:
+
+    .. code-block:: bash
+
+        echo '{"startIndex": 50, "count": 10}' | scim https://scim.example query user
+    """
+
+    if resource_type:
+        try:
+            resource_type = ctx.obj["resource_types"][resource_type]
+        except KeyError:
+            ok_values = ", ".join(ctx.obj["resource_types"])
+            raise ClickException(
+                f"Unknown resource type '{resource_type}. Available values are: {ok_values}'"
+            )
+
+    if ctx.obj.get("stdin"):
+        check_request_payload = False
+        payload = ctx.obj.get("stdin")
+
+    else:
+        check_request_payload = True
+        payload = SearchRequest(
+            attributes=attribute,
+            excluded_attributes=excluded_attribute,
+            start_index=start_index,
+            count=count,
+            filter=filter,
+            sort_by=sort_by,
+            sort_order=sort_order,
+        )
+
+    try:
+        if resource_type:
+            response = ctx.obj["client"].query(
+                resource_type,
+                id,
+                search_request=payload,
+                check_request_payload=check_request_payload,
+            )
+
+        else:
+            response = ctx.obj["client"].query_all(
+                search_request=payload, check_request_payload=check_request_payload
+            )
+
+    except (httpx.HTTPError, SCIMClientError) as exc:
+        raise ClickException(exc) from exc
+
+    except ValidationError as exc:
+        payload = formatted_payload(exc.response_payload, indent)
+        message = f"The server response is invalid:\n{payload}\n{exc}"
+        raise ClickException(message) from exc
+
+    payload = formatted_payload(response.model_dump(), indent)
+    click.echo(payload)