feat: basic requests

stdin is forwarded to the different endpoints

Author: azmeuk

poetry.lock

@@ -27,10 +27,12 @@ classifiers = [
 [tool.poetry.dependencies]
 python = "^3.9"
 click = "^8.1.7"
+requests = "^2.32.2"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.1"
 pytest-coverage = "^0.0"
+pytest-httpserver = "^1.0.10"
 
 [tool.poetry.group.doc.dependencies]
 shibuya = "^2024.5.15"

pyproject.toml

@@ -1,7 +1,107 @@
+import json
+
 import click
+import requests
+
+BASE_HEADERS = {
+    "Accept": "application/scim+json",
+    "Content-Type": "application/scim+json",
+}
+
+
+@click.group()
+@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()
+@click.pass_context
+def get(ctx):
+    """Perform a SCIM GET request.
+
+    https://www.rfc-editor.org/rfc/rfc7644#section-3.4.1
+    """
+
+    response = requests.get(
+        ctx.obj["URL"],
+        params=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)
+
+
+@cli.command()
+@click.pass_context
+def post(ctx):
+    """Perform a SCIM POST request.
+
+    https://www.rfc-editor.org/rfc/rfc7644#section-3.3
+    """
+
+    response = requests.post(
+        ctx.obj["URL"],
+        json=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)
+
+
+@cli.command()
+@click.pass_context
+def put(ctx):
+    """Perform a SCIM PUT request.
+
+    https://www.rfc-editor.org/rfc/rfc7644#section-3.5.1
+    """
+
+    response = requests.put(
+        ctx.obj["URL"],
+        json=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)
+
+
+@cli.command()
+@click.pass_context
+def patch(ctx):
+    """Perform a SCIM PATCH request.
+
+    https://www.rfc-editor.org/rfc/rfc7644#section-3.5.2
+    """
+
+    response = requests.patch(
+        ctx.obj["URL"],
+        json=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)
+
+
+@cli.command()
+@click.pass_context
+def delete(ctx):
+    """Perform a SCIM DELETE request.
 
+    https://www.rfc-editor.org/rfc/rfc7644#section-3.6
+    """
 
-@click.command()
-def cli():
-    """Hello, world."""
-    click.echo("Hello world!")
+    response = requests.delete(
+        ctx.obj["URL"],
+        json=ctx.obj.get("STDIN"),
+        headers=BASE_HEADERS,
+        allow_redirects=True,
+    )
+    click.echo(response.text)

scim_cli/__init__.py

@@ -1,7 +1,28 @@
+import json
+
 import pytest
 from click.testing import CliRunner
 
 
 @pytest.fixture
 def runner():
     return CliRunner()
+
+
+@pytest.fixture
+def echoserver(httpserver):
+    def echo_handler(request):
+        payload = {
+            "method": request.method,
+        }
+
+        if request.args:
+            payload["args"] = request.args
+
+        if request.data:
+            payload["payload"] = request.json if request.is_json else request.data
+
+        return json.dumps(payload)
+
+    httpserver.expect_request("/").respond_with_handler(echo_handler)
+    return httpserver

tests/conftest.py

@@ -1,7 +1,87 @@
+import json
+
 from scim_cli import cli
 
 
-def test_hello_world(runner):
-    result = runner.invoke(cli)
+def test_help(runner):
+    result = runner.invoke(cli, ["--help"])
+    assert result.exit_code == 0
+    assert "SCIM application development CLI.\n" in result.output
+
+
+def test_get_stdin(runner, echoserver):
+    """Test that JSON stdin is passed in the GET request."""
+    payload = {"foo": "bar"}
+    result = runner.invoke(
+        cli,
+        [echoserver.url_for("/"), "get"],
+        input=json.dumps(payload),
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
+    expected_payload = {"method": "GET", "args": payload}
+    json_output = json.loads(result.output)
+    assert expected_payload == json_output
+
+
+def test_post_stdin(runner, echoserver):
+    """Test that JSON stdin is passed in the POST request."""
+
+    payload = {"foo": "bar"}
+    result = runner.invoke(
+        cli,
+        [echoserver.url_for("/"), "post"],
+        input=json.dumps(payload),
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
+    expected_payload = {"method": "POST", "payload": payload}
+    json_output = json.loads(result.output)
+    assert expected_payload == json_output
+
+
+def test_put_stdin(runner, echoserver):
+    """Test that JSON stdin is passed in the PUT request."""
+
+    payload = {"foo": "bar"}
+    result = runner.invoke(
+        cli,
+        [echoserver.url_for("/"), "put"],
+        input=json.dumps(payload),
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
+    expected_payload = {"method": "PUT", "payload": payload}
+    json_output = json.loads(result.output)
+    assert expected_payload == json_output
+
+
+def test_patch_stdin(runner, echoserver):
+    """Test that JSON stdin is passed in the POST request."""
+
+    payload = {"foo": "bar"}
+    result = runner.invoke(
+        cli,
+        [echoserver.url_for("/"), "patch"],
+        input=json.dumps(payload),
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
+    expected_payload = {"method": "PATCH", "payload": payload}
+    json_output = json.loads(result.output)
+    assert expected_payload == json_output
+
+
+def test_delete_stdin(runner, echoserver):
+    """Test that JSON stdin is passed in the DELETE request."""
+    payload = {"foo": "bar"}
+    result = runner.invoke(
+        cli,
+        [echoserver.url_for("/"), "delete"],
+        input=json.dumps(payload),
+        catch_exceptions=False,
+    )
     assert result.exit_code == 0
-    assert result.output == "Hello world!\n"
+    expected_payload = {"method": "DELETE", "payload": payload}
+    json_output = json.loads(result.output)
+    assert expected_payload == json_output