lsrestclient 1.0.1__py3-none-any.whl → 1.2.0__py3-none-any.whl

lsrestclient/client.py

@@ -1,5 +1,6 @@
 import os
 from typing import Optional, Dict, Any
+from unittest.mock import MagicMock
 
 import lsjsonclasses
 import requests
@@ -62,12 +63,17 @@ class LsRestClient(Session):
     ) -> None:
         """Class representing a REST client for JSON API."""
 
+        self._mocks = {}
         self.base_url = base_url
         self.base_headers = {"content-type": "application/json"}
         self.name = name
         super().__init__()
         self._clients[name] = self
 
+    @staticmethod
+    def mock_name(client_name: str, method: str, url: str) -> str:
+        return f"{client_name}_{method.upper()}_{url}"
+
     def full_url(
         self,
         url: str,
@@ -91,6 +97,12 @@ class LsRestClient(Session):
             del params[p]
         return full_url.format(**url_params)
 
+    def caller(self, method: str, url: str, *args, **kwargs) -> LsRestClientResponse:
+        # check mocks
+        mock = self._mocks.get(self.mock_name(self.name, method, url), None)
+        func = mock if mock is not None else self.request
+        return func(method, url, *args, **kwargs)
+
     def request(
         self,
         method: str,
@@ -173,7 +185,7 @@ class LsRestClient(Session):
         :param kwargs: Additional keyword arguments for the request.
         :return: The response object of type LsRestClientResponse.
         """
-        return self.request("GET", *args, **kwargs)
+        return self.caller("GET", *args, **kwargs)
 
     def post(self, *args, **kwargs) -> LsRestClientResponse:
         """
@@ -183,7 +195,7 @@ class LsRestClient(Session):
         :param kwargs: The keyword arguments for the POST request, including headers, body, and any other parameters.
         :return: An instance of LsRestClientResponse, representing the response from the POST request.
         """
-        return self.request("POST", *args, **kwargs)
+        return self.caller("POST", *args, **kwargs)
 
     def put(self, *args, **kwargs) -> LsRestClientResponse:
         """
@@ -193,7 +205,7 @@ class LsRestClient(Session):
         :param kwargs: The keyword arguments to be passed to the request.
         :return: An instance of LsRestClientResponse representing the response from the server.
         """
-        return self.request("PUT", *args, **kwargs)
+        return self.caller("PUT", *args, **kwargs)
 
     def patch(self, *args, **kwargs) -> LsRestClientResponse:
         """
@@ -203,7 +215,7 @@ class LsRestClient(Session):
         :param kwargs: The keyword arguments for the PATCH request.
         :return: The response from the PATCH request as an `LsRestClientResponse` object.
         """
-        return self.request("PATCH", *args, **kwargs)
+        return self.caller("PATCH", *args, **kwargs)
 
     def delete(self, *args, **kwargs) -> LsRestClientResponse:
         """
@@ -213,7 +225,7 @@ class LsRestClient(Session):
         :param kwargs: Arbitrary keyword arguments.
         :return: An instance of LsRestClientResponse.
         """
-        return self.request("DELETE", *args, **kwargs)
+        return self.caller("DELETE", *args, **kwargs)
 
     def options(self, *args, **kwargs) -> LsRestClientResponse:
         """
@@ -223,7 +235,7 @@ class LsRestClient(Session):
         :param kwargs: Additional keyword arguments to be passed to the request.
         :return: LsRestClientResponse object containing the response of the OPTIONS request.
         """
-        return self.request("OPTIONS", *args, **kwargs)
+        return self.caller("OPTIONS", *args, **kwargs)
 
     def head(
         self,
@@ -238,3 +250,10 @@ class LsRestClient(Session):
         :return: The response object from the request.
         """
         return self.request("HEAD", *args, **kwargs)
+
+    def mock(self, mock_name: str, mock: MagicMock):
+        self._mocks[mock_name] = mock
+
+    def unmock(self, mock_name: str):
+        if mock_name in self._mocks:
+            del self._mocks[mock_name]

lsrestclient/fixtures.py

@@ -0,0 +1,12 @@
+from lsrestclient.mock import lsrestclient_mock_context
+
+try:
+    import pytest
+
+    @pytest.fixture
+    def lsrestclient_mocker():
+        with lsrestclient_mock_context() as mocker:
+            yield mocker
+
+except ImportError:
+    pass

lsrestclient/mock.py

@@ -0,0 +1,36 @@
+import dataclasses
+from contextlib import contextmanager
+from unittest.mock import MagicMock
+
+from lsrestclient import LsRestClient
+
+
+@dataclasses.dataclass
+class LsRestClientMockModel:
+    mock_name: str
+    client: LsRestClient
+    mock: MagicMock
+
+
+class LsRestClientMocker(object):
+    def __init__(self):
+        super().__init__()
+        self.mocks = {}
+
+    def mock(self, client: LsRestClient, method: str, url: str, *args, **kwargs):
+        mock_name = LsRestClient.mock_name(client.name, method, url)
+        mock = MagicMock(*args, **kwargs)
+        client.mock(mock_name, mock)
+        self.mocks[mock_name] = LsRestClientMockModel(client=client, mock_name=mock_name, mock=mock)
+        return mock
+
+    def unmock_all(self):
+        for mock_name, mock_model in self.mocks.items():
+            mock_model.client.unmock(mock_name)
+
+
+@contextmanager
+def lsrestclient_mock_context():
+    mocker = LsRestClientMocker()
+    yield mocker
+    mocker.unmock_all()

{lsrestclient-1.0.1.dist-info → lsrestclient-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lsrestclient
-Version: 1.0.1
+Version: 1.2.0
 Summary: REST Api Client
 Author: mba
 Author-email: bartel@electronic-shop.lu

lsrestclient-1.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+lsrestclient/__init__.py,sha256=lI62SHmG0m-iukB5UEwdN5dO4cKnDasOt-TmR1rgaWI,72
+lsrestclient/auth.py,sha256=-XT9OajBudLDZJ7tZyM0E5EXF2R1Kc-jyeKMf24wyJA,403
+lsrestclient/client.py,sha256=cQXgRZ7oktHR7u8i9sib9FhBV5JxdmA-QOz6UGkYzUc,9922
+lsrestclient/contexts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+lsrestclient/contexts/bearer_token.py,sha256=GZZOzAI2Ng_9DvFCbhv1Wwb8wJ1AYCca3fQeNtt2NaU,753
+lsrestclient/exceptions.py,sha256=2Nw3eISrpBCdhHWOZTBjttEtPkJmTpRoPis72VO-R_g,979
+lsrestclient/fixtures.py,sha256=dFkAYQXL6xqTOwRofb03Nsu_cIjq1sG10Rh8dxWfz9s,239
+lsrestclient/mock.py,sha256=T9QYFdkKidLLKOeQMhwvMYY5pANQpHLXmkcLOtxd5Q4,971
+lsrestclient/response.py,sha256=IXjIgb7ySF-1FdAtnOKRyF3k9LJRB3OFyzIIZI1GNxM,1816
+lsrestclient-1.2.0.dist-info/METADATA,sha256=dRRu2ymZD198uSbOuF3Fjmmn1Sd2z0nRCb6lj44KOqg,6672
+lsrestclient-1.2.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+lsrestclient-1.2.0.dist-info/entry_points.txt,sha256=zyMRgI1XpL7R013uDs4KUVTa1XL7AfzJ_-LfRPgFCXM,38
+lsrestclient-1.2.0.dist-info/RECORD,,

lsrestclient-1.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[pytest11]
+lsrestclient=lsrestclient
+

lsrestclient-1.0.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-lsrestclient/__init__.py,sha256=lI62SHmG0m-iukB5UEwdN5dO4cKnDasOt-TmR1rgaWI,72
-lsrestclient/auth.py,sha256=-XT9OajBudLDZJ7tZyM0E5EXF2R1Kc-jyeKMf24wyJA,403
-lsrestclient/client.py,sha256=4shMxnMiLtJXpTScb9LCVsqHvbUnUWKlaetKTK5-OwE,9225
-lsrestclient/contexts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-lsrestclient/contexts/bearer_token.py,sha256=GZZOzAI2Ng_9DvFCbhv1Wwb8wJ1AYCca3fQeNtt2NaU,753
-lsrestclient/exceptions.py,sha256=2Nw3eISrpBCdhHWOZTBjttEtPkJmTpRoPis72VO-R_g,979
-lsrestclient/response.py,sha256=IXjIgb7ySF-1FdAtnOKRyF3k9LJRB3OFyzIIZI1GNxM,1816
-lsrestclient-1.0.1.dist-info/METADATA,sha256=8MTtWZE5YJ__Jme1PCR92MMEftaq9D76oJpexiAshmc,6672
-lsrestclient-1.0.1.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-lsrestclient-1.0.1.dist-info/RECORD,,