Merge pull request #801 from adamtheturtle/target-summary

Add initial function to get summary report

Author: adamtheturtle

src/vws/vws.py

@@ -183,7 +183,7 @@ def wait_for_target_processed(self, target_id: str) -> None:
 
     def list_targets(self) -> List[str]:
         """
-        Get a list of targets.
+        List target IDs.
 
         Returns:
             The IDs of all targets in the database.
@@ -198,3 +198,27 @@ def list_targets(self) -> List[str]:
         )
 
         return list(response.json()['results'])
+
+    def get_target_summary_report(
+        self,
+        target_id: str,
+    ) -> Dict[str, Union[str, int]]:
+        """
+        Get a summary report for a target.
+
+        Args:
+            target_id: The ID of the target to get a summary report for.
+
+        Returns:
+            Details of the target.
+        """
+        response = _target_api_request(
+            server_access_key=self._server_access_key,
+            server_secret_key=self._server_secret_key,
+            method='GET',
+            content=b'',
+            request_path=f'/summary/{target_id}',
+            base_vws_url=self._base_vws_url,
+        )
+
+        return dict(response.json())

tests/test_get_target.py

@@ -10,7 +10,7 @@
 
 class TestGetTarget:
     """
-    Test for getting details of a target.
+    Tests for getting details of a target.
     """
 
     def test_get_target(

tests/test_get_target_summary_report.py

@@ -0,0 +1,44 @@
+"""
+Tests for helper function for getting a summary report for a target in a
+Vuforia database.
+"""
+
+import io
+
+from vws import VWS
+
+
+class TestGetTargetSummaryReport:
+    """
+    Tests for getting a summary report for a target.
+    """
+
+    def test_get_target_summary_report(
+        self,
+        client: VWS,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        Details of a target are returned by ``get_target_summary_report``.
+        """
+        target_id = client.add_target(
+            name='x',
+            width=1,
+            image=high_quality_image,
+        )
+
+        result = client.get_target_summary_report(target_id=target_id)
+        expected_keys = {
+            'status',
+            'result_code',
+            'transaction_id',
+            'database_name',
+            'target_name',
+            'upload_date',
+            'active_flag',
+            'tracking_rating',
+            'total_recos',
+            'current_month_recos',
+            'previous_month_recos',
+        }
+        assert result.keys() == expected_keys

tests/test_target_list.py

@@ -9,7 +9,7 @@
 
 class TestListTargets:
     """
-    Test for listing targets.
+    Tests for listing targets.
     """
 
     def test_list_targets(

tests/test_wait_for_target_processed.py

@@ -9,7 +9,7 @@
 
 class TestWaitForTargetProcessed:
     """
-    Test for waiting for a target to be processed.
+    Tests for waiting for a target to be processed.
     """
 
     def test_wait_for_target_processed(