Some but not all unit tests refactored; webook validation and authentication needs sorting out.

Author: callum-oakley

pusher/aiohttp.py

@@ -1,5 +1,11 @@
 # -*- coding: utf-8 -*-
 
+from __future__ import (
+    print_function,
+    unicode_literals,
+    absolute_import,
+    division)
+
 import aiohttp
 import asyncio
 

pusher/errors.py

@@ -1,5 +1,12 @@
 # -*- coding: utf-8 -*-
 
+from __future__ import (
+    print_function,
+    unicode_literals,
+    absolute_import,
+    division)
+
+
 class PusherError(Exception):
     pass
 

pusher/pusher.py

@@ -136,73 +136,16 @@ def users_info(self, channel):
         return self._pusher_client.users_info(channel)
 
 
-    @doc_string(NotificationClient.notify.__doc__)
-    def notify(self, interest, notification):
-        return self._notification_client.notify(interest, notification)
-
-
+    @doc_string(PusherClient.authenticate.__doc__)
     def authenticate(self, channel, socket_id, custom_data=None):
-        """Used to generate delegated client subscription token.
-
-        :param channel: name of the channel to authorize subscription to
-        :param socket_id: id of the socket that requires authorization
-        :param custom_data: used on presence channels to provide user info
-        """
-        channel = validate_channel(channel)
-
-        if not channel_name_re.match(channel):
-            raise ValueError('Channel should be a valid channel, got: %s' % channel)
-
-        socket_id = validate_socket_id(socket_id)
-
-        if custom_data:
-            custom_data = json.dumps(custom_data, cls=self._json_encoder)
-
-        string_to_sign = "%s:%s" % (socket_id, channel)
-
-        if custom_data:
-            string_to_sign += ":%s" % custom_data
-
-        signature = sign(self.secret, string_to_sign)
+        return self.pusher_client.authenticate(channel, socket_id, custom_data)
 
-        auth = "%s:%s" % (self.key, signature)
-        result = {'auth': auth}
 
-        if custom_data:
-            result['channel_data'] = custom_data
+    @doc_string(PusherClient.validate_webhook.__doc__)
+    def authenticate(self, key, signature, body):
+        return self.pusher_client.validate_webhook(key, signature, body)
 
-        return result
 
-
-    def validate_webhook(self, key, signature, body):
-        """Used to validate incoming webhook messages. When used it guarantees
-        that the sender is Pusher and not someone else impersonating it.
-
-        :param key: key used to sign the body
-        :param signature: signature that was given with the body
-        :param body: content that needs to be verified
-        """
-        key = ensure_text(key, "key")
-        signature = ensure_text(signature, "signature")
-        body = ensure_text(body, "body")
-
-        if key != self.key:
-            return None
-
-        if not verify(self.secret, body, signature):
-            return None
-
-        try:
-            body_data = json.loads(body, cls=self._json_decoder)
-
-        except ValueError:
-            return None
-
-        time_ms = body_data.get('time_ms')
-        if not time_ms:
-            return None
-
-        if abs(time.time()*1000 - time_ms) > 300000:
-            return None
-
-        return body_data
+    @doc_string(NotificationClient.notify.__doc__)
+    def notify(self, interest, notification):
+        return self._notification_client.notify(interest, notification)

pusher/pusher_client.py

@@ -147,3 +147,70 @@ def users_info(self, channel):
 
         return Request(
             self, GET, "/apps/%s/channels/%s/users" % (self.app_id, channel))
