Initial integration of Charity Commission API.

Frontend/CO.CDP.OrganisationApp.Tests/Pages/Registration/OrganisationEmailModelTest.cs

@@ -1,5 +1,8 @@
+using CO.CDP.OrganisationApp.CharityCommission;
+using CO.CDP.OrganisationApp.Constants;
 using CO.CDP.OrganisationApp.Models;
 using CO.CDP.OrganisationApp.Pages.Registration;
+using CO.CDP.OrganisationApp.ThirdPartyApiClients.CharityCommission;
 using FluentAssertions;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
@@ -13,10 +16,12 @@ namespace CO.CDP.OrganisationApp.Tests.Pages.Registration;
 public class OrganisationEmailModelTest
 {
     private readonly Mock<ISession> sessionMock;
+    private readonly Mock<ICharityCommissionApi> charityCommissionMock;
 
     public OrganisationEmailModelTest()
     {
         sessionMock = new Mock<ISession>();
+        charityCommissionMock = new Mock<ICharityCommissionApi>();
         sessionMock.Setup(session => session.Get<UserDetails>(Session.UserDetailsKey))
             .Returns(new UserDetails { UserUrn = "urn:test" });
     }
@@ -143,20 +148,66 @@ public void OnPost_WhenModelStateIsValidAndRedirectToSummary_ShouldRedirectToOrg
             .Which.PageName.Should().Be("OrganisationDetailsSummary");
     }
 
-    private RegistrationDetails DummyRegistrationDetails()
+    [Fact]
+    public async Task OnGet_WhenCharityCommissionNumberProvided_ShouldPrepopulateEmail()
+    {
+        var registrationDetails = DummyRegistrationDetails(organisationName: "",
+            scheme: OrganisationSchemeType.CharityCommissionEnglandWales,
+            organisationEmailAddress: "");
+        sessionMock.Setup(s => s.Get<RegistrationDetails>(Session.RegistrationDetailsKey)).Returns(registrationDetails);
+
+        var chartiyDetails = GivenEmailOnCharitiesCommission();
+        var model = GivenOrganisationEmailModel();
+
+        charityCommissionMock.Setup(s => s.GetCharityDetails(registrationDetails.OrganisationIdentificationNumber!))
+            .ReturnsAsync(chartiyDetails);
+
+        await model.OnGet();
+
+        model.EmailAddress.Should().Be(chartiyDetails.Email);
+    }
+
+    [Fact]
+    public async Task OnGet_WhenCharityCommissionNumberProvidedRegDetailsProvided_ShouldNotPrepopulateEmail()
+    {
+        var registrationDetails = DummyRegistrationDetails(scheme: OrganisationSchemeType.CharityCommissionEnglandWales);
+        sessionMock.Setup(s => s.Get<RegistrationDetails>(Session.RegistrationDetailsKey)).Returns(registrationDetails);
+
+        var chartiyDetails = GivenEmailOnCharitiesCommission();
+        var model = GivenOrganisationEmailModel();
+
+        charityCommissionMock.Setup(s => s.GetCharityDetails(registrationDetails.OrganisationIdentificationNumber!))
+            .ReturnsAsync(chartiyDetails);
+
+        await model.OnGet();
+
+        model.EmailAddress.Should().Be(registrationDetails.OrganisationEmailAddress);
+    }
+
+    private CharityDetails GivenEmailOnCharitiesCommission()
+    {
+        return new CharityDetails()
+        {
+            Email = "contactus@britishredcross.org"
+        };
+    }
+
+    private RegistrationDetails DummyRegistrationDetails(string organisationName = "TestOrg",
+        string scheme = "TestType",
+        string organisationEmailAddress = "test@example.com")
     {
         var registrationDetails = new RegistrationDetails
         {
-            OrganisationName = "TestOrg",
-            OrganisationScheme = "TestType",
-            OrganisationEmailAddress = "test@example.com"
+            OrganisationName = organisationName,
+            OrganisationScheme = scheme,
+            OrganisationEmailAddress = organisationEmailAddress
         };
 
         return registrationDetails;
     }
 
     private OrganisationEmailModel GivenOrganisationEmailModel()
     {
-        return new OrganisationEmailModel(sessionMock.Object);
+        return new OrganisationEmailModel(sessionMock.Object, charityCommissionMock.Object);
     }
 }

Frontend/CO.CDP.OrganisationApp.Tests/Pages/Registration/OrganisationNameModelTest.cs

@@ -1,6 +1,9 @@
+using CO.CDP.OrganisationApp.CharityCommission;
+using CO.CDP.OrganisationApp.Constants;
 using CO.CDP.OrganisationApp.Models;
 using CO.CDP.OrganisationApp.Pages.Registration;
 using CO.CDP.OrganisationApp.ThirdPartyApiClients;
+using CO.CDP.OrganisationApp.ThirdPartyApiClients.CharityCommission;
 using CO.CDP.OrganisationApp.ThirdPartyApiClients.CompaniesHouse;
 using FluentAssertions;
 using Microsoft.AspNetCore.Http;
@@ -16,11 +19,13 @@ public class OrganisationNameModelTest
 {
     private readonly Mock<ISession> sessionMock;
     private readonly Mock<ICompaniesHouseApi> companiesHouseMock;
+    private readonly Mock<ICharityCommissionApi> charityCommissionMock;
 
     public OrganisationNameModelTest()
     {
         sessionMock = new Mock<ISession>();
         companiesHouseMock = new Mock<ICompaniesHouseApi>();
+        charityCommissionMock = new Mock<ICharityCommissionApi>();
         sessionMock.Setup(session => session.Get<UserDetails>(Session.UserDetailsKey))
             .Returns(new UserDetails { UserUrn = "urn:test" });
     }
@@ -140,6 +145,40 @@ public async Task OnGet_WhenCompaniesHouseNumberAndCompanyNameProvided_ShouldNot
         model.OrganisationName.Should().Be(registrationDetails.OrganisationName);
     }
 
+    [Fact]
+    public async Task OnGet_WhenCharityCommissionNumberProvided_ShouldPrepopulateCompanyName()
+    {
+        var registrationDetails = DummyRegistrationDetails(organisationName: "", scheme: OrganisationSchemeType.CharityCommissionEnglandWales);
+        sessionMock.Setup(s => s.Get<RegistrationDetails>(Session.RegistrationDetailsKey)).Returns(registrationDetails);
+
+        var chartiyDetails = GivenNameOnCharitiesCommission(organisationName: "British Red Cross");
+        var model = GivenOrganisationNameModel();
+
+        charityCommissionMock.Setup(s => s.GetCharityDetails(registrationDetails.OrganisationIdentificationNumber!))
+            .ReturnsAsync(chartiyDetails);
+
+        await model.OnGet();
+
+        model.OrganisationName.Should().Be(chartiyDetails.Name);
+    }
+
+    [Fact]
+    public async Task OnGet_WhenCharityCommissionNumberProvidedAndRegDetailsProvided_ShouldNotPrepopulateCompanyName()
+    {
+        var registrationDetails = DummyRegistrationDetails(organisationName: "British Heart Foundation", scheme: OrganisationSchemeType.CharityCommissionEnglandWales);
+        sessionMock.Setup(s => s.Get<RegistrationDetails>(Session.RegistrationDetailsKey)).Returns(registrationDetails);
+
+        var chartiyDetails = GivenNameOnCharitiesCommission(organisationName: "British Red Cross");
+        var model = GivenOrganisationNameModel();
+
+        charityCommissionMock.Setup(s => s.GetCharityDetails(registrationDetails.OrganisationIdentificationNumber!))
+            .ReturnsAsync(chartiyDetails);
+
+        await model.OnGet();
+
+        model.OrganisationName.Should().Be(registrationDetails.OrganisationName);
+    }
+
     [Fact]
     public void OnPost_WhenValidModel_ShouldRedirectToOrganisationEmailPage()
     {
@@ -169,15 +208,15 @@ public void OnPost_WhenModelStateIsValidAndRedirectToSummary_ShouldRedirectToOrg
             .Which.PageName.Should().Be("OrganisationDetailsSummary");
     }
 
-    private RegistrationDetails DummyRegistrationDetails(string organisationName = "TestOrg")
+    private RegistrationDetails DummyRegistrationDetails(string organisationName = "TestOrg", string scheme = "")
     {
         var registrationDetails = new RegistrationDetails
         {
-            OrganisationName = "TestOrg",
-            OrganisationScheme = "TestType",
+            OrganisationName = organisationName,
+            OrganisationScheme = scheme,
             OrganisationEmailAddress = "test@example.com",
             OrganisationIdentificationNumber = "123456",
-            OrganisationHasCompaniesHouseNumber = true,
+            OrganisationHasCompaniesHouseNumber = true
         };
 
         return registrationDetails;
@@ -188,6 +227,14 @@ private CompanyProfile GivenProfileOnCompaniesHouse(string organisationName = ""
         return new CompanyProfile() {  CompanyName = organisationName };
     }
 
+    private CharityDetails GivenNameOnCharitiesCommission(string organisationName = "")
+    {
+        return new CharityDetails()
+        {
+            Name = organisationName
+        };
+    }
+
     private RegisteredAddress GivenRegisteredAddressOnCompaniesHouse()
     {
         return new RegisteredAddress()
@@ -202,6 +249,6 @@ private RegisteredAddress GivenRegisteredAddressOnCompaniesHouse()
 
     private OrganisationNameModel GivenOrganisationNameModel()
     {
-        return new OrganisationNameModel(sessionMock.Object, companiesHouseMock.Object);
+        return new OrganisationNameModel(sessionMock.Object, charityCommissionMock.Object, companiesHouseMock.Object);
     }
 }

Frontend/CO.CDP.OrganisationApp.Tests/Pages/Registration/OrganisationRegisteredAddressModelTest.cs

@@ -1,7 +1,9 @@
+using CO.CDP.OrganisationApp.CharityCommission;
 using CO.CDP.OrganisationApp.Constants;
 using CO.CDP.OrganisationApp.Models;
 using CO.CDP.OrganisationApp.Pages.Registration;
 using CO.CDP.OrganisationApp.ThirdPartyApiClients;
+using CO.CDP.OrganisationApp.ThirdPartyApiClients.CharityCommission;
 using CO.CDP.OrganisationApp.ThirdPartyApiClients.CompaniesHouse;
 using FluentAssertions;
 using Microsoft.AspNetCore.Http;
@@ -17,11 +19,13 @@ public class OrganisationRegisteredAddressModelTest
 {
     private readonly Mock<ISession> sessionMock;
     private readonly Mock<ICompaniesHouseApi> companiesHouseMock;
+    private readonly Mock<ICharityCommissionApi> charityCommissionMock;
 
     public OrganisationRegisteredAddressModelTest()
     {
         sessionMock = new Mock<ISession>();
         companiesHouseMock = new Mock<ICompaniesHouseApi>();
+        charityCommissionMock = new Mock<ICharityCommissionApi>();
         sessionMock.Setup(session => session.Get<UserDetails>(Session.UserDetailsKey))
             .Returns(new UserDetails { UserUrn = "urn:test" });
     }
@@ -184,7 +188,46 @@ public async Task OnGet_ValidSession_ReturnsRegistrationDetails()
         model.Address.AddressLine1.Should().Be(registrationDetails.OrganisationAddressLine1);
         model.Address.TownOrCity.Should().Be(registrationDetails.OrganisationCityOrTown);
         model.Address.Postcode.Should().Be(registrationDetails.OrganisationPostcode);
-        //model.Country.Should().Be(registrationDetails.OrganisationCountry);
+    }
+
+    [Fact]
+    public async Task OnGet_WhenCharityCommissionNumberProvided_ShouldPrepopulateRegisteredAddress()
+    {
+        RegistrationDetails registrationDetails = DummyRegistrationDetails(emptyAddress: true,
+            scheme: OrganisationSchemeType.CharityCommissionEnglandWales, hasCompaniesHouseNumber: false);
+        sessionMock.Setup(s => s.Get<RegistrationDetails>(Session.RegistrationDetailsKey)).Returns(registrationDetails);
+
+        var model = GivenOrganisationAddressModel();
+        var chartiyDetails = GivenRegisteredAddressOnCharitiesCommission();
+
+        charityCommissionMock.Setup(s => s.GetCharityDetails(registrationDetails.OrganisationIdentificationNumber!))
+            .ReturnsAsync(chartiyDetails);
+
+        await model.OnGet();
+
+        model.Address.AddressLine1.Should().Be(chartiyDetails.AddressLine2);
+        model.Address.TownOrCity.Should().Be(chartiyDetails.AddressLine3);
+        model.Address.Postcode.Should().Be(chartiyDetails.PostalCode);
+    }
+
+    [Fact]
+    public async Task OnGet_WhenCharityCommissionNumberAndRegDetailsProvided_ShouldNotPrepopulateRegisteredAddress()
+    {
+        RegistrationDetails registrationDetails = DummyRegistrationDetails(scheme: OrganisationSchemeType.CharityCommissionEnglandWales,
+            hasCompaniesHouseNumber: false);
+        sessionMock.Setup(s => s.Get<RegistrationDetails>(Session.RegistrationDetailsKey)).Returns(registrationDetails);
+
+        var model = GivenOrganisationAddressModel();
+        var chartiyDetails = GivenRegisteredAddressOnCharitiesCommission();
+
+        charityCommissionMock.Setup(s => s.GetCharityDetails(registrationDetails.OrganisationIdentificationNumber!))
+            .ReturnsAsync(chartiyDetails);
+
+        await model.OnGet();
+
+        model.Address.AddressLine1.Should().Be(registrationDetails.OrganisationAddressLine1);
+        model.Address.TownOrCity.Should().Be(registrationDetails.OrganisationCityOrTown);
+        model.Address.Postcode.Should().Be(registrationDetails.OrganisationPostcode);
     }
 
     [Fact]
@@ -225,7 +268,7 @@ public async Task OnGet_WhenCompaniesHouseNumberAndRegDetailsProvided_ShouldNotP
         model.Address.Postcode.Should().Be(registrationDetails.OrganisationPostcode);
     }
 
