feat: Added timeout param

Author: IvanildoBarauna

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "api-to-dataframe"
-version = "1.0.3"
+version = "1.1.0"
 description = "A package to convert API responses to pandas dataframe"
 authors = ["IvanildoBarauna <[email protected]>"]
 readme = "README.md"

src/api_to_dataframe/controller/client_builder.py

@@ -3,21 +3,17 @@
 
 
 class ClientBuilder:
-    """
-    Builder for creating clients that interact with an API endpoint and return data.
-
-    Attributes:
-        endpoint (str): The API endpoint to be accessed.
-        retry_strategy (RetryStrategies): The retry strategy for the request. Default is NoRetryStrategy.
-    """
-
-    def __init__(self, endpoint: str, retry_strategy: RetryStrategies = RetryStrategies.NoRetryStrategy):
+    def __init__(self,
+                 endpoint: str,
+                 retry_strategy: RetryStrategies = RetryStrategies.NoRetryStrategy,
+                 timeout: int = 5):
         """
         Initializes an instance of ClientBuilder.
 
         Args:
             endpoint (str): The API endpoint to be accessed.
             retry_strategy (RetryStrategies, optional): The retry strategy for the request. Default is NoRetryStrategy.
+            timeout (int, optional): The timeout for the request. Default is 5 seconds.
 
         Raises:
             ValueError: If the endpoint is empty.
@@ -27,6 +23,7 @@ def __init__(self, endpoint: str, retry_strategy: RetryStrategies = RetryStrateg
         else:
             self.endpoint = endpoint
             self.retry_strategy = retry_strategy
+            self.timeout = timeout
 
     def get_api_data(self):
         """
@@ -35,7 +32,7 @@ def get_api_data(self):
         Returns:
             dict: The response from the API.
         """
-        response = GetData.get_response(self.endpoint, self.retry_strategy)
+        response = GetData.get_response(self.endpoint, self.retry_strategy, self.timeout)
         return response
 
     @staticmethod

src/api_to_dataframe/models/get_data.py

@@ -1,24 +1,33 @@
 import requests
+from requests.exceptions import HTTPError, Timeout, RequestException
 import pandas as pd
 
 from api_to_dataframe.common.utils.retry_strategies import RetryStrategies
 
 
 class GetData:
     @staticmethod
-    def get_response(endpoint: str, RetryStrategies: RetryStrategies):
-        response = requests.get(endpoint)
-
-        if response.ok:
-            return response.json()
+    def get_response(endpoint: str, retry_strategies: RetryStrategies, timeout: int):
+        try:
+            response = requests.get(endpoint, timeout=timeout)
+            response.raise_for_status()
+        except HTTPError as http_err:
+            print(f'HTTP error occurred: {http_err}')
+        except Timeout as timeout_err:
+            print(f'Timeout error occurred: {timeout_err}')
+        except RequestException as req_err:
+            print(f'Error occurred: {req_err}')
         else:
-            raise ConnectionError(response.status_code)
+            return response
 
     @staticmethod
     def to_dataframe(response):
-        df = pd.DataFrame(response)
+        try:
+            df = pd.DataFrame(response.json())
+        except Exception as err:
+            raise TypeError(f"Invalid response for transform in dataframe: {err}")
+
         if df.empty:
             raise ValueError("::: DataFrame is empty :::")
         else:
             return df
-

tests/test_run.py

@@ -1,5 +1,7 @@
 import pytest
 import pandas as pd
+import requests
+
 from api_to_dataframe import ClientBuilder
 
 
@@ -29,7 +31,7 @@ def test_constructor_with_param(setup):
 def test_response_to_json(setup):
     new_client = setup
     response = new_client.get_api_data()
-    assert isinstance(response, dict)
+    assert isinstance(response, requests.Response)
 
 
 def test_to_dataframe(response_setup):