Merge pull request #5 from IowaComputerGurus/feature/changes

mitchelsellers · web-flow · commit 551e314dc776 · 2021-10-02T23:36:07.000-05:00
Creation of initial 2.x release
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # ICG.NetCore.Utilities.Email.SendGrid ![](https://img.shields.io/github/license/iowacomputergurus/netcore.utilities.email.SendGrid.svg)
 This library provides an easy to use implementation of SendGrid based email delivery.  This abstraction with proper interfaces allows email implementation inside of your project with little effort and easy to manage integration, and boasts features such as automatic environment name appending as well as robust email templates.
 
-This package depends on the ICG.NetCore.Utilities.Email project for template implementation 
+This package depends on the ICG.NetCore.Utilities.Email project for template implementation
 
 ## Build Status
 
@@ -48,6 +48,7 @@ Additionally you must specify the needed configuration elements within your AppS
 ```
   "SendGridServiceOptions": {
     "AdminEmail": "test@test.com",
+    "AdminName": "John Smith",
     "SendGridApiKey": "YourKey",
     "AdditionalApiKeys": { "SpecialSender": "SpecialKey" }
     "AlwaysTemplateEmails": true,
@@ -63,6 +64,7 @@ Additionally you must specify the needed configuration elements within your AppS
 | Setting | Description |
 | --- | --- |
 | AdminEmail | This is the email address used as the "from" address and also for any usage of the "SendToAdministrator" option |
+| AdminName | If specified this is the name that will be used for the "From" address on all outbound emails |
 | SendGridApiKey | The API Key to use for default sending of email addresses |
 | AdditionalApiKeys | These are name/value pairs of additional API keys that could be used for sending emails.  Totally optional |
 | AlwaysTemplateEmails | If selected ALL emails sent will be templated, by default using the "DefaultTemplate" as configured |
@@ -73,7 +75,7 @@ Additionally you must specify the needed configuration elements within your AppS
 
 ### Usage
 
-Usage is primarly completed by injecting the ISmtpService interface to your respective project, one injected emails can be sent with a single line of code. 
+Usage is primarly completed by injecting the IEmailService interface to your respective project, one injected emails can be sent with a single line of code. 
 
 ```
 _sendGridService.SendEmail("recipient@me.com", "My Subject", "<p>Hello!</p>");
diff --git a/src/NetCore.Utilities.Email.SendGrid.Tests/NetCore.Utilities.Email..SendGrid.Tests.csproj b/src/NetCore.Utilities.Email.SendGrid.Tests/NetCore.Utilities.Email..SendGrid.Tests.csproj
@@ -10,8 +10,8 @@
     <PackageReference Include="Microsoft.AspNetCore.Hosting.Abstractions" Version="2.2.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="5.0.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
-    <PackageReference Include="Moq" Version="4.16.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
+    <PackageReference Include="Moq" Version="4.16.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <PrivateAssets>all</PrivateAssets>
diff --git a/src/NetCore.Utilities.Email.SendGrid.Tests/SmtpServiceTests.cs b/src/NetCore.Utilities.Email.SendGrid.Tests/SmtpServiceTests.cs
@@ -11,14 +11,15 @@ public class SendGridServiceTests
         private readonly SendGridServiceOptions _options = new SendGridServiceOptions()
         {
             AdminEmail = "admin@test.com",
+            AdminName = "John Smith",
             SendGridApiKey = "APIKEY",
             AddEnvironmentSuffix = false,
             AlwaysTemplateEmails = false
         };
 
         private readonly Mock<ISendGridMessageBuilder> _sendGridMessageBuilderMock;
         private readonly Mock<ISendGridSender> _sendGridSenderMock;
-        private readonly ISendGridService _service;
+        private readonly IEmailService _service;
 
         public SendGridServiceTests()
         {
@@ -54,6 +55,32 @@ public void AdminEmail_ShouldReturnNullWhenNoConfiguration()
             Assert.Null(result);
         }
 
+        [Fact]
+        public void AdminName_ShouldReturnConfigurationName()
+        {
+            //Arrange
+            var expectedName = "John Smith";
+
+            //Act
+            var result = _service.AdminName;
+
+            //Assert
+            Assert.Equal(expectedName, result);
+        }
+
+        [Fact]
+        public void AdminName_ShouldReturnNullWhenNoConfiguration()
+        {
+            //Arrange
+            var testService = new SendGridService(new OptionsWrapper<SendGridServiceOptions>(null), _sendGridMessageBuilderMock.Object, _sendGridSenderMock.Object);
+
+            //Act
+            var result = testService.AdminName;
+
+            //Assert
+            Assert.Null(result);
+        }
+
         [Fact]
         public void SendToAdministrator_ShouldSend_DefaultingFromAndToAddress()
         {
@@ -122,7 +149,7 @@ public void SendMessageWithAttachment_ShouldSend_DefaultingFromAddress()
             var message = "message";
 
             //Act
-            _service.SendMessageWithAttachment(to, cc, subject, fileContent, fileName, message);
+            _service.SendMessageWithAttachment(to, cc, subject, fileContent, fileName, message, null);
 
             //Assets
         }
