Add delete_user method

Author: jonathanlloyd

pusher_push_notifications/__init__.py

@@ -339,12 +339,12 @@ def authenticate_user(self, user_id):
             auth token for the requested user id (string)
 
         Raises:
-            ValueError: if user_id is not a string
+            TypeError: if user_id is not a string
             ValueError: is user_id is longer than the maximum of 164 chars
 
         """
         if not isinstance(user_id, six.string_types):
-            raise ValueError('user_id must be a string')
+            raise TypeError('user_id must be a string')
         if len(user_id) > USER_ID_MAX_LENGTH:
             raise ValueError('user_id longer than the maximum of 164 chars')
 
@@ -363,3 +363,42 @@ def authenticate_user(self, user_id):
             self.secret_key,
             algorithm='HS256',
         ).decode('utf-8')
+
+    def delete_user(self, user_id):
+        """Remove the user with the given ID (and all of their devices) from
+        the Pusher Beams database. The user will no longer receive any
+        notifications. This action cannot be undone.
+
+        Args:
+            user_id (string): id of the user to be deleted
+
+        Returns:
+            None
+
+        Raises:
+            TypeError: if user_id is not a string
+            ValueError: is user_id is longer than the maximum of 164 chars
+
+        """
+        if not isinstance(user_id, six.string_types):
+            raise TypeError('user_id must be a string')
+        if len(user_id) > USER_ID_MAX_LENGTH:
+            raise ValueError('user_id longer than the maximum of 164 chars')
+
+        session = requests.Session()
+        request = requests.Request(
+            'DELETE',
+            'https://{}/user_api/v1/instances/{}/users/{}'.format(
+                self.endpoint,
+                self.instance_id,
+                user_id,
+            ),
+            headers={
+                'host': self.endpoint,
+                'authorization': 'Bearer {}'.format(self.secret_key),
+                'x-pusher-library': 'pusher-push-notifications-python {}'.format(
+                    SDK_VERSION,
+                )
+            },
+        )
+        session.send(request.prepare())

tests/test_users.py

@@ -50,7 +50,7 @@ def test_authenticate_user_should_fail_if_user_id_not_a_string(self):
             'INSTANCE_ID',
             'SECRET_KEY'
         )
-        with self.assertRaises(ValueError) as e:
+        with self.assertRaises(TypeError) as e:
             pn_client.authenticate_user(user_id)
         self.assertIn('user_id must be a string', str(e.exception))
 
@@ -419,3 +419,58 @@ def test_publish_to_users_should_handle_not_json_success(self):
                     },
                 )
             self.assertIn('The server returned a malformed response', str(e.exception))
+
+    def test_delete_user_should_make_correct_http_request(self):
+        pn_client = PushNotifications(
+            'INSTANCE_ID',
+            'SECRET_KEY'
+        )
+        with requests_mock.Mocker() as http_mock:
+            http_mock.register_uri(
+                requests_mock.ANY,
+                requests_mock.ANY,
+                status_code=200,
+                json='',
+            )
+            pn_client.delete_user('alice')
+            req = http_mock.request_history[0]
+
+        method = req.method
+        path = req.path
+        headers = dict(req._request.headers.lower_items())
+
+        self.assertEqual(
+            method,
+            'DELETE',
+        )
+        self.assertEqual(
+            path,
+            '/user_api/v1/instances/instance_id/users/alice',
+        )
+        self.assertDictEqual(
+            headers,
+            {
+                'content-length': '0',
+                'authorization': 'Bearer SECRET_KEY',
+                'x-pusher-library': 'pusher-push-notifications-python 1.0.1',
+                'host': 'instance_id.pushnotifications.pusher.com',
+            },
+        )
+
+    def test_delete_user_should_fail_if_user_id_not_a_string(self):
+        pn_client = PushNotifications(
+            'INSTANCE_ID',
+            'SECRET_KEY'
+        )
+        with self.assertRaises(TypeError) as e:
+            pn_client.delete_user(False)
+        self.assertIn('user_id must be a string', str(e.exception))
+
+    def test_delete_user_should_fail_if_user_id_too_long(self):
+        pn_client = PushNotifications(
+            'INSTANCE_ID',
+            'SECRET_KEY'
+        )
+        with self.assertRaises(ValueError) as e:
+            pn_client.delete_user('A'*165)
+        self.assertIn('longer than the maximum of 164 chars', str(e.exception))