mockserver-client 7.3.0__tar.gz → 7.5.0__tar.gz

{mockserver_client-7.3.0 → mockserver_client-7.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mockserver-client
-Version: 7.3.0
+Version: 7.5.0
 Summary: Official Python client for MockServer — create expectations, verify requests, and register dynamic callbacks via WebSocket
 Author-email: James Bloom <jamesdbloom@gmail.com>
 License-Expression: Apache-2.0
@@ -190,6 +190,63 @@ client.verify_sequence(
 client.verify_zero_interactions()
 ```
 
+## Request Matching
+
+### JWT matcher
+
+Match requests by the claims (and metadata) of a JWT carried in a header. Each
+claim value is exact-or-regex; prefix a value with `!` to negate it.
+
+```python
+from mockserver import HttpRequest, HttpResponse, Jwt
+
+client.when(
+    HttpRequest.request("/secure")
+        .with_method("GET")
+        .with_jwt(
+            claims={
+                "sub": "user-123",           # exact match
+                "email": "^.+@example.com$", # regex match
+                "role": "!admin",            # negated — matches any role except admin
+            },
+            issuer="https://issuer.example.com",
+            audience="my-api",
+            algorithm="RS256",
+            header="authorization",          # optional (defaults to Authorization)
+            scheme="Bearer",                 # optional token scheme
+        )
+).respond(
+    HttpResponse.response("granted", status_code=200)
+)
+
+# ...or pass a Jwt object directly:
+HttpRequest.request("/secure").with_jwt(Jwt(claims={"sub": "user-123"}))
+```
+
+### allOf body matcher
+
+Require a request body to satisfy **all** of several body matchers at once.
+
+```python
+from mockserver import AllOfBody, Body, JsonPathBody, RegexBody, HttpRequest
+
+client.when(
+    HttpRequest.request("/api/orders")
+        .with_method("POST")
+        .with_body(AllOfBody(body_all_of=[
+            JsonPathBody(json_path="$.name"),   # body has a name field
+            RegexBody(regex=".*active.*"),      # and mentions "active"
+        ]))
+).respond(
+    HttpResponse.response("ok")
+)
+
+# Shorthand factory:
+HttpRequest.request("/api/orders").with_body(
+    Body.all_of(JsonPathBody(json_path="$.name"), RegexBody(regex=".*active.*"))
+)
+```
+
 ## Retrieval
 
 ```python
@@ -429,7 +486,7 @@ launcher_path = ensure_binary()  # returns Path to the launcher executable
 ```python
 from mockserver.launcher import start
 
-server = start(port=1080, version="7.3.0")
+server = start(port=1080, version="7.5.0")
 # ...
 server.stop()
 ```

{mockserver_client-7.3.0 → mockserver_client-7.5.0}/README.md

@@ -160,6 +160,63 @@ client.verify_sequence(
 client.verify_zero_interactions()
 ```
 
+## Request Matching
+
+### JWT matcher
+
+Match requests by the claims (and metadata) of a JWT carried in a header. Each
+claim value is exact-or-regex; prefix a value with `!` to negate it.
+
+```python
+from mockserver import HttpRequest, HttpResponse, Jwt
+
+client.when(
+    HttpRequest.request("/secure")
+        .with_method("GET")
+        .with_jwt(
+            claims={
+                "sub": "user-123",           # exact match
+                "email": "^.+@example.com$", # regex match
+                "role": "!admin",            # negated — matches any role except admin
+            },
+            issuer="https://issuer.example.com",
+            audience="my-api",
+            algorithm="RS256",
+            header="authorization",          # optional (defaults to Authorization)
+            scheme="Bearer",                 # optional token scheme
+        )
+).respond(
+    HttpResponse.response("granted", status_code=200)
+)
+
+# ...or pass a Jwt object directly:
+HttpRequest.request("/secure").with_jwt(Jwt(claims={"sub": "user-123"}))
+```
+
+### allOf body matcher
+
+Require a request body to satisfy **all** of several body matchers at once.
+
+```python
+from mockserver import AllOfBody, Body, JsonPathBody, RegexBody, HttpRequest
+
+client.when(
+    HttpRequest.request("/api/orders")
+        .with_method("POST")
+        .with_body(AllOfBody(body_all_of=[
+            JsonPathBody(json_path="$.name"),   # body has a name field
+            RegexBody(regex=".*active.*"),      # and mentions "active"
+        ]))
+).respond(
+    HttpResponse.response("ok")
+)
+
+# Shorthand factory:
+HttpRequest.request("/api/orders").with_body(
+    Body.all_of(JsonPathBody(json_path="$.name"), RegexBody(regex=".*active.*"))
+)
+```
+
 ## Retrieval
 
 ```python
@@ -399,7 +456,7 @@ launcher_path = ensure_binary()  # returns Path to the launcher executable
 ```python
 from mockserver.launcher import start
 
-server = start(port=1080, version="7.3.0")
+server = start(port=1080, version="7.5.0")
 # ...
 server.stop()
 ```

{mockserver_client-7.3.0 → mockserver_client-7.5.0}/mockserver/__init__.py

@@ -1,17 +1,24 @@
 from mockserver.models import (
     AfterAction,
+    AllOfBody,
     BinaryResponse,
     Body,
+    CaptureRule,
+    CaptureSource,
     ConnectionOptions,
     CrossProtocolScenario,
     CrossProtocolTrigger,
     Delay,
     DelayDistribution,
     DnsRecord,
+    DnsRecordClass,
+    DnsRecordType,
+    DnsRequestDefinition,
     DnsResponse,
     Expectation,
     ExpectationId,
     ExpectationStep,
+    GraphQLBody,
     GrpcBidiResponse,
     GrpcBidiRule,
     GrpcStreamMessage,
@@ -20,6 +27,8 @@ from mockserver.models import (
     HttpClassCallback,
     HttpError,
     HttpForward,
+    HttpForwardValidateAction,
+    HttpForwardWithFallback,
     HttpObjectCallback,
     HttpOverrideForwardedRequest,
     HttpRequest,
@@ -30,7 +39,19 @@ from mockserver.models import (
     HttpWebSocketResponse,
     JsonPathBody,
     JsonRpcBody,
+    JsonSchemaBody,
+    Jwt,
     KeyToMultiValue,
+    MultipartBody,
+    ParameterBody,
+    Protocol,
+    RateLimit,
+    RateLimitAlgorithm,
+    ValidationMode,
+    WasmBody,
+    XmlBody,
+    XmlSchemaBody,
+    XPathBody,
     LoadCapture,
     LoadFeeder,
     LoadPacing,
@@ -44,6 +65,7 @@ from mockserver.models import (
     OpenAPIDefinition,
     OpenAPIExpectation,
     Ports,
+    RegexBody,
     RequestDefinition,
     ResponseMode,
     SocketAddress,
@@ -53,10 +75,12 @@ from mockserver.models import (
     Verification,
     VerificationSequence,
     VerificationTimes,
+    WebSocketFrameMatcher,
     WebSocketMessage,
 )
 from mockserver.llm import (
     Completion,
+    ContentFilter,
     ConversationPredicates,
     EmbeddingResponse,
     HttpLlmResponse,
@@ -65,14 +89,17 @@ from mockserver.llm import (
     LlmConversationBuilder,
     LlmFailoverBuilder,
     LlmMockBuilder,
+    ModerationResponse,
     NormalizationOptions,
     Provider,
+    RerankResponse,
     Role,
     StreamingPhysics,
     ToolUse,
     TurnBuilder,
     Usage,
     completion,
+    content_filter,
     conversation,
     cookie,
     embedding,
@@ -80,7 +107,9 @@ from mockserver.llm import (
     llm_failover,
     llm_mock,
     llm_response,
+    moderation,
     query_parameter,
+    rerank,
     streaming_physics,
     time_to_first_token,
     tool_use,
@@ -119,19 +148,26 @@ from mockserver.launcher import (
 
 __all__ = [
     "AfterAction",
+    "AllOfBody",
     "AsyncMockServerClient",
     "BinaryResponse",
     "Body",
+    "CaptureRule",
+    "CaptureSource",
     "ConnectionOptions",
     "CrossProtocolScenario",
     "CrossProtocolTrigger",
     "Delay",
     "DelayDistribution",
     "DnsRecord",
+    "DnsRecordClass",
+    "DnsRecordType",
+    "DnsRequestDefinition",
     "DnsResponse",
     "Expectation",
     "ExpectationId",
     "ExpectationStep",
+    "GraphQLBody",
     "GrpcBidiResponse",
     "GrpcBidiRule",
     "GrpcStreamMessage",
@@ -140,6 +176,8 @@ __all__ = [
     "HttpClassCallback",
     "HttpError",
     "HttpForward",
+    "HttpForwardValidateAction",
+    "HttpForwardWithFallback",
     "HttpObjectCallback",
     "HttpOverrideForwardedRequest",
     "HttpRequest",
@@ -150,7 +188,19 @@ __all__ = [
     "HttpWebSocketResponse",
     "JsonPathBody",
     "JsonRpcBody",
+    "JsonSchemaBody",
+    "Jwt",
     "KeyToMultiValue",
+    "MultipartBody",
+    "ParameterBody",
+    "Protocol",
+    "RateLimit",
+    "RateLimitAlgorithm",
+    "ValidationMode",
+    "WasmBody",
+    "XmlBody",
+    "XmlSchemaBody",
+    "XPathBody",
     "LoadCapture",
     "LoadFeeder",
     "LoadPacing",
@@ -162,6 +212,7 @@ __all__ = [
     "LoadThreshold",
     "MockMode",
     "Completion",
+    "ContentFilter",
     "ConversationPredicates",
     "EmbeddingResponse",
     "HttpLlmResponse",
@@ -170,14 +221,17 @@ __all__ = [
     "LlmConversationBuilder",
     "LlmFailoverBuilder",
     "LlmMockBuilder",
+    "ModerationResponse",
     "NormalizationOptions",
     "Provider",
+    "RerankResponse",
     "Role",
     "StreamingPhysics",
     "ToolUse",
     "TurnBuilder",
     "Usage",
     "completion",
+    "content_filter",
     "conversation",
     "cookie",
     "embedding",
@@ -185,7 +239,9 @@ __all__ = [
     "llm_failover",
     "llm_mock",
     "llm_response",
+    "moderation",
     "query_parameter",
+    "rerank",
     "streaming_physics",
     "time_to_first_token",
     "tool_use",
@@ -208,6 +264,7 @@ __all__ = [
     "OpenAPIDefinition",
     "OpenAPIExpectation",
     "Ports",
+    "RegexBody",
     "RequestDefinition",
     "ResponseMode",
     "SocketAddress",
@@ -217,6 +274,7 @@ __all__ = [
     "Verification",
     "VerificationSequence",
     "VerificationTimes",
+    "WebSocketFrameMatcher",
     "WebSocketMessage",
     "MockServerProcess",
     "bundle_base_name",

{mockserver_client-7.3.0 → mockserver_client-7.5.0}/mockserver/async_client.py

@@ -58,7 +58,7 @@ class AsyncScenarioHandle:
     async def state(self) -> str | None:
         """GET the current state of this scenario (``None`` if not yet set)."""
         result = await self._client._scenario_request(
-            "GET", f"/mockserver/scenario/{urllib.parse.quote(self._name, safe="")}"
+            "GET", f"/mockserver/scenario/{urllib.parse.quote(self._name, safe='')}"
         )
         return result.get("currentState")
 
@@ -78,7 +78,7 @@ class AsyncScenarioHandle:
             payload["nextState"] = next_state
         return await self._client._scenario_request(
             "PUT",
-            f"/mockserver/scenario/{urllib.parse.quote(self._name, safe="")}",
+            f"/mockserver/scenario/{urllib.parse.quote(self._name, safe='')}",
             json.dumps(payload),
         )
 
@@ -86,7 +86,7 @@ class AsyncScenarioHandle:
         """PUT an external trigger advancing this scenario to ``new_state``."""
         return await self._client._scenario_request(
             "PUT",
-            f"/mockserver/scenario/{urllib.parse.quote(self._name, safe="")}/trigger",
+            f"/mockserver/scenario/{urllib.parse.quote(self._name, safe='')}/trigger",
             json.dumps({"newState": new_state}),
         )
 
@@ -383,6 +383,35 @@ class AsyncMockServerClient:
             )
         return response_body or ""
 
+    async def retrieve_drift(self) -> dict:
+        """Retrieve the recorded mock drift report.
+
+        Issues ``GET /mockserver/drift`` and returns the parsed report, a dict of
+        the form ``{"count": <n>, "drifts": [ ... ]}`` where each entry describes a
+        difference detected between a mock's configured response and the live
+        upstream response for the same request. When no drift has been recorded the
+        server returns an empty report (``{}``).
+        """
+        status, response_body = await self._request("GET", "/mockserver/drift")
+        if status >= 400:
+            raise MockServerError(
+                f"Failed to retrieve drift (status={status}): {response_body}"
+            )
+        return json.loads(response_body) if response_body else {}
+
+    async def clear_drift(self) -> None:
+        """Clear all recorded mock drift.
+
+        Issues ``PUT /mockserver/drift/clear``.
+        """
+        status, response_body = await self._request(
+            "PUT", "/mockserver/drift/clear"
+        )
+        if status >= 400:
+            raise MockServerError(
+                f"Failed to clear drift (status={status}): {response_body}"
+            )
+
     async def pact_import(self, pact_json: str) -> str:
         """Import a Pact v3 contract as expectations.
 

{mockserver_client-7.3.0 → mockserver_client-7.5.0}/mockserver/client.py

@@ -224,6 +224,17 @@ class MockServerClient:
         """
         return self._run(self._async_client.update_configuration(config_json))
 
+    def retrieve_drift(self) -> dict:
+        """Retrieve the recorded mock drift report
+        (``GET /mockserver/drift``); returns a dict of the form
+        ``{"count": <n>, "drifts": [ ... ]}``.
+        """
+        return self._run(self._async_client.retrieve_drift())
+
+    def clear_drift(self) -> None:
+        """Clear all recorded mock drift (``PUT /mockserver/drift/clear``)."""
+        return self._run(self._async_client.clear_drift())
+
     def pact_import(self, pact_json: str) -> str:
         """Import a Pact v3 contract as expectations; returns the upserted
         expectations JSON (``PUT /mockserver/pact/import``).

{mockserver_client-7.3.0 → mockserver_client-7.5.0}/mockserver/launcher.py

@@ -45,7 +45,7 @@ logger = logging.getLogger(__name__)
 
 # The version shipped with this client.  ``ensure_binary()`` defaults to this
 # when no explicit version is passed.
-_CLIENT_VERSION = "7.1.0"
+_CLIENT_VERSION = "7.5.0"
 
 _REPO = "mock-server/mockserver-monorepo"