@@ -138,7 +165,7 @@ public void SendMessage_ShouldPassOptionalTemplateName_ToMessageMethods()
             var requestedTemplate = "Test";
 
             //Act
-            _service.SendMessage(to, cc, subject, message, requestedTemplate);
+            _service.SendMessage(to, cc, subject, message, null, requestedTemplate);
 
             //Assets
         }
@@ -156,7 +183,7 @@ public void SendMessageWithAttachment_ShouldPassOptionalTemplateName_ToMessageMe
             var requestedTemplate = "Test";
 
             //Act
-            _service.SendMessageWithAttachment(to, cc, subject, fileContent, fileName, message, requestedTemplate);
+            _service.SendMessageWithAttachment(to, cc, subject, fileContent, fileName, message, null, requestedTemplate);
 
             //Assets
         }
diff --git a/src/NetCore.Utilities.Email.SendGrid.Tests/StartupExtensiosTests.cs b/src/NetCore.Utilities.Email.SendGrid.Tests/StartupExtensiosTests.cs
@@ -53,7 +53,7 @@ public void ServiceCollection_ShouldRegisterSendGridService()
             var services = collection.BuildServiceProvider();
 
             //Act
-            var result = services.GetService<ISendGridService>();
+            var result = services.GetService<IEmailService>();
 
             //Assert
             Assert.NotNull(result);
