Merge pull request #180 from opentok/implement-standard-logging-module

Implement standard logging module

Author: superdiana

opentok/opentok.py

@@ -12,8 +12,10 @@
 import xml.dom.minidom as xmldom  # create_session
 from jose import jwt  # _create_jwt_auth_header
 import random  # _create_jwt_auth_header
+import logging  # logging
 import warnings  # Native. Used for notifying deprecations
 
+
 # compat
 from six.moves.urllib.parse import urlencode
 from six import text_type, u, b, PY3
@@ -77,6 +79,9 @@ class ArchiveModes(Enum):
     """The session will be automatically archived."""
 
 
+logger = logging.getLogger("opentok")
+
+
 class OpenTok(object):
     """Use this SDK to create tokens and interface with the server-side portion
     of the Opentok API.
@@ -381,6 +386,13 @@ def create_session(
             options[u("location")] = location
 
         try:
+            logger.debug(
+                "POST to %r with params %r, headers %r, proxies %r",
+                self.endpoints.session_url(),
+                options,
+                self.headers(),
+                self.proxies,
+            )
             response = requests.post(
                 self.endpoints.get_session_url(),
                 data=options,
@@ -521,6 +533,14 @@ def start_archive(
             "resolution": resolution,
         }
 
+        logger.debug(
+            "POST to %r with params %r, headers %r, proxies %r",
+            self.endpoints.archive_url(),
+            json.dumps(payload),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.post(
             self.endpoints.get_archive_url(),
             data=json.dumps(payload),
@@ -560,6 +580,13 @@ def stop_archive(self, archive_id):
 
         :rtype: The Archive object corresponding to the archive being stopped.
         """
