v3.20

Author: Kolappan Nathan

CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.2.0] - 2019-05-09
+### Added
+ - Documentation for encryption helper
+
+### Changed
+ - Renamed CSV Logger
+ - Optimised code in helpersLib
+
 ## [3.1.0] - 2019-05-08
 ### Changed
  - Added sub classes to helper

src/WebApiBolierplate/Business.Lib/Core/Base.cs

@@ -10,13 +10,13 @@ public class Base
 
         public DBAdapter dBAdapter;
         public Helpers helper;
-        public Logger logger;
+        public CsvLogger csvLogger;
 
         #endregion [Declarations]
 
         public Base()
         {
-            logger = new Logger(Config.Logger.DateFormat, Config.Logger.FileName);
+            csvLogger = new CsvLogger(Config.Logger.DateFormat, Config.Logger.FileName);
             helper = new Helpers();
 
             // uncomment this line when there is a valid connection string

src/WebApiBolierplate/Business.Lib/HelperLib.cs

@@ -8,53 +8,29 @@ public class HelperLib :  Base
     {
         #region [Security]
 
-        public string HashBCrypt(string plainText)
-        {
-            return helper.Hash.HashBCrypt(plainText);
-        }
-
-        public bool VerifyBCrypt(string plainText, string hash)
-        {
-            return helper.Hash.VerifyBCrypt(plainText, hash);
-        }
-
-        public string EncryptString(string clearText)
-        {
-            return helper.Encryption.EncryptString(clearText);
-        }
-
-        public string DecryptString(string cipherText)
-        {
-            return helper.Encryption.DecryptString(cipherText);
-        }
+        public string HashBCrypt(string plainText) => helper.Hash.HashBCrypt(plainText);
+
+        public bool VerifyBCrypt(string plainText, string hash) => helper.Hash.VerifyBCrypt(plainText, hash);
+
+        public string EncryptString(string clearText) => helper.Encryption.EncryptString(clearText);
+
+        public string DecryptString(string cipherText) => helper.Encryption.DecryptString(cipherText);
 
         #endregion [Security]
 
         #region [Utilities]
 
-        public int GenRandomNumber(int min, int max)
-        {
-            return helper.Rando.GenRandomNumber(min, max);
-        }
+        public int GenRandomNumber(int min, int max) => helper.Rando.GenRandomNumber(min, max);
 
-        public string GenRandomChar(int length)
-        {
-            return helper.Rando.GenRandomChar(length, CharSet.AlphaNumeric);
-        }
+        public string GenRandomChar(int length) => helper.Rando.GenRandomChar(length, CharSet.AlphaNumeric);
 
         #endregion [Utilities]
 
         #region [Compression]
 
-        public string CompressToGzipString(string plaintText)
-        {
-            return helper.GZip.CompressToString(plaintText, Encoding.UTF8);
-        }
+        public string CompressToGzipString(string plaintText) => helper.GZip.CompressToString(plaintText, Encoding.UTF8);
 
-        public string DecompressGzipString(string compressedString)
-        {
-            return helper.GZip.DecompressString(compressedString, Encoding.UTF8);
-        }
+        public string DecompressGzipString(string compressedString) => helper.GZip.DecompressString(compressedString, Encoding.UTF8);
 
         #endregion [Compression]
     }

src/WebApiBolierplate/Business.Lib/UserLib.cs

@@ -43,7 +43,7 @@ public int ValidateLogin(LoginDTO login)
             }
             catch (Exception ex)
             {
-                logger.Error(ex);
+                csvLogger.Error(ex);
                 return -1;
             }
         }
@@ -64,7 +64,7 @@ public User GetUser(string userName)
             }
             catch (Exception ex)
             {
-                logger.Error(ex);
+                csvLogger.Error(ex);
                 return null;
             }
         }

src/WebApiBolierplate/Core.Lib/Logger.cs renamed to src/WebApiBolierplate/Core.Lib/CsvLogger.cs

@@ -2,7 +2,7 @@
 
 namespace Core.Lib
 {
-    public class Logger
+    public class CsvLogger
     {
         #region [Declarations]
 
@@ -17,7 +17,7 @@ public class Logger
         /// <param name="fileName">Name of the log file. Without extension</param>
         /// <param name="relativePath">Relative path from Base directory.</param>
         /// <param name="replacementValue">Value to replace comma (,) with. Uses semicolon by default.</param>
-        public Logger(string dateFormat, string fileName, string relativePath = "", char replacementValue = ';')
+        public CsvLogger(string dateFormat, string fileName, string relativePath = "", char replacementValue = ';')
         {
             csvLogger = new nk.logger.csv.Logger(dateFormat, fileName, relativePath, replacementValue);
         }

src/WebApiBolierplate/Core.Lib/Security/EncryptionHelper.cs

@@ -29,6 +29,9 @@ private void BuildAesEncryptor()
             aesEncryptor.IV = pdb.GetBytes(16);
         }
 
+        /// <summary>
+        /// Encrypts the given string and return ciphertext
+        /// </summary>
         public string EncryptString(string clearText)
         {
             BuildAesEncryptor();
@@ -44,6 +47,9 @@ public string EncryptString(string clearText)
             }
         }
 
+        /// <summary>
+        /// Decrypts the given string and returns plain text
+        /// </summary>
         public string DecryptString(string cipherText)
         {
             BuildAesEncryptor();