Add CompanyLogoDto and update CompanyLogosController to use DTO for logo retrieval and creation

Marechai.Data/Dtos/CompanyLogoDto.cs

@@ -0,0 +1,40 @@
+/******************************************************************************
+// MARECHAI: Master repository of computing history artifacts information
+// ----------------------------------------------------------------------------
+//
+// Author(s)      : Natalia Portillo <claunia@claunia.com>
+//
+// --[ License ] --------------------------------------------------------------
+//
+//     This program is free software: you can redistribute it and/or modify
+//     it under the terms of the GNU 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 General Public License for more details.
+//
+//     You should have received a copy of the GNU General Public License
+//     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+// ----------------------------------------------------------------------------
+// Copyright © 2003-2021 Natalia Portillo
+*******************************************************************************/
+
+using System.ComponentModel.DataAnnotations;
+using System.Text.Json.Serialization;
+
+namespace Marechai.Data.Dtos;
+
+public class CompanyLogoDto : BaseDto<int>
+{
+    [JsonPropertyName("company_id")]
+    [Required]
+    public int CompanyId { get; set; }
+
+    [JsonPropertyName("year")] public int? Year { get; set; }
+
+    [JsonPropertyName("guid")] [Required] public Guid Guid { get; set; }
+}

Marechai.Server/Controllers/CompanyLogosController.cs

@@ -28,6 +28,7 @@ using System.IO;
 using System.Linq;
 using System.Security.Claims;
 using System.Threading.Tasks;
+using Marechai.Data.Dtos;
 using Marechai.Database.Models;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Hosting;
@@ -41,16 +42,26 @@ namespace Marechai.Server.Controllers;
 [ApiController]
 public class CompanyLogosController(MarechaiContext context, IWebHostEnvironment host) : ControllerBase
 {
-    readonly string _webRootPath = host.WebRootPath;
+    private readonly string _webRootPath = host.WebRootPath;
 
     [HttpGet("/companies/{companyId:int}/logos")]
     [AllowAnonymous]
     [ProducesResponseType(StatusCodes.Status200OK)]
     [ProducesResponseType(StatusCodes.Status400BadRequest)]
-    public Task<List<CompanyLogo>> GetByCompany(int companyId) => context.CompanyLogos
+    public Task<List<CompanyLogoDto>> GetByCompany(int companyId)
-                                                                         .Where(l => l.CompanyId == companyId)
+    {
-                                                                         .OrderBy(l => l.Year)
+        return context.CompanyLogos
-                                                                         .ToListAsync();
+        .Where(l => l.CompanyId == companyId)
+        .OrderBy(l => l.Year)
+        .Select(l => new CompanyLogoDto
+        {
+            Id = l.Id,
+            CompanyId = l.CompanyId,
+            Year = l.Year,
+            Guid = l.Guid
+        })
+        .ToListAsync();
+    }
 
     [HttpDelete("{id:int}")]
     [Authorize(Roles = "Admin,UberAdmin")]
@@ -60,53 +71,53 @@ public class CompanyLogosController(MarechaiContext context, IWebHostEnvironment
     [ProducesResponseType(StatusCodes.Status401Unauthorized)]
     public async Task<ActionResult> DeleteAsync(int id)
     {
-        string userId = User.FindFirstValue(ClaimTypes.Sid);
+        var userId = User.FindFirstValue(ClaimTypes.Sid);
 
-        if(userId is null) return Unauthorized();
+        if (userId is null) return Unauthorized();
-        CompanyLogo logo = await context.CompanyLogos.Where(l => l.Id == id).FirstOrDefaultAsync();
+        var logo = await context.CompanyLogos.Where(l => l.Id == id).FirstOrDefaultAsync();
 
-        if(logo is null) return NotFound();
+        if (logo is null) return NotFound();
 
         context.CompanyLogos.Remove(logo);
         await context.SaveChangesWithUserAsync(userId);
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos", logo.Guid + ".svg")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos", logo.Guid + ".svg")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos", logo.Guid + ".svg"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/webp/1x", logo.Guid + ".webp")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/webp/1x", logo.Guid + ".webp")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/webp/1x", logo.Guid + ".webp"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/webp/2x", logo.Guid + ".webp")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/webp/2x", logo.Guid + ".webp")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/webp/2x", logo.Guid + ".webp"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/webp/3x", logo.Guid + ".webp")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/webp/3x", logo.Guid + ".webp")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/webp/3x", logo.Guid + ".webp"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/png/1x", logo.Guid + ".png")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/png/1x", logo.Guid + ".png")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/png/1x", logo.Guid + ".png"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/png/2x", logo.Guid + ".png")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/png/2x", logo.Guid + ".png")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/png/2x", logo.Guid + ".png"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/png/3x", logo.Guid + ".png")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/png/3x", logo.Guid + ".png")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/png/3x", logo.Guid + ".png"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/1x", logo.Guid + ".webp")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/1x", logo.Guid + ".webp")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/1x", logo.Guid + ".webp"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/2x", logo.Guid + ".webp")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/2x", logo.Guid + ".webp")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/2x", logo.Guid + ".webp"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/3x", logo.Guid + ".webp")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/3x", logo.Guid + ".webp")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/thumbs/webp/3x", logo.Guid + ".webp"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/png/1x", logo.Guid + ".png")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/png/1x", logo.Guid + ".png")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/thumbs/png/1x", logo.Guid + ".png"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/png/2x", logo.Guid + ".png")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/png/2x", logo.Guid + ".png")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/thumbs/png/2x", logo.Guid + ".png"));
 
