Merge pull request #55 from socketlabs/usr/matt.soler/threading-issue

Usr/matt.soler/threading issue

Author: msoler8785

Example Projects/dotNetCoreExample/Examples/Basic/BasicComplexExample.cs

@@ -51,11 +51,7 @@ public SendResponse RunExample()
             var metadata = new List<IMetadata>()
             {
                 new Metadata("example-type", "basic-send-complex"),
-                new Metadata()
-                {
-                    Key = "message-contains",
-                    Value = "attachments, headers"
-                }
+                new Metadata("message-contains","attachments, headers")
             };
             message.Metadata.Add(metadata);
             message.Metadata.Add("x-mycustommetadata", "I am custom metadata");

Example Projects/dotNetCoreExample/Examples/Bulk/BulkSendComplexExample.cs

@@ -45,11 +45,7 @@ public SendResponse RunExample()
             var metadata = new List<IMetadata>()
             {
                 new Metadata("example-type", "bulk-send-complex"),
-                new Metadata()
-                {
-                    Key = "message-contains",
-                    Value = "attachments, headers"
-                }
+                new Metadata("message-contains","attachments, headers")
             };
             message.Metadata.Add(metadata);
             message.Metadata.Add("x-mycustommetadata", "I am custom metadata");

README.md

@@ -21,9 +21,9 @@ The SocketLabs Email Delivery C# library allows you to easily send email message
 # Prerequisites and Installation
 ## Prerequisites
 * A supported .NET version
-  * .NET version 4.5 or higher
-  * .NET Core 1.0 or higher
-  * .NET Standard 1.3 or higher
+  * .NET Framework version 4.8 or higher
+  * .NET 8.0 or higher
+  * .NET Standard 2.0 or higher
 * A SocketLabs account. If you don't have one yet, you can [sign up for a free account](https://signup.socketlabs.com/step-1?plan=free) to get started.
 
 ## Installation
@@ -36,7 +36,7 @@ PM> Install-Package SocketLabs.EmailDelivery
 Adding a Package Reference to your project:
 
 ```
-<PackageReference Include="SocketLabs.EmailDelivery" Version="1.4.3" />
+<PackageReference Include="SocketLabs.EmailDelivery" Version="2.0.0" />
 ```
 
 .NET CLI users can also use the following command:

docs/release-notes/2.0.0.md

@@ -0,0 +1,10 @@
+## 2.0.0
+
+* Fix issue with ApiKey being unset for bearer type keys
+* Add explicit support for .NET 8.0 and .NET 9.0
+* Update dependencies
+* Implement nullable pattern
+
+```note
+This is a breaking change. Some objects require constructor initialization now.
+```

src/SocketLabs/InjectionApi/AddressResult.cs

@@ -8,7 +8,7 @@ public class AddressResult
         /// <summary>
         /// The recipient's email address.
         /// </summary>
-        public string EmailAddress { get; set; }
+        public string? EmailAddress { get; set; }
 
         /// <summary>
         /// Whether the recipient was accepted for delivery.
@@ -18,7 +18,7 @@ public class AddressResult
         /// <summary>
         /// An error code detailing why the recipient was not accepted.
         /// </summary>
-        public string ErrorCode { get; set; }
+        public string? ErrorCode { get; set; }
 
         /// <summary>
         /// Represents the <c>AddressResult</c> as a string.  Useful for debugging.

src/SocketLabs/InjectionApi/Core/ApiKeyParser.cs

@@ -5,7 +5,7 @@ namespace SocketLabs.InjectionApi.Core
     /// <summary>
     /// Parses a provided api key and provides a result
     /// </summary>
