Push key validation down to base client

Author: mdpye

pusher/authentication_client.py

@@ -31,22 +31,37 @@
 
 class AuthenticationClient(Client):
     def __init__(
-            self, app_id, key, secret, ssl=True, host=None, port=None,
-            timeout=5, cluster=None, encryption_master_key=None, json_encoder=None, json_decoder=None,
-            backend=None, **backend_options):
+            self,
+            app_id,
+            key,
+            secret,
+            ssl=True,
+            host=None,
+            port=None,
+            timeout=5,
+            cluster=None,
+            encryption_master_key=None,
+            encryption_master_key_base64=None,
+            json_encoder=None,
+            json_decoder=None,
+            backend=None,
+            **backend_options):
+
         super(AuthenticationClient, self).__init__(
-            app_id, key, secret, ssl, host, port, timeout, cluster, encryption_master_key,
-            json_encoder, json_decoder, backend, **backend_options)
-
-        if host:
-            self._host = ensure_text(host, "host")
-
-        elif cluster:
-            self._host = (
-                six.text_type("api-%s.pusher.com") %
-                ensure_text(cluster, "cluster"))
-        else:
-            self._host = six.text_type("api.pusherapp.com")
+            app_id,
+            key,
+            secret,
+            ssl,
+            host,
+            port,
+            timeout,
+            cluster,
+            encryption_master_key,
+            encryption_master_key_base64,
+            json_encoder,
+            json_decoder,
+            backend,
+            **backend_options)
 
 
     def authenticate(self, channel, socket_id, custom_data=None):

pusher/client.py

@@ -9,6 +9,7 @@
 import six
 
 from pusher.util import ensure_text, ensure_binary, app_id_re
+from pusher.crypto import parse_master_key
 
 
 class Client(object):
