Merge branch 'main' of https://github.com/bvdcode/EasyExtensions

Author: bvdcode

Sources/EasyExtensions.AspNetCore.Authorization/Controllers/BaseAuthController.cs

@@ -31,6 +31,31 @@ public abstract class BaseAuthController(
         /// </summary>
         public IPAddress RequestIP => IPAddress.Parse(Request.GetRemoteAddress());
 
+        /// <summary>
+        /// Logs out the current user by revoking the refresh token and removing the authentication cookie.
+        /// </summary>
+        /// <remarks>This endpoint supports GET, POST, and DELETE HTTP methods. If a refresh token cookie
+        /// is present, it is revoked and deleted. If no refresh token is found, the operation completes without
+        /// error.</remarks>
+        /// <returns>An <see cref="IActionResult"/> indicating the result of the logout operation. Returns a success message if
+        /// the user was logged out.</returns>
+        [HttpGet("logout")]
+        [HttpPost("logout")]
+        [HttpDelete("logout")]
+        public async Task<IActionResult> Logout([FromQuery] string? token = "")
+        {
+            if (Request.Cookies.TryGetValue(CookieRefreshTokenName, out string? refreshToken))
+            {
+                await RevokeRefreshTokenAsync(refreshToken);
+                Response.Cookies.Delete(CookieRefreshTokenName);
+            }
+            if (!string.IsNullOrWhiteSpace(token))
+            {
+                await RevokeRefreshTokenAsync(token);
+            }
+            return Ok("Logged out successfully");
+        }
+
         /// <summary>
         /// Changes the password for the currently authenticated user.
         /// </summary>
@@ -248,6 +273,15 @@ public async Task<IActionResult> LoginWithGoogle([FromQuery] string token)
         /// <returns>A task that represents the asynchronous operation.</returns>
         public abstract Task SaveAndRevokeRefreshTokenAsync(Guid userId, string oldRefreshToken, string newRefreshToken, AuthType authType);
 
+        /// <summary>
+        /// Revokes the specified refresh token, invalidating it for future use.
+        /// </summary>
+        /// <remarks>After revocation, the specified refresh token can no longer be used to obtain new
+        /// access tokens. This method is typically used to log out a user or to respond to a security event.</remarks>
+        /// <param name="refreshToken">The refresh token to revoke. Cannot be null or empty.</param>
+        /// <returns>A task that represents the asynchronous revoke operation.</returns>
+        public abstract Task RevokeRefreshTokenAsync(string refreshToken);
+
         /// <summary>
         /// Asynchronously retrieves the unique identifier of a user associated with the specified refresh token.
         /// </summary>

Sources/EasyExtensions.AspNetCore.Sentry/Factories/UserFactory.cs

@@ -23,6 +23,10 @@ public class UserFactory(IHttpContextAccessor httpContextAccessor) : ISentryUser
                 return null;
             }
             var context = httpContextAccessor.HttpContext;
+            if (context.User?.Identity == null || !context.User.Identity.IsAuthenticated)
+            {
+                return null;
+            }
             var claims = httpContextAccessor.HttpContext.User.Claims;
             int userId = httpContextAccessor.HttpContext.User.TryGetId();
             bool hasUserId = httpContextAccessor.HttpContext.User.TryGetUserId(out Guid guidUserId);

Sources/EasyExtensions.EntityFrameworkCore.Npgsql/Database/BasePostgresUser.cs

