rb-commons 0.2.2__py3-none-any.whl → 0.2.3__py3-none-any.whl

rb_commons/http/base_api.py

@@ -0,0 +1,91 @@
+import json
+import requests
+from rb_commons.http.exceptions import BadRequestException, InternalException
+from requests import RequestException
+
+class BaseAPI:
+    def __init__(self, base_url: str):
+        self.BASE_URL = base_url
+
+    def _make_request(self, method: str, path: str, data: dict = None,
+                      params: dict = None, headers: dict = None, reset_base_url: bool = False, form_encoded: bool = False) -> requests.Response:
+        """
+        A general method to make HTTP requests (GET, POST, etc.)
+
+        This method abstracts the process of making HTTP requests, allowing for
+        different types of requests (GET, POST, PUT, DELETE) to be easily performed
+        by specifying the method and other parameters. This adheres to the DRY
+        (Don't Repeat Yourself) principle by centralizing request handling.
+
+        :param method: HTTP method to use for the request (e.g., 'GET', 'POST', 'PUT', 'DELETE').
+        :param path: The API endpoint path to which the request is made. This should be
+                     relative to the base URL defined in the class.
+        :param data: Optional dictionary containing the data to be sent in the body of
+                     the request (used for POST and PUT requests). Default is None.
+        :param params: Optional dictionary containing query parameters to be included
+                       in the request URL. Default is None.
+        :param headers: Optional dictionary containing any custom headers to be sent
+                        with the request. Default is None.
+        :return: Response object containing the server's response to the HTTP request.
+        :raises HttpException: Raises a custom HttpException if the request fails for
+                             any reason, including invalid HTTP methods, network issues,
+                             or JSON parsing errors.
+
+        The method constructs the full URL from the base URL and the provided path.
+        It uses a dictionary to map HTTP methods to their respective request functions
+        from the requests library. After making the request, it checks the response
+        status and attempts to parse the response as JSON.
+        """
+        url = self.BASE_URL + path
+
+        if reset_base_url:
+            url = path
+
+        try:
+            request_methods = {
+                'POST': requests.post,
+                'GET': requests.get,
+                'PUT': requests.put,
+                'DELETE': requests.delete
+            }
+
+            if method not in request_methods:
+                raise BadRequestException(f"Unsupported HTTP method: {method}")
+
+            kwargs = {
+                'params': params,
+                'headers': headers,
+                'data' if form_encoded else 'json': data
+            }
+
+            response = request_methods[method](url, **kwargs)
+
+            data = response.json()
+
+            if not (200 <= response.status_code < 300):
+                error_message = data.get("message")
+                if error_message is not None:
+                    raise BadRequestException(error_message)
+
+                raise BadRequestException(f"Unexpected error occured: {response.text}")
+
+            return response
+
+        except RequestException as e:
+            raise BadRequestException(f"Request failed: {e}")
+        except (json.JSONDecodeError, ValueError) as e:
+            raise InternalException(f"Failed to parse JSON: {e}")
+        except Exception as e:
+            raise InternalException("Something went wrong")
+
+    def _post(self, path: str, data: dict, headers: dict = None, params: dict = None, reset_base_url: bool = False, form_encoded: bool = False) -> requests.Response:
+        return self._make_request('POST', path, data=data, headers=headers, params=params, reset_base_url=reset_base_url, form_encoded=form_encoded)
+
+    def _get(self, path: str, params: dict = None, headers: dict = None, reset_base_url: bool = False, form_encoded: bool = False) -> requests.Response:
+        return self._make_request('GET', path, params=params, headers=headers, reset_base_url=reset_base_url, form_encoded=form_encoded)
+
+    def _put(self, path: str, params: dict = None, data: dict = None, headers: dict = None, reset_base_url: bool = False, form_encoded: bool = False) -> requests.Response:
+        return self._make_request('PUT', path, params=params, data=data, headers=headers, reset_base_url=reset_base_url, form_encoded=form_encoded)
+
+    def _delete(self, path: str, headers: dict = None, reset_base_url: bool = False, form_encoded: bool = False) -> requests.Response:
+        return self._make_request('DELETE', path, headers=headers, reset_base_url=reset_base_url, form_encoded=form_encoded)

{rb_commons-0.2.2.dist-info → rb_commons-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rb-commons
-Version: 0.2.2
+Version: 0.2.3
 Summary: Commons of project and simplified orm based on sqlalchemy.
 Home-page: https://github.com/RoboSell-organization/rb-commons
 Author: Abdulvoris

{rb_commons-0.2.2.dist-info → rb_commons-0.2.3.dist-info}/RECORD

@@ -6,6 +6,7 @@ rb_commons/configs/config.py,sha256=zla62zy3UfjE2YpvSDwsfhP2Qsm0BbGsycngfyiVvE4,
 rb_commons/configs/injections.py,sha256=6B1EOgIGnkWv3UrFaV9PRgG0-CJAbLu1UZ3kq-SjPVU,273
 rb_commons/configs/rabbitmq.py,sha256=vUqa_PcZkPp1lX0B6HLSAXVMUcPR2_8-8cN-C7xFxRI,741
 rb_commons/http/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+rb_commons/http/base_api.py,sha256=W-nXoO0TcngSMVgmJHFRdXeOrI9FDPi36I_Ih8hP3VE,4824
 rb_commons/http/exceptions.py,sha256=EGRMr1cRgiJ9Q2tkfANbf0c6-zzXf1CD6J3cmCaT_FA,1885
 rb_commons/orm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rb_commons/orm/exceptions.py,sha256=1aMctiEwrPjyehoXVX1l6ML5ZOhmDkmBISzlTD5ey1Y,509
@@ -16,7 +17,7 @@ rb_commons/schemes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuF
 rb_commons/schemes/jwt.py,sha256=F66JJDhholuOPPzlKeoC6f1TL4gXg4oRUrV5yheNpyo,1675
 rb_commons/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rb_commons/utils/media.py,sha256=KNY_9SdRa3Rp7d3B1tZaXkhmzVa65RcS62BYwZP1bVM,332
-rb_commons-0.2.2.dist-info/METADATA,sha256=_WLAr4eS8xznDVugZa1-aRQz4eKYo4_2Y12t8P7OH8c,6570
-rb_commons-0.2.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-rb_commons-0.2.2.dist-info/top_level.txt,sha256=HPx_WAYo3_fbg1WCeGHsz3wPGio1ucbnrlm2lmqlJog,11
-rb_commons-0.2.2.dist-info/RECORD,,
+rb_commons-0.2.3.dist-info/METADATA,sha256=SLk96EUMK1idDf_Nr36qIv6X_r0szP0ZHiR1dP4ZYAk,6570
+rb_commons-0.2.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+rb_commons-0.2.3.dist-info/top_level.txt,sha256=HPx_WAYo3_fbg1WCeGHsz3wPGio1ucbnrlm2lmqlJog,11
+rb_commons-0.2.3.dist-info/RECORD,,