Academies database connection - add search provider

DfE.FindInformationAcademiesTrusts.Data.AcademiesDb/AcademiesDbContext.cs

@@ -4,8 +4,13 @@
 
 namespace DfE.FindInformationAcademiesTrusts.Data.AcademiesDb;
 
+public interface IAcademiesDbContext
+{
+    DbSet<Group> Groups { get; }
+}
+
 [ExcludeFromCodeCoverage]
-public class AcademiesDbContext : DbContext
+public class AcademiesDbContext : DbContext, IAcademiesDbContext
 {
     public AcademiesDbContext()
     {

DfE.FindInformationAcademiesTrusts.Data.AcademiesDb/DfE.FindInformationAcademiesTrusts.Data.AcademiesDb.csproj

@@ -14,4 +14,8 @@
         <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="7.0.11"/>
     </ItemGroup>
 
+    <ItemGroup>
+        <ProjectReference Include="..\DfE.FindInformationAcademiesTrusts.Data\DfE.FindInformationAcademiesTrusts.Data.csproj"/>
+    </ItemGroup>
+
 </Project>

DfE.FindInformationAcademiesTrusts.Data.AcademiesDb/TrustHelper.cs

@@ -0,0 +1,23 @@
+using DfE.FindInformationAcademiesTrusts.Data.AcademiesDb.Models;
+
+namespace DfE.FindInformationAcademiesTrusts.Data.AcademiesDb;
+
+public interface ITrustHelper
+{
+    string BuildAddressString(Group group);
+}
+
+public class TrustHelper : ITrustHelper
+{
+    public string BuildAddressString(Group group)
+    {
+        return string.Join(", ", new[]
+        {
+            group.GroupContactStreet,
+            group.GroupContactLocality,
+            group.GroupContactTown,
+            group.GroupContactCounty,
+            group.GroupContactPostcode
+        }.Where(s => !string.IsNullOrWhiteSpace(s)));
+    }
+}

DfE.FindInformationAcademiesTrusts.Data.AcademiesDb/TrustSearch.cs

@@ -0,0 +1,52 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace DfE.FindInformationAcademiesTrusts.Data.AcademiesDb;
+
+public class TrustSearch : ITrustSearch
+{
+    private readonly IAcademiesDbContext _academiesDbContext;
+    private readonly ITrustHelper _trustHelper;
+
+    [ExcludeFromCodeCoverage] // This constructor is used by the DI container and is not unit testable
+    public TrustSearch(AcademiesDbContext academiesDbContext, ITrustHelper trustHelper)
+        : this((IAcademiesDbContext)academiesDbContext, trustHelper)
+    {
+    }
+
+    public TrustSearch(IAcademiesDbContext academiesDbContext, ITrustHelper trustHelper)
+    {
+        _trustHelper = trustHelper;
+        _academiesDbContext = academiesDbContext;
+    }
+
+    public Task<IEnumerable<TrustSearchEntry>> SearchAsync(string searchTerm)
+    {
+        if (string.IsNullOrWhiteSpace(searchTerm))
+        {
+            return Task.FromResult(
+                Array.Empty<TrustSearchEntry>().AsEnumerable()
+            );
+        }
+
+        var trustSearchEntries = _academiesDbContext.Groups
+            .Where(g =>
+                g.GroupUid != null &&
+                g.GroupId != null &&
+                g.GroupName != null &&
+                g.GroupName.Contains(searchTerm) &&
+                g.GroupType != null &&
+                (g.GroupType == "Multi-academy trust" ||
+                 g.GroupType == "Single-academy trust")
+            ) //note that LINQ translates string.contains to case insensitive SQL
+            .OrderBy(g => g.GroupName)
+            .Take(20)
+            .Select(g =>
+                new TrustSearchEntry(g.GroupName!, _trustHelper.BuildAddressString(g), g.GroupUid!, g.GroupId!))
+            .AsEnumerable();
+
+
+        return Task.FromResult(
+            trustSearchEntries
+        );
+    }
+}

DfE.FindInformationAcademiesTrusts.Data/DfE.FindInformationAcademiesTrusts.Data.csproj

@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFramework>net7.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+</Project>

DfE.FindInformationAcademiesTrusts.Data/ITrustSearch.cs

@@ -0,0 +1,6 @@
+namespace DfE.FindInformationAcademiesTrusts.Data;
+
+public interface ITrustSearch
+{
+    public Task<IEnumerable<TrustSearchEntry>> SearchAsync(string searchTerm);
+}

DfE.FindInformationAcademiesTrusts.Data/Trust.cs

@@ -0,0 +1,3 @@
+namespace DfE.FindInformationAcademiesTrusts.Data;
+
+public record Trust(string Name, string? Ukprn, string Type);

DfE.FindInformationAcademiesTrusts.Data/TrustSearchEntry.cs

@@ -0,0 +1,3 @@
+namespace DfE.FindInformationAcademiesTrusts.Data;
+
+public record TrustSearchEntry(string Name, string Address, string Uid, string GroupId);

DfE.FindInformationAcademiesTrusts.sln

@@ -10,6 +10,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DfE.FindInformationAcademie
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DfE.FindInformationAcademiesTrusts.Data.AcademiesDb.UnitTests", "tests\DfE.FindInformationAcademiesTrusts.Data.AcademiesDb.UnitTests\DfE.FindInformationAcademiesTrusts.Data.AcademiesDb.UnitTests.csproj", "{E20D30CB-8EB1-453B-8C49-77CAFBF16A13}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DfE.FindInformationAcademiesTrusts.Data", "DfE.FindInformationAcademiesTrusts.Data\DfE.FindInformationAcademiesTrusts.Data.csproj", "{DC3BD883-B6DA-4C54-85CB-2CD5D261E8FE}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -32,6 +34,10 @@ Global
 		{E20D30CB-8EB1-453B-8C49-77CAFBF16A13}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E20D30CB-8EB1-453B-8C49-77CAFBF16A13}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E20D30CB-8EB1-453B-8C49-77CAFBF16A13}.Release|Any CPU.Build.0 = Release|Any CPU
+		{DC3BD883-B6DA-4C54-85CB-2CD5D261E8FE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{DC3BD883-B6DA-4C54-85CB-2CD5D261E8FE}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{DC3BD883-B6DA-4C54-85CB-2CD5D261E8FE}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{DC3BD883-B6DA-4C54-85CB-2CD5D261E8FE}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{0A3416F9-33DB-4870-97EA-7CFF8D828031} = {E22DC2DA-4EB5-41C6-A41D-349692BCCDBE}

DfE.FindInformationAcademiesTrusts/DfE.FindInformationAcademiesTrusts.csproj

@@ -45,5 +45,6 @@
 
     <ItemGroup>
         <ProjectReference Include="..\DfE.FindInformationAcademiesTrusts.Data.AcademiesDb\DfE.FindInformationAcademiesTrusts.Data.AcademiesDb.csproj"/>
+        <ProjectReference Include="..\DfE.FindInformationAcademiesTrusts.Data\DfE.FindInformationAcademiesTrusts.Data.csproj"/>
     </ItemGroup>
 </Project>

DfE.FindInformationAcademiesTrusts/Pages/Search.cshtml

@@ -27,7 +27,7 @@
         @foreach (var trust in Model.Trusts)
         {
           <li class="govuk-!-margin-bottom-6">
-            <a asp-page="./Trusts/Details" asp-route-ukprn="@trust.Ukprn" class="govuk-!-font-weight-bold govuk-link govuk-!-font-size-24">@Html.DisplayFor(modelItem => trust.Name)</a>
+            <a asp-page="./Trusts/Details" asp-route-uid="@trust.Uid" class="govuk-!-font-weight-bold govuk-link govuk-!-font-size-24">@Html.DisplayFor(modelItem => trust.Name)</a>
             <dl class="govuk-summary-list govuk-summary-list--no-border app-search-results-summary-list">
               <div class="govuk-summary-list__row govuk-body app-search-results-summary-list__row">
                 <dt class="govuk-summary-list__key app-search-results-summary-list__key app-search-results-summary-list__item">
@@ -39,18 +39,18 @@
               </div>
               <div class="govuk-summary-list__row govuk-body app-search-results-summary-list__row">
                 <dt class="govuk-summary-list__key app-search-results-summary-list__key app-search-results-summary-list__item">
-                  UKPRN:
+                  Group ID/TRN:
                 </dt>
                 <dd class="govuk-summary-list__value app-search-results-summary-list__item">
-                  @Html.DisplayFor(modelItem => trust.Ukprn)
+                  @Html.DisplayFor(modelItem => trust.GroupId)
                 </dd>
               </div>
-              <div class="govuk-summary-list__row app-search-results-summary-list__row">
+              <div class="govuk-summary-list__row govuk-body app-search-results-summary-list__row">
                 <dt class="govuk-summary-list__key app-search-results-summary-list__key app-search-results-summary-list__item">
-                  Academies in this trust:
+                  UID:
                 </dt>
                 <dd class="govuk-summary-list__value app-search-results-summary-list__item">
-                  @Html.DisplayFor(modelItem => trust.AcademyCount)
+                  @Html.DisplayFor(modelItem => trust.Uid)
                 </dd>
               </div>
             </dl>

DfE.FindInformationAcademiesTrusts/Pages/Search.cshtml.cs

@@ -1,3 +1,4 @@
+using DfE.FindInformationAcademiesTrusts.Data;
 using DfE.FindInformationAcademiesTrusts.Pages.Shared;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.RazorPages;
@@ -9,10 +10,12 @@ public class SearchModel : PageModel, ISearchFormModel
     public record AutocompleteEntry(string Address, string Name, string? TrustId);
 
     private readonly ITrustProvider _trustProvider;
+    private readonly ITrustSearch _trustSearch;
 
-    public SearchModel(ITrustProvider trustProvider)
+    public SearchModel(ITrustProvider trustProvider, ITrustSearch trustSearch)
     {
         _trustProvider = trustProvider;
+        _trustSearch = trustSearch;
     }
 
     public string InputId => "search";
@@ -27,7 +30,7 @@ public async Task<IActionResult> OnGetAsync()
             var trust = await _trustProvider.GetTrustByUkprnAsync(TrustId);
             if (trust != null && string.Equals(trust.Name, KeyWords, StringComparison.CurrentCultureIgnoreCase))
             {
-                return RedirectToPage("/Trusts/Details", new { Ukprn = TrustId });
+                return RedirectToPage("/Trusts/Details", new { Uid = TrustId });
             }
         }
 
@@ -38,7 +41,7 @@ public async Task<IActionResult> OnGetAsync()
     private async Task<IEnumerable<TrustSearchEntry>> GetTrustsForKeywords()
     {
         return !string.IsNullOrEmpty(KeyWords)
-            ? await _trustProvider.GetTrustsByNameAsync(KeyWords)
+            ? await _trustSearch.SearchAsync(KeyWords)
             : Array.Empty<TrustSearchEntry>();
     }
 
@@ -49,7 +52,7 @@ public async Task<IActionResult> OnGetPopulateAutocompleteAsync()
                 new AutocompleteEntry(
                     trust.Address,
                     trust.Name,
-                    trust.Ukprn
+                    trust.Uid
                 )));
     }
 }

DfE.FindInformationAcademiesTrusts/Pages/Trusts/Contacts.cshtml

@@ -1,4 +1,4 @@
-@page "{ukprn}"
+@page "{uid}"
 @model ContactsModel
 
 @{

DfE.FindInformationAcademiesTrusts/Pages/Trusts/Contacts.cshtml.cs

@@ -1,3 +1,4 @@
+using DfE.FindInformationAcademiesTrusts.Data;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.RazorPages;
 
@@ -12,14 +13,14 @@ public ContactsModel(ITrustProvider trustProvider)
         _trustProvider = trustProvider;
     }
 
-    [BindProperty(SupportsGet = true)] public string Ukprn { get; set; } = "";
+    [BindProperty(SupportsGet = true)] public string Uid { get; set; } = "";
     public Trust Trust { get; set; } = default!;
     public string PageName => "Contacts";
     public string Section => ViewConstants.AboutTheTrustSectionName;
 
     public async Task<IActionResult> OnGetAsync()
     {
-        var trust = await _trustProvider.GetTrustByUkprnAsync(Ukprn);
+        var trust = await _trustProvider.GetTrustByUkprnAsync(Uid);
 
         if (trust == null)
         {

DfE.FindInformationAcademiesTrusts/Pages/Trusts/Details.cshtml

@@ -1,4 +1,4 @@
-@page "{ukprn}"
+@page "{uid}"
 @model DetailsModel
 @{
   Layout = "_TrustLayout";

DfE.FindInformationAcademiesTrusts/Pages/Trusts/Details.cshtml.cs

@@ -1,3 +1,4 @@
+using DfE.FindInformationAcademiesTrusts.Data;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.RazorPages;
 
@@ -12,15 +13,15 @@ public DetailsModel(ITrustProvider trustProvider)
         _trustProvider = trustProvider;
     }
 
-    [BindProperty(SupportsGet = true)] public string Ukprn { get; set; } = "";
+    [BindProperty(SupportsGet = true)] public string Uid { get; set; } = "";
     public Trust Trust { get; set; } = default!;
     public string PageName => "Details";
     public string Section => ViewConstants.AboutTheTrustSectionName;
 
 
     public async Task<IActionResult> OnGetAsync()
     {
-        var trust = await _trustProvider.GetTrustByUkprnAsync(Ukprn);
+        var trust = await _trustProvider.GetTrustByUkprnAsync(Uid);
 
         if (trust == null)
         {

DfE.FindInformationAcademiesTrusts/Pages/Trusts/ITrustsAreaModel.cs

@@ -1,3 +1,5 @@
+using DfE.FindInformationAcademiesTrusts.Data;
+
 namespace DfE.FindInformationAcademiesTrusts.Pages.Trusts;
 
 public interface ITrustsAreaModel

DfE.FindInformationAcademiesTrusts/Program.cs

@@ -1,5 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
+using DfE.FindInformationAcademiesTrusts.Data;
 using DfE.FindInformationAcademiesTrusts.Data.AcademiesDb;
 using Microsoft.ApplicationInsights.Extensibility;
 using Microsoft.AspNetCore.Authentication.Cookies;
@@ -149,6 +150,7 @@ private static void AddDependenciesTo(WebApplicationBuilder builder)
 
         builder.Services.AddScoped<ITrustSearch, TrustSearch>();
         builder.Services.AddScoped<ITrustProvider, TrustProvider>();
+        builder.Services.AddScoped<ITrustHelper, TrustHelper>();
 
         builder.Services.AddHttpClient("AcademiesApi", (provider, httpClient) =>
         {

DfE.FindInformationAcademiesTrusts/TrustProvider.cs

@@ -1,13 +1,12 @@
 using System.Net;
 using System.Text.Json;
 using DfE.FindInformationAcademiesTrusts.AcademiesApiResponseModels;
+using DfE.FindInformationAcademiesTrusts.Data;
 
 namespace DfE.FindInformationAcademiesTrusts;
 
 public interface ITrustProvider
 {
-    public Task<IEnumerable<TrustSearchEntry>> GetTrustsAsync();
-    public Task<IEnumerable<TrustSearchEntry>> GetTrustsByNameAsync(string name);
     public Task<Trust?> GetTrustByUkprnAsync(string ukprn);
 }
 
@@ -24,46 +23,6 @@ public TrustProvider(IHttpClientFactory httpClientFactory,
         _httpClient = httpClientFactory.CreateClient("AcademiesApi");
     }
 
-    public async Task<IEnumerable<TrustSearchEntry>> GetTrustsAsync()
-    {
-        var requestUri = "v3/trusts";
-
-        return await FetchTrustsAsync(requestUri);
-    }
-
-    public async Task<IEnumerable<TrustSearchEntry>> GetTrustsByNameAsync(string name)
-    {
-        var requestUri = $"v3/trusts?groupName={name}";
-
-        return await FetchTrustsAsync(requestUri);
-    }
-
-    private async Task<IEnumerable<TrustSearchEntry>> FetchTrustsAsync(string requestUri)
-    {
-        var httpResponseMessage = await _httpClient.GetAsync(requestUri);
-        if (httpResponseMessage.IsSuccessStatusCode)
-        {
-            await using var contentStream = await httpResponseMessage.Content.ReadAsStreamAsync();
-            var json = await JsonSerializer.DeserializeAsync<ApiResponseV3<TrustSummaryResponse>>(contentStream,
-                new JsonSerializerOptions { PropertyNameCaseInsensitive = true });
-
-            if (json?.Data == null) throw new JsonException();
-            var transformedData = json.Data
-                .Where(t => t.GroupName != null)
-                .Select(t => new TrustSearchEntry(
-                    t.GroupName!,
-                    TrustAddressAsString(t.TrustAddress),
-                    t.Ukprn,
-                    t.Establishments?.Count ?? 0
-                ));
-            return transformedData.OrderBy(t => t.Name);
-        }
-
-        var errorMessage = await httpResponseMessage.Content.ReadAsStringAsync();
-        LogHttpError(httpResponseMessage, errorMessage);
-        throw new HttpRequestException("Problem communicating with Academies API");
-    }
-
     public async Task<Trust?> GetTrustByUkprnAsync(string ukprn)
     {
         var httpResponseMessage = await _httpClient.GetAsync($"v3/trust/{ukprn}");
@@ -104,17 +63,4 @@ private void LogHttpError(HttpResponseMessage httpResponseMessage, string errorM
             httpResponseMessage.Headers
         );
     }
-
-    private static string TrustAddressAsString(AddressResponse? addressResponse)
-    {
-        if (addressResponse == null) return string.Empty;
-        return string.Join(", ", new[]
-        {
-            addressResponse.Street,
-            addressResponse.Locality,
-            addressResponse.AdditionalLine,
-            addressResponse.Town,
-            addressResponse.Postcode
-        }.Where(s => !string.IsNullOrWhiteSpace(s)));
-    }
 }