mimicker 2.0.0__tar.gz → 2.0.2__tar.gz

{mimicker-2.0.0 → mimicker-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mimicker
-Version: 2.0.0
+Version: 2.0.2
 Summary: A lightweight HTTP mocking server for Python
 License: MIT
 Keywords: http,mocking,testing,mock-server,stubbing,ci-cd,http-server,testing-tools,stub-server,purepython
@@ -248,6 +248,7 @@ mimicker(8080).routes(
 * `post(path)`: Defines a `POST` endpoint.
 * `put(path)`: Defines a `PUT` endpoint.
 * `delete(path)`: Defines a `DELETE` endpoint.
+* `patch(path)`: Defines a `PATCH` endpoint.
 * `.delay(duration)`: Defines the delay in seconds waited before returning the response (optional, 0. by default).
 * `.body(content)`: Defines the response `body`.
 * `.status(code)`: Defines the response `status code`.
@@ -270,10 +271,9 @@ or 🗣️ discuss features and ideas @ [slack community](https://join.slack.com
 I'm thankful to all the people who have contributed to this project.
 
 <a href="https://github.com/amaziahub/mimicker/graphs/contributors">
-<img src="https://contrib.rocks/image?repo=amaziahub/mimicker" />
+  <img src="https://contrib.rocks/image?repo=amaziahub/mimicker" />
 </a>
 
 
-
 ## License
 Mimicker is released under the MIT License. see the [LICENSE](LICENSE) for more information.

{mimicker-2.0.0 → mimicker-2.0.2}/README.md

@@ -226,6 +226,7 @@ mimicker(8080).routes(
 * `post(path)`: Defines a `POST` endpoint.
 * `put(path)`: Defines a `PUT` endpoint.
 * `delete(path)`: Defines a `DELETE` endpoint.
+* `patch(path)`: Defines a `PATCH` endpoint.
 * `.delay(duration)`: Defines the delay in seconds waited before returning the response (optional, 0. by default).
 * `.body(content)`: Defines the response `body`.
 * `.status(code)`: Defines the response `status code`.
@@ -248,10 +249,9 @@ or 🗣️ discuss features and ideas @ [slack community](https://join.slack.com
 I'm thankful to all the people who have contributed to this project.
 
 <a href="https://github.com/amaziahub/mimicker/graphs/contributors">
-<img src="https://contrib.rocks/image?repo=amaziahub/mimicker" />
+  <img src="https://contrib.rocks/image?repo=amaziahub/mimicker" />
 </a>
 
 
-
 ## License
 Mimicker is released under the MIT License. see the [LICENSE](LICENSE) for more information.

{mimicker-2.0.0 → mimicker-2.0.2}/mimicker/handler.py

@@ -23,6 +23,9 @@ class MimickerHandler(http.server.SimpleHTTPRequestHandler):
     def do_DELETE(self):
         self._handle_request("DELETE")
 
+    def do_PATCH(self):
+        self._handle_request("PATCH")
+
     def _handle_request(self, method: str):
         request_headers = {key.lower(): value for key, value in self.headers.items()}
         matched_stub, path_params = self.stub_matcher.match(

mimicker-2.0.2/mimicker/mimicker.py

@@ -0,0 +1,85 @@
+import logging
+
+from mimicker.route import Route
+from mimicker.server import MimickerServer
+
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(message)s")
+
+
+def get(path: str) -> Route:
+    """
+    Creates a GET route for the specified path.
+
+    Args:
+        path (str): The URL path for the route.
+
+    Returns:
+        Route: A GET route instance.
+    """
+    return Route("GET", path)
+
+
+def post(path: str) -> Route:
+    """
+    Creates a POST route for the specified path.
+
+    Args:
+        path (str): The URL path for the route.
+
+    Returns:
+        Route: A POST route instance.
+    """
+    return Route("POST", path)
+
+
+def put(path: str) -> Route:
+    """
+    Creates a PUT route for the specified path.
+
+    Args:
+        path (str): The URL path for the route.
+
+    Returns:
+        Route: A PUT route instance.
+    """
+    return Route("PUT", path)
+
+
+def delete(path: str) -> Route:
+    """
+    Creates a DELETE route for the specified path.
+
+    Args:
+        path (str): The URL path for the route.
+
+    Returns:
+        Route: A DELETE route instance.
+    """
+    return Route("DELETE", path)
+
+
+def patch(path: str) -> Route:
+    """
+    Creates a PATCH route for the specified path.
+
+    Args:
+        path (str): The URL path for the route.
+
+    Returns:
+        Route: A PATCH route instance.
+    """
+    return Route("PATCH", path)
+
+
+def mimicker(port: int = 8080) -> MimickerServer:
+    """
+    Starts a Mimicker server on the specified port.
+
+    Args:
+        port (int, optional): The port to run the server on. Defaults to 8080.
+
+    Returns:
+        MimickerServer: An instance of the running Mimicker server.
+    """
+    server = MimickerServer(port).start()
+    return server

mimicker-2.0.2/mimicker/route.py

@@ -0,0 +1,113 @@
+import re
+from typing import Dict, Tuple, Any, Callable, Optional, Pattern, Union, List
+
+
+class Route:
+    """
+    Represents an HTTP route with configurable response properties.
+    """
+
+    def __init__(self, method: str, path: str):
+        """
+        Initializes a new Route.
+
+        Args:
+            method (str): The HTTP method (GET, POST, PUT, DELETE, etc.).
+            path (str): The URL path for the route, supporting parameterized paths.
+        """
+        self.method = method
+        self.path = path
+        self._body = {}
+        self._delay = 0.
+        self._status = 200
+        self._headers: List[Tuple[str, str]] = []
+        self._response_func: Optional[Callable[[], Tuple[int, Any]]] = None
+
+        escaped_path = re.escape(path)
+        parameterized_path = re.sub(r'\\{(\w+)\\}',
+                                    r'(?P<\1>[^/]+)', escaped_path)
+        self._compiled_path: Pattern = re.compile(f"^{parameterized_path}$")
+
+    def delay(self, delay: float):
+        """
+        Sets the delay (in seconds) before returning the response.
+
+        Args:
+            delay (float): The delay time in seconds.
+
+        Returns:
+            Route: The current Route instance (for method chaining).
+        """
+        self._delay = delay
+        return self
+
+    def body(self, response: Union[Dict[str, Any], str] = None):
+        """
+        Sets the response body for the route.
+
+        Args:
+            response (Union[Dict[str, Any], str], optional): The response body (JSON or string).
+            Defaults to an empty string.
+
+        Returns:
+            Route: The current Route instance (for method chaining).
+        """
+        self._body = response if response is not None else ""
+        return self
+
+    def status(self, status_code: int):
+        """
+        Sets the HTTP status code for the response.
+
+        Args:
+            status_code (int): The HTTP status code (e.g., 200, 404, 500).
+
+        Returns:
+            Route: The current Route instance (for method chaining).
+        """
+        self._status = status_code
+        return self
+
+    def headers(self, headers: List[Tuple[str, str]]):
+        """
+        Sets the HTTP headers for the response.
+
+        Args:
+            headers (List[Tuple[str, str]]): A list of key-value pairs representing headers.
+
+        Returns:
+            Route: The current Route instance (for method chaining).
+        """
+        self._headers = headers
+        return self
+
+    def response_func(self, func: Callable[[], Tuple[int, Any]]):
+        """
+        Sets a custom response function for dynamic responses.
+
+        Args:
+            func (Callable[[], Tuple[int, Any]]): A function returning a tuple (status_code, response_body).
+
+        Returns:
+            Route: The current Route instance (for method chaining).
+        """
+        self._response_func = func
+        return self
+
+    def build(self):
+        """
+        Builds the route configuration dictionary.
+
+        Returns:
+            Dict[str, Any]: The route configuration containing method, path, response settings, and handlers.
+        """
+        return {
+            "method": self.method,
+            "path": self.path,
+            "compiled_path": self._compiled_path,
+            "delay": self._delay,
+            "body": self._body,
+            "status": self._status,
+            "headers": self._headers,
+            "response_func": self._response_func
+        }

{mimicker-2.0.0 → mimicker-2.0.2}/mimicker/server.py

@@ -13,7 +13,18 @@ class ReusableAddressThreadingTCPServer(socketserver.ThreadingTCPServer):
 
 
 class MimickerServer:
+    """
+    A lightweight HTTP mocking server.
+
+    This server allows defining request-response routes for testing or simulation purposes.
+    """
     def __init__(self, port: int = 8080):
+        """
+        Initializes the Mimicker server.
+
+        Args:
+            port (int, optional): The port to run the server on. Defaults to 8080.
+        """
         self.stub_matcher = StubGroup()
         self.server = ReusableAddressThreadingTCPServer(("", port), self._handler_factory)
         self._thread = threading.Thread(target=self.server.serve_forever, daemon=True)
@@ -23,6 +34,15 @@ class MimickerServer:
         return MimickerHandler(self.stub_matcher, *args)
 
     def routes(self, *routes: Route):
+        """
+        Adds multiple routes to the server.
+
+        Args:
+            *routes (Route): One or more Route instances to be added.
+
+        Returns:
+            MimickerServer: The current server instance (for method chaining).
+        """
         for route in routes:
             route_config = route.build()
             self.stub_matcher.add(
@@ -37,12 +57,23 @@ class MimickerServer:
         return self
 
     def start(self):
+        """
+        Starts the Mimicker server in a background thread.
+
+        Returns:
+            MimickerServer: The current server instance (for method chaining).
+        """
         logging.info("MimickerServer starting on port %s",
                      self.server.server_address[1])
         self._thread.start()
         return self
 
     def shutdown(self):
+        """
+        Shuts down the Mimicker server gracefully.
+
+        Ensures that the server is stopped and the thread is joined if still running.
+        """
         self.server.server_close()
         self.server.shutdown()
         if self._thread.is_alive():

{mimicker-2.0.0 → mimicker-2.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mimicker"
-version = "2.0.0"
+version = "2.0.2"
 description = "A lightweight HTTP mocking server for Python"
 authors = ["Amazia Gur <amaziagur@gmail.com>"]
 license = "MIT"
@@ -13,12 +13,12 @@ homepage = "https://github.com/amaziahub/mimicker"
 python = "^3.7"
 
 [tool.poetry.dev-dependencies]
-pytest = "^6.0"
+pytest = "^7.4"
 PyHamcrest = "^2.0"
 requests = "^2.0"
 
 [tool.poetry.group.dev.dependencies]
-pytest-cov = "<3.0"
+pytest-cov = "<5.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

mimicker-2.0.0/mimicker/mimicker.py

@@ -1,27 +0,0 @@
-import logging
-
-from mimicker.route import Route
-from mimicker.server import MimickerServer
-
-logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(message)s")
-
-
-def get(path: str) -> Route:
-    return Route("GET", path)
-
-
-def post(path: str) -> Route:
-    return Route("POST", path)
-
-
-def put(path: str) -> Route:
-    return Route("PUT", path)
-
-
-def delete(path: str) -> Route:
-    return Route("DELETE", path)
-
-
-def mimicker(port: int = 8080) -> MimickerServer:
-    server = MimickerServer(port).start()
-    return server

mimicker-2.0.0/mimicker/route.py

@@ -1,54 +0,0 @@
-import re
-
-from typing import Dict, Tuple, Any, Callable, Optional, Pattern, Union, List
-
-
-class Route:
-    def __init__(self, method: str, path: str):
-        self.method = method
-        self.path = path
-        self._body = {}
-        self._delay = 0.
-        self._status = 200
-        self._headers: List[Tuple[str, str]] = []
-        self._response_func: Optional[Callable[[], Tuple[int, Any]]] = None
-
-        escaped_path = re.escape(path)
-        parameterized_path = re.sub(r'\\{(\w+)\\}',
-                                    r'(?P<\1>[^/]+)', escaped_path)
-        self._compiled_path: Pattern = re.compile(f"^{parameterized_path}$")
-
-    def delay(self, delay: float):
-        """
-        Sets the delay (in seconds) to wait before returning the response
-        """
-        self._delay = delay
-        return self
-
-    def body(self, response: Union[Dict[str, Any], str] = None):
-        self._body = response if response is not None else ""
-        return self
-
-    def status(self, status_code: int):
-        self._status = status_code
-        return self
-
-    def headers(self, headers: List[Tuple[str, str]]):
-        self._headers = headers
-        return self
-
-    def response_func(self, func: Callable[[], Tuple[int, Any]]):
-        self._response_func = func
-        return self
-
-    def build(self):
-        return {
-            "method": self.method,
-            "path": self.path,
-            "compiled_path": self._compiled_path,
-            "delay": self._delay,
-            "body": self._body,
-            "status": self._status,
-            "headers": self._headers,
-            "response_func": self._response_func
-        }