Fix lint issues

Author: adamtheturtle

src/vws/exceptions.py

@@ -0,0 +1,22 @@
+"""
+Custom exceptions for Vuforia errors.
+
+Generated with the script ``_generate_exceptions.py``.
+"""
+
+from requests import Response
+
+
+class UnknownTarget(Exception):
+    """
+    Exception raised when Vuforia returns a response with a result code
+    'UnknownTarget'.
+    """
+
+    def __init__(self, response: Response) -> None:
+        """
+        Args:
+            response: The response to a request to Vuforia.
+        """
+        super().__init__()
+        self.response = response

src/vws/vws.py

@@ -5,6 +5,7 @@
 import base64
 import io
 import json
+from enum import Enum
 from time import sleep
 from typing import Dict, List, Union
 from urllib.parse import urljoin
@@ -14,6 +15,7 @@
 from requests import Response
 
 from vws._authorization import authorization_header, rfc_1123_date
+from vws.exceptions import UnknownTarget
 
 
 def _target_api_request(
@@ -74,6 +76,39 @@ def _target_api_request(
     return response
 
 
+class _ResultCodes(Enum):
+    """
+    Constants representing various VWS result codes.
+
+    See
+    https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API.html#How-To-Interperete-VWS-API-Result-Codes
+
+    Some codes here are not documented in the above link.
+    """
+
+    SUCCESS = 'Success'
+    TARGET_CREATED = 'TargetCreated'
+    AUTHENTICATION_FAILURE = 'AuthenticationFailure'
+    REQUEST_TIME_TOO_SKEWED = 'RequestTimeTooSkewed'
+    TARGET_NAME_EXIST = 'TargetNameExist'
+    UNKNOWN_TARGET = 'UnknownTarget'
+    BAD_IMAGE = 'BadImage'
+    IMAGE_TOO_LARGE = 'ImageTooLarge'
+    METADATA_TOO_LARGE = 'MetadataTooLarge'
+    DATE_RANGE_ERROR = 'DateRangeError'
+    FAIL = 'Fail'
+    TARGET_STATUS_PROCESSING = 'TargetStatusProcessing'
+    REQUEST_QUOTA_REACHED = 'RequestQuotaReached'
+    TARGET_STATUS_NOT_SUCCESS = 'TargetStatusNotSuccess'
+    PROJECT_INACTIVE = 'ProjectInactive'
+    INACTIVE_PROJECT = 'InactiveProject'
+
+
+_EXCEPTIONS = {
+    _ResultCodes.UNKNOWN_TARGET: UnknownTarget,
+}
+
+
 class VWS:
     """
     An interface to Vuforia Web Services APIs.
@@ -162,7 +197,12 @@ def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
             base_vws_url=self._base_vws_url,
         )
 
-        return dict(response.json()['target_record'])
+        result_code = response.json()['result_code']
+        if _ResultCodes(result_code) == _ResultCodes.SUCCESS:
+            return dict(response.json()['target_record'])
+
+        exception = _EXCEPTIONS[_ResultCodes(result_code)]
+        raise exception(response=response)
 
     @timeout_decorator.timeout(seconds=60 * 5)
     def wait_for_target_processed(self, target_id: str) -> None:

tests/test_unknown_target.py

@@ -1,27 +1,26 @@
 """
-Tests for passing invalid target IDs to endpoints which
-require a target ID to be given.
+Tests for passing invalid target IDs to helpers which require a target ID to
+be given.
 """
 
-from functools import partial
-
 from vws import VWS
 
 
 class TestInvalidGivenID:
     """
-    Tests for giving an invalid ID to endpoints which require a target ID to
-    be given.
+    Tests for giving an invalid ID to helpers which require a target ID to be
+    given.
     """
 
-    def test_invalid_given_id(
-        self,
-        client: VWS,
-    ):
-        get_target_record = partial(client.get_target_record)
-
+    def test_invalid_given_id(self, client: VWS) -> None:
+        """
+        Giving an invalid ID to a helper which requires a target ID to be given
+        causes an ``UnknownTarget`` exception to be raised.
+        """
         funcs = (
-            get_target_record,
+            client.get_target_record,
+            client.get_target_summary_report,
+            client.delete_target,
         )
 
         for func in funcs: