telesign 2.2.7__py2.py3-none-any.whl → 2.3.1__py2.py3-none-any.whl

telesign/rest.py

@@ -6,6 +6,7 @@ from base64 import b64encode, b64decode
 from email.utils import formatdate
 from hashlib import sha256
 from platform import python_version
+import time
 
 import requests
 import json
@@ -16,8 +17,8 @@ from telesign.util import AuthMethod
 
 class RestClient(requests.models.RequestEncodingMixin):
     """
-    The TeleSign RestClient is a generic HTTP REST client that can be extended to make requests against any of
-    TeleSign's REST API endpoints.
+    The Telesign RestClient is a generic HTTP REST client that can be extended to make requests against any of
+    Telesign's REST API endpoints.
 
     RequestEncodingMixin offers the function _encode_params for url encoding the body for use in string_to_sign outside
     of a regular HTTP request.
@@ -52,9 +53,10 @@ class RestClient(requests.models.RequestEncodingMixin):
                  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.
+        Telesign RestClient useful for making generic RESTful requests against our API.
 
         :param customer_id: Your customer_id string associated with your account.
         :param api_key: Your api_key string associated with your account.
@@ -62,13 +64,22 @@ class RestClient(requests.models.RequestEncodingMixin):
         :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 {}
 
@@ -99,17 +110,17 @@ class RestClient(requests.models.RequestEncodingMixin):
                                   content_type=None,
                                   auth_method=None):
         """
-        Generates the TeleSign REST API headers used to authenticate requests.
+        Generates the Telesign REST API headers used to authenticate requests.
 
         Creates the canonicalized string_to_sign and generates the HMAC signature. This is used to authenticate requests
-        against the TeleSign REST API.
+        against the Telesign REST API.
 
         See https://developer.telesign.com/docs/authentication for detailed API documentation.
 
         :param customer_id: Your account customer_id.
         :param api_key: Your account api_key.
         :param method_name: The HTTP method name of the request as a upper case string, should be one of 'POST', 'GET',
-            'PUT' or 'DELETE'.
+            'PUT', 'PATCH' or 'DELETE'.
         :param resource: The partial resource URI to perform the request against, as a string.
         :param url_encoded_fields: HTTP body parameters to perform the HTTP request with, must be a urlencoded string.
         :param date_rfc2616: The date and time of the request formatted in rfc 2616, as a string.
@@ -117,7 +128,7 @@ class RestClient(requests.models.RequestEncodingMixin):
         :param user_agent: (optional) User Agent associated with the request, as a string.
         :param content_type: (optional) ContentType of the request, as a string.
         :param auth_method: (optional) Authentication type ex: Basic, HMAC etc
-        :return: The TeleSign authentication headers.
+        :return: The Telesign authentication headers.
         """
         if date_rfc2616 is None:
             date_rfc2616 = formatdate(usegmt=True)
@@ -177,7 +188,7 @@ class RestClient(requests.models.RequestEncodingMixin):
 
     def post(self, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API POST handler.
+        Generic Telesign REST API POST handler.
 
         :param resource: The partial resource URI to perform the request against, as a string.
         :param body: (optional) A dictionary sent as a part of request body.
@@ -188,7 +199,7 @@ class RestClient(requests.models.RequestEncodingMixin):
 
     def get(self, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API GET handler.
+        Generic Telesign REST API GET handler.
 
         :param resource: The partial resource URI to perform the request against, as a string.
         :param body: (optional) A dictionary sent as a part of request body.
@@ -199,7 +210,7 @@ class RestClient(requests.models.RequestEncodingMixin):
 
     def put(self, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API PUT handler.
+        Generic Telesign REST API PUT handler.
 
         :param resource: The partial resource URI to perform the request against, as a string.
         :param body: (optional) A dictionary sent as a part of request body.
@@ -213,7 +224,7 @@ class RestClient(requests.models.RequestEncodingMixin):
 
     def delete(self, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API DELETE handler.
+        Generic Telesign REST API DELETE handler.
 
         :param resource: The partial resource URI to perform the request against, as a string.
         :param body: (optional) A dictionary sent as a part of request body.
@@ -221,10 +232,33 @@ class RestClient(requests.models.RequestEncodingMixin):
         :return: The RestClient Response object.
         """
         return self._execute(self.session.delete, 'DELETE', resource, body, json_fields, **query_params)
