Merge pull request #13 from RENCI/csv-file

Second try at getting this right - add endpoint for get_station_data_file

src/server.py

@@ -13,6 +13,7 @@
 import json
 import os
 import uuid
+import csv
 
 from typing import Union
 
@@ -456,6 +457,91 @@ def get_station_data(station_name: Union[str, None] = Query(default=None), time_
     return PlainTextResponse(content=ret_val, status_code=status_code, media_type="text/csv")
 
 
+@APP.get('/get_station_data_file', status_code=200, response_model=None)
+async def get_station_data_file(file_name: Union[str, None] = Query(default='station.csv'),
+                                station_name: Union[str, None] = Query(default=None), time_mark: Union[str, None] = Query(default=None),
+                                data_source: Union[str, None] = Query(default=None), instance_name: Union[str, None] = Query(default=None),
+                                forcing_metclass: Union[str, None] = Query(default=None)) -> csv:
+    """
+    Returns the CSV formatted observational station data as a csv file.
+
+    Note that all fields are mandatory.
+
+    :return:
+    """
+    # init the return and html status code
+    ret_val: str = ''
+    status_code: int = 200
+
+    # get a file path to the temp file directory.
+    # append a unique path to avoid collisions
+    temp_file_path: str = os.path.join(os.getenv('TEMP_FILE_PATH', os.path.dirname(__file__)), str(uuid.uuid4()))
+
+    # append the file name
+    file_path: str = os.path.join(temp_file_path, file_name)
+
+    # example input - station name: 8728690,
+    #                 timemark: 2024-03-07T00:00:00Z,
+    #                 data_source: GFSFORECAST_NCSC_SAB_V1.23
+    #                 instance_name: ncsc123_gfs_sb55.01 
+    #                 forcing_metclass: synoptic
+
+    try:
+        # validate the input. nothing is optional
+        if station_name or time_mark or data_source or instance_name or forcing_metclass:
+            # init the kwargs variable
+            kwargs: dict = {}
+
+            # create the param list
+            params: list = ['station_name', 'time_mark', 'data_source', 'instance_name', 'forcing_metclass']
+
+            # loop through the SP params passed in
+            for param in params:
+                # add this parm to the list
+                kwargs.update({param: 'null' if not locals()[param] else f'{locals()[param]}'})
+
+            # try to make the call for records
+            ret_val: str = db_info.get_station_data(**kwargs)
+
+            # was the call successful
+            if len(ret_val) == 0:
+                # set the Warning message and the return status
+                ret_val = 'Warning: No station data found using the criteria selected.'
+
+                # set the status to a not found
+                status_code = 404
+
+            else:
+                # make the directory
+                os.makedirs(temp_file_path)
+
+                # write out the data to a file
+                reader = csv.reader(ret_val.splitlines(), skipinitialspace=True)
+                with open(file_path, 'w', encoding="utf-8") as f_h:
+                    writer = csv.writer(f_h)
+                    writer.writerows(reader)
+        else:
+            # set the error message
+            ret_val = 'Error Invalid input. Insure that all input fields are populated.'
+
+            # set the status to a not found
+            status_code = 404
+
+    except Exception:
+        # return a failure message
+        ret_val = 'Exception detected trying to get station data.'
+
+        # log the exception
+        logger.exception(ret_val)
+
+        # set the status to a server error
+        status_code = 500
+
+    # return to the caller
+    return FileResponse(path=file_path, filename=file_name, media_type='text/csv', status_code=status_code,
+                        background=BackgroundTask(GenUtils.cleanup, temp_file_path))
+
+
 @APP.get('/get_catalog_member_records', status_code=200, response_model=None)
 async def get_catalog_member_records(run_id: Union[str, None] = Query(default=None), project_code: Union[str, None] = Query(default=None),
                                      filter_event_type: Union[str, None] = Query(default=None), limit: Union[int, None] = Query(default=4)) -> json: