Merge pull request #1572 from bcgov/stories/ecer-5118

Stories/ecer 5118: Status endpoint for ICRA eligibility application

Author: farzadnadiri

src/ECER.Clients.RegistryPortal/ECER.Clients.RegistryPortal.Server/ICRA/ICRAEligibilitiesEndpoints.cs

@@ -89,6 +89,32 @@ public void Register(IEndpointRouteBuilder endpointRouteBuilder)
         .WithOpenApi("Submit an ICRA Eligibility", string.Empty, "icra_post")
         .RequireAuthorization()
         .WithParameterValidation();
+
+    endpointRouteBuilder.MapGet("/api/icra/{id}/status", async Task<Results<Ok<ICRAEligibilityStatus>, BadRequest<ProblemDetails>, NotFound<ProblemDetails>>> (string id, HttpContext ctx, IMediator messageBus, IMapper mapper, CancellationToken ct) =>
+        {
+          var userId = ctx.User.GetUserContext()?.UserId;
+          bool IdIsNotGuid = !Guid.TryParse(id, out _);
+          if (IdIsNotGuid)
+          {
+            return TypedResults.BadRequest(new ProblemDetails() { Title = "ICRAEligibilityId is not valid" });
+          }
+
+          var query = new ICRAEligibilitiesQuery
+          {
+            ById = id,
+            ByApplicantId = userId
+          };
+          var result = await messageBus.Send(query, ct);
+          var eligibility = result.Items.FirstOrDefault();
+          if (eligibility == null)
+          {
+            return TypedResults.NotFound(new ProblemDetails() { Title = "ICRA eligibility not found" });
+          }
+          return TypedResults.Ok(mapper.Map<ICRAEligibilityStatus>(eligibility));
+        })
+        .WithOpenApi("Handles icra eligibility status queries", string.Empty, "icra_status_get")
+        .RequireAuthorization()
+        .WithParameterValidation();
   }
 }
 
@@ -103,10 +129,8 @@ public record ICRAEligibility()
   public string? Id { get; set; }
   public string ApplicantId { get; set; } = string.Empty;
   public string? PortalStage { get; set; }
-
   public DateTime? SignedDate { get; set; }
   public DateTime? CreatedOn { get; set; }
-
   public ICRAStatus Status { get; set; }
   public IEnumerable<InternationalCertification> InternationalCertifications { get; set; } = Array.Empty<InternationalCertification>();
   public IEnumerable<EmploymentReference> EmploymentReferences { get; set; } = Array.Empty<EmploymentReference>();
@@ -146,6 +170,7 @@ public record EmploymentReference
   public string? FirstName { get; set; }
   public string? EmailAddress { get; set; }
   public string? PhoneNumber { get; set; }
+  public ICRAStatus? Status { get; set; }
 }
 
 public enum ICRAStatus
@@ -163,3 +188,15 @@ public enum ICRAStatus
 
 public record ICRAEligibilitySubmissionRequest(string Id);
 public record SubmitICRAEligibilityResponse(ICRAEligibility Eligibility);
+
+public record ICRAEligibilityStatus(string Id, DateTime? CreatedOn, DateTime? SignedDate, ICRAStatus Status)
+{
+  public IEnumerable<InternationalCertification> InternationalCertifications { get; set; } = Array.Empty<InternationalCertification>();
+  public IEnumerable<EmploymentReferenceStatus> EmploymentReferencesStatus { get; set; } = Array.Empty<EmploymentReferenceStatus>();
+}
+
+public record EmploymentReferenceStatus(string Id, Managers.Registry.Contract.Applications.WorkExperienceRefStage? Status, string? FirstName, string? LastName, string? EmailAddress)
+{
+  public string? PhoneNumber { get; set; }
+  public bool? WillProvideReference { get; set; }
+}

src/ECER.Clients.RegistryPortal/ECER.Clients.RegistryPortal.Server/ICRA/ICRAEligibilityMapper.cs

@@ -14,6 +14,19 @@ public ICRAEligibilityMapper()
       .ReverseMap();
     CreateMap<EmploymentReference, Managers.Registry.Contract.ICRA.EmploymentReference>()
       .ForMember(dest => dest.Type, opt => opt.Ignore())
