Javier Val - Task

.gitignore

@@ -21,3 +21,4 @@
 node_modules
 bower_components
 npm-debug.log
+/.vs

jobs/Backend/Task/.gitignore

@@ -0,0 +1,43 @@
+*.swp
+*.*~
+project.lock.json
+.DS_Store
+*.pyc
+nupkg/
+
+# Visual Studio Code
+.vscode/
+
+# Rider
+.idea/
+
+# Visual Studio
+.vs/
+
+# Fleet
+.fleet/
+
+# Code Rush
+.cr/
+
+# User-specific files
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+build/
+bld/
+[Bb]in/
+[Oo]bj/
+[Oo]ut/
+msbuild.log
+msbuild.err
+msbuild.wrn

jobs/Backend/Task/ExchangeRateUpdater.sln

@@ -1,22 +1,60 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 14
-VisualStudioVersion = 14.0.25123.0
+# Visual Studio Version 17
+VisualStudioVersion = 17.12.35527.113
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExchangeRateUpdater", "ExchangeRateUpdater.csproj", "{7B2695D6-D24C-4460-A58E-A10F08550CE0}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{E3C917E0-FC47-45B5-B3E6-895B67735184}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExchangeRateUpdater.Domain", "src\ExchangeRateUpdater.Domain\ExchangeRateUpdater.Domain.csproj", "{352FD975-379A-4490-BE0B-8F95D3AA5696}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExchangeRateUpdater.Application", "src\ExchangeRateUpdater.Application\ExchangeRateUpdater.Application.csproj", "{C670B148-7B12-4543-8CFB-B6A8B71064A5}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExchangeRateUpdater.Infrastructure", "src\ExchangeRateUpdater.Infrastructure\ExchangeRateUpdater.Infrastructure.csproj", "{5AA591A3-B5B8-46B2-9421-93B95C58CB1B}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExchangeRateUpdater.Api", "src\ExchangeRateUpdater.Api\ExchangeRateUpdater.Api.csproj", "{7488A15C-2636-4E0B-A84E-745B216213E8}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{9471D275-B28F-482C-A8E5-27BC140A271F}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "unit", "unit", "{89B9F30D-0062-47BB-8A3A-D8F51D243B01}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExchangeRateUpdater.UnitTest", "test\unit\ExchangeRateUpdater.UnitTest\ExchangeRateUpdater.UnitTest.csproj", "{CA1D4834-5F3F-495C-8F4B-1DFBF72A66BD}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{7B2695D6-D24C-4460-A58E-A10F08550CE0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{7B2695D6-D24C-4460-A58E-A10F08550CE0}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{7B2695D6-D24C-4460-A58E-A10F08550CE0}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{7B2695D6-D24C-4460-A58E-A10F08550CE0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{352FD975-379A-4490-BE0B-8F95D3AA5696}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{352FD975-379A-4490-BE0B-8F95D3AA5696}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{352FD975-379A-4490-BE0B-8F95D3AA5696}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{352FD975-379A-4490-BE0B-8F95D3AA5696}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C670B148-7B12-4543-8CFB-B6A8B71064A5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C670B148-7B12-4543-8CFB-B6A8B71064A5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C670B148-7B12-4543-8CFB-B6A8B71064A5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C670B148-7B12-4543-8CFB-B6A8B71064A5}.Release|Any CPU.Build.0 = Release|Any CPU
+		{5AA591A3-B5B8-46B2-9421-93B95C58CB1B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{5AA591A3-B5B8-46B2-9421-93B95C58CB1B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{5AA591A3-B5B8-46B2-9421-93B95C58CB1B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{5AA591A3-B5B8-46B2-9421-93B95C58CB1B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7488A15C-2636-4E0B-A84E-745B216213E8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7488A15C-2636-4E0B-A84E-745B216213E8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7488A15C-2636-4E0B-A84E-745B216213E8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7488A15C-2636-4E0B-A84E-745B216213E8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CA1D4834-5F3F-495C-8F4B-1DFBF72A66BD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CA1D4834-5F3F-495C-8F4B-1DFBF72A66BD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CA1D4834-5F3F-495C-8F4B-1DFBF72A66BD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CA1D4834-5F3F-495C-8F4B-1DFBF72A66BD}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{352FD975-379A-4490-BE0B-8F95D3AA5696} = {E3C917E0-FC47-45B5-B3E6-895B67735184}
+		{C670B148-7B12-4543-8CFB-B6A8B71064A5} = {E3C917E0-FC47-45B5-B3E6-895B67735184}
+		{5AA591A3-B5B8-46B2-9421-93B95C58CB1B} = {E3C917E0-FC47-45B5-B3E6-895B67735184}
+		{7488A15C-2636-4E0B-A84E-745B216213E8} = {E3C917E0-FC47-45B5-B3E6-895B67735184}
+		{89B9F30D-0062-47BB-8A3A-D8F51D243B01} = {9471D275-B28F-482C-A8E5-27BC140A271F}
+		{CA1D4834-5F3F-495C-8F4B-1DFBF72A66BD} = {89B9F30D-0062-47BB-8A3A-D8F51D243B01}
+	EndGlobalSection
 EndGlobal

jobs/Backend/Task/src/ExchangeRateUpdater.Api/Authorization/ApiKeyConstants.cs

@@ -0,0 +1,7 @@
+namespace ExchangeRateUpdater.Api.Authorization
+{
+    public static class ApiKeyConstants
+    {
+        public const string ApiKeyHeaderName = "X-API-Key";
+    }
+}

jobs/Backend/Task/src/ExchangeRateUpdater.Api/Authorization/ApiKeyValidation.cs

@@ -0,0 +1,31 @@
+namespace ExchangeRateUpdater.Api.Authorization
+{
+    /// <summary>
+    /// Class responsible for validating the API Key
+    /// </summary>
+    public class ApiKeyValidation : IApiKeyValidation
+    {
+        private readonly IConfiguration _configuration;
+
+        public ApiKeyValidation(IConfiguration configuration)
+        {
+            _configuration = configuration;
+        }
+
+        public bool IsValidApiKey(string userApiKey)
+        {
+            if (string.IsNullOrWhiteSpace(userApiKey))
+            {
+                return false;
+            }
+
+            string? apiKey = _configuration.GetValue<string>("ApiKey");
+            if (apiKey == null || apiKey != userApiKey)
+            {
+                return false;
+            }
+
+            return true;
+        }
+    }
+}

jobs/Backend/Task/src/ExchangeRateUpdater.Api/Authorization/IApiKeyValidation.cs

@@ -0,0 +1,7 @@
+namespace ExchangeRateUpdater.Api.Authorization
+{
+    public interface IApiKeyValidation
+    {
+        bool IsValidApiKey(string userApiKey);
+    }
+}

jobs/Backend/Task/src/ExchangeRateUpdater.Api/Controllers/ExchangeRateController.cs

@@ -0,0 +1,48 @@
+using ExchangeRateUpdater.Application.Queries.ExchangeRates.GetExchangeRates;
+using ExchangeRateUpdater.Domain.ValueObjects;
+using MediatR;
+using Microsoft.AspNetCore.Mvc;
+
+namespace ExchangeRateUpdater.Api.Controllers
+{
+    [ApiController]
+    [Route("api/v1/exchange-rates")]
+    public class ExchangeRateController : ControllerBase
+    {
+        private readonly IMediator _mediator;
+
+        public ExchangeRateController(IMediator mediator)
+        {
+            _mediator = mediator;
+        }
+
+        /// <summary>
+        /// Returns last valid data for exchange rates among the specified currencies that are defined by the provider (by default Czech National Bank)
+        /// </summary>
+        /// <remarks>
+        /// Regarding parameters, the currencies must be indicated, and the date optionally.
+        /// 
+        /// Currencies are in three-letter ISO 4217 code.
+        /// Example: AUD for Australian Dollar
+        /// 
+        /// Date in ISO format (yyyy-MM-dd); default value: NOW
+        /// Example : 2019-05-17
+        /// </remarks>
+        /// <param name="query">The currencies must be indicated, and the date optionally.</param>
+        /// <param name="cancellationToken">Cancellation token</param>
+        /// <returns></returns>
+        [HttpGet]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
+        [ProducesResponseType(StatusCodes.Status409Conflict)]
+        [ProducesResponseType(StatusCodes.Status502BadGateway)]
+        [ProducesResponseType(typeof(IEnumerable<ExchangeRate>), StatusCodes.Status200OK)]
+        public async Task<IActionResult> GetExchangeRates(
+            [FromQuery] GetExchangeRatesQuery query,
+            CancellationToken cancellationToken)
+        {
+            var response = await _mediator.Send(query, cancellationToken);
+
+            return Ok(response.ToList());
+        }
+    }
+}

jobs/Backend/Task/src/ExchangeRateUpdater.Api/Exceptions/CustomExceptionHandler.cs

@@ -0,0 +1,75 @@
+using ExchangeRateUpdater.Application.Exceptions;
+using ExchangeRateUpdater.Domain.Exceptions;
+using FluentValidation;
+using Microsoft.AspNetCore.Diagnostics;
+using Microsoft.AspNetCore.Mvc;
+
+namespace ExchangeRateUpdater.Api.Exceptions
+{
+    /// <summary>
+    /// Class that encapsulates global exception handling
+    /// </summary>
+    /// <param name="logger"></param>
+    public class CustomExceptionHandler
+        (ILogger<CustomExceptionHandler> logger)
+        : IExceptionHandler
+    {
+        public async ValueTask<bool> TryHandleAsync(HttpContext context, Exception exception, CancellationToken cancellationToken)
+        {
+            logger.LogError("Error message: {exceptionMessage}, Time of occurrence {time}",
+                exception.Message, DateTime.UtcNow);
+
+            (string Detail, string Title, int StatusCode) = exception switch
+            {
+                DomainException =>
+                (
+                    exception.Message,
+                    exception.GetType().Name,
+                    context.Response.StatusCode = StatusCodes.Status409Conflict
+                ),
+                BadGatewayException =>
+                (
+                    exception.Message,
+                    exception.GetType().Name,
+                    context.Response.StatusCode = StatusCodes.Status502BadGateway
+                ),
+                ValidationException =>
+                (
+                    exception.Message,
+                    exception.GetType().Name,
+                    context.Response.StatusCode = StatusCodes.Status400BadRequest
+                ),
+                NotFoundException =>
+                (
+                    exception.Message,
+                    exception.GetType().Name,
+                    context.Response.StatusCode = StatusCodes.Status404NotFound
+                ),
+                _ =>
+                (
+                    exception.Message,
+                    exception.GetType().Name,
+                    context.Response.StatusCode = StatusCodes.Status500InternalServerError
+                )
+            };
+
+            var problemDetails = new ProblemDetails
+            {
+                Title = Title,
+                Detail = Detail,
+                Status = StatusCode,
+                Instance = context.Request.Path
+            };
+
+            problemDetails.Extensions.Add("TraceId", context.TraceIdentifier);
+
+            if (exception is ValidationException validationException)
+            {
+                problemDetails.Extensions.Add("ValidationErrors", validationException.Errors);
+            }
+
+            await context.Response.WriteAsJsonAsync(problemDetails, cancellationToken: cancellationToken);
+            return true;
+        }
+    }
+}

jobs/Backend/Task/src/ExchangeRateUpdater.Api/ExchangeRateUpdater.Api.csproj

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
+		<NoWarn>$(NoWarn);1591</NoWarn>
+	</PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="7.2.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\ExchangeRateUpdater.Application\ExchangeRateUpdater.Application.csproj" />
+    <ProjectReference Include="..\ExchangeRateUpdater.Infrastructure\ExchangeRateUpdater.Infrastructure.csproj" />
+  </ItemGroup>
+
+</Project>