Pull request #12: EOA-3340 Update Python SDK to manage auto refresh of the connections

Merge in SDK/python_telesign from fix/EOA-3340/UpdatePythonSDKToManageAutoRefreshOfTheConnections1 to developer

* commit '9c9b77c6c277b2eadf740c1f4f129942a9bf8046':
  solving english texts
  deleting readme
  EOA-3340 python sdk with auto refresh
  Pull request #11: EOA-3340 Update Python SDK to manage auto refresh of the connections
  Pull request #11: EOA-3340 Update Python SDK to manage auto refresh of the connections

Author: Dario Vallejo

README.md

@@ -37,6 +37,4 @@ If you use a Telesign SDK to make your request, authentication is handled behind
 
 * Learn to send a request to Telesign with code with one of our [tutorials](https://developer.telesign.com/enterprise/docs/tutorials).  
 * Browse our [Developer Portal](https://developer.telesign.com) for tutorials, how-to guides, reference content, and more.
-* Check out our [sample code](https://github.com/TeleSign/sample_code) on GitHub.
-
-
+* Check out our [sample code](https://github.com/TeleSign/sample_code) on GitHub.

RELEASE

@@ -1,3 +1,7 @@
+2.3.1
+- Adds automatic HTTP session recycling (`pool_recycle`).
+- Improves keep-alive connection handling.
+
 2.3.0
 - Added PATCH method to the RestClient class to facilitate Update Verification Process action
 

telesign/rest.py

@@ -6,6 +6,7 @@
 from email.utils import formatdate
 from hashlib import sha256
 from platform import python_version
+import time
 
 import requests
 import json
@@ -52,7 +53,8 @@ def __init__(self,
                  sdk_version_dependency=None,
                  proxies=None,
                  timeout=10,
-                 auth_method=None):
+                 auth_method=None,
+                 pool_recycle=480):
         """
         Telesign RestClient useful for making generic RESTful requests against our API.
 
@@ -62,13 +64,22 @@ def __init__(self,
         :param proxies: (optional) Dictionary mapping protocol or protocol and hostname to the URL of the proxy.
         :param timeout: (optional) How long to wait for the server to send data before giving up, as a float,
                         or as a (connect timeout, read timeout) tuple
+        :param pool_recycle: (optional) Time in seconds to recycle the HTTP session to avoid stale connections (default 480).
+            If a session is older than this value, it will be closed and a new session will be created automatically before each request.
+            This helps prevent errors due to HTTP keep-alive connections being closed by the server after inactivity.
+
+        HTTP Keep-Alive behavior:
+            TeleSign endpoints close idle HTTP keep-alive connections after 499 seconds. If you attempt to reuse a connection older than this, you may get a 'connection reset by peer' error.
+            By default, pool_recycle=480 ensures sessions are refreshed before this limit.
         """
         self.customer_id = customer_id
         self.api_key = api_key
 
         self.api_host = rest_endpoint
 
-        self.session = requests.Session()
+        self.pool_recycle = pool_recycle
+        self._session_created_at = None
+        self.session = self._create_session()
 
         self.session.proxies = proxies if proxies else {}
 
@@ -234,6 +245,28 @@ def patch(self, resource, body=None, json_fields=None, **query_params):
         """
         return self._execute(self.session.patch, 'PATCH', resource, body, json_fields, **query_params)
 
+    def _create_session(self):
+        session = requests.Session()
+        self._session_created_at = time.time()
+        return session
+
+    def _ensure_session(self):
+        if self._session_created_at is None or (time.time() - self._session_created_at > self.pool_recycle):
+            if self.session:
+                self.session.close()
+            self.session = self._create_session()
+
+    def _create_session(self):
+        session = requests.Session()
+        self._session_created_at = time.time()
+        return session
+
+    def _ensure_session(self):
+        if self._session_created_at is None or (time.time() - self._session_created_at > self.pool_recycle):
+            if self.session:
+                self.session.close()
+            self.session = self._create_session()
+
     def _execute(self, method_function, method_name, resource, body=None, json_fields=None, **query_params):
         """
         Generic Telesign REST API request handler.
@@ -245,6 +278,7 @@ def _execute(self, method_function, method_name, resource, body=None, json_field
         :param query_params: query_params to perform the HTTP request with, as a dictionary.
         :return: The RestClient Response object.
         """
+        self._ensure_session()
         resource_uri = "{api_host}{resource}".format(api_host=self.api_host, resource=resource)
 
         url_encoded_fields = self._encode_params(query_params)

tests/test_rest.py

@@ -290,4 +290,23 @@ def test_post_basic_auth(self, mock_generate_telesign_headers):
         self.assertEqual(post_args, expected_post_args,
                          "client.session.post.call_args args do not match expected")
         self.assertEqual(post_kwargs, expected_post_kwargs,
-                         "client.session.post.call_args kwargs do not match expected")
+                         "client.session.post.call_args kwargs do not match expected")
+
+    def test_session_adapter_is_httpadapter(self):
+        client = RestClient(self.customer_id, self.api_key)
+        https_adapter = client.session.adapters["https://"]
+        import requests
+        self.assertIsInstance(https_adapter, requests.adapters.HTTPAdapter)
+
+    @patch("time.time")
+    def test_session_refresh_on_pool_recycle(self, mock_time):
+        # Simulate time to force session recycling
+        mock_time.return_value = 1000
+        client = RestClient(self.customer_id, self.api_key, pool_recycle=10)
+        created_at_first = client._session_created_at
+        # Advance time beyond the threshold
+        mock_time.return_value = 1012
+        # Force a request (any method calls _ensure_session)
+        client._ensure_session()
+        created_at_second = client._session_created_at
+        self.assertNotEqual(created_at_first, created_at_second)