Merge pull request #1071 from adamtheturtle/oops

Add an exception for the bad char case

Author: adamtheturtle

spelling_private_dict.txt

@@ -12,6 +12,7 @@ TargetProcessingTimeout
 TargetStatusProcessing
 Ubuntu
 UnknownTarget
+UnknownVWSErrorPossiblyBadName
 api
 args
 ascii

src/vws/_result_codes.py

@@ -2,6 +2,8 @@
 Tools for managing result codes.
 """
 
+import json
+
 from requests import Response
 
 from vws.exceptions import (
@@ -16,6 +18,7 @@
     TargetStatusNotSuccess,
     TargetStatusProcessing,
     UnknownTarget,
+    UnknownVWSErrorPossiblyBadName,
 )
 
 
@@ -31,8 +34,18 @@ def raise_for_result_code(
         response: A response from Vuforia.
         expected_result_code: See
             https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API.html#How-To-Interperete-VWS-API-Result-Codes
+
+    Raises:
+        ~vws.exceptions.UnknownVWSErrorPossiblyBadName: Vuforia returns an HTML
+            page with the text "Oops, an error occurred". This has been seen to
+            happen when the given name includes a bad character.
     """
-    result_code = response.json()['result_code']
+    try:
+        result_code = response.json()['result_code']
+    except json.decoder.JSONDecodeError as exc:
+        assert 'Oops' in response.text
+        raise UnknownVWSErrorPossiblyBadName() from exc
+
     if result_code == expected_result_code:
         return
 

src/vws/exceptions.py

@@ -6,6 +6,15 @@
 from requests import Response
 
 
+class UnknownVWSErrorPossiblyBadName(Exception):
+    """
+    Exception raised when VWS returns an HTML page which says "Oops, an error
+    occurred".
+
+    This has been seen to happen when the given name includes a bad character.
+    """
+
+
 class ConnectionErrorPossiblyImageTooLarge(
     requests.exceptions.ConnectionError,
 ):

src/vws/vws.py

@@ -178,6 +178,10 @@ def add_target(
             ~vws.exceptions.ProjectInactive: The project is inactive.
             ~vws.exceptions.RequestTimeTooSkewed: There is an error with the
                 time sent to Vuforia.
+            ~vws.exceptions.UnknownVWSErrorPossiblyBadName: Vuforia returns an
+                HTML page with the text "Oops, an error occurred". This has
+                been seen to happen when the given name includes a bad
+                character.
         """
         image_data = image.getvalue()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')

tests/test_exceptions.py

@@ -25,6 +25,7 @@
     TargetStatusNotSuccess,
     TargetStatusProcessing,
     UnknownTarget,
+    UnknownVWSErrorPossiblyBadName,
 )
 
 
@@ -52,6 +53,17 @@ def test_invalid_given_id(vws_client: VWS) -> None:
     assert exc.value.response.status_code == codes.NOT_FOUND
 
 
+def test_add_bad_name(vws_client: VWS, high_quality_image: io.BytesIO) -> None:
+    """
+    When a name with a bad character is given, an
+    ``UnknownVWSErrorPossiblyBadName`` exception is raised.
+    """
+    max_char_value = 65535
+    bad_name = chr(max_char_value + 1)
+    with pytest.raises(UnknownVWSErrorPossiblyBadName):
+        vws_client.add_target(name=bad_name, width=1, image=high_quality_image)
+
+
 def test_request_quota_reached() -> None:
     """
     See https://github.com/adamtheturtle/vws-python/issues/822 for writing