fdc-shared-kernel 0.0.28__tar.gz → 0.0.30__tar.gz

{fdc_shared_kernel-0.0.28 → fdc_shared_kernel-0.0.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fdc_shared_kernel
-Version: 0.0.28
+Version: 0.0.30
 Summary: Shared library for microservice
 Author-email: Shikhil S <shikhil.s@dbizsolution.com>, Ahammed Akdham N <ahammedakdham.n@dbizsolution.com>
 Classifier: Programming Language :: Python :: 3

{fdc_shared_kernel-0.0.28 → fdc_shared_kernel-0.0.30}/fdc_shared_kernel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fdc_shared_kernel
-Version: 0.0.28
+Version: 0.0.30
 Summary: Shared library for microservice
 Author-email: Shikhil S <shikhil.s@dbizsolution.com>, Ahammed Akdham N <ahammedakdham.n@dbizsolution.com>
 Classifier: Programming Language :: Python :: 3

{fdc_shared_kernel-0.0.28 → fdc_shared_kernel-0.0.30}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fdc_shared_kernel"
-version = "0.0.28"
+version = "0.0.30"
 requires-python = ">=3.7"
 readme = "README_pypi.md"
 description = "Shared library for microservice"

{fdc_shared_kernel-0.0.28 → fdc_shared_kernel-0.0.30}/shared_kernel/http/httpx_http_client.py

@@ -1,6 +1,7 @@
 import httpx
 from shared_kernel.interfaces import HttpApiClient
 
+
 class HttpxHttpClient(HttpApiClient):
     """
     An implementation of the HttpApiClient interface using httpx for asynchronous HTTP requests.
@@ -49,7 +50,9 @@ class HttpxHttpClient(HttpApiClient):
             response = await client.get(url, params=params, headers=headers)
         return response.json()
 
-    async def post(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    async def post(
+        self, url: str, data: dict = None, json: dict = None, headers: dict = None
+    ) -> dict:
         """
         Sends an asynchronous POST request to the specified URL.
 
@@ -66,7 +69,9 @@ class HttpxHttpClient(HttpApiClient):
             response = await client.post(url, data=data, json=json, headers=headers)
         return response.json()
 
-    async def put(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    async def put(
+        self, url: str, data: dict = None, json: dict = None, headers: dict = None
+    ) -> dict:
         """
         Sends an asynchronous PUT request to the specified URL.
 
@@ -98,7 +103,9 @@ class HttpxHttpClient(HttpApiClient):
             response = await client.delete(url, headers=headers)
         return response.json()
 
-    async def patch(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    async def patch(
+        self, url: str, data: dict = None, json: dict = None, headers: dict = None
+    ) -> dict:
         """
         Sends an asynchronous PATCH request to the specified URL.
 
@@ -130,7 +137,9 @@ class HttpxHttpClient(HttpApiClient):
             response = await client.head(url, headers=headers)
         return response.json()
 
-    async def upload_file(self, url: str, file_path: str, filename: str, headers: dict = None) -> dict:
+    async def upload_file(
+        self, url: str, file_path: str, filename: str, headers: dict = None
+    ) -> dict:
         """
         Uploads a file asynchronously to the specified URL.
 
@@ -144,11 +153,15 @@ class HttpxHttpClient(HttpApiClient):
         - dict: The response from the server as a JSON-decoded dictionary.
         """
         async with httpx.AsyncClient() as client:
-            with open(file_path, 'rb') as file:
-                response = await client.post(url, files={filename: file}, headers=headers)
+            with open(file_path, "rb") as file:
+                response = await client.post(
+                    url, files={filename: file}, headers=headers
+                )
         return response.json()
 
-    async def download_file(self, url: str, save_path: str, headers: dict = None) -> None:
+    async def download_file(
+        self, url: str, save_path: str, headers: dict = None
+    ) -> None:
         """
         Downloads a file asynchronously from the specified URL and saves it to the given path.
 
@@ -162,5 +175,5 @@ class HttpxHttpClient(HttpApiClient):
         """
         async with httpx.AsyncClient() as client:
             response = await client.get(url, headers=headers)
-            with open(save_path, 'wb') as file:
+            with open(save_path, "wb") as file:
                 file.write(await response.aread())

{fdc_shared_kernel-0.0.28 → fdc_shared_kernel-0.0.30}/shared_kernel/http/request_http_client.py

@@ -1,4 +1,6 @@
 import requests
+from requests.exceptions import Timeout, RequestException
+from requests import Response
 
 from shared_kernel.exceptions import InternalServerError
 from shared_kernel.interfaces.http import HttpApiClient
@@ -36,7 +38,7 @@ class RequestsHttpClient(HttpApiClient):
         Downloads a file synchronously from the specified URL and saves it to the given path.
     """
 
-    def get(self, url: str, params: dict = None, headers: dict = None) -> dict:
+    def get(self, url: str, params: dict = None, headers: dict = None) -> Response:
         """
         Sends a synchronous GET request to the specified URL.
 
@@ -46,15 +48,15 @@ class RequestsHttpClient(HttpApiClient):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a JSON-decoded dictionary.
+        - Response: Http response object
         """
         try:
             response = requests.get(url, params=params, headers=headers)
-            return response.json()
-        except requests.exceptions.RequestException as e:
+            return response
+        except (Timeout, RequestException) as e:
             raise InternalServerError(message=str(e))
 
-    def post(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    def post(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> Response:
         """
         Sends a synchronous POST request to the specified URL.
 
@@ -65,15 +67,15 @@ class RequestsHttpClient(HttpApiClient):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a JSON-decoded dictionary.
+        - Response: Http response object
         """
         try:
             response = requests.post(url, data=data, json=json, headers=headers)
-            return response.json()
-        except requests.exceptions.RequestException as e:
+            return response
+        except (Timeout, RequestException) as e:
             raise InternalServerError(message=str(e))
 
-    def put(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    def put(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> Response:
         """
         Sends a synchronous PUT request to the specified URL.
 
@@ -84,12 +86,12 @@ class RequestsHttpClient(HttpApiClient):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a JSON-decoded dictionary.
+        - Response: Http response object
         """
         response = requests.put(url, data=data, json=json, headers=headers)
-        return response.json()
+        return response
 
-    def delete(self, url: str, headers: dict = None) -> dict:
+    def delete(self, url: str, headers: dict = None) -> Response:
         """
         Sends a synchronous DELETE request to the specified URL.
 
@@ -98,15 +100,15 @@ class RequestsHttpClient(HttpApiClient):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a JSON-decoded dictionary.
+        - Response: Http response object
         """
         try:
             response = requests.delete(url, headers=headers)
-            return response.json()
+            return response
         except requests.exceptions.RequestException as e:
             raise InternalServerError(message=str(e))
 
-    def patch(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    def patch(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> Response:
         """
         Sends a synchronous PATCH request to the specified URL.
 
@@ -117,15 +119,15 @@ class RequestsHttpClient(HttpApiClient):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a JSON-decoded dictionary.
+        - Response: Http response object
         """
         try:
             response = requests.patch(url, data=data, json=json, headers=headers)
-            return response.json()
+            return response
         except requests.exceptions.RequestException as e:
             raise InternalServerError(message=str(e))
 
-    def head(self, url: str, headers: dict = None) -> dict:
+    def head(self, url: str, headers: dict = None) -> Response:
         """
         Sends a synchronous HEAD request to the specified URL.
 
@@ -134,15 +136,15 @@ class RequestsHttpClient(HttpApiClient):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a JSON-decoded dictionary.
+        - Response: Http response object
         """
         try:
             response = requests.head(url, headers=headers)
-            return response.json()
+            return response
         except requests.exceptions.RequestException as e:
             raise InternalServerError(message=str(e))
 
-    def upload_file(self, url: str, file_path: str, filename: str, headers: dict = None) -> dict:
+    def upload_file(self, url: str, file_path: str, filename: str, headers: dict = None) -> Response:
         """
         Uploads a file synchronously to the specified URL.
 
@@ -153,12 +155,12 @@ class RequestsHttpClient(HttpApiClient):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a JSON-decoded dictionary.
+        - Response: Http response object
         """
         try:
             with open(file_path, 'rb') as file:
                 response = requests.post(url, files={filename: file}, headers=headers)
-            return response.json()
+            return response
         except requests.exceptions.RequestException as e:
             raise InternalServerError(message=str(e))
 

{fdc_shared_kernel-0.0.28 → fdc_shared_kernel-0.0.30}/shared_kernel/interfaces/http.py

@@ -1,4 +1,5 @@
 from abc import ABC, abstractmethod
+from requests import Response
 
 
 class HttpApiClient(ABC):
@@ -34,7 +35,7 @@ class HttpApiClient(ABC):
     """
 
     @abstractmethod
-    def get(self, url: str, params: dict = None, headers: dict = None) -> dict:
+    def get(self, url: str, params: dict = None, headers: dict = None) -> Response:
         """
         Sends a GET request to the specified URL.
 
@@ -44,12 +45,12 @@ class HttpApiClient(ABC):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a dictionary.
+        - Response: Http response object
         """
         pass
 
     @abstractmethod
-    def post(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    def post(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> Response:
         """
         Sends a POST request to the specified URL with optional data or JSON payload.
 
@@ -60,12 +61,12 @@ class HttpApiClient(ABC):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a dictionary.
+        - Response: Http response object
         """
         pass
 
     @abstractmethod
-    def put(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    def put(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> Response:
         """
         Sends a PUT request to the specified URL with optional data or JSON payload.
 
@@ -76,12 +77,12 @@ class HttpApiClient(ABC):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a dictionary.
+        - Response: Http response object
         """
         pass
 
     @abstractmethod
-    def delete(self, url: str, headers: dict = None) -> dict:
+    def delete(self, url: str, headers: dict = None) -> Response:
         """
         Sends a DELETE request to the specified URL.
 
@@ -90,12 +91,12 @@ class HttpApiClient(ABC):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a dictionary.
+        - Response: Http response object
         """
         pass
 
     @abstractmethod
-    def patch(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> dict:
+    def patch(self, url: str, data: dict = None, json: dict = None, headers: dict = None) -> Response:
         """
         Sends a PATCH request to the specified URL with optional data or JSON payload.
 
@@ -106,12 +107,12 @@ class HttpApiClient(ABC):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a dictionary.
+        - Response: Http response object
         """
         pass
 
     @abstractmethod
-    def head(self, url: str, headers: dict = None) -> dict:
+    def head(self, url: str, headers: dict = None) -> Response:
         """
         Sends a HEAD request to the specified URL.
 
@@ -120,12 +121,12 @@ class HttpApiClient(ABC):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a dictionary.
+        - Response: Http response object
         """
         pass
 
     @abstractmethod
-    def upload_file(self, url: str, file_path: str, filename: str, headers: dict = None) -> dict:
+    def upload_file(self, url: str, file_path: str, filename: str, headers: dict = None) -> Response:
         """
         Uploads a file to the specified URL.
 
@@ -136,7 +137,7 @@ class HttpApiClient(ABC):
         - headers (dict, optional): HTTP headers to include in the request.
 
         Returns:
-        - dict: The response from the server as a dictionary.
+        - Response: Http response object
         """
         pass
 

{fdc_shared_kernel-0.0.28 → fdc_shared_kernel-0.0.30}/shared_kernel/logger/__init__.py

@@ -1,7 +1,24 @@
 import logging
 import os
+import json
 
+class JSONFormatter(logging.Formatter):
+    """
+    Custom JSON formatter to structure log records as JSON.
+    """
 
+    def format(self, record):
+        log_record = {
+            "time": self.formatTime(record, self.datefmt),
+            "name": record.name,
+            "filename": record.filename,
+            "module": record.module,
+            "level": record.levelname,
+            "message": record.getMessage(),
+        }
+        if record.exc_info:
+            log_record["exception"] = self.formatException(record.exc_info)
+        return json.dumps(log_record)
 class Logger:
     """
     A singleton logger class that ensures only one logger instance is created.
@@ -22,7 +39,7 @@ class Logger:
             cls._instance._initialize(name=name)
         return cls._instance
 
-    def _initialize(self, name=None, log_file: str = "fdc_app_logs.log"):
+    def _initialize(self, name=None, log_file: str = "fdc_app_logs.log", json_log_file: str = "fdc_app_logs.jsonl"):
 
         self.logger = logging.getLogger(name if name else __name__)
         self.logger.setLevel(logging.DEBUG)
@@ -30,6 +47,7 @@ class Logger:
             "%(asctime)s - %(name)s - %(filename)s - %(module)s - %(levelname)s - %(message)s"
         )
         self.log_file = log_file
+        self.json_log_file = json_log_file
 
         # ensure handlers are configured only once
         if not self.logger.handlers:
@@ -41,6 +59,7 @@ class Logger:
         """
         self.add_stream_handler()
         self.add_file_handler(log_file=self.log_file)
+        self.add_json_file_handler(log_file=self.json_log_file)
 
     def add_stream_handler(self):
         """
@@ -61,6 +80,17 @@ class Logger:
         file_handler.setLevel(self.logger.level)
         file_handler.setFormatter(self.formatter)
         self.logger.addHandler(file_handler)
+    
+    def add_json_file_handler(self, log_file, log_directory="./logs"):
+        """
+        Adds a JSON file handler to the logger.
+        """
+        if not os.path.exists(log_directory):
+            os.makedirs(log_directory)
+        json_file_handler = logging.FileHandler(os.path.join(log_directory, log_file))
+        json_file_handler.setLevel(self.logger.level)
+        json_file_handler.setFormatter(JSONFormatter())  # Using the custom JSON formatter
+        self.logger.addHandler(json_file_handler)
 
     def info(self, message, *args, **kwargs):
         self.logger.info(message, *args, **kwargs)

{fdc_shared_kernel-0.0.28 → fdc_shared_kernel-0.0.30}/shared_kernel/messaging/http_databus.py

@@ -1,6 +1,7 @@
 import asyncio
 import logging
 from typing import Callable, Any, Dict
+from shared_kernel.exceptions.http_exceptions import BadRequest, InternalServerError
 from shared_kernel.interfaces import DataBus
 from concurrent.futures import ThreadPoolExecutor
 from shared_kernel.http import HttpClient
@@ -73,7 +74,20 @@ class HTTPDataBus(DataBus):
             Any: The response from the HTTP endpoint.
         """
         response = self.http_client.post(url=event_name, json=event_payload)
-        return response
+
+        # handling success cases
+        if response.status_code in [200, 201, 204]:
+            return response.json()
+
+        # default error handling
+        response_data: Dict[str, Any] = response.json()
+        error_message: str = response_data.get('message', 'An error occurred')
+
+        # handling common HTTP errors
+        if response.status_code == 400:
+            raise BadRequest(error_message)
+        elif response.status_code == 500:
+            raise InternalServerError(error_message)
 
     def subscribe_sync_event(self, event_name: str, callback: Callable[[Any], None]):
         """