feat: dynamic options for create and replace commands

Author: azmeuk

README.md

@@ -24,12 +24,7 @@ Check the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html)
 Here is an example of resource creation:
 
 ```shell
-$ scim2 https://auth.example --headers "Authorization: Bearer 12345" create user << EOL
-{
-    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
-    "userName": "bjensen@example.com"
-}
-EOL
+$ scim2 https://auth.example --headers "Authorization: Bearer 12345" create user --user-name "bjensen@example.com"
 {
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
     "id": "2819c223-7f76-453a-919d-413861904646",

doc/changelog.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+[0.2.0] - Unreleased
+--------------------
+
+Fixed
+^^^^^
+- Dynamic command parameters for ``create`` and ``replace``.
+
 [0.1.4] - 2024-07-26
 --------------------
 

poetry.lock

@@ -34,6 +34,7 @@ click = "^8.1.7"
 scim2-client = "^0.1.10"
 scim2-tester = "^0.1.3"
 sphinx-click-rst-to-ansi-formatter = "^0.1.0"
+pydanclick = "^0.3.0"
 
 [tool.poetry.group.doc]
 optional = true

pyproject.toml

@@ -47,6 +47,5 @@ def cli(ctx, url):
 cli.add_command(search_cli)
 cli.add_command(test_cli)
 
-
 if __name__ == "__main__":  # pragma: no cover
     cli()

scim2_cli/__init__.py

@@ -2,15 +2,97 @@
 
 import click
 from click import ClickException
+from pydanclick import from_pydantic
 from scim2_client import SCIMClientError
+from scim2_models import Context
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from .utils import DOC_URL
+from .utils import ModelCommand
 from .utils import formatted_payload
 from .utils import split_headers
+from .utils import unacceptable_fields
 
 
-@click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="create")
+def create_payload(client, payload, indent, headers):
+    try:
+        response = client.create(payload, headers=split_headers(headers))
+
+    except SCIMClientError as scim_exc:
+        message = str(scim_exc)
+        if sys.version_info >= (3, 11) and hasattr(
+            scim_exc, "__notes__"
+        ):  # pragma: no cover
+            for note in scim_exc.__notes__:
+                message = f"{message}\n{note}"
+        raise ClickException(message) from scim_exc
+
+    payload = formatted_payload(response.model_dump(), indent)
+    click.echo(payload)
+
+
+def create_factory(model):
+    exclude = unacceptable_fields(Context.RESOURCE_CREATION_REQUEST, model)
+
+    @click.command(
+        cls=make_rst_to_ansi_formatter(DOC_URL),
+        name=model.__name__.lower(),
+    )
+    @click.option(
+        "--indent/--no-indent",
+        is_flag=True,
+        default=True,
+        help="Indent JSON response payloads.",
+    )
+    @click.option(
+        "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+    )
+    @from_pydantic("obj", model, exclude=exclude)
+    @click.pass_context
+    def create_command(ctx, indent, headers, obj: model, *args, **kwargs):
+        """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request
+        on resources endpoint.
+
+        Input data can be passed through parameters like :code:`--external-id`.
+
+        .. code-block:: bash
+
+            scim https://scim.example create user --user-name "foo" --name-given-name "bar"
+
+        Multiple attributes should be passed as JSON payloads:
+
+        .. code-block:: bash
+
+            scim https://scim.example create user \\
+                --user-name "foo" \\
+                --emails '[{"value":"foo@bar.example", "primary": true}, {"value": "foo@baz.example"}]'
+
+        Input can also be passed through stdin in JSON format:
+
+        .. code-block:: bash
+
+            echo '{"userName": "bjensen@example.com", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"]}' | scim https://scim.example create user
+        """
+
+        if obj == model():
+            obj = None
+
+        payload = ctx.obj.get("stdin") or obj
+        if not payload:
+            click.echo(ctx.get_help())
+            ctx.exit(1)
+
+        create_payload(ctx.obj["client"], payload, indent, headers)
+
+    return create_command
+
+
+@click.command(
+    cls=ModelCommand,
+    factory=create_factory,
+    name="create",
+    invoke_without_command=True,
+)
 @click.pass_context
 @click.option(
     "--indent/--no-indent",
@@ -25,29 +107,26 @@ def create_cli(ctx, indent, headers):
     """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:
+    There are subcommands for all the available models, with dynamic attributes.
+    See the attributes for :code:`user` with:
 
     .. code-block:: bash
 
-        echo '{"userName": "bjensen@example.com", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"]}' | scim https://scim.example create user
+        scim https://scim.example create user --help
+
+    If no subcommand is executed, 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
     """
 
+    if ctx.invoked_subcommand is not None:
+        return
+
     payload = ctx.obj.get("stdin")
     if not payload:
-        raise ClickException("Input data is missing")
-
-    try:
-        response = ctx.obj["client"].create(payload, headers=split_headers(headers))
-
-    except SCIMClientError as scim_exc:
-        message = str(scim_exc)
-        if sys.version_info >= (3, 11) and hasattr(
-            scim_exc, "__notes__"
-        ):  # pragma: no cover
-            for note in scim_exc.__notes__:
-                message = f"{message}\n{note}"
-        raise ClickException(message) from scim_exc
+        click.echo(ctx.get_help())
+        ctx.exit(1)
 
-    payload = formatted_payload(response.model_dump(), indent)
-    click.echo(payload)
+    create_payload(ctx.obj["client"], payload, indent, headers)

scim2_cli/create.py

@@ -2,15 +2,99 @@
 
 import click
 from click import ClickException
+from pydanclick import from_pydantic
 from scim2_client import SCIMClientError
+from scim2_models import Context
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from .utils import DOC_URL
+from .utils import ModelCommand
 from .utils import formatted_payload
 from .utils import split_headers
+from .utils import unacceptable_fields
 
 
-@click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="replace")
+def replace_payload(client, payload, indent, headers):
+    try:
+        response = client.replace(payload, headers=split_headers(headers))
+
+    except SCIMClientError as scim_exc:
+        message = str(scim_exc)
+        if sys.version_info >= (3, 11) and hasattr(
+            scim_exc, "__notes__"
+        ):  # pragma: no cover
+            for note in scim_exc.__notes__:
+                message = f"{message}\n{note}"
+        raise ClickException(message) from scim_exc
+
+    payload = formatted_payload(response.model_dump(), indent)
+    click.echo(payload)
+
+
+def replace_factory(model):
+    exclude = unacceptable_fields(Context.RESOURCE_REPLACEMENT_REQUEST, model)
+    exclude.remove("id")
+
+    @click.command(
+        cls=make_rst_to_ansi_formatter(DOC_URL),
+        name=model.__name__.lower(),
+    )
+    @click.option(
+        "--indent/--no-indent",
+        is_flag=True,
+        default=True,
+        help="Indent JSON response payloads.",
+    )
+    @click.option(
+        "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+    )
+    @from_pydantic("obj", model, exclude=exclude)
+    @click.pass_context
+    def replace_command(ctx, indent, headers, obj: model, *args, **kwargs):
+        """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request
+        on resources endpoint.
+
+        Input data can be passed through parameters like :code:`--external-id`.
+
+        .. code-block:: bash
+
+            scim https://scim.example replace user --id "xxxx-yyyy" --user-name "foo" --name-given-name "bar"
+
+        Multiple attributes should be passed as JSON payloads:
+
+        .. code-block:: bash
+
+            scim https://scim.example replace user \\
+                --id "xxxx-yyyy" \\
+                --user-name "foo" \\
+                --emails '[{"value":"foo@bar.example", "primary": true}, {"value": "foo@baz.example"}]'
+
+        Input can also be passed through stdin in JSON format:
+
+        .. code-block:: bash
+
+            echo '{"id": "xxxx-yyyy", "userName": "bjensen@example.com", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"]}' | scim https://scim.example replace user
+        """
+
+        if obj == model():
+            obj = None
+
+        payload = ctx.obj.get("stdin") or obj
+        if not payload:
+            click.echo(ctx.get_help())
+            ctx.exit(1)
+
+        replace_payload(ctx.obj["client"], payload, indent, headers)
+
+    return replace_command
+
+
+@click.command(
+    cls=ModelCommand,
+    factory=replace_factory,
+    name="replace",
+    invoke_without_command=True,
+)
 @click.pass_context
 @click.option(
     "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
@@ -25,29 +109,26 @@ def replace_cli(ctx, headers, indent):
     """Perform a `SCIM PUT <https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1>`_ request
     on the resources endpoint.
 
-    Input data is expected to be passed in JSON format to stdin:
+    There are subcommands for all the available models, with dynamic attributes.
+    See the attributes for :code:`user` with:
+
+    .. code-block:: bash
+
+        scim https://scim.example replace user --help
+
+    If no subcommand is executed, 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"], "id": "1234"}' | scim https://scim.example replace user
 
     """
+    if ctx.invoked_subcommand is not None:
+        return
 
     payload = ctx.obj.get("stdin")
     if not payload:
-        raise ClickException("Input data is missing")
-
-    try:
-        response = ctx.obj["client"].replace(payload, headers=split_headers(headers))
-
-    except SCIMClientError as scim_exc:
-        message = str(scim_exc)
-        if sys.version_info >= (3, 11) and hasattr(
-            scim_exc, "__notes__"
-        ):  # pragma: no cover
-            for note in scim_exc.__notes__:
-                message = f"{message}\n{note}"
-        raise ClickException(message) from scim_exc
+        click.echo(ctx.get_help())
+        ctx.exit(1)
 
-    payload = formatted_payload(response.model_dump(), indent)
-    click.echo(payload)
+    replace_payload(ctx.obj["client"], payload, indent, headers)