Merge pull request #803 from adamtheturtle/database-summary

Add database summary helper

Author: adamtheturtle

src/vws/vws.py

@@ -233,3 +233,21 @@ def get_target_summary_report(
         )
 
         return dict(response.json())
+
+    def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
+        """
+        Get a summary report for the database.
+
+        Returns:
+            Details of the database.
+        """
+        response = _target_api_request(
+            server_access_key=self._server_access_key,
+            server_secret_key=self._server_secret_key,
+            method='GET',
+            content=b'',
+            request_path='/summary',
+            base_vws_url=self._base_vws_url,
+        )
+
+        return dict(response.json())

tests/test_get_database_summary_report.py

@@ -0,0 +1,34 @@
+"""
+Tests for helper function for getting a summary report for a Vuforia database.
+"""
+
+from vws import VWS
+
+
+class TestGetDatabaseSummaryReport:
+    """
+    Tests for getting a summary report for a database.
+    """
+
+    def test_get_target(self, client: VWS) -> None:
+        """
+        Details of a database are returned by ``get_database_summary_report``.
+        """
+        report = client.get_database_summary_report()
+        expected_keys = {
+            'active_images',
+            'current_month_recos',
+            'failed_images',
+            'inactive_images',
+            'name',
+            'previous_month_recos',
+            'processing_images',
+            'reco_threshold',
+            'request_quota',
+            'request_usage',
+            'result_code',
+            'target_quota',
+            'total_recos',
+            'transaction_id',
+        }
+        assert report.keys() == expected_keys