scim2-cli 0.1.1__tar.gz → 0.1.2__tar.gz

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scim2-cli
-Version: 0.1.1
+Version: 0.1.2
 Summary: SCIM application development CLI
 License: MIT
 Keywords: scim,scim2,provisioning
@@ -20,13 +20,21 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Dist: click (>=8.1.7,<9.0.0)
-Requires-Dist: scim2-client (>=0.1.4,<0.2.0)
+Requires-Dist: scim2-client (>=0.1.6,<0.2.0)
+Requires-Dist: scim2-tester (>=0.1.2,<0.2.0)
 Requires-Dist: sphinx-click-rst-to-ansi-formatter (>=0.1.0,<0.2.0)
 Description-Content-Type: text/markdown
 
 # scim2-cli
 
-An utility command line to help you perform requests against a SCIM server, while validating input and response payloads.
+An utility command line to help you perform requests against a SCIM server, while validating input and response payloads. It also uses [scim2-tester](https://scim2-tester.readthedocs.io) to perform a [SCIM server compliance test](https://scim2-cli.readthedocs.io/en/latest/reference.html#scim-url-test).
+
+## What's SCIM anyway?
+
+SCIM stands for System for Cross-domain Identity Management, and it is a provisioning protocol.
+Provisioning is the action of managing a set of resources across different services, usually users and groups.
+SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect.
+It allows users and groups creations, modifications and deletions to be synchronized between applications.
 
 ## Installation
 
@@ -41,7 +49,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 create user << EOL
+$ 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"
@@ -64,7 +72,7 @@ EOL
 Here is an example of resource query:
 
 ```shell
-$ scim2 https://auth.example query user 2819c223-7f76-453a-919d-413861904646
+$ scim2 https://auth.example --header "Authorization: Bearer 12345" query user 2819c223-7f76-453a-919d-413861904646
 {
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
     "id": "2819c223-7f76-453a-919d-413861904646",
@@ -79,3 +87,8 @@ $ scim2 https://auth.example query user 2819c223-7f76-453a-919d-413861904646
 }
 ```
 
+scim2-cli belongs in a collection of SCIM tools developed by [Yaal Coop](https://yaal.coop),
+with [scim2-models](https://github.com/yaal-coop/scim2-models),
+[scim2-client](https://github.com/yaal-coop/scim2-client) and
+[scim2-tester](https://github.com/yaal-coop/scim2-tester)
+

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/README.md

@@ -1,6 +1,13 @@
 # scim2-cli
 
-An utility command line to help you perform requests against a SCIM server, while validating input and response payloads.
+An utility command line to help you perform requests against a SCIM server, while validating input and response payloads. It also uses [scim2-tester](https://scim2-tester.readthedocs.io) to perform a [SCIM server compliance test](https://scim2-cli.readthedocs.io/en/latest/reference.html#scim-url-test).
+
+## What's SCIM anyway?
+
+SCIM stands for System for Cross-domain Identity Management, and it is a provisioning protocol.
+Provisioning is the action of managing a set of resources across different services, usually users and groups.
+SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect.
+It allows users and groups creations, modifications and deletions to be synchronized between applications.
 
 ## Installation
 
@@ -15,7 +22,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 create user << EOL
+$ 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"
@@ -38,7 +45,7 @@ EOL
 Here is an example of resource query:
 
 ```shell
-$ scim2 https://auth.example query user 2819c223-7f76-453a-919d-413861904646
+$ scim2 https://auth.example --header "Authorization: Bearer 12345" query user 2819c223-7f76-453a-919d-413861904646
 {
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
     "id": "2819c223-7f76-453a-919d-413861904646",
@@ -52,3 +59,8 @@ $ scim2 https://auth.example query user 2819c223-7f76-453a-919d-413861904646
    }
 }
 ```
+
+scim2-cli belongs in a collection of SCIM tools developed by [Yaal Coop](https://yaal.coop),
+with [scim2-models](https://github.com/yaal-coop/scim2-models),
+[scim2-client](https://github.com/yaal-coop/scim2-client) and
+[scim2-tester](https://github.com/yaal-coop/scim2-tester)

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "scim2-cli"
-version = "0.1.1"
+version = "0.1.2"
 description = "SCIM application development CLI"
 authors = ["Yaal Coop <contact@yaal.coop>"]
 license = "MIT"
@@ -27,7 +27,8 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.10"
 click = "^8.1.7"
-scim2-client = "^0.1.4"
+scim2-client = "^0.1.6"
+scim2-tester = "^0.1.2"
 sphinx-click-rst-to-ansi-formatter = "^0.1.0"
 
 [tool.poetry.group.doc]

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/scim2_cli/__init__.py

@@ -3,7 +3,6 @@ import json
 import click
 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
@@ -13,6 +12,7 @@ from .delete import delete_cli
 from .query import query_cli
 from .replace import replace_cli
 from .search import search_cli
+from .test import test_cli
 from .utils import DOC_URL
 
 
@@ -25,9 +25,7 @@ def cli(ctx, url):
     ctx.ensure_object(dict)
     ctx.obj["URL"] = url
     client = Client(base_url=ctx.obj["URL"])
-    ctx.obj["client"] = SCIMClient(
-        client, resource_types=(User, User[EnterpriseUser], Group)
-    )
+    ctx.obj["client"] = SCIMClient(client, resource_types=(User, Group))
     ctx.obj["resource_types"] = {
         resource_type.__name__.lower(): resource_type
         for resource_type in ctx.obj["client"].resource_types
@@ -47,3 +45,4 @@ cli.add_command(query_cli)
 cli.add_command(replace_cli)
 cli.add_command(delete_cli)
 cli.add_command(search_cli)
+cli.add_command(test_cli)

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/scim2_cli/create.py

@@ -1,12 +1,13 @@
+import sys
+
 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
+from .utils import split_headers
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="create")
@@ -17,7 +18,10 @@ from .utils import formatted_payload
     default=True,
     help="Indent JSON response payloads.",
 )
-def create_cli(ctx, indent):
+@click.option(
+    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+)
+def create_cli(ctx, indent, headers):
     """Perform a `SCIM POST <https://www.rfc-editor.org/rfc/rfc7644#section-3.3>`_ request
     on resources endpoint.
 
@@ -34,15 +38,16 @@ def create_cli(ctx, indent):
         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
+        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
 
     payload = formatted_payload(response.model_dump(), indent)
     click.echo(payload)

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/scim2_cli/delete.py

@@ -1,16 +1,23 @@
+import sys
+
 import click
-import httpx
 from click import ClickException
 from scim2_client import SCIMClientError
+from scim2_models import Message
+from scim2_models import Resource
 from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
 
 from .utils import DOC_URL
 from .utils import formatted_payload
+from .utils import split_headers
 
 
 @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(
+    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+)
 @click.option(
     "--indent/--no-indent",
     is_flag=True,
@@ -18,7 +25,7 @@ from .utils import formatted_payload
     help="Indent JSON response payloads.",
 )
 @click.pass_context
-def delete_cli(ctx, resource_type, id, indent):
+def delete_cli(ctx, resource_type, id, headers, indent):
     """Perform a `SCIM DELETE query <https://www.rfc-editor.org/rfc/rfc7644#section-3.6>`_ request.
 
     .. code-block:: bash
@@ -35,11 +42,24 @@ def delete_cli(ctx, resource_type, id, indent):
         )
 
     try:
-        response = ctx.obj["client"].delete(resource_type, id)
+        response = ctx.obj["client"].delete(
+            resource_type, id, headers=split_headers(headers)
+        )
 
-    except (httpx.HTTPError, SCIMClientError) as exc:
-        raise ClickException(exc) from exc
+    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
 
     if response:
-        payload = formatted_payload(response.model_dump(), indent)
+        payload = (
+            response.model_dump()
+            if isinstance(response, (Resource, Message))
+            else response
+        )
+        payload = formatted_payload(payload, indent)
         click.echo(payload)

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/scim2_cli/query.py

@@ -1,16 +1,16 @@
+import sys
 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
+from .utils import split_headers
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="query")
@@ -48,6 +48,9 @@ from .utils import formatted_payload
     "--sort-order",
     help="A string indicating the order in which the “sortBy” parameter is applied.",
 )
+@click.option(
+    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+)
 @click.option(
     "--indent/--no-indent",
     is_flag=True,
@@ -65,6 +68,7 @@ def query_cli(
     filter: str,
     sort_by: str,
     sort_order: str,
+    headers: List[str],
     indent: bool,
 ):
     """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request
@@ -107,26 +111,22 @@ def query_cli(
         )
 
     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
+        response = ctx.obj["client"].query(
+            resource_type,
+            id,
+            search_request=payload,
+            check_request_payload=check_request_payload,
+            headers=split_headers(headers),
+        )
 
-    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
+    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)

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/scim2_cli/replace.py

@@ -1,23 +1,27 @@
+import sys
+
 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
+from .utils import split_headers
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="replace")
 @click.pass_context
+@click.option(
+    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+)
 @click.option(
     "--indent/--no-indent",
     is_flag=True,
     default=True,
     help="Indent JSON response payloads.",
 )
-def replace_cli(ctx, indent):
+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.
 
@@ -34,15 +38,16 @@ def replace_cli(ctx, indent):
         raise ClickException("Input data is missing")
 
     try:
-        response = ctx.obj["client"].replace(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
+        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
 
     payload = formatted_payload(response.model_dump(), indent)
     click.echo(payload)

{scim2_cli-0.1.1 → scim2_cli-0.1.2}/scim2_cli/search.py

@@ -1,15 +1,15 @@
+import sys
 from typing import List
 
 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
+from .utils import split_headers
 
 
 @click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="search")
@@ -45,6 +45,9 @@ from .utils import formatted_payload
     "--sort-order",
     help="A string indicating the order in which the “sortBy” parameter is applied.",
 )
+@click.option(
+    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+)
 @click.option(
     "--indent/--no-indent",
     is_flag=True,
@@ -60,6 +63,7 @@ def search_cli(
     filter: str,
     sort_by: str,
     sort_order: str,
+    headers: List[str],
     indent: bool,
 ):
     """Perform a `SCIM GET <https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1>`_ request
@@ -92,15 +96,17 @@ def search_cli(
         response = ctx.obj["client"].search(
             search_request=payload,
             check_request_payload=check_request_payload,
+            headers=split_headers(headers),
         )
 
-    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
+    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)

scim2_cli-0.1.2/scim2_cli/test.py

@@ -0,0 +1,40 @@
+import click
+from scim2_tester import Status
+from scim2_tester import check_server
+from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
+
+from .utils import DOC_URL
+from .utils import Color
+from .utils import split_headers
+
+
+@click.command(cls=make_rst_to_ansi_formatter(DOC_URL), name="test")
+@click.pass_context
+@click.option(
+    "-h", "--headers", multiple=True, help="Header to pass in the HTTP requests."
+)
+@click.option("-v", "--verbose", is_flag=True, help="Enables verbose mode")
+def test_cli(ctx, headers, verbose):
+    """Perform a server SCIM compliance check using :doc:`scim2-tester
+    <scim2-tester:index>`.
+
+    .. code-block:: bash
+
+        scim https://scim.example test
+    """
+
+    client = ctx.obj["client"]
+    client.client.headers.update(split_headers(headers))
+    results = check_server(client)
+    click.echo(f"Performing a SCIM compliance check on {client.client.base_url} ...")
+    for result in results:
+        if result.status == Status.SUCCESS:
+            status = click.style(result.status.name, fg=Color.green)
+        else:
+            status = click.style(result.status.name, fg=Color.red)
+        click.echo(f"{status} {result.title}")
+
+        if result.reason:
+            click.echo(f"  {result.reason}")
+            if verbose and result.data:
+                click.echo(f"  {result.data}")

scim2_cli-0.1.2/scim2_cli/utils.py

@@ -0,0 +1,36 @@
+import json
+from enum import Enum
+
+DOC_URL = "https://scim2-cli.readthedocs.io/"
+INDENTATION_SIZE = 4
+
+
+class Color(str, Enum):
+    black = "black"
+    red = "red"
+    green = "green"
+    yellow = "yellow"
+    blue = "blue"
+    magenta = "magenta"
+    cyan = "cyan"
+    white = "white"
+    bright_black = "bright_black"
+    bright_red = "bright_red"
+    bright_green = "bright_green"
+    bright_yellow = "bright_yellow"
+    bright_blue = "bright_blue"
+    bright_magenta = "bright_magenta"
+    bright_cyan = "bright_cyan"
+    bright_white = "bright_white"
+
+
+def formatted_payload(obj, indent):
+    indent = INDENTATION_SIZE if indent else False
+    return json.dumps(obj, indent=indent)
+
+
+def split_headers(headers):
+    return {
+        header[: header.index(":")].strip(): header[header.index(":") + 1 :].strip()
+        for header in headers
+    }

scim2_cli-0.1.1/scim2_cli/utils.py

@@ -1,9 +0,0 @@
-import json
-
-DOC_URL = "https://scim2-cli.readthedocs.io/"
-INDENTATION_SIZE = 4
-
-
-def formatted_payload(obj, indent):
-    indent = INDENTATION_SIZE if indent else False
-    return json.dumps(obj, indent=indent)