vws-python-mock 2026.2.22__tar.gz → 2026.2.22.2__tar.gz

{vws_python_mock-2026.2.22 → vws_python_mock-2026.2.22.2}/CHANGELOG.rst

@@ -4,6 +4,14 @@ Changelog
 Next
 ----
 
+2026.02.22.2
+------------
+
+
+2026.02.22.1
+------------
+
+
 2026.02.22
 ----------
 

{vws_python_mock-2026.2.22/src/vws_python_mock.egg-info → vws_python_mock-2026.2.22.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vws-python-mock
-Version: 2026.2.22
+Version: 2026.2.22.2
 Summary: A mock for the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License-Expression: MIT

{vws_python_mock-2026.2.22 → vws_python_mock-2026.2.22.2}/src/mock_vws/_requests_mock_server/decorators.py

@@ -5,7 +5,7 @@ import time
 from collections.abc import Callable, Mapping
 from contextlib import ContextDecorator
 from typing import Any, Literal, Self
-from urllib.parse import urljoin, urlparse
+from urllib.parse import urlparse
 
 import requests
 from beartype import BeartypeConf, beartype
@@ -162,6 +162,7 @@ class MockVWS(ContextDecorator):
         callback: _MockCallback,
         delay_seconds: float,
         sleep_fn: Callable[[float], None],
+        base_path: str,
     ) -> _ResponsesCallback:
         """Wrap a callback to add a response delay."""
 
@@ -197,9 +198,13 @@ class MockVWS(ContextDecorator):
             else:
                 body_bytes = raw_body
 
+            path = request.path_url
+            if base_path and path.startswith(base_path):
+                path = path[len(base_path) :]
+
             request_data = RequestData(
                 method=request.method or "",
-                path=request.path_url,
+                path=path,
                 headers=dict(request.headers),
                 body=body_bytes,
             )
@@ -221,11 +226,9 @@ class MockVWS(ContextDecorator):
             (self._mock_vws_api, self._base_vws_url),
             (self._mock_vwq_api, self._base_vwq_url),
         ):
+            base_path = urlparse(url=base_url).path.rstrip("/")
             for route in api.routes:
-                url_pattern = urljoin(
-                    base=base_url,
-                    url=f"{route.path_pattern}$",
-                )
+                url_pattern = base_url.rstrip("/") + route.path_pattern + "$"
                 compiled_url_pattern = re.compile(pattern=url_pattern)
 
                 for http_method in route.http_methods:
@@ -237,6 +240,7 @@ class MockVWS(ContextDecorator):
                             callback=original_callback,
                             delay_seconds=self._response_delay_seconds,
                             sleep_fn=self._sleep_fn,
+                            base_path=base_path,
                         ),
                         content_type=None,
                     )

{vws_python_mock-2026.2.22 → vws_python_mock-2026.2.22.2}/src/mock_vws/_respx_mock_server/decorators.py

@@ -5,7 +5,7 @@ import time
 from collections.abc import Callable, Mapping
 from contextlib import ContextDecorator
 from typing import Literal, Self
-from urllib.parse import urljoin, urlparse
+from urllib.parse import urlparse
 
 import httpx
 import respx
@@ -36,19 +36,27 @@ _STRUCTURAL_SIMILARITY_MATCHER = StructuralSimilarityMatcher()
 _BRISQUE_TRACKING_RATER = BrisqueTargetTrackingRater()
 
 
-def _to_request_data(request: httpx.Request) -> RequestData:
+def _to_request_data(
+    request: httpx.Request,
+    *,
+    base_path: str,
+) -> RequestData:
     """Convert an httpx.Request to a RequestData.
 
     Args:
         request: The httpx request to convert.
+        base_path: The base path prefix to strip from the request path.
 
     Returns:
         A RequestData with method, path, headers, and body set.
     """
+    path = request.url.raw_path.decode(encoding="ascii")
+    if base_path and path.startswith(base_path):
+        path = path[len(base_path) :]
     return RequestData(
         method=request.method,
-        path=request.url.raw_path.decode(encoding="ascii"),
-        headers=request.headers,
+        path=path,
+        headers={k.title(): v for k, v in request.headers.items()},
         body=request.content,
     )
 
@@ -155,12 +163,14 @@ class MockVWSForHttpx(ContextDecorator):
     def _make_callback(
         self,
         handler: Callable[[RequestData], _ResponseType],
+        base_path: str,
     ) -> Callable[[httpx.Request], httpx.Response]:
         """Create a respx-compatible callback from a handler.
 
         Args:
             handler: A handler that takes a RequestData and returns a
                 response tuple.
+            base_path: The base path prefix to strip from the request path.
 
         Returns:
             A callback that takes an httpx.Request and returns an
@@ -183,7 +193,10 @@ class MockVWSForHttpx(ContextDecorator):
                 Exception: A timeout error is raised when the response
                     delay exceeds the read timeout.
             """
