EnvelopeGenerator/EnvelopeGenerator.GeneratorAPI/Controllers/HistoryController.cs

using EnvelopeGenerator.Application.Contracts.Services;
using EnvelopeGenerator.Application.Histories.Queries.Read;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;
using static EnvelopeGenerator.Common.Constants;


namespace EnvelopeGenerator.GeneratorAPI.Controllers;

/// <summary>
/// Dieser Controller stellt Endpunkte für den Zugriff auf die Umschlaghistorie bereit.
/// </summary>
[Route("api/[controller]")]
[ApiController]
[Authorize]
public class HistoryController : ControllerBase
{
    private readonly ILogger<HistoryController> _logger;

    private readonly IEnvelopeHistoryService _service;

    /// <summary>
    /// Konstruktor für den HistoryController.
    /// </summary>
    /// <param name="logger">Der Logger, der für das Protokollieren von Informationen verwendet wird.</param>
    /// <param name="service">Der Dienst, der für die Verarbeitung der Umschlaghistorie verantwortlich ist.</param>
    public HistoryController(ILogger<HistoryController> logger, IEnvelopeHistoryService service)
    {
        _logger = logger;
        _service = service;
    }

    /// <summary>
    /// An der Versendung eines Umschlags können mehrere Beteiligte beteiligt sein, darunter der Absender, der Empfänger und das System selbst.
    /// Der Prozess liefert alle relevanten Nenner, die mit der Schlüsselnummer verbunden sind, und ermöglicht es dem Kunden,
    /// die Aktualität und Richtigkeit der Informationen zu überprüfen.
    /// <list type="bullet">
    /// <item><description><c>0</c>: Receiver</description></item>
    /// <item><description><c>1</c>: Sender</description></item>
    /// <item><description><c>2</c>: System</description></item>
    /// <item><description><c>3</c>: Unknown
    /// (Ein unbekannter Datensatz weist auf einen möglichen Mangel oder eine Unstimmigkeit im Aktualisierungsprozess der Anwendung hin.)</description></item>
    /// </list>
    /// </summary>
    /// <returns></returns>
    /// <response code="200"></response>
    [HttpGet("related")]
    [Authorize]
    public IActionResult GetReferenceTypes()
    {
        // Enum zu Schlüssel-Wert-Paar
        var referenceTypes = Enum.GetValues(typeof(ReferenceType))
                                 .Cast<ReferenceType>()
                                 .ToDictionary(rt =>
                                 {
                                     var key = rt.ToString();
                                     var keyAsCamelCase = char.ToLower(key[0]) + key[1..];
                                     return keyAsCamelCase;
                                 }, rt => (int)rt);

        return Ok(referenceTypes);
    }

    /// <summary>
    /// Ruft die gesamte Umschlaghistorie basierend auf den angegebenen Abfrageparametern ab.
    /// </summary>
    /// <param name="history">Die Abfrageparameter, die die Filterkriterien für die Umschlaghistorie definieren.</param>
    /// <returns>Eine Liste von Historieneinträgen, die den angegebenen Kriterien entsprechen, oder nur der letzte Eintrag.</returns>
    /// <response code="200">Die Anfrage war erfolgreich, und die Umschlaghistorie wird zurückgegeben.</response>
    /// <response code="400">Die Anfrage war ungültig oder unvollständig.</response>
    /// <response code="401">Der Benutzer ist nicht authentifiziert.</response>
    /// <response code="403">Der Benutzer hat keine Berechtigung, auf die Ressource zuzugreifen.</response>
    /// <response code="500">Ein unerwarteter Fehler ist aufgetreten.</response>
    [HttpGet]
    [Authorize]
    public async Task<IActionResult> GetAllAsync([FromQuery] ReadHistoryQuery history)
    {
        bool withReceiver = false;
        bool withSender = false;

        switch (history.Related)
        {
            case ReferenceType.Receiver:
                withReceiver = true;
                break;
            case ReferenceType.Sender:
                withSender = true;
                break;
        }

        var histories = await _service.ReadAsync(
            envelopeId: history.EnvelopeId,
            referenceType: history.Related,
            withSender: withSender,
            withReceiver: withReceiver);

        return Ok(histories);
    }
}