+      .ForMember(d => d.Status, o => o.Ignore())
+      .ForMember(d => d.WillProvideReference, o => o.Ignore())
       .ReverseMap();
+    CreateMap<Managers.Registry.Contract.ICRA.ICRAEligibility, ICRAEligibilityStatus>()
+      .ForMember(d => d.EmploymentReferencesStatus, o => o.MapFrom(s => s.EmploymentReferences));
+    CreateMap<Managers.Registry.Contract.ICRA.EmploymentReference, EmploymentReferenceStatus>()
+      .ForCtorParam(nameof(EmploymentReference.Id), o => o.MapFrom(s => s.Id))
+      .ForCtorParam(nameof(EmploymentReference.Status), o => o.MapFrom(s => s.Status))
+      .ForCtorParam(nameof(EmploymentReference.FirstName), o => o.MapFrom(s => s.FirstName))
+      .ForCtorParam(nameof(EmploymentReference.LastName), o => o.MapFrom(s => s.LastName))
+      .ForCtorParam(nameof(EmploymentReference.EmailAddress), o => o.MapFrom(s => s.EmailAddress))
+      .ForMember(d => d.PhoneNumber, o => o.MapFrom(s => s.PhoneNumber))
+      .ForMember(d => d.WillProvideReference, o => o.MapFrom(s => s.WillProvideReference));
+
   }
 }

src/ECER.Managers.Registry.Contract/ICRA/Contract.cs

@@ -70,6 +70,8 @@ public record EmploymentReference
   public string? FirstName { get; set; }
   public string? EmailAddress { get; set; }
   public string? PhoneNumber { get; set; }
+  public Applications.WorkExperienceRefStage? Status { get; set; }
+  public bool? WillProvideReference { get; set; }
   public WorkExperienceTypesIcra Type { get; set; }
 }
 

src/ECER.Resources.Documents/ICRA/ICRARepositoryMapper.cs

@@ -71,7 +71,9 @@ public ICRARepositoryMapper()
         .ConvertUsingEnumMapping(o => o.MapByName(true));
 
     CreateMap<EmploymentReference, ecer_WorkExperienceRef>(MemberList.Source)
-      .ForMember(d => d.ecer_WorkExperienceRefId, opts => opts.MapFrom(s => string.IsNullOrEmpty(s.Id) ? null : s.Id))
+      .ForSourceMember(s => s.Status, opts => opts.DoNotValidate())
+      .ForSourceMember(s => s.WillProvideReference, opts => opts.DoNotValidate())
+      .ForMember(d => d.ecer_WorkExperienceRefId, opts => opts.MapFrom(s => string.IsNullOrEmpty(s.Id)? null : s.Id))
       .ForMember(d => d.ecer_FirstName, opts => opts.MapFrom(s => s.FirstName))
       .ForMember(d => d.ecer_LastName, opts => opts.MapFrom(s => s.LastName))
       .ForMember(d => d.ecer_EmailAddress, opts => opts.MapFrom(s => s.EmailAddress))
@@ -84,7 +86,9 @@ public ICRARepositoryMapper()
       .ForMember(d => d.LastName, opts => opts.MapFrom(s => s.ecer_LastName))
       .ForMember(d => d.EmailAddress, opts => opts.MapFrom(s => s.ecer_EmailAddress))
       .ForMember(d => d.PhoneNumber, opts => opts.MapFrom(s => s.ecer_PhoneNumber))
-      .ForMember(d => d.Type, opts => opts.MapFrom(s => s.ecer_Type));
+      .ForMember(d => d.Status, opts => opts.MapFrom(s => s.StatusCode))
+      .ForMember(d => d.Type, opts => opts.MapFrom(s => s.ecer_Type))
+      .ForMember(d => d.WillProvideReference, opts => opts.MapFrom(s => s.ecer_WillProvideReference.HasValue ? s.ecer_WillProvideReference.Equals(ecer_YesNoNull.Yes) : default(bool?)));
 
     CreateMap<ICRAWorkExperienceReferenceSubmissionRequest, ecer_WorkExperienceRef>(MemberList.Source)
       .ForSourceMember(s => s.CountryId, opts => opts.DoNotValidate())