-    private RegistrationDetails DummyRegistrationDetails(bool emptyAddress = false)
+    private RegistrationDetails DummyRegistrationDetails(bool emptyAddress = false, string scheme = "", bool hasCompaniesHouseNumber = true)
     {
         var registrationDetails = new RegistrationDetails
         {
@@ -235,7 +278,8 @@ private RegistrationDetails DummyRegistrationDetails(bool emptyAddress = false)
             OrganisationIdentificationNumber = "123456",
             OrganisationHasCompaniesHouseNumber = true,
             OrganisationCountryName = "United Kingdom",
-            OrganisationCountryCode = "GB"
+            OrganisationCountryCode = "GB",
+            OrganisationScheme = scheme
         };
 
         return registrationDetails;
@@ -253,8 +297,18 @@ private RegisteredAddress GivenRegisteredAddressOnCompaniesHouse()
         };
     }
 
+    private CharityDetails GivenRegisteredAddressOnCharitiesCommission()
+    {
+        return new CharityDetails()
+        {
+            AddressLine1 = "1 Mayfair",
+            AddressLine2 = "",
+            PostalCode = "SW2 1PT"
+        };
+    }
+
     private OrganisationRegisteredAddressModel GivenOrganisationAddressModel()
     {
-        return new OrganisationRegisteredAddressModel(sessionMock.Object, companiesHouseMock.Object) { Address = new() };
+        return new OrganisationRegisteredAddressModel(sessionMock.Object, charityCommissionMock.Object, companiesHouseMock.Object) { Address = new() };
     }
 }