+        logger.debug(
+            "POST to %r with headers %r, proxies %r",
+            self.endpoints.archive_url(archive_id) + "/stop",
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.post(
             self.endpoints.get_archive_url(archive_id) + "/stop",
             headers=self.get_json_headers(),
@@ -588,6 +615,13 @@ def delete_archive(self, archive_id):
 
         :param String archive_id: The archive ID of the archive to be deleted.
         """
+        logger.debug(
+            "DELETE to %r with headers %r, proxies %r",
+            self.endpoints.archive_url(archive_id),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.delete(
             self.endpoints.get_archive_url(archive_id),
             headers=self.get_json_headers(),
@@ -611,6 +645,13 @@ def get_archive(self, archive_id):
 
         :rtype: The Archive object.
         """
+        logger.debug(
+            "GET to %r with headers %r, proxies %r",
+            self.endpoints.archive_url(archive_id),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.get(
             self.endpoints.get_archive_url(archive_id),
             headers=self.get_json_headers(),
@@ -650,6 +691,13 @@ def get_archives(self, offset=None, count=None, session_id=None):
 
         endpoint = self.endpoints.get_archive_url() + "?" + urlencode(params)
 
+        logger.debug(
+            "GET to %r with headers %r, proxies %r",
+            endpoint,
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.get(
             endpoint,
             headers=self.get_json_headers(),
@@ -688,6 +736,14 @@ def send_signal(self, session_id, payload, connection_id=None):
         the signal is sent to the specified client. Otherwise, the signal is sent to all clients
         connected to the session
         """
+        logger.debug(
+            "POST to %r with params %r, headers %r, proxies %r",
+            self.endpoints.signaling_url(session_id, connection_id),
+            json.dumps(payload),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.post(
             self.endpoints.get_signaling_url(session_id, connection_id),
             data=json.dumps(payload),
@@ -735,6 +791,14 @@ def get_stream(self, session_id, stream_id):
         -layoutClassList: It's an array of the layout classes for the stream
         """
         endpoint = self.endpoints.get_stream_url(session_id, stream_id)
+
+        logger.debug(
+            "GET to %r with headers %r, proxies %r",
+            endpoint,
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.get(
             endpoint,
             headers=self.get_json_headers(),
@@ -765,6 +829,13 @@ def list_streams(self, session_id):
         """
         endpoint = self.endpoints.get_stream_url(session_id)
 
+        logger.debug(
+            "GET to %r with headers %r, proxies %r",
+            endpoint,
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.get(
             endpoint,
             headers=self.get_json_headers(),
@@ -793,6 +864,14 @@ def force_disconnect(self, session_id, connection_id):
         :param String connection_id: The connection ID of the client that will be disconnected
         """
         endpoint = self.endpoints.force_disconnect_url(session_id, connection_id)
+
+        logger.debug(
+            "DELETE to %r with headers %r, proxies %r",
+            endpoint,
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.delete(
             endpoint,
             headers=self.get_json_headers(),
@@ -838,6 +917,15 @@ def set_archive_layout(self, archive_id, layout_type, stylesheet=None):
                 payload["stylesheet"] = stylesheet
 
         endpoint = self.endpoints.set_archive_layout_url(archive_id)
+
+        logger.debug(
+            "PUT to %r with params %r, headers %r, proxies %r",
+            endpoint,
+            json.dumps(payload),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.put(
             endpoint,
             data=json.dumps(payload),
@@ -909,6 +997,15 @@ def dial(self, session_id, token, sip_uri, options=[]):
             payload["sip"]["secure"] = options["secure"]
 
         endpoint = self.endpoints.dial_url()
+
+        logger.debug(
+            "POST to %r with params %r, headers %r, proxies %r",
+            endpoint,
+            json.dumps(payload),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.post(
             endpoint,
             data=json.dumps(payload),
@@ -954,6 +1051,15 @@ class names (Strings) to apply to the stream. For example:
         items_payload = {"items": payload}
 
         endpoint = self.endpoints.set_stream_class_lists_url(session_id)
+
+        logger.debug(
+            "PUT to %r with params %r, headers %r, proxies %r",
+            endpoint,
+            json.dumps(items_payload),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.put(
             endpoint,
             data=json.dumps(items_payload),
@@ -1016,7 +1122,16 @@ def start_broadcast(self, session_id, options):
 
         payload.update(options)
 
-        endpoint = self.endpoints.get_broadcast_url()
+        endpoint = self.endpoints.broadcast_url()
+
+        logger.debug(
+            "POST to %r with params %r, headers %r, proxies %r",
+            endpoint,
+            json.dumps(payload),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.post(
             endpoint,
             data=json.dumps(payload),
@@ -1050,7 +1165,16 @@ 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.get_broadcast_url(broadcast_id, stop=True)
+
+        endpoint = self.endpoints.broadcast_url(broadcast_id, stop=True)
+
+        logger.debug(
+            "POST to %r with headers %r, proxies %r",
+            endpoint,
+            self.json_headers(),
+            self.proxies,
+        )
+    
         response = requests.post(
             endpoint,
             headers=self.get_json_headers(),
@@ -1084,7 +1208,16 @@ 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.get_broadcast_url(broadcast_id)
+
+        endpoint = self.endpoints.broadcast_url(broadcast_id)
+
+        logger.debug(
+            "GET to %r with headers %r, proxies %r",
+            endpoint,
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.get(
             endpoint,
             headers=self.get_json_headers(),
@@ -1126,7 +1259,16 @@ def set_broadcast_layout(self, broadcast_id, layout_type, stylesheet=None):
             if stylesheet is not None:
                 payload["stylesheet"] = stylesheet
 
-        endpoint = self.endpoints.get_broadcast_url(broadcast_id, layout=True)
+        endpoint = self.endpoints.broadcast_url(broadcast_id, layout=True)
+
+        logger.debug(
+            "PUT to %r with params %r, headers %r, proxies %r",
+            endpoint,
+            json.dumps(payload),
+            self.json_headers(),
+            self.proxies,
+        )
+
         response = requests.put(
             endpoint,
             data=json.dumps(payload),