-            request_data = _to_request_data(request=request)
+            request_data = _to_request_data(
+                request=request,
+                base_path=base_path,
+            )
             timeout_info: dict[str, float | None] = request.extensions.get(
                 "timeout", {}
             )
@@ -237,11 +250,9 @@ class MockVWSForHttpx(ContextDecorator):
             (self._mock_vws_api, self._base_vws_url),
             (self._mock_vwq_api, self._base_vwq_url),
         ):
+            base_path = urlparse(url=base_url).path.rstrip("/")
             for route in api.routes:
-                url_pattern = urljoin(
-                    base=base_url,
-                    url=f"{route.path_pattern}$",
-                )
+                url_pattern = base_url.rstrip("/") + route.path_pattern + "$"
                 compiled_url_pattern = re.compile(pattern=url_pattern)
 
                 for http_method in route.http_methods:
@@ -252,6 +263,7 @@ class MockVWSForHttpx(ContextDecorator):
                     ).mock(
                         side_effect=self._make_callback(
                             handler=original_callback,
+                            base_path=base_path,
                         ),
                     )
 

{vws_python_mock-2026.2.22 → vws_python_mock-2026.2.22.2/src/vws_python_mock.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vws-python-mock
-Version: 2026.2.22
+Version: 2026.2.22.2
 Summary: A mock for the Vuforia Web Services (VWS) API.
 Author-email: Adam Dangoor <adamdangoor@gmail.com>
 License-Expression: MIT

{vws_python_mock-2026.2.22 → vws_python_mock-2026.2.22.2}/tests/mock_vws/test_requests_mock_usage.py

@@ -5,6 +5,7 @@ import email.utils
 import io
 import json
 import socket
+from http import HTTPStatus
 from urllib.parse import urlparse
 
 import pytest
@@ -13,7 +14,7 @@ from beartype import beartype
 from freezegun import freeze_time
 from PIL import Image
 from vws import VWS, CloudRecoService
-from vws_auth_tools import rfc_1123_date
+from vws_auth_tools import authorization_header, rfc_1123_date
 
 from mock_vws import MissingSchemeError, MockVWS
 from mock_vws.database import CloudDatabase, VuMarkDatabase
@@ -347,6 +348,86 @@ class TestCustomBaseURLs:
                 timeout=30,
             )
 
+    @staticmethod
+    def test_custom_base_vws_url_with_path_prefix() -> None:
+        """A custom base VWS URL with a path prefix intercepts at the
+        prefix.
+        """
+        with MockVWS(
+            base_vws_url="https://vuforia.vws.example.com/prefix",
+            real_http=False,
+        ):
+            with pytest.raises(
+                expected_exception=requests.exceptions.ConnectionError
+            ):
+                requests.get(
+                    url="https://vuforia.vws.example.com/summary",
+                    timeout=30,
+                )
+
+            requests.get(
+                url="https://vuforia.vws.example.com/prefix/summary",
+                timeout=30,
+            )
+
+    @staticmethod
+    def test_custom_base_vwq_url_with_path_prefix() -> None:
+        """A custom base VWQ URL with a path prefix intercepts at the
+        prefix.
+        """
+        with MockVWS(
+            base_vwq_url="https://vuforia.vwq.example.com/prefix",
+            real_http=False,
+        ):
+            with pytest.raises(
+                expected_exception=requests.exceptions.ConnectionError
+            ):
+                requests.post(
+                    url="https://vuforia.vwq.example.com/v1/query",
+                    timeout=30,
+                )
+
+            requests.post(
+                url="https://vuforia.vwq.example.com/prefix/v1/query",
+                timeout=30,
+            )
+
+    @staticmethod
+    def test_vws_operations_work_with_path_prefix() -> None:
+        """VWS API operations work correctly with a base URL path
+        prefix.
+        """
+        database = CloudDatabase()
+        base_vws_url = "https://vuforia.vws.example.com/prefix"
+
+        with MockVWS(base_vws_url=base_vws_url) as mock:
+            mock.add_cloud_database(cloud_database=database)
+
+            request_path = "/targets"
+            date = rfc_1123_date()
+            auth = authorization_header(
+                access_key=database.server_access_key,
+                secret_key=database.server_secret_key,
+                method="GET",
+                content=b"",
+                content_type="",
+                date=date,
+                request_path=request_path,
+            )
+            response = requests.get(
+                url=base_vws_url + request_path,
+                headers={
+                    "Authorization": auth,
+                    "Date": date,
+                },
+                timeout=30,
+            )
+
+        assert response.status_code == HTTPStatus.OK
+        response_json = response.json()
+        assert response_json["result_code"] == "Success"
+        assert response_json["results"] == []
+
     @staticmethod
     def test_no_scheme() -> None:
         """An error if raised if a URL is given with no scheme."""

