add user_agent as a property and create append method

Author: maxkahan

opentok/opentok.py

@@ -115,6 +115,9 @@ def __init__(
         self._proxies = None
         self.endpoints = Endpoints(api_url, self.api_key)
         self._app_version = __version__ if app_version == None else app_version
+        self._user_agent = (
+            f"OpenTok-Python-SDK/{self.app_version} python/{platform.python_version()}"
+        )
         # JWT custom claims - Default values
         self._jwt_livetime = 3  # In minutes
 
@@ -134,6 +137,17 @@ def app_version(self):
     def app_version(self, value):
         self._app_version = value
 
+    @property
+    def user_agent(self):
+        return self._user_agent
+
+    @user_agent.setter
+    def user_agent(self, value):
+        self._user_agent = value
+
+    def append_to_user_agent(self, value):
+        self.user_agent = self.user_agent + value
+
     @property
     def jwt_livetime(self):
         return self._jwt_livetime

tests/test_getter_setter.py

@@ -1,10 +1,8 @@
 import unittest
-from six import text_type, u, b, PY2, PY3
-from nose.tools import raises
+from six import u
 from expects import *
 
 from opentok import Client, __version__
-import time
 
 
 class GetterSetterTest(unittest.TestCase):

tests/test_initialization.py

@@ -1,11 +1,8 @@
-# import time
-# import urllib2
 import unittest
 from nose.tools import raises
+import platform
 
-# from xml.dom.minidom import parseString
-
-from opentok import Client  # , OpenTokException
+from opentok import Client
 
 
 class OpenTokInitializationTest(unittest.TestCase):
@@ -40,6 +37,16 @@ def test_initialization_with_timeout(self):
         opentok = Client(self.api_key, self.api_secret, timeout=5)
         assert isinstance(opentok, Client)
 
+    def test_user_agent(self):
+        opentok = Client(self.api_key, self.api_secret, self.api_url)
+        assert opentok.user_agent == f"OpenTok-Python-SDK/{opentok.app_version} python/{platform.python_version()}"
+    
+    def test_append_to_user_agent(self):
+        opentok = Client(self.api_key, self.api_secret, self.api_url)
+        opentok.append_to_user_agent('/my_appended_user_agent_string')
+        assert opentok.user_agent == f"OpenTok-Python-SDK/{opentok.app_version} python/{platform.python_version()}/my_appended_user_agent_string"
+
+
 
 if __name__ == "__main__":
     unittest.main()

tests/test_session_creation.py

@@ -1,10 +1,11 @@
 import unittest
-from six import text_type, u, b, PY2, PY3
+from six import u, b
 from six.moves.urllib.parse import parse_qs
 from nose.tools import raises
 from expects import *
 import httpretty
 from .validate_jwt import validate_jwt_header
+import platform
 
 from opentok import (
     Client,
@@ -38,7 +39,7 @@ def test_create_default_session(self):
 
         validate_jwt_header(self, httpretty.last_request().headers[u("x-opentok-auth")])
         expect(httpretty.last_request().headers[u("user-agent")]).to(
-            contain(u("OpenTok-Python-SDK/") + __version__)
+            equal(u("OpenTok-Python-SDK/") + __version__ + ' python/' + platform.python_version())
         )
         body = parse_qs(httpretty.last_request().body)
         expect(body).to(have_key(b("p2p.preference"), [b("enabled")]))