WIP add timeout option

Author: aoberoi

opentok/opentok.py

@@ -48,10 +48,11 @@ class OpenTok(object):
     TOKEN_SENTINEL = 'T1=='
     """For internal use."""
 
-    def __init__(self, api_key, api_secret, api_url='https://api.opentok.com'):
+    def __init__(self, api_key, api_secret, api_url='https://api.opentok.com', timeout=None):
         self.api_key = str(api_key)
         self.api_secret = api_secret
         self.api_url = api_url
+        self.timeout = timeout
 
     def generate_token(self, session_id, role=Roles.publisher, expire_time=None, data=None):
         """
@@ -216,7 +217,7 @@ def create_session(self, location=None, media_mode=MediaModes.relayed):
             options[u('location')] = location
 
         try:
-            response = requests.post(self.session_url(), data=options, headers=self.headers())
+            response = requests.post(self.session_url(), data=options, headers=self.headers(), timeout=self.timeout)
             response.encoding = 'utf-8'
 
             if response.status_code == 403:
@@ -284,7 +285,7 @@ def start_archive(self, session_id, **kwargs):
         """
         payload = {'name': kwargs.get('name'), 'sessionId': session_id}
 
-        response = requests.post(self.archive_url(), data=json.dumps(payload), headers=self.archive_headers())
+        response = requests.post(self.archive_url(), data=json.dumps(payload), headers=self.archive_headers(), timeout=self.timeout)
 
         if response.status_code < 300:
             return Archive(self, response.json())
@@ -310,7 +311,7 @@ def stop_archive(self, archive_id):
 
         :rtype: The Archive object corresponding to the archive being stopped.
         """
-        response = requests.post(self.archive_url(archive_id) + '/stop', headers=self.archive_headers())
+        response = requests.post(self.archive_url(archive_id) + '/stop', headers=self.archive_headers(), timeout=self.timeout)
 
         if response.status_code < 300:
             return Archive(self, response.json())
@@ -333,7 +334,7 @@ def delete_archive(self, archive_id):
 
         :param String archive_id: The archive ID of the archive to be deleted.
         """
-        response = requests.delete(self.archive_url(archive_id), headers=self.archive_headers())
+        response = requests.delete(self.archive_url(archive_id), headers=self.archive_headers(), timeout=self.timeout)
 
         if response.status_code < 300:
             pass
@@ -351,7 +352,7 @@ def get_archive(self, archive_id):
 
         :rtype: The Archive object.
         """
-        response = requests.get(self.archive_url(archive_id), headers=self.archive_headers())
+        response = requests.get(self.archive_url(archive_id), headers=self.archive_headers(), timeout=self.timeout)
 
         if response.status_code < 300:
             return Archive(self, response.json())
@@ -380,7 +381,7 @@ def get_archives(self, offset=None, count=None):
         if count is not None:
             params['count'] = count
 
-        response = requests.get(self.archive_url() + "?" + urlencode(params), headers=self.archive_headers())
+        response = requests.get(self.archive_url() + "?" + urlencode(params), headers=self.archive_headers(), timeout=self.timeout)
 
         if response.status_code < 300:
             return ArchiveList(self, response.json())

tests/test_http_options.py

@@ -0,0 +1,29 @@
+import unittest
+from six import text_type, u, b, PY2, PY3
+from six.moves.urllib.parse import parse_qs
+from nose.tools import raises
+from sure import expect
+import httpretty
+
+from opentok import OpenTok, Session, MediaModes, OpenTokException, __version__
+
+class OpenTokSessionCreationTest(unittest.TestCase):
+    def setUp(self):
+        self.api_key = u('123456')
+        self.api_secret = u('1234567890abcdef1234567890abcdef1234567890')
+        httpretty.enable()
+        httpretty.register_uri(httpretty.POST, u('https://api.opentok.com/session/create'),
+                               body=u('<?xml version="1.0" encoding="UTF-8" standalone="yes"?><sessions><Session><session_id>1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg</session_id><partner_id>123456</partner_id><create_dt>Mon Mar 17 00:41:31 PDT 2014</create_dt></Session></sessions>'),
+                               status=200,
+                               content_type=u('text/xml'))
+
+    def tearDown(self):
+        httpretty.disable()
+
+    def test_timeout(self):
+        # TODO: tell httpretty to timeout
+        opentok = OpenTok(self.api_key, self.api_secret, timeout=5)
+
+        session = opentok.create_session()
+
+        # TODO: expect an exception

tests/test_initialization.py

@@ -25,7 +25,11 @@ def test_initialization_with_api_url(self):
         assert isinstance(opentok, OpenTok)
 
     def test_initialization_with_numeric_api_key(self):
-        opentok = OpenTok(123456, self.api_secret, self.api_url)
+        opentok = OpenTok(123456, self.api_secret)
+        assert isinstance(opentok, OpenTok)
+
+    def test_initialization_with_timeout(self):
+        opentok = OpenTok(self.api_key, self.api_secret, timeout=5)
         assert isinstance(opentok, OpenTok)
 
 if __name__ == '__main__':