Add fixes to user authentication and send a message to a specific one

Author: andersonrocha0

README.md

@@ -329,7 +329,9 @@ To authenticate users on Pusher Channels on your application, you can use the au
 |:-:|:-:|
 |response `Dict`   | A dictionary to send as a response to the authentication request.|
 
-For  more information see [authenticating users](https://pusher.com/docs/channels/server_api/authenticating-users/).
+For  more information see:
+* [authenticating users](https://pusher.com/docs/channels/server_api/authenticating-users/)
+* [auth-signatures](https://pusher.com/docs/channels/library_auth_reference/auth-signatures/)
 
 ##### Example
 

pusher/pusher.py

@@ -16,7 +16,7 @@
 from pusher.util import (
     ensure_text,
     pusher_url_re,
-    doc_string)
+    doc_string, validate_user_id)
 
 from pusher.pusher_client import PusherClient
 from pusher.authentication_client import AuthenticationClient
@@ -146,9 +146,11 @@ def trigger(self, channels, event_name, data, socket_id=None):
         return self._pusher_client.trigger(
             channels, event_name, data, socket_id)
 
-    @doc_string(PusherClient.send_to_user.__doc__)
+    @doc_string(PusherClient.trigger.__doc__)
     def send_to_user(self, user_id, event_name, data):
-        return self._pusher_client.send_to_user(user_id, event_name, data)
+        validate_user_id(user_id)
+        user_server_string = "#server-to-user-%s" % user_id
+        return self._pusher_client.trigger([user_server_string], event_name, data)
 
     @doc_string(PusherClient.trigger_batch.__doc__)
     def trigger_batch(self, batch=[], already_encoded=False):

pusher/pusher_client.py

@@ -114,13 +114,6 @@ def trigger(self, channels, event_name, data, socket_id=None):
 
         return Request(self, POST, "/apps/%s/events" % self.app_id, params)
 
-    def send_to_user(self, user_id, event_name, data):
-        """Send an event to a specific user
-        """
-        validate_user_id(user_id)
-        user_server_string = "#server-to-user-%s" % user_id
-        return self.trigger([user_server_string], event_name, data)
-
     @request_method
     def trigger_batch(self, batch=[], already_encoded=False):
         """Trigger multiple events with a single HTTP call.

pusher/util.py

@@ -11,9 +11,10 @@
 import six
 import sys
 import base64
+SERVER_TO_USER_PREFIX = "#server-to-user-"
 
 channel_name_re = re.compile(r'\A[-a-zA-Z0-9_=@,.;]+\Z')
-server_to_user_channel_re = re.compile(r'\A#server-to-user[-a-zA-Z0-9_=@,.;]+\Z')
+server_to_user_channel_re = re.compile(rf'\A{SERVER_TO_USER_PREFIX}[-a-zA-Z0-9_=@,.;]+\Z')
 app_id_re = re.compile(r'\A[0-9]+\Z')
 pusher_url_re = re.compile(r'\A(http|https)://(.*):(.*)@(.*)/apps/([0-9]+)\Z')
 socket_id_re = re.compile(r'\A\d+\.\d+\Z')
@@ -91,12 +92,10 @@ def validate_channel(channel):
     if len(channel) > 200:
         raise ValueError("Channel too long: %s" % channel)
 
-    if "server-to-user" in channel:
+    if channel.startswith(SERVER_TO_USER_PREFIX):
         if not server_to_user_channel_re.match(channel):
             raise ValueError("Invalid server to user Channel: %s" % channel)
-        return channel
-
-    if not channel_name_re.match(channel):
+    elif not channel_name_re.match(channel):
         raise ValueError("Invalid Channel: %s" % channel)
 
     return channel
@@ -116,6 +115,7 @@ def validate_user_data(user_data: dict):
         raise ValueError('user_data is null')
     if user_data.get('id') is None:
         raise ValueError('user_data has no id field')
+    validate_user_id(user_data.get('id'))
 
 
 def join_attributes(attributes):

pusher_tests/test_pusher_client.py

@@ -360,28 +360,6 @@ def test_terminate_user_connection_fail_case_invalid_user_id(self):
         with self.assertRaises(ValueError):
             self.pusher_client.terminate_user_connections("")
 
-    def test_send_to_user_success_case(self):
-        json_dumped = u'{"message": "hello worlds"}'
-        request_params = [u'#server-to-user-123'], u'some_event', {u'message': u'hello worlds'}
-
-        with mock.patch('json.dumps', return_value=json_dumped):
-            with mock.patch(
-                'pusher.pusher_client.PusherClient.trigger',
-                return_value=self.pusher_client.trigger.make_request(*request_params)
-            ) as mock_trigger:
-                request = self.pusher_client.send_to_user(
-                    u'123', u'some_event', {u'message': u'hello worlds'}
-                )
-
-                expected_params = {
-                    u'channels': [u'#server-to-user-123'],
-                    u'data': json_dumped,
-                    u'name': u'some_event'
-                }
-
-                self.assertEqual(request.params, expected_params)
-            mock_trigger.assert_called_with(*request_params)
-
 
 if __name__ == '__main__':
     unittest.main()

pusher_tests/test_util.py

@@ -16,10 +16,9 @@ def test_validate_user_id(self):
                 pusher.util.validate_user_id(user_id)
 
     def test_validate_channel(self):
-        valid_channels = ["123", "xyz", "xyz123", "xyz_123", "xyz-123", "Channel@123", "channel_xyz", "channel-xyz",
-                          "channel,456", "channel;asd", "-abc_ABC@012.xpto,987;654"]
+        valid_channels = ["123", "xyz", "xyz123", "xyz_123", "xyz-123", "Channel@123", "channel_xyz", "channel-xyz", "channel,456", "channel;asd", "-abc_ABC@012.xpto,987;654"]
 
-        invalid_channels = ["#123", "x" * 201, "abc%&*"]
+        invalid_channels = ["#123", "x" * 201, "abc%&*", "#server-to-user1234", "#server-to-users"]
 
         for channel in valid_channels:
             self.assertEqual(channel, pusher.util.validate_channel(channel))
@@ -29,14 +28,14 @@ def test_validate_channel(self):
                 pusher.util.validate_channel(invalid_channel)
 
     def test_validate_server_to_user_channel(self):
+        self.assertEqual("#server-to-user-123", pusher.util.validate_channel("#server-to-user-123"))
+        self.assertEqual("#server-to-user-user123", pusher.util.validate_channel("#server-to-user-user123"))
+        self.assertEqual("#server-to-user-ID-123", pusher.util.validate_channel("#server-to-user-ID-123"))
 
-        valid_server_to_user_channel = "#server-to-user-123"
-
-        invalid_server_to_user_channel = "#server-to-useR-123"
-
-        self.assertEqual(valid_server_to_user_channel, pusher.util.validate_channel(valid_server_to_user_channel))
         with self.assertRaises(ValueError):
-            pusher.util.validate_channel(invalid_server_to_user_channel)
+            pusher.util.validate_channel("#server-to-useR-123")
+            pusher.util.validate_channel("#server-to-user1234")
+            pusher.util.validate_channel("#server-to-users")
 
 
 if __name__ == '__main__':