Merge pull request #1280 from VWS-Python/target-status-return

Change the return type of ``vws_client.get_target_record`` to match w…

Author: adamtheturtle

CHANGELOG.rst

@@ -6,6 +6,8 @@ Changelog
 Next
 ----
 
+* Change the return type of ``vws_client.get_target_record`` to match what is returned by the web API.
+
 2020.06.19.0
 ------------
 

src/vws/reports.py

@@ -66,7 +66,7 @@ class TargetSummaryReport:
 @dataclass
 class TargetRecord:
     """
-    A target summary record.
+    A target record.
 
     See
     https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API#How-To-Retrieve-a-Target-Record.
@@ -102,3 +102,16 @@ class QueryResult:
 
     target_id: str
     target_data: Optional[TargetData]
+
+
+@dataclass
+class TargetStatusAndRecord:
+    """
+    The target status and a target record.
+
+    See
+    https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API#How-To-Retrieve-a-Target-Record.
+    """
+
+    status: TargetStatuses
+    target_record: TargetRecord

src/vws/vws.py

@@ -21,6 +21,7 @@
 from vws.reports import (
     DatabaseSummaryReport,
     TargetRecord,
+    TargetStatusAndRecord,
     TargetStatuses,
     TargetSummaryReport,
 )
@@ -215,7 +216,7 @@ def add_target(
 
         return str(response.json()['target_id'])
 
-    def get_target_record(self, target_id: str) -> TargetRecord:
+    def get_target_record(self, target_id: str) -> TargetStatusAndRecord:
         """
         Get a given target's target record from the Target Management System.
 
@@ -245,7 +246,9 @@ def get_target_record(self, target_id: str) -> TargetRecord:
             expected_result_code='Success',
         )
 
-        target_record_dict = dict(response.json()['target_record'])
+        result_data = response.json()
+        status = TargetStatuses(result_data['status'])
+        target_record_dict = dict(result_data['target_record'])
         target_record = TargetRecord(
             target_id=target_record_dict['target_id'],
             active_flag=target_record_dict['active_flag'],
@@ -254,7 +257,11 @@ def get_target_record(self, target_id: str) -> TargetRecord:
             tracking_rating=target_record_dict['tracking_rating'],
             reco_rating=target_record_dict['reco_rating'],
         )
-        return target_record
+        target_status_and_record = TargetStatusAndRecord(
+            status=status,
+            target_record=target_record,
+        )
+        return target_status_and_record
 
     def _wait_for_target_processed(
         self,

tests/test_vws.py

@@ -57,7 +57,9 @@ def test_add_target(
             application_metadata=encoded_metadata,
             active_flag=active_flag,
         )
-        target_record = vws_client.get_target_record(target_id=target_id)
+        target_record = vws_client.get_target_record(
+            target_id=target_id,
+        ).target_record
         assert target_record.name == name
         assert target_record.width == width
         assert target_record.active_flag is active_flag
@@ -277,7 +279,8 @@ def test_get_target_record(
             reco_rating='',
         )
 
-        assert result == expected_target_record
+        assert result.target_record == expected_target_record
+        assert result.status == TargetStatuses.PROCESSING
 
 
 class TestWaitForTargetProcessed:
@@ -534,9 +537,9 @@ def test_update_target(
         )
 
         target_details = vws_client.get_target_record(target_id=target_id)
-        assert target_details.name == new_name
-        assert target_details.width == new_width
-        assert not target_details.active_flag
+        assert target_details.target_record.name == new_name
+        assert target_details.target_record.width == new_width
+        assert not target_details.target_record.active_flag
 
     def test_no_fields_given(
         self,