Merge pull request #178 from opentok/verb-to-nout-format

Adding Verb Noun format to methods

Author: superdiana

opentok/endpoints.py

@@ -1,3 +1,6 @@
+import warnings
+
+
 class Endpoints(object):
     """
     For internal use.
@@ -8,17 +11,34 @@ def __init__(self, api_url, api_key):
         self.api_url = api_url
         self.api_key = api_key
 
-    def session_url(self):
+    def get_session_url(self):
         url = self.api_url + "/session/create"
         return url
 
-    def archive_url(self, archive_id=None):
+    def session_url(self):
+        warnings.warn(
+            "endpoints.session_url is deprecated (use endpoints.get_session_url instead).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+        return self.get_session_url()
+
+    def get_archive_url(self, archive_id=None):
         url = self.api_url + "/v2/project/" + self.api_key + "/archive"
         if archive_id:
             url = url + "/" + archive_id
         return url
 
-    def signaling_url(self, session_id, connection_id=None):
+    def archive_url(self, archive_id=None):
+        warnings.warn(
+            "endpoints.archive_url is deprecated (use endpoints.get_archive_url instead).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.get_archive_url(archive_id)
+
+    def get_signaling_url(self, session_id, connection_id=None):
         url = self.api_url + "/v2/project/" + self.api_key + "/session/" + session_id
 
         if connection_id:
@@ -27,6 +47,14 @@ def signaling_url(self, session_id, connection_id=None):
         url += "/signal"
         return url
 
+    def signaling_url(self, session_id, connection_id=None):
+        warnings.warn(
+            "endpoints.signaling_url is deprecated (use endpoints.get_signaling_url instead).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.get_signaling_url(session_id, connection_id)
+
     def get_stream_url(self, session_id, stream_id=None):
         """ this method returns the url to get streams information """
         url = (
@@ -41,6 +69,14 @@ def get_stream_url(self, session_id, stream_id=None):
             url = url + "/" + stream_id
         return url
 
+    def broadcast_url(self, broadcast_id=None, stop=False, layout=False):
+        warnings.warn(
+            "endpoints.broadcast_url is deprecated (use endpoints.get_broadcast_url instead).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.get_broadcast_url(broadcast_id, stop, layout)
+
     def force_disconnect_url(self, session_id, connection_id):
         """ this method returns the force disconnect url endpoint """
         url = (
@@ -83,7 +119,7 @@ def set_stream_class_lists_url(self, session_id):
         )
         return url
 
-    def broadcast_url(self, broadcast_id=None, stop=False, layout=False):
+    def get_broadcast_url(self, broadcast_id=None, stop=False, layout=False):
         """ this method returns urls for working with broadcast """
         url = self.api_url + "/v2/project/" + self.api_key + "/broadcast"
 

opentok/opentok.py

@@ -12,6 +12,7 @@
 import xml.dom.minidom as xmldom  # create_session
 from jose import jwt  # _create_jwt_auth_header
 import random  # _create_jwt_auth_header
+import warnings  # Native. Used for notifying deprecations
 
 # compat
 from six.moves.urllib.parse import urlencode
@@ -381,9 +382,9 @@ def create_session(
 
         try:
             response = requests.post(
-                self.endpoints.session_url(),
+                self.endpoints.get_session_url(),
                 data=options,
-                headers=self.headers(),
+                headers=self.get_headers(),
                 proxies=self.proxies,
                 timeout=self.timeout,
             )
@@ -422,7 +423,7 @@ def create_session(
         except Exception as e:
             raise OpenTokException("Failed to generate session: %s" % str(e))
 
-    def headers(self):
+    def get_headers(self):
         """For internal use."""
         return {
             "User-Agent": "OpenTok-Python-SDK/"
@@ -432,12 +433,28 @@ def headers(self):
             "X-OPENTOK-AUTH": self._create_jwt_auth_header(),
         }
 
-    def json_headers(self):
+    def headers(self):
+        warnings.warn(
+            "opentok.headers is deprecated (use opentok.get_headers instead).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.get_headers()
+
+    def get_json_headers(self):
         """For internal use."""
-        result = self.headers()
+        result = self.get_headers()
         result["Content-Type"] = "application/json"
         return result
 
+    def json_headers(self):
+        warnings.warn(
+            "opentok.json_headers is deprecated (use opentok.get_json_headers instead).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.get_json_headers()
+
     def start_archive(
         self,
         session_id,
@@ -505,9 +522,9 @@ def start_archive(
         }
 
         response = requests.post(
-            self.endpoints.archive_url(),
+            self.endpoints.get_archive_url(),
             data=json.dumps(payload),
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -544,8 +561,8 @@ def stop_archive(self, archive_id):
         :rtype: The Archive object corresponding to the archive being stopped.
         """
         response = requests.post(
-            self.endpoints.archive_url(archive_id) + "/stop",
-            headers=self.json_headers(),
+            self.endpoints.get_archive_url(archive_id) + "/stop",
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -572,8 +589,8 @@ def delete_archive(self, archive_id):
         :param String archive_id: The archive ID of the archive to be deleted.
         """
         response = requests.delete(
-            self.endpoints.archive_url(archive_id),
-            headers=self.json_headers(),
+            self.endpoints.get_archive_url(archive_id),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -595,8 +612,8 @@ def get_archive(self, archive_id):
         :rtype: The Archive object.
         """
         response = requests.get(
-            self.endpoints.archive_url(archive_id),
-            headers=self.json_headers(),
+            self.endpoints.get_archive_url(archive_id),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -631,11 +648,11 @@ def get_archives(self, offset=None, count=None, session_id=None):
         if session_id is not None:
             params["sessionId"] = session_id
 
-        endpoint = self.endpoints.archive_url() + "?" + urlencode(params)
+        endpoint = self.endpoints.get_archive_url() + "?" + urlencode(params)
 
         response = requests.get(
             endpoint,
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -656,7 +673,7 @@ def list_archives(self, offset=None, count=None, session_id=None):
         """
         return self.get_archives(offset, count, session_id)
 
-    def signal(self, session_id, payload, connection_id=None):
+    def send_signal(self, session_id, payload, connection_id=None):
         """
         Send signals to all participants in an active OpenTok session or to a specific client
         connected to that session.
@@ -672,9 +689,9 @@ def signal(self, session_id, payload, connection_id=None):
         connected to the session
         """
         response = requests.post(
-            self.endpoints.signaling_url(session_id, connection_id),
+            self.endpoints.get_signaling_url(session_id, connection_id),
             data=json.dumps(payload),
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -700,6 +717,14 @@ def signal(self, session_id, payload, connection_id=None):
         else:
             raise RequestError("An unexpected error occurred", response.status_code)
 
+    def signal(self, session_id, payload, connection_id=None):
+        warnings.warn(
+            "opentok.signal is deprecated (use opentok.send_signal instead).",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        self.send_signal(session_id, payload, connection_id)
+
     def get_stream(self, session_id, stream_id):
         """
         Returns an Stream object that contains information of an OpenTok stream:
@@ -712,7 +737,7 @@ def get_stream(self, session_id, stream_id):
         endpoint = self.endpoints.get_stream_url(session_id, stream_id)
         response = requests.get(
             endpoint,
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -742,7 +767,7 @@ def list_streams(self, session_id):
 
         response = requests.get(
             endpoint,
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -770,7 +795,7 @@ def force_disconnect(self, session_id, connection_id):
         endpoint = self.endpoints.force_disconnect_url(session_id, connection_id)
         response = requests.delete(
             endpoint,
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -816,7 +841,7 @@ def set_archive_layout(self, archive_id, layout_type, stylesheet=None):
         response = requests.put(
             endpoint,
             data=json.dumps(payload),
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -887,7 +912,7 @@ def dial(self, session_id, token, sip_uri, options=[]):
         response = requests.post(
             endpoint,
             data=json.dumps(payload),
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -932,7 +957,7 @@ class names (Strings) to apply to the stream. For example:
         response = requests.put(
             endpoint,
             data=json.dumps(items_payload),
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -991,11 +1016,11 @@ def start_broadcast(self, session_id, options):
 
         payload.update(options)
 
-        endpoint = self.endpoints.broadcast_url()
+        endpoint = self.endpoints.get_broadcast_url()
         response = requests.post(
             endpoint,
             data=json.dumps(payload),
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -1025,10 +1050,10 @@ def stop_broadcast(self, broadcast_id):
         :rtype A Broadcast object, which contains information of the broadcast: id, sessionId
         projectId, createdAt, updatedAt and resolution
         """
-        endpoint = self.endpoints.broadcast_url(broadcast_id, stop=True)
+        endpoint = self.endpoints.get_broadcast_url(broadcast_id, stop=True)
         response = requests.post(
             endpoint,
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -1059,10 +1084,10 @@ def get_broadcast(self, broadcast_id):
         :rtype A Broadcast object, which contains information of the broadcast: id, sessionId
         projectId, createdAt, updatedAt, resolution, broadcastUrls and status
         """
-        endpoint = self.endpoints.broadcast_url(broadcast_id)
+        endpoint = self.endpoints.get_broadcast_url(broadcast_id)
         response = requests.get(
             endpoint,
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )
@@ -1101,11 +1126,11 @@ def set_broadcast_layout(self, broadcast_id, layout_type, stylesheet=None):
             if stylesheet is not None:
                 payload["stylesheet"] = stylesheet
 
-        endpoint = self.endpoints.broadcast_url(broadcast_id, layout=True)
+        endpoint = self.endpoints.get_broadcast_url(broadcast_id, layout=True)
         response = requests.put(
             endpoint,
             data=json.dumps(payload),
-            headers=self.json_headers(),
+            headers=self.get_json_headers(),
             proxies=self.proxies,
             timeout=self.timeout,
         )

tests/test_signal.py

@@ -39,7 +39,7 @@ def test_signal(self):
             content_type=u("application/json"),
         )
 
-        self.opentok.signal(self.session_id, data)
+        self.opentok.send_signal(self.session_id, data)
 
         validate_jwt_header(self, httpretty.last_request().headers[u("x-opentok-auth")])
         expect(httpretty.last_request().headers[u("user-agent")]).to(
@@ -81,7 +81,7 @@ def test_signal_with_connection_id(self):
             content_type=u("application/json"),
         )
 
-        self.opentok.signal(self.session_id, data, connection_id)
+        self.opentok.send_signal(self.session_id, data, connection_id)
 
         validate_jwt_header(self, httpretty.last_request().headers[u("x-opentok-auth")])
         expect(httpretty.last_request().headers[u("user-agent")]).to(