-        if(System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/png/3x", logo.Guid + ".png")))
+        if (System.IO.File.Exists(Path.Combine(_webRootPath, "assets/logos/thumbs/png/3x", logo.Guid + ".png")))
             System.IO.File.Delete(Path.Combine(_webRootPath, "assets/logos/thumbs/png/3x", logo.Guid + ".png"));
 
         return Ok();
@@ -120,13 +131,13 @@ public class CompanyLogosController(MarechaiContext context, IWebHostEnvironment
     [ProducesResponseType(StatusCodes.Status401Unauthorized)]
     public async Task<ActionResult> ChangeYearAsync(int id, [FromBody] int? year)
     {
-        string userId = User.FindFirstValue(ClaimTypes.Sid);
+        var userId = User.FindFirstValue(ClaimTypes.Sid);
 
-        if(userId is null) return Unauthorized();
+        if (userId is null) return Unauthorized();
 
-        CompanyLogo logo = await context.CompanyLogos.Where(l => l.Id == id).FirstOrDefaultAsync();
+        var logo = await context.CompanyLogos.Where(l => l.Id == id).FirstOrDefaultAsync();
 
-        if(logo is null) return NotFound();
+        if (logo is null) return NotFound();
 
         logo.Year = year;
         await context.SaveChangesWithUserAsync(userId);
@@ -139,16 +150,16 @@ public class CompanyLogosController(MarechaiContext context, IWebHostEnvironment
     [ProducesResponseType(StatusCodes.Status200OK)]
     [ProducesResponseType(StatusCodes.Status400BadRequest)]
     [ProducesResponseType(StatusCodes.Status401Unauthorized)]
-    public async Task<ActionResult<int>> CreateAsync([FromBody] CompanyLogo dto)
+    public async Task<ActionResult<int>> CreateAsync([FromBody] CompanyLogoDto dto)
     {
-        string userId = User.FindFirstValue(ClaimTypes.Sid);
+        var userId = User.FindFirstValue(ClaimTypes.Sid);
 
-        if(userId is null) return Unauthorized();
+        if (userId is null) return Unauthorized();
 
         var logo = new CompanyLogo
         {
-            Guid      = dto.Guid,
+            Guid = dto.Guid,
-            Year      = dto.Year,
+            Year = dto.Year,
             CompanyId = dto.CompanyId
         };