@@ -103,6 +107,7 @@ public ICRARepositoryMapper()
       .ForMember(d => d.ecer_RelationshiptoApplicant, opts => opts.MapFrom(s => s.ReferenceRelationship))
       .ForMember(d => d.ecer_WillProvideReference, opts => opts.MapFrom(s => s.WillProvideReference ? ecer_YesNoNull.Yes : ecer_YesNoNull.No))
       .ForMember(d => d.ecer_DateSigned, opts => opts.MapFrom(s => s.DateSigned));
+
   }
 
   public static string IdOrEmpty(EntityReference? reference) =>

src/ECER.Resources.Documents/ICRA/IICRARepository.cs

@@ -62,7 +62,10 @@ public record EmploymentReference
   public string? FirstName { get; set; }
   public string? EmailAddress { get; set; }
   public string? PhoneNumber { get; set; }
+  public WorkExperienceRefStage? Status { get; set; }
+  public bool? WillProvideReference { get; set; }
   public WorkExperienceTypesIcra Type { get; set; }
+
 }
 
 public record ICRAWorkExperienceReferenceSubmissionRequest

src/ECER.Tests/Integration/RegistryApi/IcraTests.cs

@@ -145,6 +145,130 @@ await Host.Scenario(_ =>
     });
   }
 
