Merge pull request #1141 from adamtheturtle/database-summary-report-obj

Make database summary report return a dataclass rather than a dict

Author: adamtheturtle

docs/source/api-reference.rst

@@ -5,6 +5,10 @@ API Reference
    :undoc-members:
    :members:
 
+.. automodule:: vws.reports
+   :undoc-members:
+   :members:
+
 .. automodule:: vws.include_target_data
    :undoc-members:
    :members:

docs/source/conf.py

@@ -112,3 +112,5 @@
 rst_prolog = f"""
 .. |project| replace:: {project}
 """
+
+always_document_param_types = True

src/vws/reports.py

@@ -0,0 +1,28 @@
+"""
+Classes for representing Vuforia reports.
+"""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class DatabaseSummaryReport:
+    """
+    A database summary report.
+
+    See
+    https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API#How-To-Get-a-Database-Summary-Report.
+    """
+
+    active_images: int
+    current_month_recos: int
+    failed_images: int
+    inactive_images: int
+    name: str
+    previous_month_recos: int
+    processing_images: int
+    reco_threshold: int
+    request_quota: int
+    request_usage: int
+    target_quota: int
+    total_recos: int

src/vws/vws.py

@@ -16,6 +16,7 @@
 
 from vws._result_codes import raise_for_result_code
 from vws.exceptions import TargetProcessingTimeout
+from vws.reports import DatabaseSummaryReport
 
 
 def _target_api_request(
@@ -379,7 +380,7 @@ def get_target_summary_report(
 
         return dict(response.json())
 
-    def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
+    def get_database_summary_report(self) -> DatabaseSummaryReport:
         """
         Get a summary report for the database.
 
@@ -404,7 +405,22 @@ def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
             expected_result_code='Success',
         )
 
-        return dict(response.json())
+        response_data = dict(response.json())
+        database_summary_report = DatabaseSummaryReport(
+            active_images=response_data['active_images'],
+            current_month_recos=response_data['current_month_recos'],
+            failed_images=response_data['failed_images'],
+            inactive_images=response_data['inactive_images'],
+            name=response_data['name'],
+            previous_month_recos=response_data['previous_month_recos'],
+            processing_images=response_data['processing_images'],
+            reco_threshold=response_data['reco_threshold'],
+            request_quota=response_data['request_quota'],
+            request_usage=response_data['request_usage'],
+            target_quota=response_data['target_quota'],
+            total_recos=response_data['total_recos'],
+        )
+        return database_summary_report
 
     def delete_target(self, target_id: str) -> None:
         """

tests/test_vws.py

@@ -12,7 +12,7 @@
 from mock_vws import MockVWS
 from mock_vws.database import VuforiaDatabase
 
-from vws import VWS, CloudRecoService
+from vws import VWS, CloudRecoService, DatabaseSummaryReport
 from vws.exceptions import TargetProcessingTimeout
 
 
@@ -218,23 +218,22 @@ def test_get_target(self, vws_client: VWS) -> None:
         Details of a database are returned by ``get_database_summary_report``.
         """
         report = vws_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 set(report.keys()) == expected_keys
+
+        expected_report = DatabaseSummaryReport(
+            active_images=0,
+            current_month_recos=0,
+            failed_images=0,
+            inactive_images=0,
+            name=report.name,
+            previous_month_recos=0,
+            processing_images=0,
+            reco_threshold=1000,
+            request_quota=100000,
+            request_usage=0,
+            target_quota=1000,
+            total_recos=0,
+        )
+        assert report == expected_report
 
 
 class TestGetTargetRecord:
@@ -342,7 +341,7 @@ def test_default_seconds_between_requests(
             # At the time of writing there is a bug which prevents request
             # usage from being tracked so we cannot track this.
             expected_requests = 0
-            assert report['request_usage'] == expected_requests
+            assert report.request_usage == expected_requests
 
     def test_custom_seconds_between_requests(
         self,
@@ -390,7 +389,7 @@ def test_custom_seconds_between_requests(
             # At the time of writing there is a bug which prevents request
             # usage from being tracked so we cannot track this.
             expected_requests = 0
-            assert report['request_usage'] == expected_requests
+            assert report.request_usage == expected_requests
 
     def test_custom_timeout(
         self,