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

scim2_cli-0.1.2/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.1
+Name: scim2-cli
+Version: 0.1.2
+Summary: SCIM application development CLI
+License: MIT
+Keywords: scim,scim2,provisioning
+Author: Yaal Coop
+Author-email: contact@yaal.coop
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+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.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. 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
+
+```shell
+pip install scim2-cli
+```
+
+## Usage
+
+Check the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html) for more details.
+
+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
+{
+    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+    "id": "2819c223-7f76-453a-919d-413861904646",
+    "userName": "bjensen@example.com",
+    "meta": {
+        "resourceType": "User",
+        "created": "2010-01-23T04:56:22Z",
+        "lastModified": "2011-05-13T04:42:34Z",
+        "version": 'W\\/"3694e05e9dff590"',
+        "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
+    },
+}
+```
+
+Here is an example of resource query:
+
+```shell
+$ 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",
+    "userName": "bjensen@example.com",
+    "meta": {
+        "resourceType": "User",
+        "created": "2010-01-23T04:56:22Z",
+        "lastModified": "2011-05-13T04:42:34Z",
+        "version": 'W\\/"3694e05e9dff590"',
+        "location": "https://example.com/v2/Users/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.2/README.md

@@ -0,0 +1,66 @@
+# scim2-cli
+
+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
+
+```shell
+pip install scim2-cli
+```
+
+## Usage
+
+Check the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html) for more details.
+
+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
+{
+    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
+    "id": "2819c223-7f76-453a-919d-413861904646",
+    "userName": "bjensen@example.com",
+    "meta": {
+        "resourceType": "User",
+        "created": "2010-01-23T04:56:22Z",
+        "lastModified": "2011-05-13T04:42:34Z",
+        "version": 'W\\/"3694e05e9dff590"',
+        "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
+    },
+}
+```
+
+Here is an example of resource query:
+
+```shell
+$ 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",
+    "userName": "bjensen@example.com",
+    "meta": {
+        "resourceType": "User",
+        "created": "2010-01-23T04:56:22Z",
+        "lastModified": "2011-05-13T04:42:34Z",
+        "version": 'W\\/"3694e05e9dff590"',
+        "location": "https://example.com/v2/Users/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.0 → 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.0"
+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"
-requests = "^2.32.2"
+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.2/scim2_cli/__init__.py

@@ -0,0 +1,48 @@
+import json
+
+import click
+from httpx import Client
+from scim2_client import SCIMClient
+from scim2_models import Group
+from scim2_models import User
+from sphinx_click.rst_to_ansi_formatter import make_rst_to_ansi_formatter
+
+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 .test import test_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
+    client = Client(base_url=ctx.obj["URL"])
+    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
+    }
+
+    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)
+cli.add_command(test_cli)

scim2_cli-0.1.2/scim2_cli/create.py

@@ -0,0 +1,53 @@
+import sys
+
+import click
+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
+from .utils import split_headers
+
+
+@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.",
+)
+@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.
+
+    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, 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.2/scim2_cli/delete.py

@@ -0,0 +1,65 @@
+import sys
+
+import click
+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,
+    default=True,
+    help="Indent JSON response payloads.",
+)
+@click.pass_context
+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
+
+        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, 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
+
+    if response:
+        payload = (
+            response.model_dump()
+            if isinstance(response, (Resource, Message))
+            else response
+        )
+        payload = formatted_payload(payload, indent)
+        click.echo(payload)

scim2_cli-0.1.2/scim2_cli/query.py

@@ -0,0 +1,132 @@
+import sys
+from typing import List
+from typing import Optional
+
+import click
+from click import ClickException
+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")
+@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(
+    "-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 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,
+    headers: List[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:
+        response = ctx.obj["client"].query(
+            resource_type,
+            id,
+            search_request=payload,
+            check_request_payload=check_request_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.2/scim2_cli/replace.py

@@ -0,0 +1,53 @@
+import sys
+
+import click
+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
+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, 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:
+
+    .. 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
+
+    """
+
+    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
+
+    payload = formatted_payload(response.model_dump(), indent)
+    click.echo(payload)

scim2_cli-0.1.2/scim2_cli/search.py

@@ -0,0 +1,112 @@
+import sys
+from typing import List
+
+import click
+from click import ClickException
+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")
+@click.pass_context
+@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(
+    "-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 search_cli(
+    ctx,
+    attribute: List[str],
+    excluded_attribute: List[str],
+    start_index: int,
+    count: int,
+    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
+    on the :code:`/.search` 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 search user
+    """
+
+    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:
+        response = ctx.obj["client"].search(
+            search_request=payload,
+            check_request_payload=check_request_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.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.0/PKG-INFO

@@ -1,30 +0,0 @@
-Metadata-Version: 2.1
-Name: scim2-cli
-Version: 0.1.0
-Summary: SCIM application development CLI
-License: MIT
-Keywords: scim,scim2,provisioning
-Author: Yaal Coop
-Author-email: contact@yaal.coop
-Requires-Python: >=3.10,<4.0
-Classifier: Development Status :: 3 - Alpha
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-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: requests (>=2.32.2,<3.0.0)
-Requires-Dist: sphinx-click-rst-to-ansi-formatter (>=0.1.0,<0.2.0)
-Description-Content-Type: text/markdown
-
-# scim2-cli
-
-A scim utility command line.
-

scim2_cli-0.1.0/README.md

@@ -1,3 +0,0 @@
-# scim2-cli
-
-A scim utility command line.

scim2_cli-0.1.0/scim2_cli/__init__.py

@@ -1,129 +0,0 @@
-import json
-
-import click
-import requests
-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",
-}
-
-
-@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,
-    )
-    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
-    """
-
-    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)