+  [Fact]
+  public async Task GetIcraEligibilityStatus_BadId_ReturnsBadRequest()
+  {
+    await Host.Scenario(_ =>
+    {
+      _.WithExistingUser(this.Fixture.AuthenticatedBcscUserIdentity, this.Fixture.AuthenticatedBcscUser);
+      _.Get.Url($"/api/icra/not-a-guid/status");
+      _.StatusCodeShouldBe(HttpStatusCode.BadRequest);
+    });
+  }
+
+  [Fact]
+  public async Task GetIcraEligibilityStatus_NotFound_ReturnsNotFound()
+  {
+    var invalidId = Guid.NewGuid().ToString();
+    await Host.Scenario(_ =>
+    {
+      _.WithExistingUser(this.Fixture.AuthenticatedBcscUserIdentity, this.Fixture.AuthenticatedBcscUser);
+      _.Get.Url($"/api/icra/{invalidId}/status");
+      _.StatusCodeShouldBe(HttpStatusCode.NotFound);
+    });
+  }
+
+  [Fact]
+  public async Task GetIcraEligibilityStatus_ReturnsExpectedFields()
+  {
+    var eligibility = new Clients.RegistryPortal.Server.ICRA.ICRAEligibility
+    {
+      ApplicantId = this.Fixture.AuthenticatedBcscUser.Id.ToString(),
+      Status = Clients.RegistryPortal.Server.ICRA.ICRAStatus.Draft,
+      InternationalCertifications = new List<Clients.RegistryPortal.Server.ICRA.InternationalCertification>
+      {
+        new Clients.RegistryPortal.Server.ICRA.InternationalCertification
+        {
+          CertificateStatus = Clients.RegistryPortal.Server.ICRA.CertificateStatus.Valid,
+          CertificateTitle = faker.Company.CatchPhrase(),
+          IssueDate = faker.Date.Past(),
+          ExpiryDate = faker.Date.Soon(),
+          CountryId = this.Fixture.Country.ecer_CountryId!.Value.ToString(),
+        }
+      }
+    };
+
+    var saveResponse = await Host.Scenario(_ =>
+    {
+      _.WithExistingUser(this.Fixture.AuthenticatedBcscUserIdentity, this.Fixture.AuthenticatedBcscUser);
+      _.Put.Json(new SaveDraftICRAEligibilityRequest(eligibility)).ToUrl($"/api/icra/");
+      _.StatusCodeShouldBeOk();
+    });
+
+    var saved = (await saveResponse.ReadAsJsonAsync<DraftICRAEligibilityResponse>()).ShouldNotBeNull().Eligibility;
+
+    var statusResponse = await Host.Scenario(_ =>
+    {
+      _.WithExistingUser(this.Fixture.AuthenticatedBcscUserIdentity, this.Fixture.AuthenticatedBcscUser);
+      _.Get.Url($"/api/icra/{saved.Id}/status");
+      _.StatusCodeShouldBeOk();
+    });
+
+    var status = await statusResponse.ReadAsJsonAsync<Clients.RegistryPortal.Server.ICRA.ICRAEligibilityStatus>();
+    status.ShouldNotBeNull();
+    status.Id.ShouldBe(saved.Id);
+    status.Status.ShouldBe(Clients.RegistryPortal.Server.ICRA.ICRAStatus.Draft);
+    status.InternationalCertifications.ShouldNotBeNull();
+    status.InternationalCertifications.Count().ShouldBe(1);
+
+    // employment references status should be present and empty (none added yet)
+    status.EmploymentReferencesStatus.ShouldNotBeNull();
+    status.EmploymentReferencesStatus.Count().ShouldBe(0);
+
+    await SetEligibilityToIneligible(saved.Id!);
+  }
+
+  [Fact]
+  public async Task GetIcraEligibilityStatus_IncludesEmploymentReferencesStatuses()
+  {
+    var eligibility = new Clients.RegistryPortal.Server.ICRA.ICRAEligibility
+    {
+      ApplicantId = this.Fixture.AuthenticatedBcscUser.Id.ToString(),
+      Status = Clients.RegistryPortal.Server.ICRA.ICRAStatus.Draft,
+      EmploymentReferences = new[]
+      {
+        new Clients.RegistryPortal.Server.ICRA.EmploymentReference { FirstName = "John", LastName = "Doe", EmailAddress = "[email protected]" },
+        new Clients.RegistryPortal.Server.ICRA.EmploymentReference { FirstName = "Jane", LastName = "Smith", EmailAddress = "[email protected]" }
+      },
+      InternationalCertifications = new List<Clients.RegistryPortal.Server.ICRA.InternationalCertification>
+      {
+        new Clients.RegistryPortal.Server.ICRA.InternationalCertification
+        {
+          CertificateStatus = Clients.RegistryPortal.Server.ICRA.CertificateStatus.Valid,
+          CertificateTitle = faker.Company.CatchPhrase(),
+          IssueDate = faker.Date.Past(),
+          ExpiryDate = faker.Date.Soon(),
+          CountryId = this.Fixture.Country.ecer_CountryId!.Value.ToString(),
+        }
+      }
+    };
+
+    var saveResponse = await Host.Scenario(_ =>
+    {
+      _.WithExistingUser(this.Fixture.AuthenticatedBcscUserIdentity, this.Fixture.AuthenticatedBcscUser);
+      _.Put.Json(new SaveDraftICRAEligibilityRequest(eligibility)).ToUrl($"/api/icra/");
+      _.StatusCodeShouldBeOk();
+    });
+
+    var saved = (await saveResponse.ReadAsJsonAsync<DraftICRAEligibilityResponse>()).ShouldNotBeNull().Eligibility;
+
+    var statusResponse = await Host.Scenario(_ =>
+    {
+      _.WithExistingUser(this.Fixture.AuthenticatedBcscUserIdentity, this.Fixture.AuthenticatedBcscUser);
+      _.Get.Url($"/api/icra/{saved.Id}/status");
+      _.StatusCodeShouldBeOk();
+    });
+
+    var status = await statusResponse.ReadAsJsonAsync<Clients.RegistryPortal.Server.ICRA.ICRAEligibilityStatus>();
+    status.ShouldNotBeNull();
+    status.EmploymentReferencesStatus.ShouldNotBeNull();
+    status.EmploymentReferencesStatus.Count().ShouldBe(2);
+    status.EmploymentReferencesStatus.All(r => !string.IsNullOrWhiteSpace(r.FirstName)).ShouldBeTrue();
+    status.EmploymentReferencesStatus.All(r => r.Status.HasValue).ShouldBeTrue();
+
+    await SetEligibilityToIneligible(saved.Id!);
+  }
+
   [Fact]
   public async Task SaveDraftIcraEligibility_WithMismatchedIds_ReturnsBadRequest()
   {