ENT-4496: remove special characters from sender_alias (#140)

ecommerce_worker/email/v1/braze/client.py

@@ -331,11 +331,14 @@ def send_message(
                     "message": "success"
                 }
         """
+        # To avoid circular import
+        from ecommerce_worker.email.v1.utils import remove_special_characters_from_string
         if not email_ids or not subject or not body:
             raise BrazeClientError('Missing parameters for Braze email')
         self.create_braze_alias(email_ids)
         user_aliases = []
         external_ids = []
+        sender_alias = remove_special_characters_from_string(sender_alias)
         for email_id in email_ids:
             external_id = self.get_braze_external_id(email_id)
             if external_id:

ecommerce_worker/email/v1/tests/test_utils.py

@@ -7,7 +7,11 @@
 import responses
 from mock import patch
 
-from ecommerce_worker.email.v1.utils import did_email_bounce, update_assignment_email_status
+from ecommerce_worker.email.v1.utils import (
+    did_email_bounce,
+    remove_special_characters_from_string,
+    update_assignment_email_status,
+)
 from ecommerce_worker.utils import get_configuration
 
 
@@ -78,3 +82,17 @@ def test_did_email_bounce_routing(self, braze_enabled, braze_enabled_mock, braze
         braze_client_mock.return_value.did_email_bounce.return_value = True
         bounced = did_email_bounce('email', 'site_code')
         assert bounced == braze_enabled
+
+    @ddt.data(
+        ('', ''),
+        ('EdX Support Team', 'EdX Support Team'),
+        ('ABC Mills, Inc. on edX', 'ABC Mills Inc on edX'),
+        ('A&B Enterprise, inc.', 'AB Enterprise inc'),
+    )
+    @ddt.unpack
+    def test_remove_special_characters_from_string(self, input_string, expected):
+        """
+        Test that the utility returns string with all special characters removed.
+        """
+        actual_string = remove_special_characters_from_string(input_string)
+        self.assertEqual(actual_string, expected)

ecommerce_worker/email/v1/utils.py

@@ -1,4 +1,5 @@
 """ Utility functions. """
+import string
 
 from requests.exceptions import RequestException
 
@@ -43,3 +44,16 @@ def did_email_bounce(user_email, site_code=None) -> bool:
         return client.did_email_bounce(user_email)
 
     return False
+
+
+def remove_special_characters_from_string(input_string):  # pylint: disable=invalid-name
+    """
+    Removes all special characters from the string passed as argument.
+    string.punctuation contains the following characters:  '!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~'
+
+    Args:
+        input_string (str): Input string from which special characters need to be removed.
+    """
+    if input_string:
+        return input_string.translate(str.maketrans('', '', string.punctuation))
+    return ''

setup.py

@@ -37,7 +37,7 @@ def is_requirement(line):
 
 setup(
     name='edx-ecommerce-worker',
-    version='2.1.0',
+    version='2.1.1',
     description='Celery tasks supporting the operations of edX\'s ecommerce service',
     long_description=long_description,
     classifiers=[