{vws_python_mock-2026.2.22 → vws_python_mock-2026.2.22.2}/tests/mock_vws/test_respx_mock_usage.py

@@ -1,13 +1,17 @@
 """Tests for the usage of the mock for ``httpx`` via ``respx``."""
 
+import json
 import socket
+import uuid
+from http import HTTPMethod, HTTPStatus
 
 import httpx
 import pytest
-from vws_auth_tools import rfc_1123_date
+from vws_auth_tools import authorization_header, rfc_1123_date
 
 from mock_vws import MissingSchemeError, MockVWSForHttpx
 from mock_vws.database import CloudDatabase, VuMarkDatabase
+from mock_vws.target import VuMarkTarget
 
 
 def _request_unmocked_address() -> None:
@@ -208,6 +212,82 @@ class TestCustomBaseURLs:
                 timeout=30,
             )
 
+    @staticmethod
+    def test_custom_base_vws_url_with_path_prefix() -> None:
+        """A custom base VWS URL with a path prefix intercepts at the
+        prefix.
+        """
+        with MockVWSForHttpx(
+            base_vws_url="https://vuforia.vws.example.com/prefix",
+            real_http=False,
+        ):
+            with pytest.raises(expected_exception=httpx.ConnectError):
+                httpx.get(
+                    url="https://vuforia.vws.example.com/summary",
+                    timeout=30,
+                )
+
+            httpx.get(
+                url="https://vuforia.vws.example.com/prefix/summary",
+                timeout=30,
+            )
+
+    @staticmethod
+    def test_custom_base_vwq_url_with_path_prefix() -> None:
+        """A custom base VWQ URL with a path prefix intercepts at the
+        prefix.
+        """
+        with MockVWSForHttpx(
+            base_vwq_url="https://vuforia.vwq.example.com/prefix",
+            real_http=False,
+        ):
+            with pytest.raises(expected_exception=httpx.ConnectError):
+                httpx.post(
+                    url="https://vuforia.vwq.example.com/v1/query",
+                    timeout=30,
+                )
+
+            httpx.post(
+                url="https://vuforia.vwq.example.com/prefix/v1/query",
+                timeout=30,
+            )
+
+    @staticmethod
+    def test_vws_operations_work_with_path_prefix() -> None:
+        """VWS API operations work correctly with a base URL path
+        prefix.
+        """
+        database = CloudDatabase()
+        base_vws_url = "https://vuforia.vws.example.com/prefix"
+
+        with MockVWSForHttpx(base_vws_url=base_vws_url) as mock:
+            mock.add_cloud_database(cloud_database=database)
+
+            request_path = "/targets"
+            date = rfc_1123_date()
+            auth = authorization_header(
+                access_key=database.server_access_key,
+                secret_key=database.server_secret_key,
+                method="GET",
+                content=b"",
+                content_type="",
+                date=date,
+                request_path=request_path,
+            )
+            response = httpx.get(
+                url=base_vws_url + request_path,
+                headers={
+                    "Authorization": auth,
+                    "Date": date,
+                },
+                timeout=30,
+            )
+
+        assert response.status_code == HTTPStatus.OK
+        response_json = response.json()
+        assert response_json["result_code"] == "Success"
+        assert response_json["results"] == []
+
     @staticmethod
     def test_no_scheme() -> None:
         """An error is raised if a URL is given with no scheme."""
@@ -348,3 +428,40 @@ class TestVWSEndpoints:
             )
         # We just verify we get a response (auth will fail but endpoint works)
         assert response.status_code is not None
+
+    @staticmethod
+    def test_vumark_bytes_response() -> None:
+        """The VuMark endpoint returns bytes content via httpx."""
+        vumark_target = VuMarkTarget(name="test-target")
+        database = VuMarkDatabase(vumark_targets={vumark_target})
+        target_id = vumark_target.target_id
+        request_path = f"/targets/{target_id}/instances"
+        content_type = "application/json"
+        content = json.dumps(obj={"instance_id": uuid.uuid4().hex}).encode(
+            encoding="utf-8"
+        )
+        date = rfc_1123_date()
+        auth = authorization_header(
+            access_key=database.server_access_key,
+            secret_key=database.server_secret_key,
+            method=HTTPMethod.POST,
+            content=content,
+            content_type=content_type,
+            date=date,
+            request_path=request_path,
+        )
+        with MockVWSForHttpx() as mock:
+            mock.add_vumark_database(vumark_database=database)
+            response = httpx.post(
+                url="https://vws.vuforia.com" + request_path,
+                headers={
+                    "Accept": "image/png",
+                    "Authorization": auth,
+                    "Content-Length": str(object=len(content)),
+                    "Content-Type": content_type,
+                    "Date": date,
+                },
+                content=content,
+                timeout=30,
+            )
+        assert response.status_code == HTTPStatus.OK