Add delete/patch endpoints for blob (#220)

* Add delete blob

* add patch blob

* Correct type check to value check

* Correct pydoc formatting and test the update blob method

* Bump patch version in pyproject.toml

Author: krowvin

cwms/catalog/blobs.py

@@ -9,7 +9,7 @@
     "office-id": "SWT",
     "id": "MYFILE_OR_BLOB_ID.TXT",
     "description": "Your description here",
-    "media-type-id": "application/octet-stream",
+    "media-type-id": "text/plain",
     "value": "STRING of content or BASE64_ENCODED_STRING"
 }
 """
@@ -19,16 +19,14 @@ def get_blob(blob_id: str, office_id: str) -> str:
     """Get a single BLOB (Binary Large Object).
 
     Parameters
-        ----------
-            blob_id: string
-                Specifies the id of the blob. ALL blob ids are UPPERCASE.
-            office_id: string
-                Specifies the office of the blob.
+        blob_id: string
+            Specifies the id of the blob. ALL blob ids are UPPERCASE.
+        office_id: string
+            Specifies the office of the blob.
 
 
-        Returns
-        -------
-            str: the value returned based on the content-type it was stored with as a string
+    Returns
+        str: the value returned based on the content-type it was stored with as a string
     """
 
     endpoint = f"blobs/{blob_id}"
@@ -44,18 +42,16 @@ def get_blobs(
 ) -> Data:
     """Get a subset of Blobs
 
-    Parameters
-        ----------
-            office_id: Optional[string]
-                Specifies the office of the blob.
-            page_sie: Optional[Integer]
-                How many entries per page returned. Default 100.
-            blob_id_like: Optional[string]
-                Posix regular expression matching against the clob id
-
-        Returns
-        -------
-            cwms data type.  data.json will return the JSON output and data.df will return a dataframe
+    Parameters:
+        office_id: Optional[string]
+            Specifies the office of the blob.
+        page_sie: Optional[Integer]
+            How many entries per page returned. Default 100.
+        blob_id_like: Optional[string]
+            Posix regular expression matching against the clob id
+
+    Returns:
+        cwms data type.  data.json will return the JSON output and data.df will return a dataframe
     """
 
     endpoint = "blobs"
@@ -66,21 +62,18 @@ def get_blobs(
 
 
 def store_blobs(data: JSON, fail_if_exists: Optional[bool] = True) -> None:
-    f"""Create New Blob
+    """Create New Blob
 
-    Parameters
-    ----------
+    Parameters:
         **Note**: The "id" field is automatically cast to uppercase.
 
         Data: JSON dictionary
             JSON containing information of Blob to be updated.
 
-            {STORE_DICT}
         fail_if_exists: Boolean
             Create will fail if the provided ID already exists. Default: True
 
-    Returns
-    -------
+    Returns:
         None
     """
 
@@ -97,3 +90,59 @@ def store_blobs(data: JSON, fail_if_exists: Optional[bool] = True) -> None:
     endpoint = "blobs"
     params = {"fail-if-exists": fail_if_exists}
     return api.post(endpoint, data, params, api_version=1)
+
+
+def delete_blob(blob_id: str, office_id: str) -> None:
+    """Delete a single BLOB.
+
+    Parameters
+    ----------
+        blob_id: string
+            Specifies the id of the blob. ALL blob ids are UPPERCASE.
+        office_id: string
+            Specifies the office of the blob.
+
+    Returns
+    -------
+        None
+    """
+
+    endpoint = f"blobs/{blob_id}"
+    params = {"office": office_id}
+    return api.delete(endpoint, params, api_version=1)
+
+
+def update_blob(data: JSON, fail_if_not_exists: Optional[bool] = True) -> None:
+    """Update Existing Blob
+
+    Parameters:
+        **Note**: The "id" field is automatically cast to uppercase.
+
+        Data: JSON dictionary
+            JSON containing information of Blob to be updated.
+
+        fail_if_not_exists: Boolean
+            Update will fail if the provided ID does not already exist. Default: True
+
+    Returns:
+        None
+    """
+
+    if not data:
+        raise ValueError(
+            f"Cannot update a Blob without a JSON data dictionary:\n{STORE_DICT}"
+        )
+
+    if "id" not in data:
+        raise ValueError(f"Cannot update a Blob without an 'id' field:\n{STORE_DICT}")
+
+    # Encode value if it's not already Base64-encoded
+    if "value" in data and not is_base64(data["value"]):
+        # Encode to bytes, then Base64, then decode to string for storing
+        data["value"] = base64.b64encode(data["value"].encode("utf-8")).decode("utf-8")
+
+    blob_id = data.get("id", "").upper()
+
+    endpoint = f"blobs/{blob_id}"
+    params = {"fail-if-not-exists": fail_if_not_exists}
+    return api.patch(endpoint, data, params, api_version=1)

pyproject.toml

@@ -2,7 +2,7 @@
 name = "cwms-python"
 repository = "https://github.com/HydrologicEngineeringCenter/cwms-python"
 
-version = "0.8.2"
+version = "0.8.3"
 
 
 packages = [