Merge pull request 'Add TagType CRUD' (#4) from feature/add-tag-override-crud into development

Reviewed-on: #4
Reviewed-by: Sergio Matías <sergio.matias@agilewebs.com>
Reviewed-by: efrain_marin <efrain.marin@agilewebs.com>

Core.Inventory.DAL.API/Controllers/TagOverrideController.cs

@@ -0,0 +1,154 @@
+using Asp.Versioning;
+using Core.Adapters.Lib;
+using Core.Blueprint.Logging;
+using Core.Blueprint.Mongo;
+using Core.Inventory.Domain.Contexts.Inventory.Request;
+using Core.Inventory.Provider.Contracts;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Core.Inventory.DAL.API.Controllers
+{
+    /// <summary>
+    /// Handles all requests for TagOverride authentication.
+    /// </summary>
+    [ApiVersion(MimeTypes.ApplicationVersion)]
+    [Route("api/v{api-version:apiVersion}/[controller]")]
+    [Produces(MimeTypes.ApplicationJson)]
+    [Consumes(MimeTypes.ApplicationJson)]
+    [ApiController]
+    [AllowAnonymous]
+    public class TagOverrideController(ITagOverrideProvider service) : ControllerBase
+    {
+        /// <summary>
+        /// Gets all the TagOverrides.
+        /// </summary>
+        /// <returns>The <see cref="IEnumerable{TagOverrideAdapter}"/> found entities.</returns>
+        /// <response code="200">The TagOverrides found.</response>
+        /// <response code="404">The TagOverrides not found error.</response>
+        /// <response code="500">The service internal error.</response>
+        [HttpGet]
+        [Consumes(MimeTypes.ApplicationJson)]
+        [Produces(MimeTypes.ApplicationJson)]
+        [ProducesResponseType(typeof(IEnumerable<TagOverrideAdapter>), StatusCodes.Status200OK)]
+        public async Task<IActionResult> GetAllTagOverridesAsync(CancellationToken cancellationToken)
+        {
+            var result = await service.GetAllTagOverrides(cancellationToken).ConfigureAwait(false);
+            return Ok(result);
+        }
+
+        /// <summary>
+        /// Gets all the TagOverrides by TagOverride identifiers.
+        /// </summary>
+        /// <param name="TagOverrides">The list of TagOverride identifiers.</param>
+        /// <returns>The <see cref="IEnumerable{TagOverrideAdapter}"/> found entities.</returns>
+        /// <response code="200">The TagOverrides found.</response>
+        /// <response code="404">The TagOverrides not found error.</response>
+        /// <response code="500">The service internal error.</response>
+        [HttpPost]
+        [Route("GetTagOverrideList")]
+        [Consumes(MimeTypes.ApplicationJson)]
+        [Produces(MimeTypes.ApplicationJson)]
+        [ProducesResponseType(typeof(IEnumerable<TagOverrideAdapter>), StatusCodes.Status200OK)]
+        public async Task<IActionResult> GetAllTagOverridesByList([FromBody] string[] tagOverrides, CancellationToken cancellationToken)
+        {
+            if (tagOverrides == null || !tagOverrides.Any())
+            {
+                return BadRequest("TagOverride identifiers are required.");
+            }
+
+            var result = await service.GetAllTagOverridesByList(tagOverrides, cancellationToken).ConfigureAwait(false);
+            return Ok(result);
+        }
+
+
+        /// <summary>
+        /// Gets the TagOverride by identifier.
+        /// </summary>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <returns>The <see cref="TagOverrideAdapter"/> found entity.</returns>
+        /// <response code="200">The TagOverride found.</response>
+        /// <response code="404">The TagOverride not found error.</response>
+        /// <response code="500">The service internal error.</response>
+        [HttpGet]
+        [Route("{id}")]
+        [Consumes(MimeTypes.ApplicationJson)]
+        [Produces(MimeTypes.ApplicationJson)]
+        [ProducesResponseType(typeof(TagOverrideAdapter), StatusCodes.Status200OK)]
+        public async Task<IActionResult> GetTagOverrideByIdAsync([FromRoute] string id, CancellationToken cancellationToken)
+        {
+            var result = await service.GetTagOverrideById(id, cancellationToken).ConfigureAwait(false);
+
+            if (result == null)
+            {
+                return NotFound("Entity not found");
+            }
+
+            return Ok(result);
+        }
+
+        /// <summary>
+        /// Creates a new TagOverride.
+        /// </summary>
+        /// <param name="newTagOverride">The TagOverride to be added.</param>
+        /// <returns>The <see cref="TagOverrideAdapter"/> created entity.</returns>
+        /// <response code="201">The TagOverride created.</response>
+        /// <response code="422">The TagOverride could not be created.</response>
+        /// <response code="500">The service internal e|ror.</response>
+        [HttpPost]
+        [ProducesResponseType(typeof(TagOverrideAdapter), StatusCodes.Status201Created)]
+        public async Task<IActionResult> CreateTagOverrideAsync([FromBody] TagOverrideRequest newTagOverride, CancellationToken cancellationToken)
+        {
+            var result = await service.CreateTagOverride(newTagOverride, cancellationToken).ConfigureAwait(false);
+            return Created("CreatedWithIdAsync", result);
+        }
+
+        /// <summary>
+        /// Updates a full TagOverride by identifier.
+        /// </summary>
+        /// <param name="entity">The TagOverride to update.</param>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <returns>The <see cref="TagOverrideAdapter"/> updated entity.</returns>
+        /// <response code="200">The TagOverride updated.</response>
+        /// <response code="404">The TagOverride not found.</response>
+        /// <response code="422">The TagOverride could not be updated.</response>
+        /// <response code="500">The service internal error.</response>
+        [HttpPut]
+        [Route("{id}")]
+        [Consumes(MimeTypes.ApplicationJson)]
+        [Produces(MimeTypes.ApplicationJson)]
+        [ProducesResponseType(typeof(TagOverrideAdapter), StatusCodes.Status200OK)]
+        public async Task<IActionResult> UpdateTagOverrideAsync([FromRoute] string id, TagOverrideAdapter entity, CancellationToken cancellationToken)
+        {
+            if (id != entity.Id?.ToString())
+            {
+                return BadRequest("TagOverride ID mismatch");
+            }
+
+            var result = await service.UpdateTagOverride(entity, cancellationToken).ConfigureAwait(false);
+
+            return Ok(result);
+        }
+
+        /// <summary>
+        /// Changes the status of the TagOverride.
+        /// </summary>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <param name="newStatus">The new status of the TagOverride.</param>
+        /// <returns>The <see cref="TagOverrideAdapter"/> updated entity.</returns>
+        /// <response code="200">The TagOverride updates.</response>
+        /// <response code="404">The TagOverride not found.</response>
+        /// <response code="422">The TagOverride could not be deleted.</response>
+        /// <response code="500">The service internal error.</response>
+        [HttpPatch]
+        [Route("{id}/{newStatus}/ChangeStatus")]
+        [Consumes(MimeTypes.ApplicationJson)]
+        [Produces(MimeTypes.ApplicationJson)]
+        [ProducesResponseType(typeof(TagOverrideAdapter), StatusCodes.Status200OK)]
+        public async Task<IActionResult> ChangeTagOverrideStatus([FromRoute] string id, [FromRoute] StatusEnum newStatus, CancellationToken cancellationToken)
+        {
+            var result = await service.ChangeTagOverrideStatus(id, newStatus, cancellationToken).ConfigureAwait(false);
+            return Ok(result);
+        }
+    }
+}

Core.Inventory.Domain/Contexts/Inventory/Request/TagOverrideRequest.cs

@@ -0,0 +1,36 @@
+using MongoDB.Bson;
+using MongoDB.Bson.Serialization.Attributes;
+using System.Text.Json.Serialization;
+
+namespace Core.Inventory.Domain.Contexts.Inventory.Request
+{
+    /// <summary>
+    /// Data transfer object (DTO) for adding TagOverride.
+    /// </summary>
+    public class TagOverrideRequest
+    {
+        /// <summary>
+        /// Gets or sets the tenantId of the TagOverride.
+        /// </summary>
+        [BsonElement("tenantId")]
+        [BsonRepresentation(BsonType.String)]
+        [JsonPropertyName("tenantId")]
+        public string TenantId { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the baseTagId of the TagOverride.
+        /// </summary>
+        [BsonElement("baseTagId")]
+        [BsonRepresentation(BsonType.String)]
+        [JsonPropertyName("baseTagId")]
+        public string BaseTagId { get; set; } = null!;
+
+        /// <summary>
+        /// Gets or sets the overrideTagId of the TagOverride.
+        /// </summary>
+        [BsonElement("overrideTagId")]
+        [BsonRepresentation(BsonType.String)]
+        [JsonPropertyName("overrideTagId")]
+        public string OverrideTagId { get; set; } = null!;
+    }
+}

Core.Inventory.Provider/Contracts/ITagOverrideProvider.cs

@@ -0,0 +1,59 @@
+using Core.Adapters.Lib;
+using Core.Blueprint.Mongo;
+using Core.Inventory.Domain.Contexts.Inventory.Request;
+
+namespace Core.Inventory.Provider.Contracts
+{
+    public interface ITagOverrideProvider
+    {
+        /// <summary>
+        /// Creates a new TagOverride.
+        /// </summary>
+        /// <param name="entity">The TagOverride to be created.</param>
+        /// <returns>A <see cref="{Task{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        ValueTask<TagOverrideAdapter> CreateTagOverride(TagOverrideRequest newTagOverride, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Gets an TagOverride by identifier.
+        /// </summary>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <returns>A <see cref="{Task{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        ValueTask<TagOverrideAdapter> GetTagOverrideById(string _id, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Gets all the TagOverrides.
+        /// </summary>
+        /// <returns>A <see cref="{Task{IEnumerbale{TagOverrideAdapter}}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        ValueTask<IEnumerable<TagOverrideAdapter>> GetAllTagOverrides(CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Gets all the TagOverrides by TagOverrides identifier list.
+        /// </summary>
+        /// <param name="TagOverrides">The list of TagOverrides identifiers.</param>
+        /// <returns>A <see cref="Task{IEnumerable{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        ValueTask<IEnumerable<TagOverrideAdapter>> GetAllTagOverridesByList(string[] tagOverrides, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Changes the status of the TagOverride.
+        /// </summary>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <param name="newStatus">The new status of the TagOverride.</param>
+        /// <returns>The <see cref="TagOverrideAdapter"/> updated entity.</returns>
+        /// <returns>A <see cref="{Task{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        ValueTask<TagOverrideAdapter> ChangeTagOverrideStatus(string id, StatusEnum newStatus, CancellationToken cancellationToken);
+
+        /// <summary>
+        /// Updates a TagOverride by id.
+        /// </summary>
+        /// <param name="entity">The TagOverride to be updated.</param>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <returns>A <see cref="{Task{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        ValueTask<TagOverrideAdapter> UpdateTagOverride(TagOverrideAdapter entity, CancellationToken cancellationToken);
+    }
+}

Core.Inventory.Provider/Providers/Inventory/TagOverrideProvider.cs

@@ -0,0 +1,149 @@
+using Core.Adapters.Lib;
+using Core.Blueprint.Mongo;
+using Core.Blueprint.Redis;
+using Core.Blueprint.Redis.Helpers;
+using Core.Inventory.Domain.Contexts.Inventory.Request;
+using Core.Inventory.Provider.Contracts;
+using Mapster;
+using Microsoft.Extensions.Options;
+using MongoDB.Driver;
+
+namespace Core.Inventory.Provider.Providers.Inventory
+{
+    /// <summary>
+    /// Handles all services and business rules related to <see cref="TagOverrideAdapter"/>.
+    /// </summary>
+    public class TagOverrideProvider : ITagOverrideProvider
+    {
+        private readonly CollectionRepository<TagOverrideAdapter> repository;
+        private readonly CacheSettings cacheSettings;
+        private readonly IRedisCacheProvider cacheProvider;
+
+        public TagOverrideProvider(CollectionRepository<TagOverrideAdapter> repository,
+            IRedisCacheProvider cacheProvider,
+            IOptions<CacheSettings> cacheSettings)
+        {
+            this.repository = repository;
+            this.repository.CollectionInitialization();
+            this.cacheSettings = cacheSettings.Value;
+            this.cacheProvider = cacheProvider;
+        }
+
+        /// <summary>
+        /// Creates a new TagOverride.
+        /// </summary>
+        /// <param name="entity">The TagOverride to be created.</param>
+        /// <returns>A <see cref="{Task{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        public async ValueTask<TagOverrideAdapter> CreateTagOverride(TagOverrideRequest newTagOverride, CancellationToken cancellationToken)
+        {
+            var tagOverrideCollection = newTagOverride.Adapt<TagOverrideAdapter>();
+
+            await repository.InsertOneAsync(tagOverrideCollection);
+
+            return tagOverrideCollection;
+        }
+
+        /// <summary>
+        /// Gets an TagOverride by identifier.
+        /// </summary>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <returns>A <see cref="{Task{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>0
+        public async ValueTask<TagOverrideAdapter> GetTagOverrideById(string _id, CancellationToken cancellationToken)
+        {
+            var cacheKey = CacheKeyHelper.GenerateCacheKey(this, "GetTagOverrideById", _id);
+            var cachedData = await cacheProvider.GetAsync<TagOverrideAdapter>(cacheKey);
+
+            if (cachedData is not null) { return cachedData; }
+
+            var TagOverride = await repository.FindByIdAsync(_id);
+
+            await cacheProvider.SetAsync(cacheKey, TagOverride);
+
+            return TagOverride;
+        }
+
+        /// <summary>
+        /// Gets all the TagOverrides.
+        /// </summary>
+        /// <returns>A <see cref="{Task{IEnumerbale{TagOverrideAdapter}}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        public async ValueTask<IEnumerable<TagOverrideAdapter>> GetAllTagOverrides(CancellationToken cancellationToken)
+        {
+            var cacheKey = CacheKeyHelper.GenerateCacheKey(this, "GetTagOverrides");
+            var cachedData = await cacheProvider.GetAsync<IEnumerable<TagOverrideAdapter>>(cacheKey) ?? [];
+
+            if (cachedData.Any()) return cachedData;
+
+            var TagOverrides = await repository.AsQueryable();
+
+            await cacheProvider.SetAsync(cacheKey, TagOverrides);
+
+            return TagOverrides;
+        }
+
+        /// <summary>
+        /// Gets all the TagOverrides by TagOverrides identifier list.
+        /// </summary>
+        /// <param name="TagOverrides">The list of TagOverrides identifiers.</param>
+        /// <returns>A <see cref="Task{IEnumerable{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        public async ValueTask<IEnumerable<TagOverrideAdapter>> GetAllTagOverridesByList(string[] tagOverrides, CancellationToken cancellationToken)
+        {
+            var cacheKey = CacheKeyHelper.GenerateCacheKey(this, "GetAllTagOverridesByList", tagOverrides);
+
+            var cachedData = await cacheProvider.GetAsync<IEnumerable<TagOverrideAdapter>>(cacheKey) ?? [];
+
+            if (cachedData.Any()) return cachedData;
+
+            var builder = Builders<TagOverrideAdapter>.Filter;
+            var filters = new List<FilterDefinition<TagOverrideAdapter>>();
+
+            if (tagOverrides != null || !tagOverrides.Any())
+            {
+                filters.Add(builder.In(x => x._Id, tagOverrides));
+            }
+
+            var finalFilter = filters.Any() ? builder.And(filters) : builder.Empty;
+
+            var TagOverridesList = await repository.FilterByMongoFilterAsync(finalFilter);
+
+            await cacheProvider.SetAsync(cacheKey, TagOverridesList);
+
+            return TagOverridesList;
+        }
+
+
+        /// <summary>
+        /// Changes the status of the TagOverride.
+        /// </summary>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <param name="newStatus">The new status of the TagOverride.</param>
+        /// <returns>A <see cref="{Task{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        public async ValueTask<TagOverrideAdapter> ChangeTagOverrideStatus(string id, StatusEnum newStatus, CancellationToken cancellationToken)
+        {
+            var entity = await repository.FindByIdAsync(id);
+            entity.Status = newStatus;
+
+            await repository.ReplaceOneAsync(entity);
+
+            return entity;
+        }
+
+        /// <summary>
+        /// Updates a TagOverride by id.
+        /// </summary>
+        /// <param name="entity">The TagOverride to be updated.</param>
+        /// <param name="id">The TagOverride identifier.</param>
+        /// <returns>A <see cref="{Task{TagOverrideAdapter}}"/> representing
+        /// the asynchronous execution of the service.</returns>
+        public async ValueTask<TagOverrideAdapter> UpdateTagOverride(TagOverrideAdapter entity, CancellationToken cancellationToken)
+        {
+            await repository.ReplaceOneAsync(entity);
+
+            return entity;
+        }
+    }
+}

Core.Inventory.Provider/ServiceCollectionExtensions.cs

@@ -24,6 +24,9 @@ namespace Core.Inventory.Provider
             services.AddScoped<ITagProvider, TagProvider>();
             services.AddScoped<CollectionRepository<TagAdapter>>();
 
+            services.AddScoped<ITagOverrideProvider, TagOverrideProvider>();
+            services.AddScoped<CollectionRepository<TagOverrideAdapter>>();
+
             services.AddScoped<IProductProvider, ProductProvider>();
             services.AddScoped<CollectionRepository<ProductAdapter>>();