@@ -0,0 +1,116 @@
+using EasyExtensions.EntityFrameworkCore.Abstractions;
+using EasyExtensions.Models.Enums;
+using Microsoft.EntityFrameworkCore;
+using System.ComponentModel.DataAnnotations.Schema;
+using System.Text;
+
+namespace EasyExtensions.EntityFrameworkCore.Npgsql.Database
+{
+    /// <summary>
+    /// Represents a base user account with identity, contact, and profile information.
+    /// </summary>
+    /// <remarks>This class provides common user properties for authentication, authorization, and
+    /// personalization scenarios. It is intended to be used as a base type for user entities in applications that
+    /// require user management. The class enforces unique email addresses and supports user preferences, permissions,
+    /// and role-based access control.</remarks>
+    [Table("users")]
+    [Index(nameof(Email), IsUnique = true)]
+    public class BasePostgresUser : BaseEntity<Guid>
+    {
+        /// <summary>
+        /// Gets the full name, consisting of the first and last name combined with a space.
+        /// </summary>
+        [NotMapped]
+        public string FullName => GetFullName();
+
+        private string GetFullName()
+        {
+            var sb = new StringBuilder();
+            sb.Append(FirstName);
+            if (!string.IsNullOrWhiteSpace(MiddleName))
+            {
+                sb.Append(' ').Append(MiddleName);
+            }
+            sb.Append(' ').Append(LastName);
+            return sb.ToString().Trim();
+        }
+
+        /// <summary>
+        /// Gets or sets the first name of the person.
+        /// </summary>
+        [Column("first_name", TypeName = "citext")]
+        public string FirstName { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the middle name of the person.
+        /// </summary>
+        [Column("middle_name", TypeName = "citext")]
+        public string? MiddleName { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the last name of the person.
+        /// </summary>
+        [Column("last_name", TypeName = "citext")]
+        public string LastName { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the avatar image data in WebP format.
+        /// </summary>
+        [Column("avatar_webp_bytes")]
+        public byte[]? AvatarWebPBytes { get; set; }
+
+        /// <summary>
+        /// Gets or sets the email address associated with the entity.
+        /// </summary>
+        [Column("email", TypeName = "citext")]
+        public string Email { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the phone number associated with the entity.
+        /// </summary>
+        [Column("phone_number")]
+        public long? PhoneNumber { get; set; }
+
+        /// <summary>
+        /// Gets or sets the collection of user preferences as key-value pairs.
+        /// </summary>
+        /// <remarks>Each entry in the dictionary represents a user preference, where the key is the
+        /// preference name and the value is its corresponding setting. Preference names and values are case-sensitive.
+        /// Modifying this collection updates the user's stored preferences.</remarks>
+        [Column("preferences")]
+        public Dictionary<string, string> Preferences { get; set; } = [];
+
+        /// <summary>
+        /// Gets or sets the collection of permissions assigned to the entity.
+        /// </summary>
+        [Column("permissions")]
+        public ICollection<string> Permissions { get; set; } = [];
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the entity is active.
+        /// </summary>
+        [Column("is_active")]
+        public bool IsActive { get; set; } = true;
+
+        /// <summary>
+        /// Gets or sets the password hash in PHC (Password Hashing Competition) string format.
+        /// </summary>
+        /// <remarks>The value is typically a string produced by a password hashing algorithm that follows
+        /// the PHC string format, which includes information about the algorithm, parameters, salt, and hash. This
+        /// property may be null if no password is set.</remarks>
+        [Column("password_phc")]
+        public string? PasswordPhc { get; set; }
+
+        /// <summary>
+        /// Gets or sets the role assigned to the user.
+        /// </summary>
+        [Column("role")]
+        public UserRole Role { get; set; }
+
+        /// <summary>
+        /// Gets or sets the token used to authorize a password reset request for the user.
+        /// </summary>
+        [Column("reset_password_token", TypeName = "citext")]
+        public string? ResetPasswordToken { get; set; }
+    }
+}

Sources/EasyExtensions.EntityFrameworkCore.Npgsql/EasyExtensions.EntityFrameworkCore.Npgsql.csproj

@@ -34,6 +34,7 @@
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
 	</ItemGroup>
 	<ItemGroup>
+	  <ProjectReference Include="..\EasyExtensions.EntityFrameworkCore\EasyExtensions.EntityFrameworkCore.csproj" />
 	  <ProjectReference Include="..\EasyExtensions\EasyExtensions.csproj" />
 	</ItemGroup>
 </Project>

Sources/EasyExtensions.EntityFrameworkCore.Npgsql/Providers/PostgresConnectionStringProvider.cs

@@ -2,9 +2,6 @@
 using EasyExtensions.EntityFrameworkCore.Npgsql.Builders;
 using Microsoft.Extensions.Configuration;
 using Npgsql;
-using System;
-using System.Collections.Generic;
-using System.Text;
 
 namespace EasyExtensions.EntityFrameworkCore.Npgsql.Providers
 {

Sources/EasyExtensions/Extensions/EnumExtensions.cs

@@ -0,0 +1,38 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace EasyExtensions.Extensions
+{
+    /// <summary>
+    /// Provides extension methods for working with enumeration (enum) values.
+    /// </summary>
+    /// <remarks>This static class contains utility methods that extend the functionality of enum types,
+    /// enabling more convenient or user-friendly operations when working with enumerations.</remarks>
+    public static class EnumExtensions
+    {
+        /// <summary>
+        /// Converts the value of the specified enumeration to a user-friendly string with spaces inserted before
+        /// uppercase letters.
+        /// </summary>
+        /// <remarks>This method is useful for displaying enumeration values in a more readable format,
+        /// such as in user interfaces or logs. For example, an enum value named "OrderStatusPendingApproval" would be
+        /// converted to "Order Status Pending Approval".</remarks>
+        /// <param name="e">The enumeration value to convert to a nicely formatted string.</param>
+        /// <returns>A string representation of the enumeration value with spaces inserted before uppercase letters. Returns the
+        /// enumeration name as-is if no formatting is needed.</returns>
+        public static string ToNiceString(this Enum e)
+        {
+            string enumString = e.ToString();
+            IEnumerable<char> chars = enumString.SelectMany((c, i) =>
+            {
+                if (i > 0 && char.IsUpper(c))
+                {
+                    return new char[] { ' ', c };
+                }
+                return new[] { c };
+            });
+            return new string(chars.ToArray());
+        }
+    }
+}

Sources/EasyExtensions/Models/Dto/BaseUserDto.cs

@@ -0,0 +1,40 @@
+using EasyExtensions.Models.Enums;
+using System;
+
+namespace EasyExtensions.Models.Dto
+{
+    /// <summary>
+    /// Represents the base data transfer object for a user, including common user profile information and role
+    /// assignment.
+    /// </summary>
+    /// <remarks>This class provides fundamental user properties for use in API requests and responses. It is
+    /// intended to be inherited by more specialized user DTOs as needed. The properties include identification, contact
+    /// information, activation status, and role assignment.</remarks>
+    public class BaseUserDto : BaseDto<Guid>
+    {
+        /// <summary>
+        /// Gets or sets the first name of the person.
+        /// </summary>
+        public string FirstName { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the last name of the person.
+        /// </summary>
+        public string LastName { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the email address associated with the user.
+        /// </summary>
+        public string Email { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets a value indicating whether the instance is currently active.
+        /// </summary>
+        public bool IsActive { get; set; }
+
+        /// <summary>
+        /// Gets or sets the role assigned to the user.
+        /// </summary>
+        public UserRole Role { get; set; }
+    }
+}

Sources/EasyExtensions/Models/Enums/UserRole.cs

@@ -0,0 +1,28 @@
+namespace EasyExtensions.Models.Enums
+{
+    /// <summary>
+    /// Specifies the set of roles that can be assigned to a user within the system.
+    /// </summary>
+    /// <remarks>Use this enumeration to define user permissions and access levels. The roles represent
+    /// increasing levels of responsibility and access, from standard users to administrators. The meaning and usage of
+    /// the 'Custom' role may vary depending on application-specific requirements.</remarks>
+    public enum UserRole
+    {
+        /// <summary>
+        /// Indicates that the value is unknown or not specified.
+        /// </summary>
+        /// <remarks>Use this value when the actual value cannot be determined or is not applicable. This
+        /// is typically used as a default or placeholder value.</remarks>
+        Unknown = 1,
+
+        /// <summary>
+        /// Represents a standard user account with typical permissions and access rights.
+        /// </summary>
+        User = 2,
+
+        /// <summary>
+        /// Specifies an administrator role with elevated permissions.
+        /// </summary>
+        Admin = 4,
+    }
+}