Feature/add notification from core (#1)

* Add support for Core.Notification (#72)

* Change gitversion (#72)

* Fix the gitversion

* Remove Core naming from project (#72)

* More changes after removing Core in namespace

* Remove extension & circular ref issue

* Remove project

* Update README

* Fix the NuGet attributes to point to the correct repository

* C# version change

* Format change

* Review comment

Co-authored-by: Mohammad Moattar <[email protected]>

Author: davidcassell

README.md

@@ -1,32 +1,81 @@
-Library Name 
-============
+# Easify Extensions - Notification Services
 
+The project consist of several packages which facilitate sending notifications. It covers the following scenarios:
 ![Release](https://github.com/icgam/Easify.Extensions.Notifications/workflows/Release%20build%20on%20master/main/badge.svg) ![CI](https://github.com/icgam/Easify.Extensions.Notifications/workflows/CI%20on%20Branches%20and%20PRs/badge.svg)  ![](https://img.shields.io/nuget/v/Easify.Extensions.Notifications.Extensions.svg?style=flat-square)
 
-Brief description of the component or library.
+1. Rendering the output message content (Current support is for handle bars using https://github.com/Antaris/FuManchu library)
 
-## Get Started
+2. Sending messages to multiple audiences using Smtp protocol (It has been implemented using https://github.com/jstedfast/MailKit)
 
-Description of how to start working with library
+## Usage
 
-### How to use
+### Installation
 
-The usage of the library or link to the relevant wiki page need to be here.
+Using NuGet
 
-### How to Engage, Contribute, and Give Feedback
+```
+Install-Package Easify.Extensions.Notifications
+```
 
-Description of the steps or process to be a contributor to the project.
+Using dotnet cli
 
-Some of the best ways to contribute are to try things out, file issues, join in design conversations,
-and make pull-requests.
+```
+dotnet add package Easify.Extensions.Notifications
+```
 
-* [Be an active contributor](./docs/CONTRIBUTING.md): Check out the contributing page to see the best places to log issues and start discussions.
-* [Roadmap](./docs/ROADMAP.md): The schedule and milestone themes for project.
+### Configuration
 
-## Reporting bugs and useful features
+There is an extension which help to setup the service for IServiceCollection.
 
-Security issues and bugs should be reported by creating the relevant features and bugs in issues sections
+```csharp
+services.AddNotification(configuration)
+```
 
-## Related projects
+which is adding the following services to the DI container
 
-Include related projects 
+```csharp
+
+services.AddOptions().Configure<NotificationOptions>(configuration.GetSection(nameof(NotificationOptions)));
+services.AddOptions().Configure<SmtpOptions>(configuration.GetSection(nameof(SmtpOptions)));
+
+services.AddTransient<ITemplateProvider, FileBasedTemplateProvider>();
+services.AddTransient<IMessagingService, MailKitMessagingService>();
+services.AddTransient<ITemplateContentRenderer, HandleBarsTemplateContentRenderer>();
+services.AddTransient<ITemplateRenderer, TemplateRenderer>();
+services.AddTransient<INotificationService, NotificationService>();
+
+```
+
+You should notice every one of the services can be customize in order to implement something different.
+
+Also the following sections need to be added to the _appsettings.json_ file.
+
+```json
+"NotificationOptions": {
+    "Sender": "sender email address",
+    "Profiles": [
+        {
+            "ProfileName": "profile name",
+            "Audiences": [
+                {"Email": "email or distribution group name" }
+            ]
+        },
+    ],
+    "Templates": [
+        {
+            "Name": "template name",
+            "Path": "template default location relative to application"
+        },
+    ]
+},
+"SmtpOptions": {
+    "Server": "Smtp server name",
+    "LocalDomain": "ICGPLC",
+    "Port": "Optional. Default to 25"
+}
+
+```
+
+Then you can inject **INotificationService** to your classes to be able to send the email.
+
+**Note:** Use Relay Messaging so there is no setup to be made on application servers to support smtp. Also the sender can be a fake email address or even a descriptive email address.

src/Easify.Extensions.Notifications.Messaging.MailKit/Easify.Extensions.Notifications.Messaging.MailKit.csproj

@@ -0,0 +1,26 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <Description>MailKit implementation for Easify Notification Messaging</Description>
+        <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+        <Authors>Mohammad Moattar</Authors>
+        <Company>ICG</Company>
+        <PackageProjectUrl>https://github.com/icgam/Easify.Extensions.Notifications</PackageProjectUrl>
+        <RepositoryUrl>https://github.com/icgam/Easify.Extensions.Notifications</RepositoryUrl>
+        <GenerateAssemblyVersionAttribute>false</GenerateAssemblyVersionAttribute>
+        <Version>1.0.0</Version>
+        <LangVersion>8</LangVersion>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="MailKit" Version="2.10.0" />
+      <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="3.1.9" />
+      <PackageReference Include="Microsoft.Extensions.Options" Version="3.1.9" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Easify.Extensions.Notifications.Messaging\Easify.Extensions.Notifications.Messaging.csproj" />
+    </ItemGroup>
+
+</Project>

src/Easify.Extensions.Notifications.Messaging.MailKit/MailKitMessagingService.cs

@@ -0,0 +1,85 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using Easify.Extensions.Notifications.Messaging;
+using Easify.Extensions.Notifications.Messaging.Configuration;
+using Easify.Extensions.Notifications.Messaging.Exceptions;
+using MailKit.Net.Smtp;
+using MailKit.Security;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using MimeKit;
+
+// This software is part of the Easify framework
+// Copyright (C) 2019 Intermediate Capital Group
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Easify.Extensions.Notifications.Messaging.MailKit
+{
+    public sealed class MailKitMessagingService : IMessagingService
+    {
+        private readonly ILogger<MailKitMessagingService> _logger;
+        private readonly SmtpOptions _smtpOptions;
+
+        public MailKitMessagingService(IOptions<SmtpOptions> smtpOptionsAccessor, ILogger<MailKitMessagingService> logger)
+        {
+            _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+            _smtpOptions = smtpOptionsAccessor?.Value ?? throw new ArgumentNullException(nameof(smtpOptionsAccessor));
+        }
+
+        public async Task SendAsync(Message message)
+        {
+            if (message == null) throw new ArgumentNullException(nameof(message));
+
+            EnsureOptions();
+
+            var emailMessage = new MimeMessage();
+
+            emailMessage.From.Add(CreateAddress(message.Sender));
+            emailMessage.To.AddRange(message.Recipients.Select(CreateAddress).ToList());
+            emailMessage.Subject = message.Subject;
+            emailMessage.Body = new TextPart("html") {Text = message.Content};
+
+            await SendEmailMessageAsync(emailMessage);
+        }
+
+        private void EnsureOptions()
+        {
+            if (string.IsNullOrWhiteSpace(_smtpOptions.LocalDomain))
+                throw new SmtpOptionsException(nameof(_smtpOptions.LocalDomain));
+
+            if (string.IsNullOrWhiteSpace(_smtpOptions.Server))
+                throw new SmtpOptionsException(nameof(_smtpOptions.Server));
+        }
+
+        private async Task SendEmailMessageAsync(MimeMessage message)
+        {
+            using (var client = new SmtpClient())
+            {
+                client.LocalDomain = _smtpOptions.LocalDomain;
+                await client.ConnectAsync(_smtpOptions.Server, _smtpOptions.Port, SecureSocketOptions.None);
+                await client.SendAsync(message);
+                await client.DisconnectAsync(true);
+            }
+        }
+
+        private MailboxAddress CreateAddress(EmailAddress recipient)
+        {
+            if (recipient == null) throw new ArgumentNullException(nameof(recipient));
+
+            return new MailboxAddress(recipient.Name ?? recipient.Email, recipient.Email);
+        }
+    }
+}

src/Easify.Extensions.Notifications.Messaging/Configuration/NotificationAudience.cs

@@ -0,0 +1,23 @@
+// This software is part of the Easify framework
+// Copyright (C) 2019 Intermediate Capital Group
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Easify.Extensions.Notifications.Messaging.Configuration
+{
+    public sealed class NotificationAudience
+    {
+        public string Email { get; set; }
+    }
+}

src/Easify.Extensions.Notifications.Messaging/Configuration/NotificationOptions.cs

@@ -0,0 +1,25 @@
+// This software is part of the Easify framework
+// Copyright (C) 2019 Intermediate Capital Group
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Easify.Extensions.Notifications.Messaging.Configuration
+{
+    public sealed class NotificationOptions
+    {
+        public string Sender { get; set; }
+        public NotificationProfile[] Profiles { get; set; } = { };
+        public NotificationTemplate[] Templates { get; set; } = { };
+    }
+}

src/Easify.Extensions.Notifications.Messaging/Configuration/NotificationProfile.cs

@@ -0,0 +1,24 @@
+// This software is part of the Easify framework
+// Copyright (C) 2019 Intermediate Capital Group
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Easify.Extensions.Notifications.Messaging.Configuration
+{
+    public sealed class NotificationProfile
+    {
+        public string ProfileName { get; set; }
+        public NotificationAudience[] Audiences { get; set; }
+    }
+}

src/Easify.Extensions.Notifications.Messaging/Configuration/NotificationProfileNames.cs

@@ -0,0 +1,23 @@
+// This software is part of the Easify framework
+// Copyright (C) 2019 Intermediate Capital Group
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Easify.Extensions.Notifications.Messaging.Configuration
+{
+    public static class NotificationProfileNames
+    {
+        public const string DefaultProfile = "DefaultProfile";
+    }
+}

src/Easify.Extensions.Notifications.Messaging/Configuration/NotificationTemplate.cs

@@ -0,0 +1,24 @@
+// This software is part of the Easify framework
+// Copyright (C) 2019 Intermediate Capital Group
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Easify.Extensions.Notifications.Messaging.Configuration
+{
+    public class NotificationTemplate
+    {
+        public string Name { get; set; }
+        public string Path { get; set; }
+    }
+}

src/Easify.Extensions.Notifications.Messaging/Configuration/SmtpOptions.cs

@@ -0,0 +1,25 @@
+// This software is part of the Easify framework
+// Copyright (C) 2019 Intermediate Capital Group
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace Easify.Extensions.Notifications.Messaging.Configuration
+{
+    public sealed class SmtpOptions
+    {
+        public string Server { get; set; }
+        public int Port { get; set; } = 25;
+        public string LocalDomain { get; set; }
+    }
+}

src/Easify.Extensions.Notifications.Messaging/Configuration/Validators/NotificationAudienceValidator.cs

@@ -0,0 +1,28 @@
+// This software is part of the Easify framework
+// Copyright (C) 2019 Intermediate Capital Group
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// 
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+using FluentValidation;
+
+namespace Easify.Extensions.Notifications.Messaging.Configuration.Validators
+{
+    public class NotificationAudienceValidator : AbstractValidator<NotificationAudience>
+    {
+        public NotificationAudienceValidator()
+        {
+            RuleFor(m => m.Email).NotEmpty().EmailAddress();
+        }
+    }
+}