Merge pull request #3 from PraneethChandraThota/request-timeout

LU-43 Python Http Request Timeout

Author: david-schrenker

python-examples/basic/basic_send_with_proxy.py

@@ -26,10 +26,11 @@
 api_key = os.environ.get('SOCKETLABS_INJECTION_API_KEY')
 
 # create the proxy
-proxy = Proxy("127.0.0.1", 8888)
+proxy = Proxy("127.0.0.1", 4433)
 
 # create the client
 client = SocketLabsClient(server_id, api_key, proxy)
+client.request_timeout = 10
 
 # send the message
 response = client.send(message)

socketlabs/injectionapi/core/httprequest.py

@@ -28,7 +28,7 @@ class HttpRequestMethod(Enum):
         PUT = 2
         DELETE = 3
 
-    def __init__(self, method: HttpRequestMethod, endpoint: HttpEndpoint):
+    def __init__(self, method: HttpRequestMethod, endpoint: HttpEndpoint, timeout: int):
         """
         Creates a new instance of the HTTP Request class
         :param method: the HTTP request method
@@ -39,6 +39,7 @@ def __init__(self, method: HttpRequestMethod, endpoint: HttpEndpoint):
         self._request_method = method
         self._endpoint = endpoint
         self._http_proxy = None
+        self._timeout = timeout
 
     @property
     def __user_agent(self):
@@ -68,6 +69,15 @@ def __endpoint(self):
         """
         return self._endpoint
 
+    @property
+    def __timeout(self):
+        """
+        The SocketLabs Injection API timeout
+        :return the Http timeout for the HTTP request
+        :rtype int
+        """ 
+        return self._timeout       
+
     @property
     def proxy(self):
         """
@@ -162,9 +172,9 @@ def __get_connection(self):
         :rtype HTTPSConnection
         """
         if self._http_proxy is not None:
-            connection = http.client.HTTPSConnection(self._http_proxy.host, self._http_proxy.port)
+            connection = http.client.HTTPSConnection(self._http_proxy.host, self._http_proxy.port, timeout=self.__timeout)
             connection.set_tunnel(self._endpoint.host, 443)
         else:
-            connection = http.client.HTTPSConnection(self._endpoint.host)
+            connection = http.client.HTTPSConnection(self._endpoint.host, timeout=self.__timeout)
 
         return connection

socketlabs/injectionapi/socketlabsclient.py

@@ -31,6 +31,7 @@ def __init__(self, server_id: int, api_key: str, proxy: Proxy = None):
         self._server_id = server_id
         self._api_key = api_key
         self._http_proxy = proxy
+        self._request_timeout = 120
 
     @property
     def __endpoint(self):
@@ -49,14 +50,32 @@ def __proxy(self):
         :rtype Proxy
         """
         return self._http_proxy
+    
+    @property
+    def request_timeout(self):
+        """
+        The SocketLabs Injection API timeout
+        :return the Http timeout for the HTTP request
+        :rtype int
+        """ 
+        return self._request_timeout
+    
+    @request_timeout.setter
+    def request_timeout(self, timeout: int):
+        """
+        Set the request_timeout to use when making the HTTP request
+        :param timeout: the request_timeout to use for the HTTP request
+        :type timeout: int
+        """
+        self._request_timeout = timeout
 
     def __build_http_request(self):
         """
         Build the HttpRequest. Will add the proxy, if set
         :return the HttpRequest object to use for the request
         :rtype HttpRequest
         """
-        req = HttpRequest(HttpRequest.HttpRequestMethod.POST, self.__endpoint)
+        req = HttpRequest(HttpRequest.HttpRequestMethod.POST, self.__endpoint, self.request_timeout)
         if self._http_proxy is not None:
             req.proxy = self._http_proxy
         return req