added empty message exception and custom phone number formatting

Author: Amar Khanshali

src/notify_mi/helper.py

@@ -17,6 +17,7 @@
 AT_SYMBOL = "@"
 EMAIL_SUFFIX = ".com"
 MB = 1000000
+PHONE_NUMBER_LENGTH = 10
 
 # exceptions
 class FileSizeExceeded(Exception):
@@ -37,19 +38,19 @@ def __str__(self):
 
 class EmailFormatError(Exception):
     def __str__(self):
-        return "The receiver email should follow the following format -> name@email.com."
+        return "The receiver email should follow the following format -> email@gmail.com."
 
 class MessageError(Exception):
     def __str__(self):
         return "Message type not specified. Pick text, email, or both and include the respective parameters."
 
 class MessageTextError(Exception):
     def __str__(self):
-        return "Phone number AND phone provider is required for sending a text message."
+        return "Phone number AND phone provider are required for sending a text message."
 
-class MessageEmailError(Exception):
+class MessageFieldError(Exception):
     def __str__(self):
-        return "Receiver's email is required to send a message."
+        return "Interesting...trying to send a message without a message."
 
 # decorator to automatically launch a function in a thread
 def threaded(func):
@@ -60,6 +61,12 @@ def wrapper(*args, **kwargs):
         return thread
     return wrapper
 
+
+# remove all non-digit characters from phone number
+def filter_phone_number(phone_number):
+    # filter requires a function, wrap phone number in type function
+    return ''.join(filter(type(phone_number).isdigit, phone_number))
+
 extensions_and_mime_types = [
     (".aac", "audio/aac"),    
     (".abw", "application/x-abiword"),    

src/notify_mi/notify.py

@@ -56,7 +56,7 @@ def __send_message_via_email(
     file_attachment = None):
 
     # ensure that credentials and info added meets specifications
-    __check_for_exceptions(phone_number, phone_provider, send_to)
+    __check_for_exceptions(message, phone_number, phone_provider, send_to)
 
     # initialize variables needed
     _phone_number: str = phone_number
@@ -86,7 +86,7 @@ def __send_message_via_email(
             if PROVIDERS.get(_phone_provider).get(helper.MMS_SUPPORT_KEY) \
             else helper.MESSAGE_TYPE[1]
         # create receiver email based on their phone number and carrier
-        receiver_phone_number = f'{_phone_number}@{PROVIDERS.get(_phone_provider).get(message_type)}'
+        receiver_phone_number = f'{helper.filter_phone_number(_phone_number)}@{PROVIDERS.get(_phone_provider).get(message_type)}'
 
     # create gmail body
     email_message = MIMEMultipart()
@@ -126,7 +126,10 @@ def __send_message_via_email(
             email.sendmail(sender_email, send_to, email_message.as_string())
 
 
-def __check_for_exceptions(phone_number, phone_provider, send_to): 
+def __check_for_exceptions(message, phone_number, phone_provider, send_to): 
+    # check is message is empty
+    if message is None or message is helper.EMPTY:
+        raise helper.MessageFieldError
     # check if at least one message type is being sent
     # check if all paramters is empty
     if None in [phone_number, phone_provider]:
@@ -143,9 +146,8 @@ def __check_for_exceptions(phone_number, phone_provider, send_to):
             if helper.AT_SYMBOL not in send_to or helper.EMAIL_SUFFIX not in send_to:
                 raise helper.EmailFormatError
         # verify phone number is formatted correctly
-        if len(phone_number) != 10 or not phone_number.isdigit():
+        if len(helper.filter_phone_number(phone_number)) != helper.PHONE_NUMBER_LENGTH:
             raise helper.PhoneNumberError
         # verify provider given is found in providers.py
         if PROVIDERS.get(phone_provider) is None:
             raise helper.ProviderNotRecognized
-