changes in create_session with tests. fixes #7, fixes #8, fixes #9, fixes #11

Author: aoberoi

opentok/__init__.py

@@ -1,6 +1,5 @@
 from .opentok import OpenTok, Roles
+from .session import Session
 from .exceptions import OpenTokException
-
-# see: http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers
-__version__ = '2.2.0a0'
+from .version import __version__
 

opentok/opentok.py

@@ -7,8 +7,12 @@
 import random                  # generate_token
 import requests                # create_session, archiving
 import json                    # archiving
+from socket import inet_aton   # create_session
+import xml.dom.minidom as xmldom # create_session
 
 from .exceptions import OpenTokException, RequestError, AuthError, NotFoundError, ArchiveError
+from .session import Session
+from .version import __version__
 
 # compat
 from six.moves import map
@@ -25,12 +29,6 @@ class Roles(Enum):
     moderator =  u('moderator')    # Can do the above along with forceDisconnect and forceUnpublish
 
 
-class OpenTokSession(object):
-
-    def __init__(self, session_id):
-        self.session_id = session_id
-
-
 class OpenTokArchive(object):
 
     def __init__(self, sdk, values):
@@ -160,7 +158,7 @@ def generate_token(self, session_id, role=Roles.publisher, expire_time=None, con
         )
         return token
 
-    def create_session(self, location='', properties={}, **kwargs):
+    def create_session(self, location=None, p2p=False):
         """Create a new session in the OpenTok API. Returns an OpenTokSession
         object with a session_id property. location: IP address of the user
         requesting the session. This is used for geolocation to choose which
@@ -169,21 +167,29 @@ def create_session(self, location='', properties={}, **kwargs):
         to use features of the groups API. Look in the documentation for more
         details. Also accepts any dict-like object.
         """
-        #ip_passthru is a deprecated argument and has been replaced with location
-        if 'ip_passthru' in kwargs:
-            location = kwargs['ip_passthru']
-        params = dict(api_key=self.api_key)
-        params['location'] = location
-        params.update(properties)
+
+        # build options
+        options = {}
+        if p2p:
+            if not isinstance(p2p, bool):
+                raise OpenTokException(u('Cannot create session. p2p must be a bool {0}').format(p2p))
+            options[u('p2p.preference')] = u('enabled')
+        if location:
+            # validate IP address
+            try:
+                inet_aton(location)
+            except:
+                raise OpenTokException(u('Cannot create session. Location must be either None or a valid IPv4 address {0}').format(location))
+            options[u('location')] = location
 
         try:
-            response = requests.post(self.session_url(), data=params, headers=self.headers())
+            response = requests.post(self.session_url(), data=options, headers=self.headers())
+            response.encoding = 'utf-8'
 
             if response.status_code == 403:
                 raise AuthError('Failed to create session, invalid credentials')
             if not response.content:
                 raise RequestError()
-            import xml.dom.minidom as xmldom
             dom = xmldom.parseString(response.content)
         except Exception as e:
             raise RequestError('Failed to create session: %s' % str(e))
@@ -195,7 +201,7 @@ def create_session(self, location='', properties={}, **kwargs):
                 raise AuthError('Failed to create session (code=%s): %s' % (error.attributes['code'].value, error.firstChild.attributes['message'].value))
 
             session_id = dom.getElementsByTagName('session_id')[0].childNodes[0].nodeValue
-            return OpenTokSession(session_id)
+            return Session(session_id, location=location, p2p=p2p)
         except Exception as e:
             raise OpenTokException('Failed to generate session: %s' % str(e))
 
@@ -211,7 +217,7 @@ def archive_headers(self):
         return result
 
     def session_url(self):
-        url = OpenTok.API_URL + '/session/create'
+        url = self.api_url + '/session/create'
         return url
 
     def archive_url(self, archive_id=None):

opentok/session.py

@@ -0,0 +1,5 @@
+class Session(object):
+    def __init__(self, session_id, **kwargs):
+        self.session_id = session_id
+        for key, value in kwargs.items():
+            setattr(self, key, value)

opentok/version.py

@@ -0,0 +1,2 @@
+# see: http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers
+__version__ = '2.2.0a0'

setup.py

@@ -28,7 +28,7 @@ def find_version(*file_paths):
 
 setup(
     name = 'opentok',
-    version = find_version('opentok', '__init__.py'),
+    version = find_version('opentok', 'version.py'),
     description = 'OpenTok server-side SDK',
     long_description=long_description,
 
@@ -70,10 +70,12 @@ def find_version(*file_paths):
     packages=find_packages(exclude=["contrib", "docs", "tests*"]),
 
     install_requires=[
-        'requests>=1,<2',
+        'requests',
         'enum34',
         'six',
-        'pytz'
+        'pytz',
+        'httpretty',
+        'sure',
     ],
 
     # TODO: these aren't in the sample package, but might again become imp
@@ -86,6 +88,8 @@ def find_version(*file_paths):
     test_suite='nose.collector',
     tests_require=[
         'nose',
-        'six'
+        'six',
+        'httpretty',
+        'sure',
     ],
 )

tests/test_session_creation.py

@@ -0,0 +1,90 @@
+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, OpenTokException, __version__
+
+class OpenTokSessionCreationTest(unittest.TestCase):
+    def setUp(self):
+        self.api_key = u('123456')
+        self.api_secret = u('1234567890abcdef1234567890abcdef1234567890')
+        # self.api_key = u('854511')
+        # self.api_secret = u('***REMOVED***')
+        self.opentok = OpenTok(self.api_key, self.api_secret)
+
+    @httpretty.activate
+    def test_create_default_session(self):
+        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'))
+
+        session = self.opentok.create_session()
+
+        expect(httpretty.last_request().headers[u('x-tb-partner-auth')]).to.equal(self.api_key+u(':')+self.api_secret)
+        expect(httpretty.last_request().headers[u('user-agent')]).to.contain(u('OpenTok-Python-SDK/')+__version__)
+        expect(session).to.be.a(Session)
+        expect(session).to.have.property(u('session_id')).being.equal(u('1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg'))
+        expect(session).to.have.property(u('p2p')).being.equal(False)
+        expect(session).to.have.property(u('location')).being.equal(None)
+
+    @httpretty.activate
+    def test_create_p2p_session(self):
+        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'))
+
+        session = self.opentok.create_session(p2p=True)
+
+        expect(httpretty.last_request().headers[u('x-tb-partner-auth')]).to.equal(self.api_key+u(':')+self.api_secret)
+        expect(httpretty.last_request().headers[u('user-agent')]).to.contain(u('OpenTok-Python-SDK/')+__version__)
+        expect(httpretty.last_request().body).to.equal(b('p2p.preference=enabled'))
+        expect(session).to.be.a(Session)
+        expect(session).to.have.property(u('session_id')).being.equal(u('1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg'))
+        expect(session).to.have.property(u('p2p')).being.equal(True)
+        expect(session).to.have.property(u('location')).being.equal(None)
+
+    @httpretty.activate
+    def test_create_session_with_location_hint(self):
+        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'))
+
+        session = self.opentok.create_session(location='12.34.56.78')
+
+        expect(httpretty.last_request().headers[u('x-tb-partner-auth')]).to.equal(self.api_key+u(':')+self.api_secret)
+        expect(httpretty.last_request().headers[u('user-agent')]).to.contain(u('OpenTok-Python-SDK/')+__version__)
+        expect(httpretty.last_request().body).to.equal(b('location=12.34.56.78'))
+        expect(session).to.be.a(Session)
+        expect(session).to.have.property(u('session_id')).being.equal(u('1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg'))
+        expect(session).to.have.property(u('p2p')).being.equal(False)
+        expect(session).to.have.property(u('location')).being.equal(u('12.34.56.78'))
+
+    @httpretty.activate
+    def test_create_p2p_session_with_location_hint(self):
+        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'))
+
+        session = self.opentok.create_session(location='12.34.56.78', p2p=True)
+
+        expect(httpretty.last_request().headers[u('x-tb-partner-auth')]).to.equal(self.api_key+u(':')+self.api_secret)
+        expect(httpretty.last_request().headers[u('user-agent')]).to.contain(u('OpenTok-Python-SDK/')+__version__)
+        # ordering of keys is non-deterministic, must parse the body to see if it is correct
+        body = parse_qs(httpretty.last_request().body)
+        expect(body).to.have.key(b('location')).being.equal([b('12.34.56.78')])
+        expect(body).to.have.key(b('p2p.preference')).being.equal([b('enabled')])
+        expect(session).to.be.a(Session)
+        expect(session).to.have.property(u('session_id')).being.equal(u('1_MX4xMjM0NTZ-fk1vbiBNYXIgMTcgMDA6NDE6MzEgUERUIDIwMTR-MC42ODM3ODk1MzQ0OTQyODA4fg'))
+        expect(session).to.have.property(u('p2p')).being.equal(True)
+        expect(session).to.have.property(u('location')).being.equal(u('12.34.56.78'))
+
+    # TODO: all the cases that throw exceptions
+    # TODO: custom api_url requests
+