Merge pull request #789 from adamtheturtle/simple-get-target

Simple get_target without error handling

Author: adamtheturtle

src/vws/vws.py

@@ -5,7 +5,7 @@
 import base64
 import io
 import json
-from typing import Union
+from typing import Any, Dict, Union
 from urllib.parse import urljoin
 
 import requests
@@ -133,3 +133,24 @@ def add_target(
         )
 
         return str(response.json()['target_id'])
+
+    def get_target(self, target_id: str) -> Dict[str, Any]:
+        """
+        Get details of a given target.
+
+        Args:
+            target_id: The ID of the target to get details of.
+
+        Returns:
+            Response details of a target from Vuforia.
+        """
+        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'/targets/{target_id}',
+            base_vws_url=self._base_vws_url,
+        )
+
+        return dict(response.json())

tests/test_get_target.py

@@ -0,0 +1,47 @@
+"""
+Tests for helper function for getting details of a target from a Vuforia
+database.
+"""
+
+import io
+
+from vws import VWS
+
+
+class TestGetTarget:
+    """
+    Test for getting details of a target.
+    """
+
+    def test_get_target(
+        self,
+        client: VWS,
+        high_quality_image: io.BytesIO,
+    ) -> None:
+        """
+        Details of a target are returned by ``get_target``.
+        """
+        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
+
+        expected_keys = {
+            'target_id',
+            'active_flag',
+            'name',
+            'width',
+            'tracking_rating',
+            'reco_rating',
+        }
+        assert result['target_record'].keys() == expected_keys