Merge pull request #36 from microbiomedata/copilot/fix-35

Add batch minting support to Minter class with optional count parameter

Author: hesspnnl

nmdc_api_utilities/minter.py

@@ -17,9 +17,11 @@ class Minter(NMDCSearch):
     def __init__(self, env="prod"):
         super().__init__(env=env)
 
-    def mint(self, nmdc_type: str, client_id: str, client_secret: str) -> str:
+    def mint(
+        self, nmdc_type: str, client_id: str, client_secret: str, count: int = 1
+    ) -> str | list[str]:
         """
-        Mint a new identifier for a collection.
+        Mint new identifier(s) for a collection.
 
         Parameters
         ----------
@@ -30,16 +32,21 @@ def mint(self, nmdc_type: str, client_id: str, client_secret: str) -> str:
             The client ID for the NMDC API.
         client_secret : str
             The client secret for the NMDC API.
+        count : int, optional
+            The number of identifiers to mint. Default is 1.
 
         Returns
         -------
-        str
-            The minted identifier.
+        str or list[str]
+            If count is 1, returns a single minted identifier as a string.
+            If count is greater than 1, returns a list of minted identifiers.
 
         Raises
         ------
         RuntimeError
             If the API request fails.
+        ValueError
+            If count is less than 1.
 
         Notes
         -----
@@ -48,6 +55,10 @@ def mint(self, nmdc_type: str, client_id: str, client_secret: str) -> str:
             Do not hard code these values in your code.
 
         """
+        # Validate count parameter
+        if count < 1:
+            raise ValueError("count must be at least 1")
+
         # get the token
         client = oauthlib.oauth2.BackendApplicationClient(client_id=client_id)
         oauth = requests_oauthlib.OAuth2Session(client=client)
@@ -57,7 +68,7 @@ def mint(self, nmdc_type: str, client_id: str, client_secret: str) -> str:
             client_secret=client_secret,
         )
         url = f"{self.base_url}/pids/mint"
-        payload = {"schema_class": {"id": nmdc_type}, "how_many": 1}
+        payload = {"schema_class": {"id": nmdc_type}, "how_many": count}
         try:
             response = oauth.post(url, data=json.dumps(payload))
             response.raise_for_status()
@@ -69,4 +80,8 @@ def mint(self, nmdc_type: str, client_id: str, client_secret: str) -> str:
                 f"API request response: {response.json()}\n API Status Code: {response.status_code}"
             )
         # return the response
-        return response.json()[0]
+        response_data = response.json()
+        if count == 1:
+            return response_data[0]
+        else:
+            return response_data

nmdc_api_utilities/test/test_mint.py

@@ -3,15 +3,55 @@
 import logging
 import os
 from dotenv import load_dotenv
+import pytest
 
 load_dotenv()
 ENV = os.getenv("ENV")
 CLIENT_ID = os.getenv("CLIENT_ID")
 CLIENT_SECRET = os.getenv("CLIENT_SECRET")
 
 
-def test_mint():
+def test_mint_single():
+    """Test minting a single ID (default behavior)."""
     mint = Minter(env=ENV)
     results = mint.mint("nmdc:DataObject", CLIENT_ID, CLIENT_SECRET)
     assert results
+    assert isinstance(results, str)
     assert "nmdc:dobj" in results
+
+
+def test_mint_single_explicit():
+    """Test minting a single ID with explicit count=1."""
+    mint = Minter(env=ENV)
+    results = mint.mint("nmdc:DataObject", CLIENT_ID, CLIENT_SECRET, count=1)
+    assert results
+    assert isinstance(results, str)
+    assert "nmdc:dobj" in results
+
+
+def test_mint_multiple():
+    """Test minting multiple IDs."""
+    mint = Minter(env=ENV)
+    results = mint.mint("nmdc:DataObject", CLIENT_ID, CLIENT_SECRET, count=3)
+    assert results
+    assert isinstance(results, list)
+    assert len(results) == 3
+    for result in results:
+        assert isinstance(result, str)
+        assert "nmdc:dobj" in result
+
+
+def test_mint_invalid_count():
+    """Test that invalid count values raise ValueError."""
+    mint = Minter(env=ENV)
+    with pytest.raises(ValueError, match="count must be at least 1"):
+        mint.mint("nmdc:DataObject", CLIENT_ID, CLIENT_SECRET, count=0)
+
+    with pytest.raises(ValueError, match="count must be at least 1"):
+        mint.mint("nmdc:DataObject", CLIENT_ID, CLIENT_SECRET, count=-1)
+
+
+# Keep the old test name for backward compatibility
+def test_mint():
+    """Original test for backward compatibility."""
+    test_mint_single()