feat: add cli parameters for return_type selection (#113)

Fixes #111

Author: afuetterer

.github/workflows/test.yml

@@ -28,6 +28,8 @@ jobs:
       run: python -m pip install --require-hashes --requirement=.github/requirements/ci.txt
     - name: Run test suite
       run: hatch run cov
+      env:
+        TERM: dumb # keep rich from printing escape sequences, which made testing CLI outputs messy
     - name: Generate coverage report
       run: |
         export TOTAL_COV=$(hatch run cov-total)

src/re3data/_cli.py

@@ -11,6 +11,7 @@
 from rich import print
 
 import re3data
+from re3data._client import ReturnType
 
 logger = logging.getLogger(__name__)
 
@@ -53,14 +54,14 @@ def callback(
 
 
 @repositories_app.command("list")
-def list_repositories() -> None:
+def list_repositories(return_type: ReturnType = ReturnType.xml) -> None:
     """List the metadata of all repositories in the re3data API."""
-    response = re3data.repositories.list()
+    response = re3data.repositories.list(return_type=return_type.value)
     print(response)
 
 
 @repositories_app.command("get")
-def get_repository(repository_id: str) -> None:
+def get_repository(repository_id: str, return_type: ReturnType = ReturnType.xml) -> None:
     """Get the metadata of a specific repository."""
-    response = re3data.repositories.get(repository_id)
+    response = re3data.repositories.get(repository_id, return_type=return_type.value)
     print(response)

src/re3data/_client.py

@@ -8,6 +8,7 @@
 
 import logging
 from abc import ABC, abstractmethod
+from enum import Enum
 
 import httpx
 
@@ -21,7 +22,14 @@
     "User-Agent": f"python-re3data/{__version__}",
 }
 DEFAULT_TIMEOUT = httpx.Timeout(timeout=10.0)  # timeout in seconds
-ALLOWED_RETURN_TYPES = {"xml", "response"}
+
+
+class ReturnType(str, Enum):
+    response = "response"
+    xml = "xml"
+
+
+ALLOWED_RETURN_TYPES = {return_type.value for return_type in ReturnType}
 
 
 def log_response(response: httpx.Response) -> None:
@@ -51,7 +59,7 @@ class RepositoryManager:
     def __init__(self, client: Client) -> None:
         self._client = client
 
-    def list(self, return_type: str = "xml") -> str | httpx.Response:
+    def list(self, return_type: str = ReturnType.xml.value) -> str | httpx.Response:
         """List the metadata of all repositories in the re3data API.
 
         Args:
@@ -62,7 +70,7 @@ def list(self, return_type: str = "xml") -> str | httpx.Response:
         """
         return self._client._request("repositories", return_type)
 
-    def get(self, repository_id: str, return_type: str = "xml") -> str | httpx.Response:
+    def get(self, repository_id: str, return_type: str = ReturnType.xml.value) -> str | httpx.Response:
         """Get the metadata of a specific repository.
 
         Args:

tests/integration/test_cli.py

@@ -64,14 +64,35 @@ def test_repository_no_args_displays_help() -> None:
     assert "Options" in result.output
 
 
-def test_repository_list(mock_repository_list_route: Route) -> None:
+def test_repository_list_default_return_type(mock_repository_list_route: Route) -> None:
     result = runner.invoke(app, ["repository", "list"])
     assert result.exit_code == 0
     assert "<list>" in result.output
     assert "<repository>" in result.output
     assert "<id>" in result.output
 
 
+def test_repository_list_xml(mock_repository_list_route: Route) -> None:
+    result = runner.invoke(app, ["repository", "list", "--return-type", "xml"])
+    assert result.exit_code == 0
+    assert "<list>" in result.output
+    assert "<repository>" in result.output
+    assert "<id>" in result.output
+
+
+def test_repository_list_response(mock_repository_list_route: Route) -> None:
+    result = runner.invoke(app, ["repository", "list", "--return-type", "response"])
+    assert result.exit_code == 0
+    assert "<Response [200 OK]>" in result.output
+
+
+def test_repository_list_invalid_return_type(mock_repository_list_route: Route) -> None:
+    result = runner.invoke(app, ["repository", "list", "--return-type", "json"])
+    assert result.exit_code == 2
+    assert "Error" in result.output
+    assert "Invalid value for '--return-type': 'json'" in result.output
+
+
 def test_repository_get_without_repository_id(mock_repository_list_route: Route) -> None:
     result = runner.invoke(app, ["repository", "get"])
     assert result.exit_code == 2
@@ -80,13 +101,39 @@ def test_repository_get_without_repository_id(mock_repository_list_route: Route)
 
 @pytest.mark.default_cassette("repository.yaml")
 @pytest.mark.vcr()
-def test_repository_get_with_repository_id(zenodo_id: str) -> None:
+def test_repository_get_with_repository_id_default_return_type(zenodo_id: str) -> None:
     result = runner.invoke(app, ["repository", "get", zenodo_id])
     assert result.exit_code == 0
     assert "<r3d:repository>" in result.output
     assert "<r3d:re3data.orgIdentifier>r3d100010468" in result.output
 
 
+@pytest.mark.default_cassette("repository.yaml")
+@pytest.mark.vcr()
+def test_repository_get_with_repository_id_xml(zenodo_id: str) -> None:
+    result = runner.invoke(app, ["repository", "get", zenodo_id, "--return-type", "xml"])
+    assert result.exit_code == 0
+    assert "<r3d:repository>" in result.output
+    assert "<r3d:re3data.orgIdentifier>r3d100010468" in result.output
+
+
+@pytest.mark.default_cassette("repository.yaml")
+@pytest.mark.vcr()
+def test_repository_get_with_repository_id_response(zenodo_id: str) -> None:
+    result = runner.invoke(app, ["repository", "get", zenodo_id, "--return-type", "response"])
+    assert result.exit_code == 0
+    assert "<Response [200 OK]>" in result.output
+
+
+@pytest.mark.default_cassette("repository.yaml")
+@pytest.mark.vcr()
+def test_repository_get_with_repository_id_invalid_return_type(zenodo_id: str) -> None:
+    result = runner.invoke(app, ["repository", "get", zenodo_id, "--return-type", "json"])
+    assert result.exit_code == 2
+    assert "Error" in result.output
+    assert "Invalid value for '--return-type': 'json'" in result.output
+
+
 @pytest.mark.default_cassette("repository.yaml")
 @pytest.mark.vcr()
 def test_repository_get_with_invalid_repository_id() -> None: