move archiving implementation, test start archive

Author: aoberoi

opentok/__init__.py

@@ -1,5 +1,6 @@
 from .opentok import OpenTok, Roles
 from .session import Session
+from .archives import Archive, ArchiveList
 from .exceptions import OpenTokException
 from .version import __version__
 

opentok/archives.py

@@ -0,0 +1,52 @@
+from datetime import datetime, date
+from six import iteritems
+import json
+
+dthandler = lambda obj: obj.isoformat() if isinstance(obj, datetime)  or isinstance(obj, date) else None
+
+class Archive(object):
+
+    def __init__(self, sdk, values):
+        self.sdk = sdk
+        self.id = values.get('id')
+        self.name = values.get('name')
+        self.status = values.get('status')
+        self.session_id = values.get('sessionId')
+        self.partner_id = values.get('partnerId')
+        self.created_at = datetime.fromtimestamp(values.get('createdAt') / 1000)
+        self.size = values.get('size')
+        self.duration = values.get('duration')
+        self.url = values.get('url')
+
+    def stop(self):
+        self.sdk.stop_archive(self.id)
+
+    def delete(self):
+        self.sdk.delete_archive(self.id)
+
+    def attrs(self):
+        return dict((k, v) for k, v in iteritems(self.__dict__) if k is not "sdk")
+
+    def json(self):
+        return json.dumps(self.attrs(), default=dthandler, indent=4)
+
+class ArchiveList(object):
+
+    def __init__(self, values):
+        self.count = values.get('count')
+        self.items = map(lambda x: OpenTokArchive(self, x), values.get('items', []))
+
+    def __iter__(self):
+        for x in self.items:
+            yield x
+
+    def attrs(self):
+        return {
+            'count': self.count,
+            'items': map(OpenTokArchive.attrs, self.items)
+        }
+
+    def json(self):
+        return json.dumps(self.attrs(), default=dthandler, indent=4)
+
+

opentok/opentok.py

@@ -1,81 +1,32 @@
 from datetime import datetime  # generate_token
 import calendar                # generate_token
+import base64                  # generate_token
+import random                  # generate_token
 import time                    # generate_token
 import hmac                    # _sign_string
 import hashlib                 # _sign_string
-import base64                  # generate_token
-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
 from six.moves.urllib.parse import urlencode
 from six import text_type, u, b, PY3
 from enum import Enum
 
-dthandler = lambda obj: obj.isoformat() if isinstance(obj, datetime.datetime)  or isinstance(obj, datetime.date) else None
+from .version import __version__
+from .session import Session
+from .archives import Archive, ArchiveList
+from .exceptions import OpenTokException, RequestError, AuthError, NotFoundError, ArchiveError
 
 class Roles(Enum):
     """List of valid roles for a token."""
     subscriber = u('subscriber')   # Can only subscribe
     publisher =  u('publisher')    # Can publish, subscribe, and signal
     moderator =  u('moderator')    # Can do the above along with forceDisconnect and forceUnpublish
 
-
-class OpenTokArchive(object):
-
-    def __init__(self, sdk, values):
-        self.sdk = sdk
-        self.id = values.get('id')
-        self.name = values.get('name')
-        self.status = values.get('status')
-        self.session_id = values.get('sessionId')
-        self.partner_id = values.get('partnerId')
-        self.created_at = datetime.datetime.fromtimestamp(values.get('createdAt') / 1000)
-        self.size = values.get('size')
-        self.duration = values.get('duration')
-        self.url = values.get('url')
-
-    def stop(self):
-        self.sdk.stop_archive(self.id)
-
-    def delete(self):
-        self.sdk.delete_archive(self.id)
-
-    def attrs(self):
-        return dict((k, v) for k, v in six.iteritems(self.__dict__) if k is not "sdk")
-
-    def json(self):
-        return json.dumps(self.attrs(), default=dthandler, indent=4)
-
-
-class OpenTokArchiveList(object):
-
-    def __init__(self, values):
-        self.count = values.get('count')
-        self.items = map(lambda x: OpenTokArchive(self, x), values.get('items', []))
-
-    def __iter__(self):
-        for x in self.items:
-            yield x
-
-    def attrs(self):
-        return {
-            'count': self.count,
-            'items': map(OpenTokArchive.attrs, self.items)
-        }
-
-    def json(self):
-        return json.dumps(self.attrs(), default=dthandler, indent=4)
-
-
 class OpenTok(object):
     """Use this SDK to create tokens and interface with the server-side portion
     of the Opentok API.
@@ -221,7 +172,7 @@ def session_url(self):
         return url
 
     def archive_url(self, archive_id=None):
-        url = OpenTok.API_URL + '/v2/partner/' + self.api_key + '/archive'
+        url = self.api_url + '/v2/partner/' + self.api_key + '/archive'
         if archive_id:
             url = url + '/' + archive_id
         return url
@@ -232,7 +183,7 @@ def start_archive(self, session_id, **kwargs):
         response = requests.post(self.archive_url(), data=json.dumps(payload), headers=self.archive_headers())
 
         if response.status_code < 300:
-            return OpenTokArchive(self, response.json())
+            return Archive(self, response.json())
         elif response.status_code == 403:
             raise AuthError()
         elif response.status_code == 400:
@@ -248,7 +199,7 @@ def stop_archive(self, archive_id):
         response = requests.post(self.archive_url(archive_id) + '/stop', headers=self.archive_headers())
 
         if response.status_code < 300:
-            return OpenTokArchive(self, response.json())
+            return Archive(self, response.json())
         elif response.status_code == 403:
             raise AuthError()
         elif response.status_code == 404:
@@ -274,7 +225,7 @@ def get_archive(self, archive_id):
         response = requests.get(self.archive_url(archive_id), headers=self.archive_headers())
 
         if response.status_code < 300:
-            return OpenTokArchive(self, response.json())
+            return Archive(self, response.json())
         elif response.status_code == 403:
             raise AuthError()
         elif response.status_code == 404:
@@ -292,7 +243,7 @@ def get_archives(self, offset=None, count=None):
         response = requests.get(self.archive_url() + "?" + urlencode(params), headers=self.archive_headers())
 
         if response.status_code < 300:
-            return OpenTokArchiveList(response.json())
+            return ArchiveList(response.json())
         elif response.status_code == 403:
             raise AuthError()
         elif response.status_code == 404:
@@ -302,3 +253,4 @@ def get_archives(self, offset=None, count=None):
 
     def _sign_string(self, string, secret):
         return hmac.new(secret.encode('utf-8'), string.encode('utf-8'), hashlib.sha1).hexdigest()
+

tests/test_archive_api.py

@@ -0,0 +1,62 @@
+import unittest
+from six import text_type, u, b, PY2, PY3
+from nose.tools import raises
+from sure import expect
+import httpretty
+import textwrap
+import json
+
+from opentok import OpenTok, Archive, __version__
+
+class OpenTokArchiveApiTest(unittest.TestCase):
+    def setUp(self):
+        self.api_key = u('123456')
+        self.api_secret = u('1234567890abcdef1234567890abcdef1234567890')
+        self.session_id = u('SESSIONID')
+        # self.api_key = u('854511')
+        # self.api_secret = u('***REMOVED***')
+        # self.session_id = u('2_MX44NTQ1MTF-flR1ZSBOb3YgMTIgMDk6NDA6NTkgUFNUIDIwMTN-MC43NjU0Nzh-')
+        self.opentok = OpenTok(self.api_key, self.api_secret)
+
+    @httpretty.activate
+    def test_start_archive(self):
+        httpretty.register_uri(httpretty.POST, u('https://api.opentok.com/v2/partner/{0}/archive').format(self.api_key),
+                               body=textwrap.dedent(u("""\
+                                       {
+                                          "createdAt" : 1395183243556,
+                                          "duration" : 0,
+                                          "id" : "30b3ebf1-ba36-4f5b-8def-6f70d9986fe9",
+                                          "name" : "",
+                                          "partnerId" : 123456,
+                                          "reason" : "",
+                                          "sessionId" : "SESSIONID",
+                                          "size" : 0,
+                                          "status" : "started",
+                                          "url" : null
+                                        }""")),
+                               status=200,
+                               content_type=u('application/json'))
+
+        archive = self.opentok.start_archive(self.session_id)
+        #print(archive.json())
+
+        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().headers[u('content-type')]).to.equal(u('application/json'))
+        # non-deterministic json encoding. have to decode to test it properly
+        if PY2:
+            body = json.loads(httpretty.last_request().body)
+        if PY3:
+            body = json.loads(httpretty.last_request().body.decode('utf-8'))
+        expect(body).to.have.key(u('name')).being.equal(None)
+        expect(body).to.have.key(u('sessionId')).being.equal(u('SESSIONID'))
+        expect(archive).to.be.an(Archive)
+        expect(archive).to.have.property(u('id')).being.equal(u('30b3ebf1-ba36-4f5b-8def-6f70d9986fe9'))
+        expect(archive).to.have.property(u('name')).being.equal(u(''))
+        expect(archive).to.have.property(u('status')).being.equal(u('started'))
+        expect(archive).to.have.property(u('session_id')).being.equal(u('SESSIONID'))
+        expect(archive).to.have.property(u('partner_id')).being.equal(123456)
+        #expect(archive).to.have.property(u('created_at')).being.equal(None)
+        expect(archive).to.have.property(u('size')).being.equal(0)
+        expect(archive).to.have.property(u('duration')).being.equal(0)
+        expect(archive).to.have.property(u('url')).being.equal(None)

tests/test_session_creation.py

@@ -11,8 +11,6 @@ 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