-    public class ApiKeyParser : IApiKeyParser
+    internal class ApiKeyParser : IApiKeyParser
     {
         /// <summary>
         /// Parses the provided Api key.

src/SocketLabs/InjectionApi/Core/IApiKeyParser.cs

@@ -2,7 +2,7 @@
 
 namespace SocketLabs.InjectionApi.Core
 {
-    public interface IApiKeyParser
+    internal interface IApiKeyParser
     {
         ApiKeyParseResult Parse(string wholeApiKey);
     }

src/SocketLabs/InjectionApi/Core/InjectionRequestFactory.cs

@@ -12,14 +12,14 @@ namespace SocketLabs.InjectionApi.Core
     internal class InjectionRequestFactory : IInjectionRequestFactory
     {
         private readonly int _serverId;
-        private readonly string _apiKey;
+        private readonly string? _apiKey;
 
         /// <summary>
         /// Creates a new instance of the <c>InjectionRequestFactory</c>.
         /// </summary>
         /// <param name="serverId">Your SocketLabs ServerId number.</param>
-        /// <param name="apiKey">Your SocketLabs Injection API key.</param>
-        public InjectionRequestFactory(int serverId, string apiKey)
+        /// <param name="apiKey">Your SocketLabs Injection API key. Set to null if using Bearer token.</param>
+        public InjectionRequestFactory(int serverId, string? apiKey)
         {
             _serverId = serverId;
             _apiKey = apiKey;
@@ -41,7 +41,7 @@ public InjectionRequest GenerateRequest(IBasicMessage message)
 
             request.Messages.Add(jsonMsg);
 
-            if (message.ReplyTo != null)
+            if (message.ReplyTo?.Email is not null)
                 jsonMsg.ReplyTo = new AddressJson(message.ReplyTo.Email, message.ReplyTo.FriendlyName);
 
             return request;
@@ -63,10 +63,13 @@ public InjectionRequest GenerateRequest(IBulkMessage message)
 
             // handle merge data per recipient for message 
             var mergeDataForEmail = GetBulkMergeFields(message.To);
-            jsonMsg.MergeData.PerMessage = mergeDataForEmail;
+            jsonMsg.MergeData = new()
+            {
+                PerMessage = mergeDataForEmail,
 
-            // handle global (per message) merge data
-            jsonMsg.MergeData.Global = PopulateMergeData(message.GlobalMergeData);
+                // handle global (per message) merge data
+                Global = PopulateMergeData(message.GlobalMergeData)
+            };
 
             request.Messages.Add(jsonMsg);
 
@@ -90,18 +93,19 @@ internal virtual MessageJson GenerateBaseMessageJson(IMessageBase message)
                 MailingId = message.MailingId,
                 MessageId = message.MessageId,
                 CharSet = message.CharSet,
-                CustomHeaders = PopulateCustomHeaders(message.CustomHeaders),
-                From = new AddressJson(message.From.Email, message.From.FriendlyName),
+                CustomHeaders = PopulateCustomHeaders(message.CustomHeaders),              
                 Attachments = PopulateList(message.Attachments),
                 Metadata = PopulateMetadata(message.Metadata),
                 Tags = PopulateTags(message.Tags)
             };
+            if (message.From?.Email is not null)
+                jsonMsg.From = new AddressJson(message.From.Email, message.From.FriendlyName);
 
-            if (message.ReplyTo != null)
+            if (message.ReplyTo?.Email is not null)
                 jsonMsg.ReplyTo = new AddressJson(message.ReplyTo.Email, message.ReplyTo.FriendlyName);
 
             if (message.ApiTemplate.HasValue)
-                jsonMsg.ApiTemplate = message.ApiTemplate.ToString();
+                jsonMsg.ApiTemplate = message.ApiTemplate?.ToString();
 
             return jsonMsg;
         }
@@ -113,9 +117,6 @@ internal virtual MessageJson GenerateBaseMessageJson(IMessageBase message)
         /// <returns>A <c><![CDATA[ List<AttachmentJson> ]]></c> used in generating an InjectionRequest</returns>
         internal virtual List<AttachmentJson> PopulateList(IEnumerable<IAttachment> attachments)
         {
-            if (attachments == null)
-                return null;
-
             var results = new List<AttachmentJson>();
 
             foreach (var attachment in attachments)
@@ -140,8 +141,8 @@ internal virtual List<AttachmentJson> PopulateList(IEnumerable<IAttachment> atta
         /// <returns>A <c><![CDATA[ List<CustomHeadersJson> ]]></c> used in generating an InjectionRequest</returns>
         internal virtual List<CustomHeadersJson> PopulateCustomHeaders(IList<ICustomHeader> customHeaders)
         {
-            var result = customHeaders?.Select(item => new CustomHeadersJson(item.Name, item.Value));
-            return result?.ToList();
+            var result = customHeaders.Select(item => new CustomHeadersJson(item.Name, item.Value));
+            return result.ToList();
         }
 
         /// <summary>
@@ -151,33 +152,37 @@ internal virtual List<CustomHeadersJson> PopulateCustomHeaders(IList<ICustomHead
         /// <returns>A <c><![CDATA[ List<AddressJson> ]]></c> used in generating an InjectionRequest</returns>
         internal virtual List<AddressJson> PopulateList(IEnumerable<IEmailAddress> recipients)
         {
-            var result = recipients?.Select(item => new AddressJson(item.Email, item.FriendlyName));
-            return result?.ToList();
+            var result = recipients.Where(x => x.Email is not null)
+                .Select(item => new AddressJson(item.Email!, item.FriendlyName));
+
+            return result.ToList();
         }
 
         /// <summary>
         /// Converting a <c><![CDATA[ IEnumerable<IBulkRecipient> ]]></c> to a <c><![CDATA[ List<List<MergeFieldJson>> ]]></c>
         /// </summary>
         /// <param name="recipients">A <c><![CDATA[ IEnumerable<IBulkRecipient> ]]></c> from the message</param>
         /// <returns>A <c><![CDATA[ List<List<MergeFieldJson>> ]]></c> used in generating an InjectionRequest</returns>
-        internal virtual List<List<MergeFieldJson>> GetBulkMergeFields(IEnumerable<IBulkRecipient> recipients)
+        internal virtual List<List<MergeFieldJson>> GetBulkMergeFields(IEnumerable<IBulkRecipient>? recipients)
         {
             var result = new List<List<MergeFieldJson>>();
-
-            //each recipient get's their own list of merge fields
-            foreach (var recipient in recipients)
+            if (recipients is not null) 
             {
-                // Get any merge data associated with the Recipients and put it in the MergeData section
-                var recipientMergeFields = recipient.MergeData?.Select(mergeField => new MergeFieldJson(mergeField.Key, mergeField.Value)).ToList() ??
-                                                 new List<MergeFieldJson>();
+                //each recipient get's their own list of merge fields
+                foreach (var recipient in recipients)
+                {
+                    // Get any merge data associated with the Recipients and put it in the MergeData section
+                    var recipientMergeFields = recipient.MergeData?.Select(mergeField => new MergeFieldJson(mergeField.Key, mergeField.Value)).ToList() ??
+                                                     new List<MergeFieldJson>();
 
-                recipientMergeFields.Add(new MergeFieldJson("DeliveryAddress", recipient.Email));
+                    recipientMergeFields.Add(new MergeFieldJson("DeliveryAddress", recipient.Email));
 
-                //don't include friendly name if it hasn't been provided
-                if (!string.IsNullOrWhiteSpace(recipient.FriendlyName))
-                    recipientMergeFields.Add(new MergeFieldJson("RecipientName", recipient.FriendlyName));
+                    //don't include friendly name if it hasn't been provided
+                    if (!string.IsNullOrWhiteSpace(recipient.FriendlyName))
+                        recipientMergeFields.Add(new MergeFieldJson("RecipientName", recipient.FriendlyName!));
 
-                result.Add(recipientMergeFields);
+                    result.Add(recipientMergeFields);
+                }        
             }
 
             return result;
@@ -191,8 +196,8 @@ internal virtual List<List<MergeFieldJson>> GetBulkMergeFields(IEnumerable<IBulk
         internal virtual List<MergeFieldJson> PopulateMergeData(IDictionary<string, string> mergeData)
         {
 
-            var result = mergeData?.Select(item => new MergeFieldJson(item.Key, item.Value));
-            return result?.ToList();
+            var result = mergeData.Select(item => new MergeFieldJson(item.Key, item.Value));
+            return result.ToList();
         }
 
 
@@ -203,8 +208,8 @@ internal virtual List<MergeFieldJson> PopulateMergeData(IDictionary<string, stri
         /// <returns>A <c><![CDATA[ List<MetadataHeaderJson> ]]></c> used in generating an InjectionRequest</returns>
         internal virtual List<MetadataHeaderJson> PopulateMetadata(IList<IMetadata> metadata)
         {
-            var result = metadata?.Select(item => new MetadataHeaderJson(item.Key, item.Value));
-            return result?.ToList();
+            var result = metadata.Select(item => new MetadataHeaderJson(item.Key, item.Value));
+            return result.ToList();
         }
 
         /// <summary>
@@ -215,7 +220,7 @@ internal virtual List<MetadataHeaderJson> PopulateMetadata(IList<IMetadata> meta
         internal virtual List<string> PopulateTags(IList<string> tags)
         {
             var result = tags.ToList();
-            return result?.ToList();
+            return result;
         }
     }
 }

src/SocketLabs/InjectionApi/Core/InjectionResponseParser.cs

@@ -23,6 +23,14 @@ public SendResponse Parse(HttpResponseMessage httpResponse)
 
             var injectionResponse = JsonConvert.DeserializeObject<InjectionResponseDto>(contentString);
 
+            if (injectionResponse is null)
+            {
+                return new SendResponse()
+                {
+                    Result = SendResult.UnknownError
+                };
+            }
+
             var resultEnum = DetermineSendResult(injectionResponse, httpResponse);
             var newResponse = new SendResponse
             {

src/SocketLabs/InjectionApi/Core/SendValidator.cs

@@ -290,7 +290,7 @@ internal virtual List<AddressResult> HasInvalidRecipients(IBulkMessage message)
         /// <returns>A <c><![CDATA[ List<AddressResult> ]]></c> if an invalid email address is found.</returns>
         /// <see cref="IEmailAddress"/>
         /// <see cref="AddressResult"/>
-        internal virtual List<AddressResult> FindInvalidRecipients(IList<IEmailAddress> recipients)
+        internal virtual List<AddressResult>? FindInvalidRecipients(IList<IEmailAddress>? recipients)
         {
             var invalid = recipients?.Where(item => !item.IsValid).Select(x => new AddressResult()
             {
@@ -312,7 +312,7 @@ internal virtual List<AddressResult> FindInvalidRecipients(IList<IEmailAddress>
         /// <returns>A <c><![CDATA[ List<AddressResult> ]]></c> if an invalid email address is found.</returns>
         /// <see cref="IBulkRecipient"/>
         /// <see cref="AddressResult"/>
-        internal virtual List<AddressResult> FindInvalidRecipients(IList<IBulkRecipient> recipients)
+        internal virtual List<AddressResult>? FindInvalidRecipients(IList<IBulkRecipient> recipients)
         {
             var invalid = recipients?.Where(item => !item.IsValid).Select(x => new AddressResult()
             {