Merge pull request #802 from adamtheturtle/target-record

Change `get` function to get just a record

Author: adamtheturtle

src/vws/vws.py

@@ -6,7 +6,7 @@
 import io
 import json
 from time import sleep
-from typing import Any, Dict, List, Union
+from typing import Dict, List, Union
 from urllib.parse import urljoin
 
 import requests
@@ -105,6 +105,9 @@ def add_target(
         """
         Add a target to a Vuforia Web Services database.
 
+        See
+        https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API#How-To-Add-a-Target.
+
         Args:
             name: The name of the target.
             width: The width of the target.
@@ -137,9 +140,12 @@ def add_target(
 
         return str(response.json()['target_id'])
 
-    def get_target(self, target_id: str) -> Dict[str, Any]:
+    def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
         """
-        Get details of a given target.
+        Get a given target's target record from the Target Management System.
+
+        See
+        https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API#How-To-Add-a-Target.
 
         Args:
             target_id: The ID of the target to get details of.
@@ -156,7 +162,7 @@ def get_target(self, target_id: str) -> Dict[str, Any]:
             base_vws_url=self._base_vws_url,
         )
 
-        return dict(response.json())
+        return dict(response.json()['target_record'])
 
     @timeout_decorator.timeout(seconds=60 * 5)
     def wait_for_target_processed(self, target_id: str) -> None:
@@ -172,15 +178,20 @@ def wait_for_target_processed(self, target_id: str) -> None:
                 than five minutes.
         """
         while True:
-            target_details = self.get_target(target_id=target_id)
-            if target_details['status'] != 'processing':
+            report = self.get_target_summary_report(target_id=target_id)
+            if report['status'] != 'processing':
                 return
 
             # We wait 0.2 seconds rather than less than that to decrease the
             # number of calls made to the API, to decrease the likelihood of
             # hitting the request quota.
             sleep(0.2)
 
+            # We wait 0.2 seconds rather than less than that to decrease the
+            # number of calls made to the API, to decrease the likelihood of
+            # hitting the request quota.
+            sleep(0.2)
+
     def list_targets(self) -> List[str]:
         """
         List target IDs.

tests/test_add_target.py

@@ -30,8 +30,7 @@ def test_add_target(
             width=width,
             image=high_quality_image,
         )
-        get_result = client.get_target(target_id=target_id)
-        target_record = get_result['target_record']
+        target_record = client.get_target_record(target_id=target_id)
         assert target_record['name'] == name
         assert target_record['width'] == width
         assert target_record['active_flag'] is True
@@ -91,8 +90,7 @@ def test_default(
             width=1,
             image=high_quality_image,
         )
-        get_result = client.get_target(target_id=target_id)
-        target_record = get_result['target_record']
+        target_record = client.get_target_record(target_id=target_id)
         assert target_record['active_flag'] is True
 
     @pytest.mark.parametrize('active_flag', [True, False])
@@ -111,7 +109,5 @@ def test_given(
             image=high_quality_image,
             active_flag=active_flag,
         )
-
-        get_result = client.get_target(target_id=target_id)
-        target_record = get_result['target_record']
+        target_record = client.get_target_record(target_id=target_id)
         assert target_record['active_flag'] is active_flag

tests/test_get_target.py tests/test_get_target_record.pytests/test_get_target.py renamed to tests/test_get_target_record.py

@@ -1,5 +1,5 @@
 """
-Tests for helper function for getting details of a target from a Vuforia
+Tests for helper function for getting a record of a target from a Vuforia
 database.
 """
 
@@ -8,33 +8,26 @@
 from vws import VWS
 
 
-class TestGetTarget:
+class TestGetTargetRecord:
     """
-    Tests for getting details of a target.
+    Tests for getting a record of a target.
     """
 
-    def test_get_target(
+    def test_get_target_record(
         self,
         client: VWS,
         high_quality_image: io.BytesIO,
     ) -> None:
         """
-        Details of a target are returned by ``get_target``.
+        Details of a target are returned by ``get_target_record``.
         """
         target_id = client.add_target(
             name='x',
             width=1,
             image=high_quality_image,
         )
 
-        result = client.get_target(target_id=target_id)
-        expected_keys = {
-            'result_code',
-            'transaction_id',
-            'target_record',
-            'status',
-        }
-        assert result.keys() == expected_keys
+        result = client.get_target_record(target_id=target_id)
 
         expected_keys = {
             'target_id',
@@ -44,4 +37,4 @@ def test_get_target(
             'tracking_rating',
             'reco_rating',
         }
-        assert result['target_record'].keys() == expected_keys
+        assert result.keys() == expected_keys

tests/test_wait_for_target_processed.py

@@ -25,8 +25,8 @@ def test_wait_for_target_processed(
             width=1,
             image=high_quality_image,
         )
-        target_details = client.get_target(target_id=target_id)
-        assert target_details['status'] == 'processing'
+        report = client.get_target_summary_report(target_id=target_id)
+        assert report['status'] == 'processing'
         client.wait_for_target_processed(target_id=target_id)
-        target_details = client.get_target(target_id=target_id)
-        assert target_details['status'] != 'processing'
+        report = client.get_target_summary_report(target_id=target_id)
+        assert report['status'] != 'processing'