pyrestkit 0.0.0__py3-none-any.whl

pyrestkit/validators/response_validator.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from typing import Any
+
+from requests import Response
+
+from pyrestkit.exceptions.validation_exception import ValidationException
+
+
+class ResponseValidator:
+    def __init__(self, response: Response) -> None:
+        self.response = response
+
+    def status_code(self, expected: int) -> ResponseValidator:
+        if self.response.status_code != expected:
+            raise ValidationException(
+                "Expected status code "
+                f"{expected}, received {self.response.status_code}."
+            )
+
+        return self
+
+    def has_key(self, key: str) -> ResponseValidator:
+        payload = self._json_payload()
+
+        if key not in payload:
+            raise ValidationException(f"Response does not contain key '{key}'.")
+
+        return self
+
+    def field_equals(
+        self,
+        key: str,
+        value: Any,
+    ) -> ResponseValidator:
+        payload = self._json_payload()
+
+        if key not in payload:
+            raise ValidationException(f"Response does not contain key '{key}'.")
+
+        if payload[key] != value:
+            raise ValidationException(
+                f"Response field '{key}' expected {value!r}, received {payload[key]!r}."
+            )
+
+        return self
+
+    def _json_payload(self) -> dict[str, Any]:
+        try:
+            payload = self.response.json()
+        except ValueError as exc:
+            raise ValidationException("Response body is not valid JSON.") from exc
+
+        if not isinstance(payload, dict):
+            raise ValidationException("Response body must be a JSON object.")
+
+        return payload

pyrestkit/validators/schema_validator.py

@@ -0,0 +1,33 @@
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any
+
+from jsonschema import validate
+
+from pyrestkit.response.framework_response import FrameworkResponse
+
+
+class SchemaValidator:
+    """
+    Validates a response against a JSON schema.
+    """
+
+    @staticmethod
+    def validate(
+        response: FrameworkResponse,
+        schema_path: str,
+    ) -> None:
+        schema_file = Path(schema_path)
+
+        with schema_file.open(
+            encoding="utf-8",
+        ) as file:
+            schema: dict[str, Any] = json.load(file)
+
+        validate(
+            # instance=response.json(),
+            instance=response.body.to_dict(),
+            schema=schema,
+        )