Changes based on PR feedback

Author: cassidysymons

microsetta_private_api/api/_source.py

@@ -212,15 +212,17 @@ def get_external_report(
 
     with Transaction() as t:
         source_repo = SourceRepo(t)
-        report = source_repo.get_external_report(
+        reports = source_repo.get_external_reports(
             source_id, external_report_id
         )
+        if len(reports) != 1:
+            return jsonify(code=404, message="Report not found"), 404
+
+        report = reports[0]
+
         # Trying to jsonify the actual contents gets ugly, so we return
         # everything else here, and the contents in get_external_report_bytes
         report.file_contents = ""
-
-        if report is None:
-            return jsonify(code=404, message="Report not found"), 404
         return jsonify(report.to_api()), 200
 
 
@@ -231,14 +233,15 @@ def get_external_report_bytes(
 
     with Transaction() as t:
         source_repo = SourceRepo(t)
-        report = source_repo.get_external_report(
+        reports = source_repo.get_external_reports(
             source_id, external_report_id
         )
 
-        if report is None:
+        if len(reports) != 1:
             return jsonify(code=404, message="Report not found"), 404
 
+        report = reports[0]
         response = make_response(bytes(report.file_contents))
-        response.headers.set("Content-Type", "application/pdf")
+        response.headers.set("Content-Type", report.file_type)
 
         return response

microsetta_private_api/db/patches/0133.sql

@@ -3,8 +3,8 @@
 -- is for highly specific documents with a pre-defined language (FFQs from the THDMI Japan project), the approach makes sense.
 
 -- The report_type value will dictate which section of the My Reports tab it displays under.
--- I'm setting the enum up to reflect current structure (sample = My Kits/ffq = My FFQs) but this could be extended to "Other" or various specifics later.
-CREATE TYPE EXTERNAL_REPORT_TYPE AS ENUM ('sample', 'ffq');
+-- I'm setting the enum up to reflect current structure (kit = My Kits/ffq = My FFQs) but this could be extended later.
+CREATE TYPE EXTERNAL_REPORT_TYPE AS ENUM ('kit', 'ffq');
 CREATE TABLE ag.external_reports (
     external_report_id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
     source_id UUID NOT NULL,

microsetta_private_api/model/external_report.py

@@ -3,16 +3,13 @@
 
 class ExternalReport(ModelBase):
     def __init__(self, **kwargs):
-        # Minimum requirements
         self.external_report_id = kwargs['external_report_id']
         self.source_id = kwargs['source_id']
         self.report_type = kwargs['report_type']
-
-        # Optional parameters
-        self.file_name = kwargs.get("file_name", "")
-        self.file_title = kwargs.get("file_title", "")
-        self.file_type = kwargs.get("file_type", "")
-        self.file_contents = kwargs.get("file_contents", "")
+        self.file_name = kwargs['file_name']
+        self.file_title = kwargs['file_title']
+        self.file_type = kwargs['file_type']
+        self.file_contents = kwargs['file_contents']
 
     def to_api(self):
         return self.__dict__.copy()

microsetta_private_api/repo/source_repo.py

@@ -313,7 +313,7 @@ def check_source_post_overhaul(self, account_id, source_id):
             )
             return cur.rowcount == 1
 
-    def get_external_reports(self, source_id):
+    def get_external_reports(self, source_id, external_report_id=None):
         """Retrieve list of external reports for a given source, if any
         NB: We only extract certain columns because there's no need to waste
         resources on the actual file_contents until the user hits the path
@@ -323,45 +323,27 @@ def get_external_reports(self, source_id):
         ----------
         source_id : uuid
             The associated source ID
+        external_report_id : uuid
+            The ID of a single external report to pull
 
         Returns
         -------
         List of ExternalReports
         """
         with self._transaction.dict_cursor() as cur:
-            cur.execute(
-                "SELECT external_report_id, source_id, file_title, "
-                "report_type "
-                "FROM ag.external_reports "
-                "WHERE source_id = %s",
-                (source_id, )
-            )
+            if external_report_id is None:
+                cur.execute(
+                    "SELECT * "
+                    "FROM ag.external_reports "
+                    "WHERE source_id = %s",
+                    (source_id, )
+                )
+            else:
+                cur.execute(
+                    "SELECT * "
+                    "FROM ag.external_reports "
+                    "WHERE source_id = %s AND external_report_id = %s",
+                    (source_id, external_report_id)
+                )
             rows = cur.fetchall()
             return [_row_to_external_report(r) for r in rows]
-
-    def get_external_report(self, source_id, external_report_id):
-        """ Retrieve the full contents of an external report
-
-        Parameters
-        ----------
-        source_id : uuid
-            The associated source ID
-        external_report_id : uuid
-            The external report ID
-
-        Returns
-        -------
-        ExternalReport object or None if not found
-        """
-        with self._transaction.dict_cursor() as cur:
-            cur.execute(
-                "SELECT * "
-                "FROM ag.external_reports "
-                "WHERE source_id = %s AND external_report_id = %s",
-                (source_id, external_report_id)
-            )
-            if cur.rowcount == 1:
-                row = cur.fetchone()
-                return _row_to_external_report(row)
-            else:
-                return None

microsetta_private_api/repo/tests/test_source.py

@@ -178,9 +178,10 @@ def test_get_external_report(self):
             reports = sr.get_external_reports(HUMAN_SOURCE.id)
 
             er = reports[0]
-            obs = sr.get_external_report(
+            obs_reports = sr.get_external_reports(
                 HUMAN_SOURCE.id, er.external_report_id
             )
+            obs = obs_reports[0]
 
             self.assertEqual(obs.source_id, HUMAN_SOURCE.id)
             self.assertEqual(obs.file_title, "Test Source Repo")
@@ -191,21 +192,22 @@ def test_get_external_report_fail(self):
             reports = sr.get_external_reports(HUMAN_SOURCE.id)
 
             er = reports[0]
-            obs = sr.get_external_report(
+            obs_reports = sr.get_external_reports(
                 "ffffffff-aaaa-cccc-aaaa-aaaaaaaaaaaa", er.external_report_id
             )
 
-            self.assertEqual(obs, None)
+            self.assertEqual(len(obs_reports), 0)
 
     def test_get_external_report_bytes(self):
         with Transaction() as t:
             sr = SourceRepo(t)
             reports = sr.get_external_reports(HUMAN_SOURCE.id)
 
             er = reports[0]
-            obs = sr.get_external_report(
+            obs_reports = sr.get_external_reports(
                 HUMAN_SOURCE.id, er.external_report_id
             )
+            obs = obs_reports[0]
 
             act = b'Imagine a full file here'