52 add deleteupdate for blobs (#53)

Add the delete and update methods for Blob. 

Tested against localhost. 

Removed extra methods that were replaced when I learned about grouping
commands.

Author: krowvin

cwmscli/commands/blob.py

@@ -228,7 +228,7 @@ def list_blobs(
     if limit is not None:
         df = df.head(limit)
 
-    logging.info(f"Found {len(df):,} blobs")
+    logging.info(f"Found {len(df):,} blob(s)")
     # List the blobs in the logger
     for _, row in df.iterrows():
         logging.info(f"Blob ID: {row['id']}, Description: {row.get('description')}")
@@ -240,77 +240,6 @@ def get_media_type(file_path: str) -> str:
     return mime_type or "application/octet-stream"
 
 
-def main(
-    directive: str,
-    input_file: str,
-    blob_id: str,
-    description: Optional[str],
-    media_type: Optional[str],
-    office: str,
-    api_root: str,
-    api_key: str,
-    overwrite: Optional[bool] = True,
-    dry_run: Optional[bool] = False,
-):
-    """
-    Upload, Download, Delete, or Update blob data in CWMS.
-
-    DIRECTIVE is the action to perform (upload, download, delete, update).
-    INPUT_FILE is the path to the file on disk.
-    BLOB_ID   is the blob ID to store under.
-    """
-
-    cwms.api.init_session(api_root=api_root, api_key=api_key)
-    file_data = None
-    if directive in ["upload", "update"]:
-        if not input_file or not os.path.isfile(input_file):
-            logging.warning(
-                "Valid input_file required for upload/update. Use --input-file to specify."
-            )
-            sys.exit(0)
-        try:
-            file_size = os.path.getsize(input_file)
-            with open(input_file, "rb") as f:
-                file_data = f.read()
-            logging.info(f"Read file: {input_file} ({file_size} bytes)")
-        except Exception as e:
-            logging.error(f"Failed to read file: {e}")
-            sys.exit(1)
-
-    # Determine what should be done based on directive
-    if directive == "upload":
-        store_blob(
-            office=office,
-            api_root=api_root,
-            input_file=input_file,
-            blob_id=blob_id,
-            description=description,
-            media_type=media_type,
-            file_data=file_data,
-            overwrite=overwrite,
-            dry_run=dry_run,
-        )
-    elif directive == "list":
-        list_blobs(office=office, blob_id_like=blob_id, sort_by="blob_id")
-    elif directive == "download":
-        retrieve_blob(
-            office=office,
-            blob_id=blob_id,
-        )
-    elif directive == "delete":
-        # TODO: Delete endpoint does not exist in cwms-python yet
-        logging.warning(
-            "[NOT IMPLEMENTED] Delete Blob is not supported yet!\n\thttps://github.com/HydrologicEngineeringCenter/cwms-python/issues/192"
-        )
-        pass
-    elif directive == "update":
-        # TODO: Patch endpoint does not exist in cwms-python yet
-        logging.warning(
-            "[NOT IMPLEMENTED] Update Blob is not supported yet! Consider overwriting instead if a rename is not needed.\n\thttps://github.com/HydrologicEngineeringCenter/cwms-python/issues/192"
-        )
-        pass
-
-
 def upload_cmd(
     input_file: str,
     blob_id: str,
@@ -322,7 +251,7 @@ def upload_cmd(
     api_root: str,
     api_key: str,
 ):
-    cwms.api.init_session(api_root=api_root, api_key=get_api_key(api_key, ""))
+    cwms.init_session(api_root=api_root, api_key=get_api_key(api_key, ""))
     try:
         file_size = os.path.getsize(input_file)
         with open(input_file, "rb") as f:
@@ -350,7 +279,7 @@ def upload_cmd(
     params = {"fail-if-exists": not overwrite}
 
     if dry_run:
-        logging.info(f"--dry-run: would POST {api_root}blobs with params={params}")
+        logging.info(f"DRY RUN: would POST {api_root}blobs with params={params}")
         logging.info(
             json.dumps(
                 {
@@ -376,8 +305,15 @@ def upload_cmd(
         sys.exit(1)
 
 
-def download_cmd(blob_id: str, dest: str, office: str, api_root: str, api_key: str):
-    cwms.api.init_session(api_root=api_root, api_key=get_api_key(api_key, ""))
+def download_cmd(
+    blob_id: str, dest: str, office: str, api_root: str, api_key: str, dry_run: bool
+):
+    if dry_run:
+        logging.info(
+            f"DRY RUN: would GET {api_root} blob with blob-id={blob_id} office={office}."
+        )
+        return
+    cwms.init_session(api_root=api_root, api_key=get_api_key(api_key, ""))
     bid = blob_id.upper()
     logging.debug(f"Office={office} BlobID={bid}")
 
@@ -395,18 +331,62 @@ def download_cmd(blob_id: str, dest: str, office: str, api_root: str, api_key: s
         sys.exit(1)
 
 
-def delete_cmd(blob_id: str, office: str, api_root: str, api_key: str):
-    logging.warning(
-        "[NOT IMPLEMENTED] Delete Blob is not supported yet.\n"
-        "See: https://github.com/HydrologicEngineeringCenter/cwms-python/issues/192"
-    )
+def delete_cmd(blob_id: str, office: str, api_root: str, api_key: str, dry_run: bool):
 
+    if dry_run:
+        logging.info(
+            f"DRY RUN: would DELETE {api_root} blob with blob-id={blob_id} office={office}"
+        )
+        return
+    cwms.init_session(api_root=api_root, api_key=api_key)
+    cwms.delete_blob(office_id=office, blob_id=blob_id)
+    logging.info(f"Deleted blob: {blob_id} for office: {office}")
 
-def update_cmd(blob_id: str, input_file: str, office: str, api_root: str, api_key: str):
-    logging.warning(
-        "[NOT IMPLEMENTED] Update Blob is not supported yet. Consider --overwrite with upload.\n"
-        "See: https://github.com/HydrologicEngineeringCenter/cwms-python/issues/192"
-    )
+
+def update_cmd(
+    input_file: str,
+    blob_id: str,
+    description: str,
+    media_type: str,
+    overwrite: bool,
+    dry_run: bool,
+    office: str,
+    api_root: str,
+    api_key: str,
+):
+    if dry_run:
+        logging.info(
+            f"DRY RUN: would PATCH {api_root} blob with blob-id={blob_id} office={office}"
+        )
+        return
+    file_data = None
+    if input_file:
+        try:
+            file_size = os.path.getsize(input_file)
+            with open(input_file, "rb") as f:
+                file_data = f.read()
+            logging.info(f"Read file: {input_file} ({file_size} bytes)")
+        except Exception as e:
+            logging.error(f"Failed to read file: {e}")
+            sys.exit(1)
+    # Setup minimum required payload
+    blob = {"office-id": office, "id": blob_id.upper()}
+    if description:
+        blob["description"] = description
+    if media_type:
+        blob["media-type-id"] = media_type
+    else:
+        logging.info("Media type not specified; Retrieving existing media type...")
+        blob_metadata = cwms.get_blobs(office_id=office, blob_id_like=blob_id)
+        blob["media-type-id"] = blob_metadata.df.get(
+            "media-type-id", "application/octet-stream"
+        )[0]
+        logging.info(f"Using existing media type: {blob['media-type-id']}")
+
+    if file_data:
+        blob["value"] = base64.b64encode(file_data).decode("utf-8")
+    cwms.init_session(api_root=api_root, api_key=api_key)
+    cwms.update_blob(blob, fail_if_not_exists=not overwrite)
 
 
 def list_cmd(
@@ -420,7 +400,7 @@ def list_cmd(
     api_root: str,
     api_key: str,
 ):
-    cwms.api.init_session(api_root=api_root, api_key=get_api_key(api_key, None))
+    cwms.init_session(api_root=api_root, api_key=get_api_key(api_key, None))
     df = list_blobs(
         office=office,
         blob_id_like=blob_id_like,

cwmscli/commands/commands_cwms.py

@@ -1,3 +1,5 @@
+import textwrap
+
 import click
 
 from cwmscli import requirements as reqs
@@ -94,12 +96,15 @@ def csv2cwms_cmd(**kwargs):
 @click.group(
     "blob",
     help="Manage CWMS Blobs (upload, download, delete, update, list)",
-    epilog="""
-  * Store a PDF/image as a CWMS blob with optional description
-  * Download a blob by id to your local filesystem
-  * Update a blob's name/description
-  * Bulk list blobs for an office
-""",
+    epilog=textwrap.dedent(
+        """
+    Example Usage:\n
+    - Store a PDF/image as a CWMS blob with optional description\n
+    - Download a blob by id to your local filesystem\n
+    - Update a blob's name/description/mime-type\n
+    - Bulk list blobs for an office  
+"""
+    ),
 )
 @requires(reqs.cwms)
 def blob_group():
@@ -148,6 +153,7 @@ def blob_upload(**kwargs):
     default=None,
     help="Destination file path. Defaults to blob-id.",
 )
+@click.option("--dry-run", is_flag=True, help="Show request; do not send.")
 @common_api_options
 def blob_download(**kwargs):
     from cwmscli.commands.blob import download_cmd
@@ -158,8 +164,9 @@ def blob_download(**kwargs):
 # ================================================================================
 #       Delete
 # ================================================================================
-@blob_group.command("delete", help="[Not implemented] Delete a blob by ID")
+@blob_group.command("delete", help="Delete a blob by ID")
 @click.option("--blob-id", required=True, type=str, help="Blob ID to delete.")
+@click.option("--dry-run", is_flag=True, help="Show request; do not send.")
 @common_api_options
 def delete_cmd(**kwargs):
     from cwmscli.commands.blob import delete_cmd
@@ -170,14 +177,31 @@ def delete_cmd(**kwargs):
 # ================================================================================
 #       Update
 # ================================================================================
-@blob_group.command("update", help="[Not implemented] Update/patch a blob by ID")
+@blob_group.command("update", help="Update/patch a blob by ID")
 @click.option("--blob-id", required=True, type=str, help="Blob ID to update.")
+@click.option("--dry-run", is_flag=True, help="Show request; do not send.")
+@click.option(
+    "--description",
+    default=None,
+    help="New description JSON or text.",
+)
+@click.option(
+    "--media-type",
+    default=None,
+    help="New media type (guessed from file if omitted).",
+)
 @click.option(
     "--input-file",
     required=False,
     type=click.Path(exists=True, dir_okay=False, readable=True, path_type=str),
     help="Optional file content to upload with update.",
 )
+@click.option(
+    "--overwrite/--no-overwrite",
+    default=False,
+    show_default=True,
+    help="If true, replace existing blob.",
+)
 @common_api_options
 def update_cmd(**kwargs):
     from cwmscli.commands.blob import update_cmd