Refactoring with SMS/Email responses and more

Author: Ruben Bisharyan

Readme.md

@@ -7,8 +7,11 @@
     - [1.3.1. Program.cs Example](#131-programcs-example)
     - [1.3.2. Appsettings.json Example](#132-appsettingsjson-example)
   - [1.4. Configuration Options Explained](#14-configuration-options-explained)
-  - [1.5. Limitations](#15-limitations)
-  - [1.6. License](#16-license)
+  - [1.5. Usage](#15-usage)
+    - [1.5.1. Send SMS message](#151-send-sms-message)
+    - [1.5.2. Send Email message](#152-send-email-message)
+  - [1.6. Limitations](#16-limitations)
+  - [1.7. License](#17-license)
 
 ## 1.1. Introduction
 **PandaTech.Communicator** is aimed to send Email and SMS messages to the clients of your service where you use this library.
@@ -191,10 +194,109 @@ The configuration options in `appsettings.json` and `program.cs` (priority) are
 - **EmailFake:** This setup is for fake Email service to be used which doesn't send real SMS messages and just return `TTask.CompletedTask`.
 - **EmailConfigurations:** Email configurations given by `appsettings.json` or via `builder.AddCommunicator()` options for Email.
 
-## 1.5. Limitations
+## 1.5. Usage
+
+In order to use the library, you need to generate `SmsMessage` or `EmailMessage` and use one of the interfaces mentioned above for the service you need to use.
+
+Both of them support multiple recipients.
+
+The structure of the messages are shown below.
+
+```csharp
+public class SmsMessage
+{
+    public List<string> Recipients { get; set; } = null!;
+    public string Message { get; set; } = null!;
+    public string Channel { get; set; } = null!;
+}
+
+public class EmailMessage
+{
+    public List<string> Recipients { get; set; } = null!;
+    public string Subject { get; set; } = null!;
+    public string Body { get; set; } = null!;
+    public List<string> Cc { get; set; } = [];
+    public List<string> Bcc { get; set; } = [];
+    public List<EmailAttachment> Attachments { get; set; } = [];
+    public bool IsBodyHtml { get; set; } = false;
+    public string Channel { get; set; } = null!;
+}
+```
+
+Channel is set by `EmailChannels` or by `SmsChannels` classes with constant values.
+
+There are 2 interfaces `ISmsService` and `IEmailService` responsible for individual cases SMS or Email.
+Methods for sending SMS/Email messages are:
+  - **SendAsync:**
+  - **SendBulkAsync:**
+
+The structure of the service interfaces are shown below.
+
+```csharp
+public interface ISmsService
+{
+    Task<List<GeneralSmsResponse>> SendAsync(SmsMessage smsMessage, CancellationToken cancellationToken = default);
+    Task<List<GeneralSmsResponse>> SendBulkAsync(List<SmsMessage> smsMessageList, CancellationToken cancellationToken = default);
+}
+
+public interface IEmailService
+{
+    Task SendAsync(EmailMessage emailMessage, CancellationToken cancellationToken = default);
+    Task SendBulkAsync(List<EmailMessage> emailMessages, CancellationToken cancellationToken = default);
+}
+```
+
+## 1.5.1. Send SMS message
+
+```csharp
+var sms = new SmsMessage
+{
+    Recipients = ["+37493910593"],
+    Message = "123456",
+    Channel = SmsChannels.GeneralSender
+};
+await smsService.SendAsync(sms);
+```
+
+Sms service return as well response for each service individually (Not generic), which can be used in the code if you need to store related information into the Database.
+
+The responses are:
+- **DexatelSmsSendResponse**
+- **TwilioSmsSendResponse**
+
+Both responses return with list (ex. List<GeneralSmsResponse>) when you use any of the methods to send sms.
+
+```csharp
+public class GeneralSmsResponse
+{
+    public string From { get; set; } = null!;
+    public string To { get; set; } = null!;
+    public string OuterSmsId { get; set; } = null!;
+    public string Status { get; set; } = null!;
+    public DateTime CreateDate { get; set; }
+    public DateTime UpdateDate { get; set; }
+    public string Body { get; set; } = null!;
+}
+```
+
+## 1.5.2. Send Email message
+
+```csharp
+var email = new EmailMessage
+{
+    Recipients = ["[email protected]"],
+    Subject = "Some subject",
+    Body = "Some body",
+    IsBodyHtml = false,
+    Channel = EmailChannels.GeneralSender
+};
+await emailService.SendAsync(email);
+```
+
+## 1.6. Limitations
 
 PandaTech.Communicator works with all Email providers, but with only with existing integrations for SMS listed above.
 
-## 1.6. License
+## 1.7. License
 
 PandaTech.Communicator is licensed under the MIT License.

src/Communicator.Demo/Program.cs

@@ -1,4 +1,5 @@
 using Communicator.Demo.MessageTemplates;
+using Communicator.Enums;
 using Communicator.Extensions;
 using Communicator.Models;
 using Communicator.Options;
@@ -83,15 +84,15 @@
         Subject = "Some subject",
         Body = "Some body",
         IsBodyHtml = false,
-        Channel = "GeneralSender"
+        Channel = EmailChannels.GeneralSender
     };
     await emailService.SendAsync(email);
 
     var sms = new SmsMessage
     {
         Recipients = ["+37493910593"],
-        Message = SmsTemplates.OtpCodeVerificationRequestMessage("123456"),
-        Channel = "GeneralSender"
+        Message = "123456",
+        Channel = SmsChannels.GeneralSender
     };
     await smsService.SendAsync(sms);
     return Results.Ok("Email and SMS sent successfully.");
@@ -105,15 +106,15 @@
         Subject = "Some subject",
         Body = "Some body",
         IsBodyHtml = false,
-        Channel = "GeneralSender"
+        Channel = EmailChannels.GeneralSender
     };
     await emailService.SendAsync(email);
 
     var sms = new SmsMessage
     {
         Recipients = ["+37493910593", "+37493910593", "+37493910594", "+37493910595"],
         Message = "Barev erjankutyun",
-        Channel = "GeneralSender"
+        Channel = SmsChannels.GeneralSender
     };
     await smsService.SendAsync(sms);
     return Results.Ok("Email and SMS sent successfully.");
@@ -127,12 +128,26 @@
         Subject = "Some subject",
         Body = EmailTemplates.AddEmailAddressTemplate("Test", "Test", "https://www.google.com/"),
         IsBodyHtml = true,
-        Channel = "GeneralSender"
+        Channel = EmailChannels.GeneralSender
     };
     await emailService.SendAsync(email);
     return Results.Ok("Email sent successfully.");
 });
 
+app.MapGet("/send/email/html-body/with-response", async (IEmailService emailService) =>
+{
+    var email = new EmailMessage
+    {
+        Recipients = ["[email protected]"],
+        Subject = "Some subject",
+        Body = EmailTemplates.AddEmailAddressTemplate("Test", "Test", "https://www.google.com/"),
+        IsBodyHtml = true,
+        Channel = EmailChannels.GeneralSender
+    };
+    var response = await emailService.SendAsync(email);
+    return Results.Ok(response);
+});
+
 app.MapGet("/send/email/multiple-recipients/html-body", async (IEmailService emailService) =>
 {
     var email = new EmailMessage
@@ -141,7 +156,7 @@
         Subject = "Some subject",
         Body = EmailTemplates.AddEmailAddressTemplate("Test", "Test", "https://www.google.com/"),
         IsBodyHtml = true,
-        Channel = "GeneralSender"
+        Channel = EmailChannels.GeneralSender
     };
     await emailService.SendAsync(email);
     return Results.Ok("Email sent successfully.");
@@ -153,7 +168,7 @@
     {
         Recipients = ["+37493910593", "+37493910593", "+37493910594", "+37493910595"],
         Message = "Barev erjankutyun",
-        Channel = "GeneralSender"
+        Channel = SmsChannels.GeneralSender
     };
     await smsService.SendAsync(sms);
     return Results.Ok("SMS sent successfully.");
@@ -165,10 +180,47 @@
     {
         Recipients = ["+37495988247"],
         Message = "Barev erjankutyun",
-        Channel = "TransactionalSender"
+        Channel = SmsChannels.TransactionalSender
     };
     await smsService.SendAsync(sms);
     return Results.Ok("SMS sent successfully.");
 });
 
+app.MapGet("/send/bulk/email/html-body", async (IEmailService emailService) =>
+{
+    var emailMessageList = new List<EmailMessage>();
+    for (var i = 0; i < 5; i++)
+    {
+        var random = new Random();
+        emailMessageList.Add(new EmailMessage
+        {
+            Recipients = ["[email protected]", "[email protected]", "[email protected]", $"a{random.Next(1, 5)}@a.com"],
+            Subject = "Some subject",
+            Body = EmailTemplates.AddEmailAddressTemplate("Test", "Test", "https://www.google.com/"),
+            IsBodyHtml = true,
+            Channel = EmailChannels.GeneralSender
+        });
+    }
+
+    await emailService.SendBulkAsync(emailMessageList);
+    return Results.Ok("Emails sent successfully.");
+});
+
+app.MapGet("/send/bulk/sms/multiple-recipients", async (ISmsService smsService) =>
+{
+    var smsMessageList = new List<SmsMessage>();
+    for (var i = 1; i <= 5; i++)
+    {
+        smsMessageList.Add(new SmsMessage
+        {
+            Recipients = ["+37493910593", $"+3749391059{i}"],
+            Message = "Barev erjankutyun",
+            Channel = SmsChannels.GeneralSender
+        });
+    }
+
+    await smsService.SendBulkAsync(smsMessageList);
+    return Results.Ok("SMS messages sent successfully.");
+});
+
 app.Run();

src/Communicator/Enums/Channels.cs

@@ -1,22 +1,28 @@
+using System.Reflection;
+
 namespace Communicator.Enums;
 
 internal static class Channels
 {
-    internal static readonly List<string> EmailChannels = new()
+    internal static List<string> EmailChannels => GetEmailChannels();
+
+    internal static List<string> SmsChannels => GetSmsChannels();
+
+    private static List<string> GetEmailChannels()
     {
-        "GeneralSender",
-        "TransactionalSender",
-        "NotificationSender",
-        "MarketingSender",
-        "SupportSender"
-    };
+        var fields = typeof(EmailChannels).GetFields(BindingFlags.Public | BindingFlags.Static);
+        
+        return fields
+            .Where(field => field.FieldType == typeof(string))
+            .Select(field => (string)field.GetValue(null)!).ToList();
+    }
 
-    internal static readonly List<string> SmsChannels = new()
+    private static List<string> GetSmsChannels()
     {
-        "GeneralSender",
-        "TransactionalSender",
-        "NotificationSender",
-        "MarketingSender",
-        "SupportSender"
-    };
+        var fields = typeof(SmsChannels).GetFields(BindingFlags.Public | BindingFlags.Static);
+        
+        return fields
+            .Where(field => field.FieldType == typeof(string))
+            .Select(field => (string)field.GetValue(null)!).ToList();
+    }
 }

src/Communicator/Enums/EmailChannels.cs

@@ -0,0 +1,10 @@
+namespace Communicator.Enums;
+
+public static class EmailChannels
+{
+    public const string GeneralSender = "GeneralSender";
+    public const string TransactionalSender = "TransactionalSender";
+    public const string NotificationSender = "NotificationSender";
+    public const string MarketingSender = "MarketingSender";
+    public const string SupportSender = "SupportSender";
+}

src/Communicator/Enums/SmsChannels.cs

@@ -0,0 +1,10 @@
+namespace Communicator.Enums;
+
+public static class SmsChannels
+{
+    public const string GeneralSender = "GeneralSender";
+    public const string TransactionalSender = "TransactionalSender";
+    public const string NotificationSender = "NotificationSender";
+    public const string MarketingSender = "MarketingSender";
+    public const string SupportSender = "SupportSender";
+}

src/Communicator/Helpers/SmsMessageValidator.cs

@@ -10,11 +10,23 @@ internal static void Validate(SmsMessage smsMessage)
         {
             throw new ArgumentException("At least one recipient is required", nameof(smsMessage.Recipients));
         }
-
+        
         char[] charsToCheck = ['(', ')', ' '];
         if (smsMessage.Recipients.Any(number => number.Any(c => charsToCheck.Contains(c))))
         {
             throw new ArgumentException("Invalid phone number", nameof(smsMessage.Recipients));
         }
     }
+    
+    internal static SmsMessage ValidateAndTransform(SmsMessage smsMessage)
+    {
+        if (smsMessage.Recipients.Count == 0)
+        {
+            throw new ArgumentException("At least one recipient is required", nameof(smsMessage.Recipients));
+        }
+
+        smsMessage.Recipients = smsMessage.Recipients.Transform();
+
+        return smsMessage;
+    }
 }

