utg-base 1.1.1__tar.gz → 1.2.0__tar.gz

{utg_base-1.1.1 → utg_base-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: utg-base
-Version: 1.1.1
+Version: 1.2.0
 Summary: UTG Base Package
 Author: Rovshen
 Author-email: rovshenashirov1619@gmail.com

{utg_base-1.1.1 → utg_base-1.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "utg-base"
-version = "1.1.1"
+version = "1.2.0"
 description = "UTG Base Package"
 authors = ["Rovshen <rovshenashirov1619@gmail.com>"]
 readme = "README.md"

utg_base-1.2.0/src/utg_base/services/__init__.py

@@ -0,0 +1 @@
+from .base_api import BaseServiceAPI

utg_base-1.2.0/src/utg_base/services/base_api.py

@@ -0,0 +1,128 @@
+from typing import Callable, Any
+
+import requests
+import urllib3
+from requests import Response
+
+from utg_base.utils import call_processor
+
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+
+class BaseServiceAPI:
+    name: str = None
+    base_url: str = None
+    default_response_processor: Callable[[Response], Any] = None
+
+    def request(self, method, path, data=None, json=None, params=None, headers=None,
+                authenticator: Callable[[dict], dict] | None = 'default',
+                response_processor: Callable[[Response], Any] | None = 'default',
+                **kwargs):
+        """
+        Make an HTTP request using the requests' library.
+
+        Args:
+            method: The HTTP method (GET, POST, PUT, DELETE, etc.).
+            path: The API endpoint path.
+            data: Dictionary or bytes to be sent in the body of the request (for form data).
+            json: JSON serializable data to be sent in the body of the request (for JSON data).
+            params: Query parameters as a dictionary.
+            headers: Headers to be included in the request.
+            authenticator: Optional authenticator function to handle authentication with headers.
+                This function should modify the headers for authentication purposes.
+                Example authenticator function:
+                def my_authenticator(headers):
+                    headers['Authorization'] = 'Bearer YOUR_ACCESS_TOKEN'
+                    return headers
+
+            response_processor: Optional function to process the response data.
+                This function should take the requests.Response object as input and return processed data.
+                Example response processor function:
+                def process_response(response):
+                    return response.json()
+        Kwargs:
+            auth: (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
+
+        Returns:
+            The response data, processed if a response processor is provided.
+        """
+
+        if headers is None:
+            headers = {}
+
+        if callable(authenticator):
+            headers = authenticator(headers)
+
+        if authenticator == 'default' and hasattr(self, 'authenticate') and callable(self.authenticate):
+            headers = self.authenticate(headers)
+
+        response = requests.request(
+            method=method,
+            url=self.base_url + path,
+            data=data,
+            json=json,
+            params=params,
+            headers=headers,
+            verify=False,
+            **kwargs
+        )
+
+        if response_processor == 'default':
+            if hasattr(self, 'default_response_processor') and callable(self.default_response_processor):
+                return self.default_response_processor(response)
+            return response
+
+        if response_processor is not None:
+            return response_processor(response)
+
+        return response
+
+    def call(self, method, path, data=None, json=None, params=None, headers=None):
+        data = self.request(
+            method=method,
+            path=path,
+            data=data,
+            json=json,
+            params=params,
+            headers=headers,
+            response_processor=call_processor
+        )
+        return {
+            'path': self.base_url + path,
+            'method': method,
+            'status': data['status'],
+            'reason': data['reason'],
+            'request': params if method == 'get' else json,
+            'response': data['response'],
+        }
+
+    def authenticate(self, headers: dict) -> dict:
+        """
+        Example authenticate method:
+            authenticate(self, headers):
+                headers['Authorization'] = 'Bearer YOUR_ACCESS_TOKEN'
+                return headers
+        :param headers:
+        :return:
+        """
+        return headers
+
+    def get(self, path, data=None, json=None, params=None, headers=None,
+            authenticator: Callable[[dict], dict] | None = 'default',
+            response_processor: Callable[[Response], Any] | None = 'default'):
+        return self.request('get', path, data, json, params, headers, authenticator, response_processor)
+
+    def post(self, path, data=None, json=None, params=None, headers=None,
+             authenticator: Callable[[dict], dict] | None = 'default',
+             response_processor: Callable[[Response], Any] | None = 'default'):
+        return self.request('post', path, data, json, params, headers, authenticator, response_processor)
+
+    def put(self, path, data=None, json=None, params=None, headers=None,
+            authenticator: Callable[[dict], dict] | None = 'default',
+            response_processor: Callable[[Response], Any] | None = 'default'):
+        return self.request('put', path, data, json, params, headers, authenticator, response_processor)
+
+    def patch(self, path, data=None, json=None, params=None, headers=None,
+              authenticator: Callable[[dict], dict] | None = 'default',
+              response_processor: Callable[[Response], Any] | None = 'default'):
+        return self.request('patch', path, data, json, params, headers, authenticator, response_processor)

utg_base-1.2.0/src/utg_base/utils/__init__.py

@@ -0,0 +1 @@
+from .response_processors import call_processor, data_processor

utg_base-1.2.0/src/utg_base/utils/response_processors.py

@@ -0,0 +1,27 @@
+from requests import Response
+
+
+def call_processor(response: Response):
+    try:
+        data = response.json()
+    except Exception as e:
+        data = response.text
+    return {
+        'status': response.status_code,
+        'reason': response.reason,
+        'response': data,
+    }
+
+
+def data_processor(response: Response):
+    try:
+        data = response.json()
+    except Exception as e:
+        raise Exception({
+            'status': response.status_code,
+            'reason': response.reason,
+            'response': response.text,
+            'exception': str(e)
+        })
+
+    return data