+    
+    def patch(self, resource, body=None, json_fields=None, **query_params):
+        """
+        Generic Telesign REST API PATCH handler.
+
+        :param resource: The partial resource URI to perform the request against, as a string.
+        :param body: (optional) A dictionary sent as a part of request body.
+        :param json_fields: (optional) A dictionary sent as a JSON body.
+        :param query_params: query_params to perform the PATCH request with, as a dictionary.
+        :return: The RestClient Response object.
+        """
+        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 _execute(self, method_function, method_name, resource, body=None, json_fields=None, **query_params):
         """
-        Generic TeleSign REST API request handler.
+        Generic Telesign REST API request handler.
 
         :param method_function: The Requests HTTP request function to perform the request.
         :param method_name: The HTTP method name, as an upper case string.
@@ -233,6 +267,7 @@ class RestClient(requests.models.RequestEncodingMixin):
         :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)

{telesign-2.2.7.dist-info → telesign-2.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: telesign
-Version: 2.2.7
+Version: 2.3.1
 Summary: TeleSign SDK
 Home-page: https://github.com/telesign/python_telesign
 Author: TeleSign Corp.

{telesign-2.2.7.dist-info → telesign-2.3.1.dist-info}/RECORD

@@ -3,12 +3,12 @@ telesign/appverify.py,sha256=wBeaeUxGmYcZkrbxkkXlG3-0oZr5sVvegzVpdvaoO2A,1195
 telesign/intelligence.py,sha256=t-xwlgxkXw1OMupF5K4_UKWeTArOr9XPvddmqgZftPI,1452
 telesign/messaging.py,sha256=v7l-eKUPqz7Nrwka0YNPMkC2TaoFUvQm3yp_djuTPu0,1367
 telesign/phoneid.py,sha256=mk03NxL3wlaXpd8b-BB6q_SKfCxbtuTO19ayAHxmzz0,954
-telesign/rest.py,sha256=9mXM89DpwuxVAlA2imHTJzdDFwdBIFk3GVPrPPvSpbI,11998
+telesign/rest.py,sha256=AHNDyVZLa1vm2RWD4TSxr6uM4K50eH29C2Kjr3eCq8c,13911
 telesign/score.py,sha256=Kceu6IrirN9SsuT1geEWs0QHAn6H9ZNFyIDVHcBJdwg,908
 telesign/util.py,sha256=stDxpL5ZQeGskE_OSGP04UFHs3ZP2ACaRpW1WyQGMHg,1624
 telesign/voice.py,sha256=DJaWyQpun-T7LfNjpxpsUjupiv2ShW1jqoFQA-CE2-Y,1341
-telesign-2.2.7.dist-info/LICENSE.txt,sha256=a--xZ4PCKUL5rpct8RrUC6ODU_8ZKIU51kJPfsA4HUs,1058
-telesign-2.2.7.dist-info/METADATA,sha256=D4e1bjdTy2lNd4b_bWZ8G6bdhjdCfwUt8DIMfy4hsVU,4532
-telesign-2.2.7.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
-telesign-2.2.7.dist-info/top_level.txt,sha256=6LG7Jcr1jnpVhOWaIShoTdwYJn0QCfPhfudyVJNz1qg,9
-telesign-2.2.7.dist-info/RECORD,,
+telesign-2.3.1.dist-info/LICENSE.txt,sha256=a--xZ4PCKUL5rpct8RrUC6ODU_8ZKIU51kJPfsA4HUs,1058
+telesign-2.3.1.dist-info/METADATA,sha256=n3TqPKDa2uPs5_RJhzRxJVhYoiMATdENw7xPPzxz5ms,4532
+telesign-2.3.1.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
+telesign-2.3.1.dist-info/top_level.txt,sha256=6LG7Jcr1jnpVhOWaIShoTdwYJn0QCfPhfudyVJNz1qg,9
+telesign-2.3.1.dist-info/RECORD,,