lsrestclient 0.3.0__tar.gz → 0.6.0__tar.gz

{lsrestclient-0.3.0 → lsrestclient-0.6.0}/PKG-INFO

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

lsrestclient-0.6.0/lsrestclient/__init__.py

@@ -0,0 +1,3 @@
+from .exceptions import *
+from .response import *
+from .client import *

lsrestclient-0.6.0/lsrestclient/client.py

@@ -0,0 +1,203 @@
+import os
+from typing import Optional, Dict, Any
+
+import lsjsonclasses
+import requests
+from requests import Session
+
+import re
+
+from lsrestclient import LsRestClientResponse, exceptions
+
+find_parameters_regex = re.compile('{(.*?)}')
+
+
+class LsRestClient(Session):
+    _clients = {}
+
+    @classmethod
+    def from_env(cls, env_name: str, name: Optional[str] = None, required: bool = True):
+        """
+        Create an instance of the LsRestClient class using environment variables.
+        It gets globally saved under the given name, so that it can be reused.
+
+        :param env_name: The name of the environment variable that holds the base URL.
+        :param name: An optional name for the client instance.
+        :param required: A flag indicating whether the environment variable is required. Defaults to True.
+        :return: An instance of the LsRestClient class.
+        """
+        base_url = os.environ.get(env_name, "")
+        if base_url == "" and required:
+            raise EnvironmentError(f"Environment variable '{env_name}' needs to be set")
+
+        return cls(
+            base_url=base_url,
+            name=name
+        )
+
+    @classmethod
+    def client(cls, name: str):
+        """
+        Retrieves the LsRestClient instance with the specified name. If a client with the given name does not exist, an exception is raised.
+
+        :param name: The name of the LsRestClient to be retrieved.
+        :return: The LsRestClient instance with the given name.
+        """
+        try:
+            return cls._clients[name]
+        except KeyError:
+            raise Exception(f"LsRestClient with name '{name}' not initialized.")
+
+    def __init__(self, base_url: str = None, name: str = "default") -> None:
+        """Class representing a REST client for JSON API."""
+
+        self.base_url = base_url
+        self.base_headers = {'content-type': 'application/json'}
+        self.name = name
+        super().__init__()
+        self._clients[name] = self
+
+    def full_url(self, url: str, params: Optional[dict] = None) -> str:
+        """
+        Builds a full url from the base_url with url parameters replaced.
+
+        :param url: The relative URL to be used to build the full URL.
+        :param params: An optional dictionary that contains the parameters to be used in formatting the URL.
+                       Default is None. Used parameters get removed from the dictionary.
+        :return: The full URL with the parameters replaced.
+        """
+        if params is None:
+            params = {}
+
+        full_url = f"{self.base_url}{url}"
+        found = find_parameters_regex.findall(full_url)
+        url_params = {p: params[p] for p in found}
+        for p in found:
+            del params[p]
+        return full_url.format(**url_params)
+
+    def request(
+        self,
+        method: str,
+        url: str,
+        *args,
+        params: Optional[Dict[str, Any]] = None,
+        body: Optional[Dict[str, Any]] = None,
+        **kwargs
+    ) -> LsRestClientResponse:  # pragma: no cover
+        """
+        :param method: The HTTP method to be used for the request.
+        :param url: The URL endpoint for the request.
+        :param args: Additional arguments for the request.
+        :param params: Optional query parameters for the request.
+        :param body: Optional request body in JSON format.
+        :param kwargs: Additional keyword arguments for the request.
+        :return: An instance of LsRestClientResponse.
+
+        This method sends an HTTP request using the provided method, URL, parameters, and body. It returns an instance of LsRestClientResponse which represents the response received from the server.
+
+        The `method` parameter specifies the HTTP method to be used for the request, e.g., 'GET', 'POST', 'PUT', 'DELETE', etc.
+
+        The `url` parameter specifies the URL endpoint for the request.
+
+        The `args` parameter is used to pass additional arguments to the underlying `Session.request` method. These arguments are passed directly to the `requests.request` function.
+
+        The `params` parameter is an optional dictionary of query parameters to be included in the request URL. This can be used to include query parameters in the URL, e.g., '/endpoint?key=value'.
+
+        The `body` parameter is an optional dictionary representing the request body in JSON format. This can be used to send data in the request body for methods like 'POST' or 'PUT'.
+
+        The `kwargs` parameter is used to pass additional keyword arguments to the underlying `Session.request` method. These keyword arguments are passed directly to the `requests.request` function.
+
+        The returned value is an instance of LsRestClientResponse, which represents the response received from the server. This object provides various properties and methods to access the response data.
+
+        Note: This method raises a `ConnectionError` if a connection error occurs during the request.
+        """
+        # apply base_headers
+        headers = self.base_headers | kwargs.get("headers", {})
+        kwargs |= dict(headers=headers)
+
+        # params
+        if params is None:
+            params = {}
+        if body is not None:
+            kwargs['data'] = lsjsonclasses.LSoftJSONEncoder.dumps(body).encode("utf8")
+
+        full_url = self.full_url(url, params)
+
+        try:
+            requests_response = requests.request(method.upper(), full_url, *args, params=params, **kwargs)
+            response = LsRestClientResponse.from_requests_response(requests_response)
+            return response
+
+        except requests.ConnectionError:
+            raise exceptions.ConnectionError(url=full_url)
+
+    def get(self, *args, **kwargs) -> LsRestClientResponse:
+        """
+        Send a GET request to the specified URL.
+
+        :param args: Positional arguments used to construct the URL.
+        :param kwargs: Additional keyword arguments for the request.
+        :return: The response object of type LsRestClientResponse.
+        """
+        return self.request('GET', *args, **kwargs)
+
+    def post(self, *args, **kwargs) -> LsRestClientResponse:
+        """
+        This method is used to send a POST request using the LSRestClient class.
+
+        :param args: The positional arguments for the POST request, including the URL and any additional parameters.
+        :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)
+
+    def put(self, *args, **kwargs) -> LsRestClientResponse:
+        """
+        This method is used to send a PUT request using the LSRestClient class.
+
+        :param args: The arguments to be passed to the request.
+        :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)
+
+    def patch(self, *args, **kwargs) -> LsRestClientResponse:
+        """
+        Send a PATCH request to the specified URL with the provided arguments.
+
+        :param args: The arguments for the PATCH request.
+        :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)
+
+    def delete(self, *args, **kwargs) -> LsRestClientResponse:
+        """
+        Deletes a resource using the DELETE method.
+
+        :param args: Variable length argument list.
+        :param kwargs: Arbitrary keyword arguments.
+        :return: An instance of LsRestClientResponse.
+        """
+        return self.request('DELETE', *args, **kwargs)
+
+    def options(self, *args, **kwargs) -> LsRestClientResponse:
+        """
+        Send an OPTIONS request using the LsRestClient.
+
+        :param args: Additional positional arguments to be passed to the request.
+        :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)
+
+    def head(self, *args: object, **kwargs: object) -> object:
+        """
+        Send a HEAD request to the specified URL.
+
+        :param args: Positional arguments passed to the `request` method.
+        :param kwargs: Keyword arguments passed to the `request` method.
+        :return: The response object from the request.
+        """
+        return self.request('HEAD', *args, **kwargs)

