CMS.StdLib.Configuration 1.0.4

CMS.StdLib.Configuration is discontinued. Version 1.0.2 will be last component released.

CMS.StdLib.Configuration

A library that provides services that make it easy to send email and sms's, store application settings, abstracts aways directory location on the filesyste and provides for exception logging

Table of contents

1. Installation
2. Todo
3. Features Requests
4. Branches
5. Components
   • CMS.Core.Util.Services.EmailService
   • CMS.Core.Util.Services.ConfigurationManager
6. Features

Features

1. Provides a service to send email.
2. Provides a service that enables a application to store its application settings in MSSQL.

Installation

Install via CMS Nuget Service

Install-Package CMS.Core.Util.Service

To Install a specific version

Install-Package CMS.Core.Util.Service -Version <latest version numer>

Todo

• Currently the connection string is hard coded in the in EmailService class. Need to move the connection string to external store and provide an abstraction that will allow the connection string to be passed in.
• The CMS.Core.Util.ConfigurationManagerService needs to be refactored to reduce the amount of technical debt.
• The hard coding of the connection string in CMS.Core.Util.ConfigurationManagerService will need to be changed.

Features Requests

• Add feature to send sms's.
• Add feature to send a comma delimited list.
• Add feature to add attachmnents to the email being sent.
• Add feature that will enable customize of the Email Service to send emails using a different profile.
• Add feature that will enable Email Service to support more parameters. See EmailServiceFeature pull request
• Add browsable documentation for the each service.

Branches

CMS.Core.Util.Services has two branches, master and dev. Code changes are done on the dev branch and then merged into the master branch

The master branch has build policy that is triggered when there are any changes on the branch. The change will build code in the master branch and create and publish a nuget package in the CMS Nuget repository.

CMS.Core.Util.EmailService

Usage

CMS.Core.Util.EmailService Usage

The EmailService class implements a IDispose interface. So you can wrap it in a using statement, like this

using (var EmailServiceInstance = new EmailService())
{
    EmailServiceInstance.SendEmail(
      to: this._emailAddress,
      subject: "Test",
      message: "Testing");
}

CMS.Core.Util.Services.ConfigurationManagerService

The ConfigurationManagerService is a singleton. The component uses a fluent api to add, update and delete application settings.

How does it work?

The use the ConfigurationManagerService you need to add the application name, then the environments (dev, test, uat, production, etc.) the application will operate in and then the application settings for each environment.

Please note, the following:

• The application name must be unique
• The environment name for each application name must be unique
• The application setting key linked to a value must be unique
• Application settings deletions uses cascading delete. If Application info entry is deleted, then environment and application settings entries are deleted as well. If environment entry is deleted, its associated application settings are deleted as well, but the application info entry will still be present in the data store.

Usage

To add application settings for an application and for all application environments, do the following:

var environments = new List<string>();
environments.Add("Testing");
environments.Add("Staging");
environments.Add("Production");

var applicationName = $"Application Name";

ConfigurationManagerService.Instance
    .ForApplication(applicationName)
    .ForEachEnvironment(environments)
    .AddApplicationSettings("Test1","Value1")
    .Save();

To add a list of application settings for an application and for all application environments, do the following:

var environments = new List<string>();
environments.Add("Testing");
environments.Add("Staging");
environments.Add("Production");

var appSettings = new  Dictionary<string, string>();

for (int i = 1; i <= 1000; i++)
{
    appSettings.Add(key: $"Key{i}", value: $"Value{i}");
}

var applicationName = $"Application Name";

var applicationConfigExpectation = ConfigurationManagerService.Instance
    .ForApplication(applicationName)
    .ForEachEnvironment(environments)
    .AddApplicationSettings(appSettings)
    .Save();

To update application name and a specific environment name, do the following:

ConfigurationManagerService.Instance
    .ForApplication("Application Name")
    .ForEnvironment("Staging")
    .UpdateEnvironmentTo("Staging2")
    .Save();

To update application settings value with a key value of "Test1" for a specific application name and a environment name, to the following:

ConfigurationManagerService.Instance
    .ForApplication("Application Name")
    .ForEnvironment("Production")
    .ForApplicationSettingKey("Test1")
    .UpdateValueTo( "New-Value2") // will update "Value" to "New-Value2"
    .Save();

To delete an application settings with a key value of "Test1", for a specific application name and a environment name, to the following:

ConfigurationManagerService.Instance
    .ForApplication("Application Name")
    .ForEnvironment("Production")
    .ForApplicationSettings()
    .DeleteByKey("Test1")
    .Save();

To delete a environment "Production" for a specific application with the name "Application Name", do the following:

ConfigurationManagerService.Instance
    .ForApplication("Application Name")
    .ForEnvironment("Production")
    .DeleteEnvironment()
    .Save();

To delete an application with the name "Application Name", do the following:

ConfigurationManagerService.Instance
    .DeleteApplicationInfo("Application Name")
    .Save();

To get an application setting with a key value of "Test1", for a specific application name and a environment name, do the following:

var applicationSettingValue = ConfigurationManagerService.Instance
   .ForApplication("Application Name")
   .ForEnvironment("Production")
   .ForApplicationSettings()
   .GetValueByKey("Test1");

To fresh application settings before retrieving their value contents, do the following:

var result = ConfigurationManagerService.Instance
   .ForApplication("Application Name")
   .ForEnvironment("Production")
   .ForApplicationSettings()
   .RefreshApplicationSettings()
   .GetValueByKey("Test1");

To add application settings for different environments, for a specified application, do the following:

ConfigurationManagerService.Instance
   .ForApplication("Application Name")
   .ForEnvironment("UAT")
   .AddApplicationSettings("DbConnString", "Uat Db Conn String")
   .Save();

ConfigurationManagerService.Instance
   .ForApplication("Application Name")
   .ForEnvironment("Production")
   .AddApplicationSettings("DbConnString, "Production Db Conn String")
   .Save();