Merge remote-tracking branch 'origin/main' into adamtheturtle/add-vumark-update-endpoint

# Conflicts:
#	src/mock_vws/_flask_server/target_manager.py
#	src/mock_vws/_flask_server/vws.py
#	tests/mock_vws/fixtures/vuforia_backends.py

Author: adamtheturtle

README.rst

@@ -30,7 +30,7 @@ This requires Python |minimum-python-version|\+.
 
     with MockVWS() as mock:
         database = CloudDatabase()
-        mock.add_database(database=database)
+        mock.add_cloud_database(cloud_database=database)
         # This will use the Vuforia mock.
         requests.get(url="https://vws.vuforia.com/summary", timeout=30)
 

docs/source/basic-example.rst

@@ -11,7 +11,7 @@ Using the mock redirects requests to Vuforia made with `requests`_ to an in-memo
 
     with MockVWS() as mock:
         database = CloudDatabase()
-        mock.add_database(database=database)
+        mock.add_cloud_database(cloud_database=database)
         # This will use the Vuforia mock.
         requests.get(url="https://vws.vuforia.com/summary", timeout=30)
 

docs/source/docker.rst

@@ -54,7 +54,7 @@ To mimic this functionality, this mock provides a target manager container which
 To add a database, make a request to the following endpoint against the target manager container:
 
 .. autoflask:: mock_vws._flask_server.target_manager:TARGET_MANAGER_FLASK_APP
-   :endpoints: create_database
+   :endpoints: create_cloud_database
 
 For example, with the containers set up as in :ref:`creating-containers`, use ``curl``:
 
@@ -63,7 +63,7 @@ For example, with the containers set up as in :ref:`creating-containers`, use ``
    $ curl --request POST \
        --header "Content-Type: application/json" \
        --data '{}' \
-       '127.0.0.1:5005/databases'
+       '127.0.0.1:5005/cloud_databases'
    {
        "client_access_key": "2d61c1d17bb94694bee77c1f1f41e5d9",
        "client_secret_key": "b73f8170cf7d42728fa8ce66221ad147",
@@ -80,7 +80,7 @@ Deleting a database
 To delete a database use the following endpoint:
 
 .. autoflask:: mock_vws._flask_server.target_manager:TARGET_MANAGER_FLASK_APP
-   :endpoints: delete_database
+   :endpoints: delete_cloud_database
 
 
 .. _Target Manager: https://developer.vuforia.com/target-manager

docs/source/mock-api-reference.rst

@@ -20,6 +20,11 @@ API Reference
    :undoc-members:
    :exclude-members: to_dict, get_target, from_dict, not_deleted_targets, active_targets, inactive_targets, failed_targets, processing_targets
 
+.. autoclass:: mock_vws.database.VuMarkDatabase
+   :members:
+   :undoc-members:
+   :exclude-members: to_dict, from_dict, not_deleted_targets
+
 .. autoenum:: mock_vws.states.States
    :members:
    :undoc-members:

src/mock_vws/_database_matchers.py

@@ -5,7 +5,9 @@
 from beartype import beartype
 from vws_auth_tools import authorization_header
 
-from mock_vws.database import CloudDatabase
+from mock_vws.database import CloudDatabase, VuMarkDatabase
+
+AnyDatabase = CloudDatabase | VuMarkDatabase
 
 
 @beartype
@@ -58,14 +60,14 @@ def get_database_matching_client_keys(
 
 
 @beartype
-def get_database_matching_server_keys(
+def get_database_matching_server_keys[DatabaseT: AnyDatabase](
     *,
     request_headers: Mapping[str, str],
     request_body: bytes | None,
     request_method: str,
     request_path: str,
-    databases: Iterable[CloudDatabase],
-) -> CloudDatabase:
+    databases: Iterable[DatabaseT],
+) -> DatabaseT:
     """Return the first of the given databases which is being accessed by
     the
     given server request.