lsrestclient-0.6.0/lsrestclient/exceptions.py

@@ -0,0 +1,21 @@
+from typing import Optional
+
+
+class ConnectionError(Exception):
+    """Exception class for connection errors.
+
+    Args:
+        url (Optional[str]): The URL that the connection could not be established to.
+
+    Attributes:
+        url (Optional[str]): The URL that the connection could not be established to.
+
+    Raises:
+        ConnectionError: If a connection could not be established to the given URL.
+
+    """
+    url: str
+
+    def __init__(self, url: Optional[str] = None) -> None:
+        self.url = url
+        super().__init__(f"Connection could not be established to '{url}'")

lsrestclient-0.6.0/lsrestclient/response.py

@@ -0,0 +1,64 @@
+from dataclasses import dataclass
+from typing import Optional
+
+import lsjsonclasses
+from requests import Response
+from requests.structures import CaseInsensitiveDict
+
+
+@dataclass
+class LsRestClientResponse:
+    """
+    Represents a response from the LsRestClient.
+    """
+
+    status_code: int
+    content: str
+    headers: CaseInsensitiveDict
+
+    _json: Optional[dict] = None
+
+    def json(self):
+        if self._json is None:
+            self._json = lsjsonclasses.LSoftJSONDecoder.loads(self.content)
+        return self._json
+
+    @classmethod
+    def from_requests_response(cls, response: Response):
+        """
+        Create an instance of LsRestClientResponse from a requests Response object.
+
+        :param response: The requests Response object.
+        :type response: Response
+        :return: An instance of LsRestClientResponse representing the response.
+        :rtype: LsRestClientResponse
+        """
+        return cls(
+            status_code=response.status_code,
+            content=response.content.decode("utf8"),
+            headers=response.headers,
+        )
+
+    @classmethod
+    def from_dict(cls, status_code: int = 200, data: dict = None, headers: CaseInsensitiveDict = None):
+        """
+        Converts a dictionary into an instance of the LsRestClientResponse class.
+
+        :param status_code: The HTTP status code. Defaults to 200.
+        :param data: The data dictionary. Defaults to None.
+        :param headers: The headers dictionary. Defaults to None.
+        :return: An instance of the LsRestClientResponse class.
+
+        """
+        if data is None:
+            data = {}
+        if headers is None:
+            headers = {}
+
+        content = lsjsonclasses.LSoftJSONEncoder.dumps(data)
+
+        return cls(
+            status_code=status_code,
+            content=content,
+            headers=headers
+        )