@@ -23,6 +24,7 @@ def __init__(
             timeout=5,
             cluster=None,
             encryption_master_key=None,
+            encryption_master_key_base64=None,
             json_encoder=None,
             json_decoder=None,
             backend=None,
@@ -44,6 +46,15 @@ def __init__(
 
         self._ssl = ssl
 
+        if host:
+            self._host = ensure_text(host, "host")
+        elif cluster:
+            self._host = (
+                six.text_type("api-%s.pusher.com") %
+                ensure_text(cluster, "cluster"))
+        else:
+            self._host = six.text_type("api.pusherapp.com")
+
         if port and not isinstance(port, six.integer_types):
               raise TypeError("port should be an integer")
 
@@ -55,10 +66,12 @@ def __init__(
         self._timeout = timeout
         self._json_encoder = json_encoder
         self._json_decoder = json_decoder
-        self._encryption_master_key = encryption_master_key
+
+        self._encryption_master_key = parse_master_key(encryption_master_key, encryption_master_key_base64)
 
         self.http = backend(self, **backend_options)
 
+
     @property
     def app_id(self):
         return self._app_id

pusher/notification_client.py

@@ -19,16 +19,38 @@
 
 class NotificationClient(Client):
     def __init__(
-            self, app_id, key, secret, ssl=True, host=None, port=None,
-            timeout=30, cluster=None, encryption_master_key=None, json_encoder=None, json_decoder=None,
-            backend=None, **backend_options):
+            self,
+            app_id,
+            key,
+            secret,
+            ssl=True,
+            host=None,
+            port=None,
+            timeout=30,
+            cluster=None,
+            json_encoder=None,
+            json_decoder=None,
+            backend=None,
+            **backend_options):
+
         super(NotificationClient, self).__init__(
-            app_id, key, secret, ssl, host, port, timeout, cluster, encryption_master_key,
-            json_encoder, json_decoder, backend, **backend_options)
+            app_id,
+            key,
+            secret,
+            ssl,
+            host,
+            port,
+            timeout,
+            cluster,
+            None, # encryption_master_key
+            None, # encryption_master_key_base64
+            json_encoder,
+            json_decoder,
+            backend,
+            **backend_options)
 
         if host:
             self._host = ensure_text(host, "host")
-
         else:
             self._host = DEFAULT_HOST
 

pusher/pusher.py

@@ -36,29 +36,77 @@ class Pusher(object):
     :param host:    Used for custom host destination
     :param port:    Used for custom port destination
     :param timeout: Request timeout (in seconds)
-    :param encryption_master_key: Used to derive a shared secret between
-      server and the clients for payload encryption/decryption
-    :param cluster: Convention for other clusters than the main Pusher-one.
+    :param encryption_master_key: deprecated, use encryption_master_key_base64
+    :param encryption_master_key_base64: Used to derive a shared secret
+      between server and the clients for payload encryption/decryption
+    :param cluster: Convention for clusters other than the original Pusher cluster.
       Eg: 'eu' will resolve to the api-eu.pusherapp.com host
     :param backend: an http adapter class (AsyncIOBackend, RequestsBackend,
       SynchronousBackend, TornadoBackend)
     :param backend_options: additional backend
     """
     def __init__(
-            self, app_id, key, secret, ssl=True, host=None, port=None,
-            timeout=5, cluster=None, encryption_master_key=None, json_encoder=None, json_decoder=None,
-            backend=None, notification_host=None, notification_ssl=True, **backend_options):
+            self,
+            app_id,
+            key,
+            secret,
+            ssl=True,
+            host=None,
+            port=None,
+            timeout=5,
+            cluster=None,
+            encryption_master_key=None,
+            encryption_master_key_base64=None,
+            json_encoder=None,
+            json_decoder=None,
+            backend=None,
+            notification_host=None,
+            notification_ssl=True,
+            **backend_options):
+
         self._pusher_client = PusherClient(
-            app_id, key, secret, ssl, host, port, timeout, cluster, encryption_master_key,
-            json_encoder, json_decoder, backend, **backend_options)
+            app_id,
+            key,
+            secret,
+            ssl,
+            host,
+            port,
+            timeout, cluster,
+            encryption_master_key,
+            encryption_master_key_base64,
+            json_encoder,
+            json_decoder,
+            backend,
+            **backend_options)
 
         self._authentication_client = AuthenticationClient(
-            app_id, key, secret, ssl, host, port, timeout, cluster, encryption_master_key,
-            json_encoder, json_decoder, backend, **backend_options)
+            app_id,
+            key,
+            secret,
+            ssl,
+            host,
+            port,
+            timeout,
+            cluster,
+            encryption_master_key,
+            encryption_master_key_base64,
+            json_encoder,
+            json_decoder,
+            backend,
+            **backend_options)
 
         self._notification_client = NotificationClient(
-            app_id, key, secret, notification_ssl, notification_host, port,
-            timeout, cluster, encryption_master_key, json_encoder, json_decoder, backend,
+            app_id,
+            key,
+            secret,
+            notification_ssl,
+            notification_host,
+            port,
+            timeout,
+            cluster,
+            json_encoder,
+            json_decoder,
+            backend,
             **backend_options)
 
 

pusher/pusher_client.py

@@ -52,8 +52,6 @@ def __init__(
             backend=None,
             **backend_options):
 
-        parsed_master_key = parse_master_key(encryption_master_key, encryption_master_key_base64)
-
         super(PusherClient, self).__init__(
                 app_id,
                 key,
@@ -63,22 +61,13 @@ def __init__(
                 port,
                 timeout,
                 cluster,
-                parsed_master_key,
+                encryption_master_key,
+                encryption_master_key_base64,
                 json_encoder,
                 json_decoder,
                 backend,
                 **backend_options)
 
-        if host:
-            self._host = ensure_text(host, "host")
-
-        elif cluster:
-            self._host = (
-                six.text_type("api-%s.pusher.com") %
-                ensure_text(cluster, "cluster"))
-        else:
-            self._host = six.text_type("api.pusherapp.com")
-
 
     @request_method
     def trigger(self, channels, event_name, data, socket_id=None):

pusher_tests/test_authentication_client.py

@@ -23,6 +23,29 @@
 
 class TestAuthenticationClient(unittest.TestCase):
 
+    def test_host_should_be_text(self):
+        AuthenticationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, host=u'foo')
+
+        self.assertRaises(TypeError, lambda: AuthenticationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, host=4))
+
+    def test_cluster_should_be_text(self):
+        AuthenticationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, cluster=u'eu')
+
+        self.assertRaises(TypeError, lambda: AuthenticationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, cluster=4))
+
+    def test_host_behaviour(self):
+        conf = AuthenticationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True)
+        self.assertEqual(conf.host, u'api.pusherapp.com', u'default host should be correct')
+
+        conf = AuthenticationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, cluster=u'eu')
+        self.assertEqual(conf.host, u'api-eu.pusher.com', u'host should be overriden by cluster setting')
+
+        conf = AuthenticationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, host=u'foo')
+        self.assertEqual(conf.host, u'foo', u'host should be overriden by host setting')
+
+        conf = AuthenticationClient(app_id=u'4', key=u'key', secret=u'secret', ssl=True, cluster=u'eu', host=u'plah')
+        self.assertEqual(conf.host, u'plah', u'host should be used in preference to cluster')
+
     def test_authenticate_for_private_channels(self):
         authenticationClient = AuthenticationClient(
             key=u'foo', secret=u'bar', host=u'host', app_id=u'4', ssl=True)
@@ -36,13 +59,13 @@ def test_authenticate_for_private_channels(self):
     def test_authenticate_for_private_encrypted_channels(self):
         # The authentication client receives the decoded bytes of the key
         # not the base64 representation
-        master_key=b'8tW5FQLniQ1sBQFwrw7t6TVEsJZd10yY'
+        master_key=u'OHRXNUZRTG5pUTFzQlFGd3J3N3Q2VFZFc0paZDEweVk='
         authenticationClient = AuthenticationClient(
                 key=u'foo',
                 secret=u'bar',
                 host=u'host',
                 app_id=u'4',
-                encryption_master_key=master_key,
+                encryption_master_key_base64=master_key,
                 ssl=True)
 
         expected = {