Merge pull request #14 from PandaTechAM/development

Nuget updates

Author: HaikAsatryan

Readme.md

@@ -1,49 +1,34 @@
-# 1. PandaTech.Communicator
-
-- [1. EasyRateLimiter](#1-easyratelimiter)
-    - [1.1. Introduction](#11-introduction)
-    - [1.2. Installation](#12-installation)
-    - [1.3. Setup](#13-setup)
-        - [1.3.1. Program.cs Example](#131-programcs-example)
-            - [1.3.1.1. Using WebApplicationBuilder](#1311-using-webapplicationbuilder)
-            - [1.3.1.2. Using IServiceCollection](#1312-using-iservicecollection)
-        - [1.3.2. Appsettings.json Example](#132-appsettingsjson-example)
-    - [1.4. Configuration Options Explained](#14-configuration-options-explained)
-    - [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
+
+## Introduction
 
 **PandaTech.Communicator** is aimed to send Email and SMS messages to the clients of your service where you use this
 library.
 
-- **Email:** By given setup it's easy and fast to configure and setup Email providers for later use by different
-  channels.
-- **SMS:** By given setup it's easy and fast to configure and setup already integrated SMS providers for later use by
-  different channels.
-    - **Dexatel**
-    - **Twilio**
+-   **Email:** By given setup it's easy and fast to configure and setup Email providers for later use by different
+    channels.
+-   **SMS:** By given setup it's easy and fast to configure and setup already integrated SMS providers for later use by
+    different channels.
+    -   **Dexatel**
+    -   **Twilio**
 
 This package is ideal for efficient and reliable messaging in any application.
 
-## 1.2. Installation
+## Installation
 
 Install this NuGet library directly from the IDE package installer or by following command:
 
 `dotnet add package PandaTech.Communicator`
 
-## 1.3. Setup
+## Setup
 
 To incorporate PandaTech.Communicator into your project, you have 2 primary methods to setup in your `Program.cs`:
 
 The first method directly using `WebApplicationBuilder` from which `IConfiguration` is directly used. But for the second
 method builder is not accessible, so we pass `IConfiguration` into it as parameter.
 
-- `builder.AddCommunicator();`
-- `services.AddCommunicator(configuration);`
+-   `builder.AddCommunicator();`
+-   `services.AddCommunicator(configuration);`
 
 Configuration options can be specified either in `appsettings.json` or directly in `Program.cs`, with the latter taking
 precedence.
@@ -59,7 +44,7 @@ EmailChannels
     "MarketingSender",
     "SupportSender"
 };
-    
+
 SmsChannels
 {
     "GeneralSender",
@@ -73,11 +58,11 @@ SmsChannels
 For each channel can be setup same provider, but it's recommended to have different sender, as they are dedicated for
 different purposes.
 
-### 1.3.1. Program.cs Example
+### Program.cs Example
 
 In case of using SSL by setting UseSsl = true use port number 456, otherwise use 587 for non SSL connection.
 
-#### 1.3.1.1. Using `WebApplicationBuilder`
+#### Using `WebApplicationBuilder`
 
 ```csharp
 builder.AddCommunicator(options =>
@@ -143,7 +128,7 @@ builder.AddCommunicator(options =>
 
 ```
 
-#### 1.3.1.2. Using `IServiceCollection`
+#### Using `IServiceCollection`
 
 ```csharp
 services.AddCommunicator(configuration, options =>
@@ -209,77 +194,77 @@ services.AddCommunicator(configuration, options =>
 
 ```
 
-### 1.3.2. Appsettings.json Example
+### Appsettings.json Example
 
 ```json
 {
-  "Logging": {
-    "LogLevel": {
-      "Default": "Information",
-      "Microsoft.AspNetCore": "Warning"
-    }
-  },
-  "Communicator": {
-    "SmsFake": false,
-    "SmsConfigurations": {
-      "GeneralSender": {
-        "Provider": "Dexatel",
-        "From": "sender_name",
-        "Properties": {
-          "X-Dexatel-Key": "key"
-        },
-        "TimeoutMs": "10000"
-      },
-      "TransactionalSender": {
-        "Provider": "Twilio",
-        "From": "sender_number",
-        "Properties": {
-          "SID": "key",
-          "AUTH_TOKEN": "token"
-        },
-        "TimeoutMs": "10000"
-      }
+    "Logging": {
+        "LogLevel": {
+            "Default": "Information",
+            "Microsoft.AspNetCore": "Warning"
+        }
     },
-    "EmailFake": false,
-    "EmailConfigurations": {
-      "GeneralSender": {
-        "SmtpServer": "smtp.gmail.com",
-        "SmtpPort": 465, // 587
-        "SmtpUsername": "vazgen",
-        "SmtpPassword": "vazgen123",
-        "SenderEmail": "[email protected]",
-        "UseSsl": true, // false
-        "TimeoutMs": "10000"
-      },
-      "TransactionalSender": {
-        "SmtpServer": "smtp.gmail.com",
-        "SmtpPort": 465, // 587
-        "SmtpUsername": "vazgen",
-        "SmtpPassword": "vazgen123",
-        "SenderEmail": "[email protected]",
-        "UseSsl": true, // false
-        "TimeoutMs": "10000"
-      }
+    "Communicator": {
+        "SmsFake": false,
+        "SmsConfigurations": {
+            "GeneralSender": {
+                "Provider": "Dexatel",
+                "From": "sender_name",
+                "Properties": {
+                    "X-Dexatel-Key": "key"
+                },
+                "TimeoutMs": "10000"
+            },
+            "TransactionalSender": {
+                "Provider": "Twilio",
+                "From": "sender_number",
+                "Properties": {
+                    "SID": "key",
+                    "AUTH_TOKEN": "token"
+                },
+                "TimeoutMs": "10000"
+            }
+        },
+        "EmailFake": false,
+        "EmailConfigurations": {
+            "GeneralSender": {
+                "SmtpServer": "smtp.gmail.com",
+                "SmtpPort": 465, // 587
+                "SmtpUsername": "vazgen",
+                "SmtpPassword": "vazgen123",
+                "SenderEmail": "[email protected]",
+                "UseSsl": true, // false
+                "TimeoutMs": "10000"
+            },
+            "TransactionalSender": {
+                "SmtpServer": "smtp.gmail.com",
+                "SmtpPort": 465, // 587
+                "SmtpUsername": "vazgen",
+                "SmtpPassword": "vazgen123",
+                "SenderEmail": "[email protected]",
+                "UseSsl": true, // false
+                "TimeoutMs": "10000"
+            }
+        }
     }
-  }
 }
 ```
 
 The configuration options in `appsettings.json` and `program.cs` (priority) are identical.
 
-## 1.4. Configuration Options Explained
+## Configuration Options Explained
 
-- **Communicator:** Global settings for PandaTech.Communicator
-- **SmsFake:** This setup is for fake SMS service to be used which doesn't send real SMS messages and just return
-  `TTask.CompletedTask`.
-- **SmsConfigurations:** SMS configurations given by `appsettings.json` or via `builder.AddCommunicator()` options for
-  SMS.
-- **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.
+-   **Communicator:** Global settings for PandaTech.Communicator
+-   **SmsFake:** This setup is for fake SMS service to be used which doesn't send real SMS messages and just return
+    `TTask.CompletedTask`.
+-   **SmsConfigurations:** SMS configurations given by `appsettings.json` or via `builder.AddCommunicator()` options for
+    SMS.
+-   **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. Usage
+## 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.
@@ -314,8 +299,8 @@ Channel is set by `EmailChannels` or by `SmsChannels` classes with constant valu
 There are 2 interfaces `ISmsService` and `IEmailService` responsible for individual cases SMS or Email.
 Methods for sending SMS/Email messages are:
 
-- **SendAsync:**
-- **SendBulkAsync:**
+-   **SendAsync:**
+-   **SendBulkAsync:**
 
 The structure of the service interfaces are shown below.
 
@@ -333,7 +318,7 @@ public interface IEmailService
 }
 ```
 
-## 1.5.1. Send SMS message
+## Send SMS message
 
 ```csharp
 var sms = new SmsMessage
@@ -363,7 +348,7 @@ public class GeneralSmsResponse
 }
 ```
 
-## 1.5.2. Send Email message
+## Send Email message
 
 ```csharp
 var email = new EmailMessage
@@ -386,10 +371,10 @@ email providers, so you can create your ouw return type and map returned string
 2.0.0 OK 8ONXSST18NU4.DSCFVS8PQ0Q13@test AM0PR08MB5346.eurprd08.prod.outlook.com
 ```
 
-## 1.6. Limitations
+## Limitations
 
 PandaTech.Communicator works with all Email providers, but with only with existing integrations for SMS listed above.
 
-## 1.7. License
+## License
 
-PandaTech.Communicator is licensed under the MIT License.
+PandaTech.Communicator is licensed under the MIT License.

src/Communicator/Communicator.csproj

@@ -8,7 +8,7 @@
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
         <Authors>Pandatech</Authors>
         <Copyright>MIT</Copyright>
-        <Version>2.1.2</Version>
+        <Version>2.1.3</Version>
         <PackageId>Pandatech.Communicator</PackageId>
         <Title>SMS and Email Communication helper</Title>
         <PackageTags>Pandatech, library, Sms, Email, Messages</PackageTags>
@@ -23,10 +23,10 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="MailKit" Version="4.10.0" />
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.2" />
-        <PackageReference Include="MimeKit" Version="4.10.0" />
-        <PackageReference Include="Pandatech.RegexBox" Version="3.0.1" />
+        <PackageReference Include="MailKit" Version="4.12.1" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.5" />
+        <PackageReference Include="MimeKit" Version="4.12.0" />
+        <PackageReference Include="Pandatech.SharedKernel" Version="1.3.8" />
     </ItemGroup>
 
 </Project>

src/Communicator/Helpers/EmailMessageValidator.cs

@@ -1,5 +1,5 @@
 using Communicator.Models;
-using RegexBox;
+using SharedKernel.Helpers;
 
 namespace Communicator.Helpers;
 
@@ -12,17 +12,17 @@ internal static void Validate(EmailMessage emailMessage)
          throw new ArgumentException("At least one recipient is required", nameof(emailMessage.Recipients));
       }
 
-      if (emailMessage.Recipients.Any(email => !PandaValidator.IsEmail(email)))
+      if (emailMessage.Recipients.Any(email => !ValidationHelper.IsEmail(email)))
       {
          throw new ArgumentException("Invalid email address", nameof(emailMessage.Recipients));
       }
 
-      if (emailMessage.Cc.Count != 0 && emailMessage.Cc.Any(email => !PandaValidator.IsEmail(email)))
+      if (emailMessage.Cc.Count != 0 && emailMessage.Cc.Any(email => !ValidationHelper.IsEmail(email)))
       {
          throw new ArgumentException("Invalid email address", nameof(emailMessage.Cc));
       }
 
-      if (emailMessage.Bcc.Count != 0 && emailMessage.Bcc.Any(email => !PandaValidator.IsEmail(email)))
+      if (emailMessage.Bcc.Count != 0 && emailMessage.Bcc.Any(email => !ValidationHelper.IsEmail(email)))
       {
          throw new ArgumentException("Invalid email address", nameof(emailMessage.Bcc));
       }

src/Communicator/Helpers/SmsRecipients.cs

@@ -1,5 +1,5 @@
 using Communicator.Extensions;
-using RegexBox;
+using SharedKernel.Helpers;
 
 namespace Communicator.Helpers;
 
@@ -9,7 +9,7 @@ internal static class SmsRecipients
 
    internal static string Transform(this string recipient)
    {
-      if (PandaValidator.IsPandaFormattedPhoneNumber(recipient)
+      if (ValidationHelper.IsPandaFormattedPhoneNumber(recipient)
           || recipient.Any(c => CharsToCheck.Contains(c)))
       {
          recipient = recipient.RemovePhoneFormatParenthesesAndAdditionSign();
@@ -20,7 +20,7 @@ internal static string Transform(this string recipient)
 
    internal static List<string> Transform(this List<string> recipients)
    {
-      foreach (var recipient in recipients.Where(PandaValidator.IsPandaFormattedPhoneNumber))
+      foreach (var recipient in recipients.Where(ValidationHelper.IsPandaFormattedPhoneNumber))
       {
          recipient.RemovePhoneFormatParenthesesAndAdditionSign();
       }

test/Communicator.Demo/Communicator.Demo.csproj

@@ -8,8 +8,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.2" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="7.2.0" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.5" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="8.1.2" />
     </ItemGroup>
 
     <ItemGroup>

test/Communicator.Tests/Communicator.Tests.csproj

@@ -10,9 +10,9 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.0" />
         <PackageReference Include="xunit" Version="2.9.3" />
-        <PackageReference Include="xunit.runner.visualstudio" Version="3.0.2">
+        <PackageReference Include="xunit.runner.visualstudio" Version="3.1.0">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>