feat: add support for custom headers to the requests

Author: azmeuk

README.md

@@ -15,7 +15,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 --header "Authorization: Bearer 12345" create user << EOL
 {
     "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
     "userName": "bjensen@example.com"
@@ -38,7 +38,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",

doc/changelog.rst

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+Added
+^^^^^
+- Add support for passing custom headers to requests.
+
 [0.1.1] - 2024-06-02
 --------------------
 

scim2_cli/create.py

@@ -7,6 +7,7 @@
 
 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 @@
     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,7 +38,7 @@ def create_cli(ctx, indent):
         raise ClickException("Input data is missing")
 
     try:
-        response = ctx.obj["client"].create(payload)
+        response = ctx.obj["client"].create(payload, headers=split_headers(headers))
 
     except (httpx.HTTPError, SCIMClientError) as exc:
         raise ClickException(exc) from exc

scim2_cli/delete.py

@@ -6,19 +6,23 @@
 
 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, 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,7 +39,9 @@ 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

scim2_cli/query.py

@@ -11,6 +11,7 @@
 
 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 +49,9 @@
     "--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 +69,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
@@ -113,11 +118,14 @@ def query_cli(
                 id,
                 search_request=payload,
                 check_request_payload=check_request_payload,
+                headers=split_headers(headers),
             )
 
         else:
             response = ctx.obj["client"].query_all(
-                search_request=payload, check_request_payload=check_request_payload
+                search_request=payload,
+                check_request_payload=check_request_payload,
+                headers=split_headers(headers),
             )
 
     except (httpx.HTTPError, SCIMClientError) as exc:

scim2_cli/replace.py

@@ -7,17 +7,21 @@
 
 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,7 +38,7 @@ def replace_cli(ctx, indent):
         raise ClickException("Input data is missing")
 
     try:
-        response = ctx.obj["client"].replace(payload)
+        response = ctx.obj["client"].replace(payload, headers=split_headers(headers))
 
     except (httpx.HTTPError, SCIMClientError) as exc:
         raise ClickException(exc) from exc

scim2_cli/search.py

@@ -10,6 +10,7 @@
 
 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 +46,9 @@
     "--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 +64,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,6 +97,7 @@ 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:

scim2_cli/utils.py

@@ -7,3 +7,10 @@
 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
+    }