Frontend/CO.CDP.OrganisationApp/Logging/CdpErrorCodes.cs

@@ -3,4 +3,5 @@ namespace CO.CDP.OrganisationApp.Logging;
 public class CdpErrorCodes
 {
     public const string CompaniesHouseApiError = "CDP_COMPANIES_HOUSE_API_ERROR";
+    public const string CharityCommissionApiError = "CDP_CHARITY_COMMISSION_API_ERROR";
 }

Frontend/CO.CDP.OrganisationApp/Pages/Registration/OrganisationEmail.cshtml.cs

@@ -1,12 +1,14 @@
+using CO.CDP.OrganisationApp.Constants;
 using CO.CDP.OrganisationApp.Models;
+using CO.CDP.OrganisationApp.ThirdPartyApiClients.CharityCommission;
 using Microsoft.AspNetCore.Mvc;
 using System.ComponentModel;
 using System.ComponentModel.DataAnnotations;
 
 namespace CO.CDP.OrganisationApp.Pages.Registration;
 
 [ValidateRegistrationStep]
-public class OrganisationEmailModel(ISession session) : RegistrationStepModel(session)
+public class OrganisationEmailModel(ISession session, ICharityCommissionApi charityCommissionApi) : RegistrationStepModel(session)
 {
     public override string CurrentPage => OrganisationEmailPage;
 
@@ -19,9 +21,19 @@ public class OrganisationEmailModel(ISession session) : RegistrationStepModel(se
     [BindProperty]
     public bool? RedirectToSummary { get; set; }
 
-    public void OnGet()
+    public async Task OnGet()
     {
         EmailAddress = RegistrationDetails.OrganisationEmailAddress;
+
+        if ((RegistrationDetails.OrganisationScheme == OrganisationSchemeType.CharityCommissionEnglandWales) && (string.IsNullOrEmpty(EmailAddress)))
+        {
+            var details = await charityCommissionApi.GetCharityDetails(RegistrationDetails.OrganisationIdentificationNumber!);
+
+            if (details != null)
+            {
+                EmailAddress = details.Email;
+            }
+        }
     }
 
     public IActionResult OnPost()

Frontend/CO.CDP.OrganisationApp/Pages/Registration/OrganisationName.cshtml.cs

@@ -1,5 +1,7 @@
 using CO.CDP.Localization;
+using CO.CDP.OrganisationApp.Constants;
 using CO.CDP.OrganisationApp.Models;
+using CO.CDP.OrganisationApp.ThirdPartyApiClients.CharityCommission;
 using CO.CDP.OrganisationApp.ThirdPartyApiClients.CompaniesHouse;
 using Microsoft.AspNetCore.Mvc;
 using System.ComponentModel;
@@ -8,7 +10,7 @@
 namespace CO.CDP.OrganisationApp.Pages.Registration;
 
 [ValidateRegistrationStep]
-public class OrganisationNameModel(ISession session, ICompaniesHouseApi companiesHouseApi) : RegistrationStepModel(session)
+public class OrganisationNameModel(ISession session, ICharityCommissionApi charityCommissionApi, ICompaniesHouseApi companiesHouseApi) : RegistrationStepModel(session)
 {
     public override string CurrentPage => OrganisationNamePage;
 
@@ -33,6 +35,16 @@ public async Task OnGet()
 
             OrganisationName = profile != null ? profile.CompanyName ?? string.Empty : string.Empty;
         }
+
+        if ((RegistrationDetails.OrganisationScheme == OrganisationSchemeType.CharityCommissionEnglandWales) && (string.IsNullOrEmpty(OrganisationName)))
+        {
+            var details = await charityCommissionApi.GetCharityDetails(RegistrationDetails.OrganisationIdentificationNumber!);
+
+            if (details != null)
+            {
+                OrganisationName = details.Name;
+            }
+        }
     }
 
     public IActionResult OnPost()