Cleanup Smartsheet (#2)

* ci: git workflows, openapirc_async, removes 404

* openapi_examples

* fixes typo in tag and publish workflow

* updates readme

Author: mekhlakapoor

workflow_templates/tag_and_publish.yml .github/workflows/tag_and_publish.ymlworkflow_templates/tag_and_publish.yml renamed to .github/workflows/tag_and_publish.yml

@@ -121,6 +121,7 @@ jobs:
       - name: Update version
         run: |
           sed -i --debug --expression="s|packageVersion.*|packageVersion\": \"${{ needs.bump_version.outputs.new_version }}\"|" openapirc.json
+          sed -i --debug --expression="s|packageVersion.*|packageVersion\": \"${{ needs.bump_version.outputs.new_version }}\"|" openapirc_async.json
       - name: Set up Python 3.10
         uses: actions/setup-python@v5
         with:
@@ -148,12 +149,28 @@ jobs:
           rm -f aind-smartsheet-service-client/.gitlab-ci.yml
           rm -f aind-smartsheet-service-client/git_push.sh
           rm -f aind-smartsheet-service-client/.travis.yml
+      - name: Generate Python Async Client
+        uses: openapi-generators/openapitools-generator-action@v1.5.0
+        with:
+          generator: python
+          generator-tag: v7.13.0
+          openapi-file: openapi.json
+          config-file: openapirc_async.json
+      - name: Handle async files
+        run: |
+          rm -rf aind-smartsheet-service-async-client
+          mv python-client aind-smartsheet-service-async-client
+          rm -rf aind-smartsheet-service-async-client/.github
+          rm -f aind-smartsheet-service-async-client/.gitignore
+          rm -f aind-smartsheet-service-async-client/.gitlab-ci.yml
+          rm -f aind-smartsheet-service-async-client/git_push.sh
+          rm -f aind-smartsheet-service-async-client/.travis.yml
       - name: Commit changes
         uses: EndBug/add-and-commit@v9
         with:
           default_author: github_actions
-          message: "ci: add client [skip actions]"
-          add: '["openapirc.json","aind-smartsheet-service-client"]'
+          message: "ci: add clients [skip actions]"
+          add: '["openapirc.json","aind-smartsheet-service-client","openapirc_async.json","aind-smartsheet-service-async-client"]'
   update_tag:
     runs-on: ubuntu-latest
     needs: [bump_version, build_client]
@@ -217,3 +234,27 @@ jobs:
         with:
           packages-dir: ./aind-smartsheet-service-client/dist
           password: ${{ secrets.AIND_PYPI_TOKEN }}
+  publish_async_client:
+    runs-on: ubuntu-latest
+    needs: update_tag
+    defaults:
+      run:
+        working-directory: ./aind-smartsheet-service-async-client
+    steps:
+      - uses: actions/checkout@v4
+      - name: Pull latest changes
+        run: git pull origin main
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          pip install --upgrade setuptools wheel twine build
+          python -m build
+          twine check dist/*
+      - name: Publish on PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1.12
+        with:
+          packages-dir: ./aind-smartsheet-service-async-client/dist
+          password: ${{ secrets.AIND_PYPI_TOKEN }}

workflow_templates/test_server.yml .github/workflows/test_server.ymlworkflow_templates/test_server.yml renamed to .github/workflows/test_server.yml

@@ -15,3 +15,4 @@ REST service to connect to Smartsheet and return information.
 - The client code is autogenerated using an openapi generator.
 - On a push to main, a python library will be built and published to PyPI.
 - The client can then be pip installed as `pip install aind-smartsheet-service-client`
+- An async client can be pip installed as `pip install aind-smartsheet-service-async-client`

README.md

@@ -2,7 +2,7 @@
 
 from typing import List, Optional
 
-from fastapi import APIRouter, Depends, HTTPException, Query, status
+from fastapi import APIRouter, Depends, Query, status
 
 from aind_smartsheet_service_server.handler import SessionHandler
 from aind_smartsheet_service_server.models import (
@@ -41,14 +41,27 @@ async def get_health() -> HealthCheck:
     "/funding",
     response_model=List[FundingModel],
 )
-async def get_funding(
+def get_funding(
     project_name: Optional[str] = Query(
         default=None,
-        examples=["Discovery-Neuromodulator circuit dynamics during foraging"],
+        openapi_examples={
+            "default": {
+                "summary": "A sample project name",
+                "description": "Example project name for smartsheet",
+                "value": "Discovery-Neuromodulator circuit dynamics"
+                " during foraging",
+            }
+        },
     ),
     subproject: Optional[str] = Query(
         default=None,
-        examples=["Subproject 2 Molecular Anatomy Cell Types"],
+        openapi_examples={
+            "default": {
+                "summary": "A sample subproject",
+                "description": "Example subproject name",
+                "value": "Subproject 2 Molecular Anatomy Cell Types",
+            }
+        },
     ),
     session: SmartsheetClient = Depends(get_session),
 ):
@@ -65,17 +78,14 @@ async def get_funding(
     content = SessionHandler(session=session).get_project_funding_info(
         sheet_model=sheet, project_name=project_name, subproject=subproject
     )
-    if len(content) == 0:
-        raise HTTPException(status_code=404, detail="Not found")
-    else:
-        return content
+    return content
 
 
 @router.get(
     "/project_names",
     response_model=List[str],
 )
-async def get_project_names(
+def get_project_names(
     session: SmartsheetClient = Depends(get_session),
 ):
     """
@@ -91,25 +101,26 @@ async def get_project_names(
     content = SessionHandler(session=session).get_project_names(
         sheet_model=sheet
     )
-    if len(content) == 0:
-        raise HTTPException(status_code=404, detail="Not found")
-    else:
-        return content
+    return content
 
 
 @router.get(
     "/protocols",
     response_model=List[ProtocolsModel],
 )
-async def get_protocols(
+def get_protocols(
     protocol_name: Optional[str] = Query(
         default=None,
-        examples=[
-            (
-                "Tetrahydrofuran and Dichloromethane Delipidation of a Whole "
-                "Mouse Brain"
-            )
-        ],
+        openapi_examples={
+            "default": {
+                "summary": "A sample protocol name",
+                "description": "Example protocol name",
+                "value": (
+                    "Tetrahydrofuran and Dichloromethane Delipidation of a "
+                    "Whole Mouse Brain"
+                ),
+            }
+        },
     ),
     session: SmartsheetClient = Depends(get_session),
 ):
@@ -126,20 +137,23 @@ async def get_protocols(
     content = SessionHandler(session=session).get_protocols_info(
         sheet_model=sheet, protocol_name=protocol_name
     )
-    if len(content) == 0:
-        raise HTTPException(status_code=404, detail="Not found")
-    else:
-        return content
+    return content
 
 
 @router.get(
     "/perfusions",
     response_model=List[PerfusionsModel],
 )
-async def get_perfusions(
+def get_perfusions(
     subject_id: Optional[str] = Query(
         default=None,
-        examples=["689418"],
+        openapi_examples={
+            "default": {
+                "summary": "A sample subject id",
+                "description": "Example subject id",
+                "value": "689418",
+            }
+        },
     ),
     session: SmartsheetClient = Depends(get_session),
 ):
@@ -156,7 +170,4 @@ async def get_perfusions(
     content = SessionHandler(session=session).get_perfusions_info(
         sheet_model=sheet, subject_id=subject_id
     )
-    if len(content) == 0:
-        raise HTTPException(status_code=404, detail="Not found")
-    else:
-        return content
+    return content

aind-smartsheet-service-server/src/aind_smartsheet_service_server/route.py

@@ -1,6 +1,6 @@
 """Test routes"""
 
-from unittest.mock import MagicMock, patch
+from unittest.mock import MagicMock
 
 import pytest
 from starlette.testclient import TestClient
@@ -55,14 +55,6 @@ def test_get_200_funding(
         assert 200 == response.status_code
         assert expected_response == response.json()
 
-    def test_get_404_funding(
-        self, client: TestClient, mock_get_raw_funding_sheet: MagicMock
-    ):
-        """Tests a response when fetching funding info for missing project"""
-
-        response = client.get("/funding?project_name=MISSING")
-        assert 404 == response.status_code
-
     def test_get_200_project_names(
         self, client: TestClient, mock_get_raw_funding_sheet: MagicMock
     ):
@@ -91,19 +83,6 @@ def test_get_200_project_names(
         assert 200 == response.status_code
         assert expected_response == response.json()
 
-    def test_get_404_project_names(
-        self, client: TestClient, mock_get_raw_funding_sheet: MagicMock
-    ):
-        """Tests an empty response when fetching project_names"""
-
-        with patch(
-            "aind_smartsheet_service_server.handler.SessionHandler"
-            ".get_parsed_sheet",
-            return_value=[],
-        ):
-            response = client.get("/project_names")
-        assert 404 == response.status_code
-
     def test_get_200_protocols(
         self, client: TestClient, mock_get_raw_protocols_sheet: MagicMock
     ):
@@ -127,14 +106,6 @@ def test_get_200_protocols(
         assert 200 == response.status_code
         assert expected_response == response.json()
 
-    def test_get_404_protocols(
-        self, client: TestClient, mock_get_raw_protocols_sheet: MagicMock
-    ):
-        """Tests a response when fetching protocol info for missing name"""
-
-        response = client.get("/protocols?protocol_name=MISSING")
-        assert 404 == response.status_code
-
     def test_get_200_perfusions(
         self, client: TestClient, mock_get_raw_perfusions_sheet: MagicMock
     ):
@@ -159,14 +130,6 @@ def test_get_200_perfusions(
         assert 200 == response.status_code
         assert expected_response == response.json()
 
-    def test_get_404_perfusions(
-        self, client: TestClient, mock_get_raw_perfusions_sheet: MagicMock
-    ):
-        """Tests a response when fetching perfusions for missing subject"""
-
-        response = client.get("/perfusions?subject_id=000")
-        assert 404 == response.status_code
-
 
 if __name__ == "__main__":
     pytest.main([__file__])

aind-smartsheet-service-server/tests/test_route.py

@@ -0,0 +1,5 @@
+{
+   "packageName": "aind_smartsheet_service_async_client",
+   "projectName": "aind-smartsheet-service-async-client",
+   "packageVersion": "0.0.0"
+}