Merge pull request #1037 from adamtheturtle/vwq-custom

Add custom VWQ URL

Author: adamtheturtle

src/vws/query.py

@@ -21,14 +21,17 @@ def __init__(
         self,
         client_access_key: str,
         client_secret_key: str,
+        base_vwq_url: str = 'https://cloudreco.vuforia.com',
     ) -> None:
         """
         Args:
             client_access_key: A VWS client access key.
             client_secret_key: A VWS client secret key.
+            base_vwq_url: The base URL for the VWQ API.
         """
         self._client_access_key = client_access_key.encode()
         self._client_secret_key = client_secret_key.encode()
+        self._base_vwq_url = base_vwq_url
 
     def query(self, image: io.BytesIO) -> List[Dict[str, Any]]:
         """
@@ -70,10 +73,9 @@ def query(self, image: io.BytesIO) -> List[Dict[str, Any]]:
             'Content-Type': content_type_header,
         }
 
-        base_vwq_url = 'https://cloudreco.vuforia.com'
         response = requests.request(
             method=method,
-            url=urljoin(base=base_vwq_url, url=request_path),
+            url=urljoin(base=self._base_vwq_url, url=request_path),
             headers=headers,
             data=content,
         )

tests/test_query.py

@@ -5,6 +5,9 @@
 import io
 import uuid
 
+from mock_vws import MockVWS
+from mock_vws.database import VuforiaDatabase
+
 from vws import VWS, CloudRecoService
 
 
@@ -43,6 +46,43 @@ def test_match(
         assert matching_target['target_id'] == target_id
 
 
+class TestCustomBaseVWQURL:
+    """
+    Tests for using a custom base VWQ URL.
+    """
+
+    def test_custom_base_url(self, high_quality_image: io.BytesIO) -> None:
+        """
+        It is possible to use query a target to a database under a custom VWQ
+        URL.
+        """
+        base_vwq_url = 'http://example.com'
+        with MockVWS(base_vwq_url=base_vwq_url) as mock:
+            database = VuforiaDatabase()
+            mock.add_database(database=database)
+            vws_client = VWS(
+                server_access_key=database.server_access_key,
+                server_secret_key=database.server_secret_key,
+            )
+
+            target_id = vws_client.add_target(
+                name='x',
+                width=1,
+                image=high_quality_image,
+            )
+
+            vws_client.wait_for_target_processed(target_id=target_id)
+
+            cloud_reco_client = CloudRecoService(
+                client_access_key=database.client_access_key,
+                client_secret_key=database.client_secret_key,
+                base_vwq_url=base_vwq_url,
+            )
+
+            [match] = cloud_reco_client.query(image=high_quality_image)
+            assert match['target_id'] == target_id
+
+
 class TestMaxNumResults:
     """
     Tests for the ``max_num_results`` parameter of ``query``.