+
+
+    def authenticate(self, channel, socket_id, custom_data=None):
+        """Used to generate delegated client subscription token.
+
+        :param channel: name of the channel to authorize subscription to
+        :param socket_id: id of the socket that requires authorization
+        :param custom_data: used on presence channels to provide user info
+        """
+        channel = validate_channel(channel)
+
+        if not channel_name_re.match(channel):
+            raise ValueError('Channel should be a valid channel, got: %s' % channel)
+
+        socket_id = validate_socket_id(socket_id)
+
+        if custom_data:
+            custom_data = json.dumps(custom_data, cls=self._json_encoder)
+
+        string_to_sign = "%s:%s" % (socket_id, channel)
+
+        if custom_data:
+            string_to_sign += ":%s" % custom_data
+
+        signature = sign(self.secret, string_to_sign)
+
+        auth = "%s:%s" % (self.key, signature)
+        result = {'auth': auth}
+
+        if custom_data:
+            result['channel_data'] = custom_data
+
+        return result
+
+
+    def validate_webhook(self, key, signature, body):
+        """Used to validate incoming webhook messages. When used it guarantees
+        that the sender is Pusher and not someone else impersonating it.
+
+        :param key: key used to sign the body
+        :param signature: signature that was given with the body
+        :param body: content that needs to be verified
+        """
+        key = ensure_text(key, "key")
+        signature = ensure_text(signature, "signature")
+        body = ensure_text(body, "body")
+
+        if key != self.key:
+            return None
+
+        if not verify(self.secret, body, signature):
+            return None
+
+        try:
+            body_data = json.loads(body, cls=self._json_decoder)
+
+        except ValueError:
+            return None
+
+        time_ms = body_data.get('time_ms')
+        if not time_ms:
+            return None
+
+        if abs(time.time()*1000 - time_ms) > 300000:
+            return None
+
+        return body_data

pusher/signature.py

@@ -1,5 +1,11 @@
 # -*- coding: utf-8 -*-
 
+from __future__ import (
+    print_function,
+    unicode_literals,
+    absolute_import,
+    division)
+
 import hashlib
 import hmac
 import six

pusher_tests/test_client.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import (
+    print_function,
+    unicode_literals,
+    absolute_import,
+    division)
+
+import hashlib
+import hmac
+import os
+import six
+import unittest
+
+from pusher.client import Client
+
+try:
+    import unittest.mock as mock
+except ImportError:
+    import mock
+
+
+class TestClient(unittest.TestCase):
+    def test_should_be_constructable(self):
+        Client(app_id=u'4', key=u'key', secret=u'secret', ssl=False)
+
+    def test_app_id_should_be_text_if_present(self):
+        self.assertRaises(TypeError, lambda: Client(app_id=4, key=u'key', secret=u'secret', ssl=False))
+
+    def test_key_should_be_text_if_present(self):
+        self.assertRaises(TypeError, lambda: Client(app_id=u'4', key=4, secret=u'secret', ssl=False))
+
+    def test_secret_should_be_text_if_present(self):
+        self.assertRaises(TypeError, lambda: Client(app_id=u'4', key=u'key', secret=4, ssl=False))
+
+    def test_ssl_should_be_boolean(self):
+        Client(app_id=u'4', key=u'key', secret=u'secret', ssl=False)
+        Client(app_id=u'4', key=u'key', secret=u'secret', ssl=True)
+
+        self.assertRaises(TypeError, lambda: Client(app_id=u'4', key=u'key', secret=u'secret', ssl=4))
+
+    def test_port_should_be_number(self):
+        Client(app_id=u'4', key=u'key', secret=u'secret', ssl=True, port=400)
+
+        self.assertRaises(TypeError, lambda: Client(app_id=u'4', key=u'key', secret=u'secret', ssl=True, port=u'400'))
+
+    def test_port_behaviour(self):
+        conf = Client(app_id=u'4', key=u'key', secret=u'secret', ssl=True)
+        self.assertEqual(conf.port, 443, u'port should be 443 for ssl')
+
+        conf = Client(app_id=u'4', key=u'key', secret=u'secret', ssl=False)
+        self.assertEqual(conf.port, 80, u'port should be 80 for non ssl')
+
+        conf = Client(app_id=u'4', key=u'key', secret=u'secret', ssl=False, port=4000)
+        self.assertEqual(conf.port, 4000, u'the port setting override the default')
+
+
+if __name__ == '__main__':
+    unittest.main()

pusher_tests/test_config.py

@@ -23,6 +23,11 @@ def setUp(self):
             }
         }
 
+    def test_host_should_be_text(self):
+        NotificationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, host=u'foo')
+
+        self.assertRaises(TypeError, lambda: NotificationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, host=4))
+
     def test_notify_success_case(self):
         request = self.client.notify.make_request(['yolo'], self.success_fixture)
         self.assertEqual(request.method, u'POST')