diff --git a/src/NetCore.Utilities.Email.SendGrid.Tests/appsettings.json b/src/NetCore.Utilities.Email.SendGrid.Tests/appsettings.json
@@ -1,6 +1,7 @@
 {
   "SendGridServiceOptions": {
     "AdminEmail": "test@test.com",
+    "AdminName": "John Smith", 
     "SendGridApiKey": "TestKey",
     "AdditionalApiKeys": { "SpecialSender": "SpecialKey" },
     "AlwaysTemplateEmails": true,
diff --git a/src/NetCore.Utilities.Email.SendGrid/DependencyResolution/StartupExtensions.cs b/src/NetCore.Utilities.Email.SendGrid/DependencyResolution/StartupExtensions.cs
@@ -1,4 +1,5 @@
-﻿using ICG.NetCore.Utilities.Email.SendGrid;
+﻿using ICG.NetCore.Utilities.Email;
+using ICG.NetCore.Utilities.Email.SendGrid;
 using Microsoft.Extensions.Configuration;
 
 namespace Microsoft.Extensions.DependencyInjection
@@ -19,7 +20,7 @@ public static void UseIcgNetCoreUtilitiesEmailSendGrid(this IServiceCollection s
             services.UseIcgNetCoreUtilitiesEmail(configuration);
 
             //Bind additional services
-            services.AddTransient<ISendGridService, SendGridService>();
+            services.AddTransient<IEmailService, SendGridService>();
             services.AddTransient<ISendGridMessageBuilder, SendGridMessageBuilder>();
             services.AddTransient<ISendGridSender, SendGridSender>();
             services.Configure<SendGridServiceOptions>(configuration.GetSection(nameof(SendGridServiceOptions)));
diff --git a/src/NetCore.Utilities.Email.SendGrid/NetCore.Utilities.Email.SendGrid.csproj b/src/NetCore.Utilities.Email.SendGrid/NetCore.Utilities.Email.SendGrid.csproj
@@ -33,17 +33,17 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="icg.netcore.utilities.email" Version="3.0.4" />
+    <PackageReference Include="icg.netcore.utilities.email" Version="4.0.4" />
     <PackageReference Include="Microsoft.AspNetCore.Hosting.Abstractions" Version="2.2.0" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="5.0.1" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="5.0.2" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="5.0.0" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="SendGrid" Version="9.24.0" />
+    <PackageReference Include="SendGrid" Version="9.24.3" />
   </ItemGroup>
 
 </Project>
diff --git a/src/NetCore.Utilities.Email.SendGrid/SendGridMessageBuilder.cs b/src/NetCore.Utilities.Email.SendGrid/SendGridMessageBuilder.cs
@@ -13,41 +13,33 @@ namespace ICG.NetCore.Utilities.Email.SendGrid
     /// </summary>
     public interface ISendGridMessageBuilder
     {
-        /// <summary>
-        /// Creates a simple message for sending
-        /// </summary>
-        /// <param name="from">Who the message is from</param>
-        /// <param name="to">Who the message is to</param>
-        /// <param name="subject">The subject of the message</param>
-        /// <param name="bodyHtml">The Email's HTML content</param>
-        /// <returns></returns>
-        SendGridMessage CreateMessage(string from, string to, string subject, string bodyHtml);
-
         /// <summary>
         /// Creates a simple message for sending with a custom template
         /// </summary>
         /// <param name="from">Who the message is from</param>
+        /// <param name="fromName">The name of the sender</param>
         /// <param name="to">Who the message is to</param>
         /// <param name="cc">An optional listing of CC addresses</param>
         /// <param name="subject">The subject of the message</param>
         /// <param name="bodyHtml">The Email's HTML content</param>
         /// <param name="templateName">The name of the template to use</param>
         /// <returns></returns>
-        SendGridMessage CreateMessage(string from, string to, IEnumerable<string> cc, string subject, string bodyHtml,
+        SendGridMessage CreateMessage(string from, string fromName, string to, IEnumerable<string> cc, string subject, string bodyHtml,
             string templateName = "");
 
         /// <summary>
         /// Creates a simple message for sending with a custom template and attachment
         /// </summary>
         /// <param name="from">Who the message is from</param>
+        /// <param name="fromName">The name of the sender</param>
         /// <param name="to">Who the message is to</param>
         /// <param name="cc">An optional listing of CC addresses</param>
         /// <param name="fileContent">The content of the attachment in bytes</param>
         /// <param name="fileName">The desired name for the file attachment</param>
         /// <param name="subject">The subject of the message</param>
         /// <param name="bodyHtml">The Email's HTML content</param>
         /// <param name="templateName">The name of the template to use</param>
-        SendGridMessage CreateMessageWithAttachment(string from, string to, IEnumerable<string> cc,
+        SendGridMessage CreateMessageWithAttachment(string from, string fromName, string to, IEnumerable<string> cc,
             byte[] fileContent, string fileName, string subject, string bodyHtml, string templateName = "");
     }
 
@@ -65,7 +57,7 @@ public class SendGridMessageBuilder : ISendGridMessageBuilder
         /// <param name="hostingEnvironment"></param>
         /// <param name="emailTemplateFactory"></param>
         /// <param name="options"></param>
-        /// <param name="loggerFactory"></param>
+        /// <param name="logger"></param>
         public SendGridMessageBuilder(IHostingEnvironment hostingEnvironment, IEmailTemplateFactory emailTemplateFactory, 
             IOptions<SendGridServiceOptions> options, ILogger<SendGridMessageBuilder> logger)
         {
@@ -74,15 +66,9 @@ public SendGridMessageBuilder(IHostingEnvironment hostingEnvironment, IEmailTemp
             _serviceOptions = options.Value;
             _logger = logger;
         }
-
+        
         /// <inheritdoc />
-        public SendGridMessage CreateMessage(string from, string to, string subject, string bodyHtml)
-        {
-            return CreateMessage(from, to, null, subject, bodyHtml);
-        }
-
-        /// <inheritdoc />
-        public SendGridMessage CreateMessage(string from, string to, IEnumerable<string> cc, string subject, string bodyHtml, string templateName = "")
+        public SendGridMessage CreateMessage(string from, string fromName, string to, IEnumerable<string> cc, string subject, string bodyHtml, string templateName = "")
         {
             //Validate inputs
             if (string.IsNullOrEmpty(from))
@@ -96,6 +82,8 @@ public SendGridMessage CreateMessage(string from, string to, IEnumerable<string>
 
             //Get addresses
             var fromAddress = new EmailAddress(from);
+            if (!string.IsNullOrEmpty(fromName))
+                fromAddress.Name = fromName;
             var recipients = new List<EmailAddress> {new EmailAddress(to)};
             if (cc != null)
             {
@@ -134,11 +122,12 @@ public SendGridMessage CreateMessage(string from, string to, IEnumerable<string>
                 bodyHtml);
         }
 
-        public SendGridMessage CreateMessageWithAttachment(string from, string to, IEnumerable<string> cc,
+        /// <inheritdoc />
+        public SendGridMessage CreateMessageWithAttachment(string from, string fromName, string to, IEnumerable<string> cc,
             byte[] fileContent, string fileName, string subject, string bodyHtml, string templateName = "")
         {
             //Build the  basic message
-            var toSend = CreateMessage(from, to, cc, subject, bodyHtml, templateName);
+            var toSend = CreateMessage(from, fromName, to, cc, subject, bodyHtml, templateName);
 
             //Attach file
             toSend.Attachments = new List<Attachment>
diff --git a/src/NetCore.Utilities.Email.SendGrid/SendGridService.cs b/src/NetCore.Utilities.Email.SendGrid/SendGridService.cs
diff --git a/src/NetCore.Utilities.Email.SendGrid/SendGridServiceOptions.cs b/src/NetCore.Utilities.Email.SendGrid/SendGridServiceOptions.cs

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"SendGridServiceOptions": {`
`3`	`3`	`"AdminEmail": "[email protected]",`
	`4`	`+ "AdminName": "John Smith",`
`4`	`5`	`"SendGridApiKey": "TestKey",`
`5`	`6`	`"AdditionalApiKeys": { "SpecialSender": "SpecialKey" },`
`6`	`7`	`"AlwaysTemplateEmails": true,`