src/Communicator/Helpers/SmsRecipients.cs

@@ -5,27 +5,27 @@ namespace Communicator.Helpers;
 
 internal static class SmsRecipients
 {
-    internal static string ValidateAndTransform(this string recipient)
-    {
-        return PandaValidator.IsPandaFormattedPhoneNumber(recipient)
-            ? recipient.RemovePhoneFormatParenthesesAndAdditionSign()
-            : recipient;
-    }
+    private static readonly char[] CharsToCheck = ['+', '(', ')', ' '];
 
-    internal static List<string> ValidateAndTransform(this List<string> recipients)
+    internal static string Transform(this string recipient)
     {
-        if (recipients.Count == 0)
+        if (PandaValidator.IsPandaFormattedPhoneNumber(recipient) 
+            || recipient.Any(c => CharsToCheck.Contains(c)))
         {
-            throw new ArgumentException("At least one recipient is required", nameof(recipients));
+            recipient = recipient.RemovePhoneFormatParenthesesAndAdditionSign();
         }
 
+        return recipient;
+    }
+
+    internal static List<string> Transform(this List<string> recipients)
+    {
         foreach (var recipient in recipients.Where(PandaValidator.IsPandaFormattedPhoneNumber))
         {
             recipient.RemovePhoneFormatParenthesesAndAdditionSign();
         }
 
-        char[] charsToCheck = ['+', '(', ')', ' '];
-        if (recipients.Any(x => x.Any(n => charsToCheck.Contains(n))))
+        if (recipients.Any(x => x.Any(n => CharsToCheck.Contains(n))))
         {
             recipients = recipients.RemovePhoneFormatParenthesesAndAdditionSign();
         }