{lsrestclient-0.3.0 → lsrestclient-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "lsrestclient"
-version = "0.3.0"
+version = "0.6.0"
 description = "REST Api Client"
 authors = ["mba <bartel@electronic-shop.lu>"]
 readme = "README.md"

lsrestclient-0.3.0/lsrestclient/__init__.py

@@ -1,114 +0,0 @@
-import re
-from dataclasses import dataclass
-from typing import Optional, Dict, Any
-
-import lsjsonclasses
-import requests
-from requests import Session, Response
-from requests.structures import CaseInsensitiveDict
-
-from lsrestclient import exceptions
-
-find_parameters_regex = re.compile('{(.*?)}')
-
-
-@dataclass
-class LsRestClientResponse:
-    status_code: int
-    content: str
-    headers: CaseInsensitiveDict
-
-    _json: Optional[dict] = None
-
-    def json(self):
-        if self._json is None:
-            self._json = lsjsonclasses.LSoftJSONDecoder.loads(self.content)
-        return self._json
-
-    @classmethod
-    def from_requests_response(cls, response: Response):
-        return cls(
-            status_code=response.status_code,
-            content=response.content.decode("utf8"),
-            headers=response.headers,
-        )
-
-
-class LsRestClient(Session):
-    _clients = {}
-
-    @classmethod
-    def client(cls, name):
-        try:
-            return cls._clients[name]
-        except KeyError:
-            raise Exception(f"LsRestClient with name '{name}' not initialized.")
-
-    def __init__(self, base_url: str = None, name: str = "default") -> None:
-        self.base_url = base_url
-        self.base_headers = {'content-type': 'application/json'}
-        self.name = name
-        super().__init__()
-        self._clients[name] = self
-
-    def full_url(self, url: str, params: Optional[dict] = None) -> str:
-        if params is None:
-            params = {}
-
-        full_url = f"{self.base_url}{url}"
-        found = find_parameters_regex.findall(full_url)
-        url_params = {p: params[p] for p in found}
-        for p in found:
-            del params[p]
-        return full_url.format(**url_params)
-
-    def request(
-        self,
-        method: str,
-        url: str,
-        *args,
-        params: Optional[Dict[str, Any]] = None,
-        body: Optional[Dict[str, Any]] = None,
-        **kwargs
-    ) -> LsRestClientResponse:  # pragma: no cover
-
-        # apply base_headers
-        headers = self.base_headers | kwargs.get("headers", {})
-        kwargs |= dict(headers=headers)
-
-        # params
-        if params is None:
-            params = {}
-        if body is not None:
-            kwargs['data'] = lsjsonclasses.LSoftJSONEncoder.dumps(body).encode("utf8")
-
-        full_url = self.full_url(url, params)
-
-        try:
-            requests_response = requests.request(method.upper(), full_url, *args, params=params, **kwargs)
-            response = LsRestClientResponse.from_requests_response(requests_response)
-            return response
-
-        except requests.ConnectionError:
-            raise exceptions.ConnectionError(url=full_url)
-
-    def get(self, *args, **kwargs) -> LsRestClientResponse:
-        return self.request('GET', *args, **kwargs)
-
-    def post(self, *args, **kwargs) -> LsRestClientResponse:
-        return self.request('POST', *args, **kwargs)
-
-    def put(self, *args, **kwargs) -> LsRestClientResponse:
-        return self.request('PUT', *args, **kwargs)
-
-    def patch(self, *args, **kwargs) -> LsRestClientResponse:
-        return self.request('PATCH', *args, **kwargs)
-
-    def delete(self, *args, **kwargs) -> LsRestClientResponse:
-        return self.request('DELETE', *args, **kwargs)
-
-    def options(self, *args, **kwargs) -> LsRestClientResponse:
-        return self.request('OPTIONS', *args, **kwargs)
-
-    def head(self, *args, **kwargs):
-        return self.request('HEAD', *args, **kwargs)

lsrestclient-0.3.0/lsrestclient/exceptions.py

@@ -1,5 +0,0 @@
-class ConnectionError(Exception):
-
-    def __init__(self, *args: object, url: str | None = None) -> None:
-        self.url = url
-        super().__init__(f"Connection could not be established to '{url}'", *args)