Kasiah/zoom single row tables (#1282)

* handle single row tables and versioning

* ruff

* change version structure

* ruff

Author: KasiaHinkson

parsons/zoom/zoom.py

@@ -80,7 +80,7 @@ def _get_request(self, endpoint, data_key, params=None, **kwargs):
                 data.extend(self.client.data_parse(r))
             return Table(data)
 
-    def __handle_nested_json(self, table: Table, column: str) -> Table:
+    def __handle_nested_json(self, table: Table, column: str, version: int = 1) -> Table:
         """
         This function unpacks JSON values from Zoom's API, which are often
         objects nested in lists
@@ -95,6 +95,8 @@ def __handle_nested_json(self, table: Table, column: str) -> Table:
         `Returns`:
             Parsons Table
         """
+        if version == 2:
+            return Table(table.unpack_list(column=column))
 
         return Table(table.unpack_list(column=column)).unpack_dict(
             column=f"{column}_0", prepend_value=f"{column}_"
@@ -305,7 +307,7 @@ def get_webinar_registrants(self, webinar_id):
         logger.info(f"Retrieved {tbl.num_rows} webinar registrants.")
         return tbl
 
-    def get_meeting_poll_metadata(self, meeting_id, poll_id) -> Table:
+    def get_meeting_poll_metadata(self, meeting_id, poll_id, version: int = 1) -> Table:
         """
         Get metadata about a specific poll for a given meeting ID
 
@@ -324,9 +326,6 @@ def get_meeting_poll_metadata(self, meeting_id, poll_id) -> Table:
         endpoint = f"meetings/{meeting_id}/polls/{poll_id}"
         tbl = self._get_request(endpoint=endpoint, data_key="questions")
 
-        if isinstance(tbl, dict):
-            logger.debug(f"No poll data returned for poll ID {poll_id}")
-            return Table(tbl)
         if tbl.num_rows == 0:
             logger.debug(f"No poll data returned for poll ID {poll_id}")
             return tbl
@@ -337,11 +336,11 @@ def get_meeting_poll_metadata(self, meeting_id, poll_id) -> Table:
 
         if "prompts" in tbl.columns:
             logger.info(f"Unnesting columns 'prompts' from existing table columns: {tbl.columns}")
-            return self.__handle_nested_json(table=tbl, column="prompts")
+            return self.__handle_nested_json(table=tbl, column="prompts", version=version)
         else:
             return tbl
 
-    def get_meeting_all_polls_metadata(self, meeting_id) -> Table:
+    def get_meeting_all_polls_metadata(self, meeting_id, version: int = 1) -> Table:
         """
         Get metadata for all polls for a given meeting ID
 
@@ -358,18 +357,15 @@ def get_meeting_all_polls_metadata(self, meeting_id) -> Table:
         endpoint = f"meetings/{meeting_id}/polls"
         tbl = self._get_request(endpoint=endpoint, data_key="polls")
 
-        if isinstance(tbl, dict):
-            logger.debug(f"No poll data returned for meeting ID {meeting_id}")
-            return Table(tbl)
         if tbl.num_rows == 0:
             logger.debug(f"No poll data returned for meeting ID {meeting_id}")
             return tbl
 
         logger.info(f"Retrieved {tbl.num_rows} polls for meeting ID {meeting_id}")
 
-        return self.__handle_nested_json(table=tbl, column="questions")
+        return self.__handle_nested_json(table=tbl, column="questions", version=version)
 
-    def get_past_meeting_poll_metadata(self, meeting_id) -> Table:
+    def get_past_meeting_poll_metadata(self, meeting_id, version: int = 1) -> Table:
         """
         List poll metadata of a past meeting.
 
@@ -386,9 +382,6 @@ def get_past_meeting_poll_metadata(self, meeting_id) -> Table:
         endpoint = f"past_meetings/{meeting_id}/polls"
         tbl = self._get_request(endpoint=endpoint, data_key="questions")
 
-        if isinstance(tbl, dict):
-            logger.debug(f"No poll data returned for meeting ID {meeting_id}")
-            return Table(tbl)
         if tbl.num_rows == 0:
             logger.debug(f"No poll data returned for meeting ID {meeting_id}")
             return tbl
@@ -398,9 +391,9 @@ def get_past_meeting_poll_metadata(self, meeting_id) -> Table:
             f"Unnesting columns 'question_details' from existing table columns: {tbl.columns}"
         )
 
-        return self.__handle_nested_json(table=tbl, column="question_details")
+        return self.__handle_nested_json(table=tbl, column="question_details", version=version)
 
-    def get_webinar_poll_metadata(self, webinar_id, poll_id) -> Table:
+    def get_webinar_poll_metadata(self, webinar_id, poll_id, version: int = 1) -> Table:
         """
         Get metadata for a specific poll for a given webinar ID
 
@@ -419,9 +412,6 @@ def get_webinar_poll_metadata(self, webinar_id, poll_id) -> Table:
         endpoint = f"webinars/{webinar_id}/polls/{poll_id}"
         tbl = self._get_request(endpoint=endpoint, data_key="questions")
 
-        if isinstance(tbl, dict):
-            logger.debug(f"No poll data returned for poll ID {poll_id}")
-            return Table(tbl)
         if tbl.num_rows == 0:
             logger.debug(f"No poll data returned for poll ID {poll_id}")
             return tbl
@@ -430,9 +420,9 @@ def get_webinar_poll_metadata(self, webinar_id, poll_id) -> Table:
             f"Retrieved {tbl.num_rows} rows of metadata [meeting={webinar_id} poll={poll_id}]"
         )
 
-        return self.__handle_nested_json(table=tbl, column="prompts")
+        return self.__handle_nested_json(table=tbl, column="prompts", version=version)
 
-    def get_webinar_all_polls_metadata(self, webinar_id) -> Table:
+    def get_webinar_all_polls_metadata(self, webinar_id, version: int = 1) -> Table:
         """
         Get metadata for all polls for a given webinar ID
 
@@ -449,18 +439,15 @@ def get_webinar_all_polls_metadata(self, webinar_id) -> Table:
         endpoint = f"webinars/{webinar_id}/polls"
         tbl = self._get_request(endpoint=endpoint, data_key="polls")
 
-        if isinstance(tbl, dict):
-            logger.debug(f"No poll data returned for webinar ID {webinar_id}")
-            return Table(tbl)
         if tbl.num_rows == 0:
             logger.debug(f"No poll data returned for webinar ID {webinar_id}")
             return tbl
 
         logger.info(f"Retrieved {tbl.num_rows} polls for meeting ID {webinar_id}")
 
-        return self.__handle_nested_json(table=tbl, column="questions")
+        return self.__handle_nested_json(table=tbl, column="questions", version=version)
 
-    def get_past_webinar_poll_metadata(self, webinar_id) -> Table:
+    def get_past_webinar_poll_metadata(self, webinar_id, version: int = 1) -> Table:
         """
         Retrieves the metadata for Webinar Polls of a specific Webinar
 
@@ -477,16 +464,13 @@ def get_past_webinar_poll_metadata(self, webinar_id) -> Table:
         endpoint = f"past_webinars/{webinar_id}/polls"
         tbl = self._get_request(endpoint=endpoint, data_key="questions")
 
-        if isinstance(tbl, dict):
-            logger.debug(f"No poll data returned for webinar ID {webinar_id}")
-            return Table(tbl)
         if tbl.num_rows == 0:
             logger.debug(f"No poll data returned for webinar ID {webinar_id}")
             return tbl
 
         logger.info(f"Retrieved {tbl.num_rows} polls for meeting ID {webinar_id}")
 
-        return self.__handle_nested_json(table=tbl, column="prompts")
+        return self.__handle_nested_json(table=tbl, column="prompts", version=version)
 
     def get_meeting_poll_results(self, meeting_id) -> Table:
         """
@@ -498,9 +482,6 @@ def get_meeting_poll_results(self, meeting_id) -> Table:
         endpoint = f"report/meetings/{meeting_id}/polls"
         tbl = self._get_request(endpoint=endpoint, data_key="questions")
 
-        if isinstance(tbl, dict):
-            logger.debug(f"No poll data returned for meeting ID {meeting_id}")
-            return Table(tbl)
         if tbl.num_rows == 0:
             logger.debug(f"No poll data returned for meeting ID {meeting_id}")
             return tbl
@@ -519,9 +500,6 @@ def get_webinar_poll_results(self, webinar_id) -> Table:
         endpoint = f"report/webinars/{webinar_id}/polls"
         tbl = self._get_request(endpoint=endpoint, data_key="questions")
 
-        if isinstance(tbl, dict):
-            logger.debug(f"No poll data returned for webinar ID {webinar_id}")
-            return Table(tbl)
         if tbl.num_rows == 0:
             logger.debug(f"No poll data returned for webinar ID {webinar_id}")
             return tbl