Merge pull request #413 from DFE-Digital/feature/trust-v4-endpoint

paullocknimble · web-flow · commit f34215bb57d1 · 2023-11-09T11:43:13.000Z
Feature/trust v4 endpoint
diff --git a/Dfe.Academies.Api.Infrastructure/Dfe.Academies.Infrastructure.csproj b/Dfe.Academies.Api.Infrastructure/Dfe.Academies.Infrastructure.csproj
@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.2" />
+    <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.4" />
     <PackageReference Include="Microsoft.EntityFrameworkCore" Version="6.0.24" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="6.0.24">
       <PrivateAssets>all</PrivateAssets>
diff --git a/Dfe.Academies.Api.Infrastructure/Repositories/TrustRepository.cs b/Dfe.Academies.Api.Infrastructure/Repositories/TrustRepository.cs
@@ -35,13 +35,13 @@ public async Task<List<Trust>> GetTrustsByUkprns(string[] ukprns, CancellationTo
             return trusts;
         }
 
-        public async Task<List<Trust>> Search(int page, int count, string name, string ukPrn, string companiesHouseNumber, CancellationToken cancellationToken)
+        public async Task<(List<Trust>, int)> Search(int page, int count, string name, string ukPrn, string companiesHouseNumber, CancellationToken cancellationToken)
         {
             if (name == null && ukPrn == null && companiesHouseNumber == null)
             {
                 List<Trust> allTrusts =  await dbSet.OrderBy(trust => trust.GroupUID).Skip((page - 1) * count)
                    .Take(count).ToListAsync(cancellationToken).ConfigureAwait(false);
-                return allTrusts;
+                return (allTrusts, allTrusts.Count);
             }
 
             IOrderedQueryable<Trust> filteredGroups = dbSet
@@ -54,7 +54,7 @@ public async Task<List<Trust>> Search(int page, int count, string name, string u
                            ))
                .OrderBy(trust => trust.GroupUID);
 
-            return await filteredGroups.Skip((page - 1) * count).Take(count).ToListAsync(cancellationToken).ConfigureAwait(false);
+            return (await filteredGroups.Skip((page - 1) * count).Take(count).ToListAsync(cancellationToken).ConfigureAwait(false), filteredGroups.Count());
         }
     }
 }
diff --git a/Dfe.Academies.Application.Tests/Queries/Establishment/EstablishmentQueriesTests.cs b/Dfe.Academies.Application.Tests/Queries/Establishment/EstablishmentQueriesTests.cs
@@ -1,12 +1,10 @@
 ﻿using AutoFixture;
 using Dfe.Academies.Application.Queries.Establishment;
-using Dfe.Academies.Contracts.Establishments;
-using Dfe.Academies.Contracts.Trusts;
+using Dfe.Academies.Contracts.V4.Establishments;
 using Dfe.Academies.Domain.Establishment;
 using Dfe.Academies.Domain.Trust;
 using FluentAssertions;
 using Moq;
-using System.Runtime.CompilerServices;
 
 namespace Dfe.Academies.Application.Tests.Queries.Establishment
 {
diff --git a/Dfe.Academies.Application.Tests/Queries/Trust/TrustQueriesTests.cs b/Dfe.Academies.Application.Tests/Queries/Trust/TrustQueriesTests.cs
@@ -1,6 +1,6 @@
 ﻿using AutoFixture;
 using Dfe.Academies.Application.Queries.Trust;
-using Dfe.Academies.Contracts.Trusts;
+using Dfe.Academies.Contracts.V4.Trusts;
 using Dfe.Academies.Domain.Trust;
 using FluentAssertions;
 using Moq;
@@ -57,7 +57,7 @@ public async Task Search_TrustsReturnedFromRepo_eturnsAListOfTrustDtosInAPagedRe
             // Arrange
             var trusts = _fixture.Create<List<Domain.Trust.Trust>>();
             var mockRepo = new Mock<ITrustRepository>();
-            mockRepo.Setup(x => x.Search(It.IsAny<int>(), It.IsAny<int>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>())).Returns(Task.FromResult(trusts));
+            mockRepo.Setup(x => x.Search(It.IsAny<int>(), It.IsAny<int>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<CancellationToken>())).Returns(Task.FromResult((trusts, trusts.Count)));
 
             var trustQueries = new TrustQueries(mockRepo.Object);
             int page = 0;
diff --git a/Dfe.Academies.Application/Builders/EstablishmentDtoBuilder.cs b/Dfe.Academies.Application/Builders/EstablishmentDtoBuilder.cs
@@ -1,4 +1,5 @@
-﻿using Dfe.Academies.Contracts.Establishments;
+﻿using Dfe.Academies.Contracts.V4;
+using Dfe.Academies.Contracts.V4.Establishments;
 
 namespace Dfe.Academies.Application.Builders
 {
@@ -128,7 +129,7 @@ public EstablishmentDtoBuilder WithMISEstablishment(Domain.Establishment.Establi
 
         public EstablishmentDtoBuilder WithAddress(Domain.Establishment.Establishment establishment)
         {
-            _dto.Address = new Contracts.Trusts.AddressDto()
+            _dto.Address = new AddressDto()
             {
                 Street = establishment?.AddressLine1,
                 Town = establishment?.Town,
diff --git a/Dfe.Academies.Application/Dfe.Academies.Application.csproj b/Dfe.Academies.Application/Dfe.Academies.Application.csproj
@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.2" />
+    <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.4" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="7.0.0" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
   </ItemGroup>
diff --git a/Dfe.Academies.Application/Queries/Establishment/EstablishmentQueries.cs b/Dfe.Academies.Application/Queries/Establishment/EstablishmentQueries.cs
@@ -1,8 +1,6 @@
-﻿using Dfe.Academies.Contracts.Establishments;
-using Dfe.Academies.Contracts.Trusts;
+﻿using Dfe.Academies.Contracts.V4.Establishments;
 using Dfe.Academies.Domain.Establishment;
-using System.Threading;
-using System;
+
 using Dfe.Academies.Application.Builders;
 using Dfe.Academies.Domain.Trust;
 
diff --git a/Dfe.Academies.Application/Queries/Establishment/IEstablishmentQueries.cs b/Dfe.Academies.Application/Queries/Establishment/IEstablishmentQueries.cs
@@ -1,10 +1,4 @@
-﻿using Dfe.Academies.Contracts.Establishments;
-using Dfe.Academies.Contracts.Trusts;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+﻿using Dfe.Academies.Contracts.V4.Establishments;
 
 namespace Dfe.Academies.Application.Queries.Establishment
 {
diff --git a/Dfe.Academies.Application/Queries/Trust/ITrustQueries.cs b/Dfe.Academies.Application/Queries/Trust/ITrustQueries.cs
@@ -1,4 +1,4 @@
-﻿using Dfe.Academies.Contracts.Trusts;
+﻿using Dfe.Academies.Contracts.V4.Trusts;
 
 namespace Dfe.Academies.Application.Queries.Trust
 {
diff --git a/Dfe.Academies.Application/Queries/Trust/TrustQueries.cs b/Dfe.Academies.Application/Queries/Trust/TrustQueries.cs
@@ -1,4 +1,5 @@
-﻿using Dfe.Academies.Contracts.Trusts;
+﻿using Dfe.Academies.Contracts.V4;
+using Dfe.Academies.Contracts.V4.Trusts;
 using Dfe.Academies.Domain.Trust;
 
 namespace Dfe.Academies.Application.Queries.Trust
@@ -24,9 +25,9 @@ public TrustQueries(ITrustRepository trustRepository)
 
         public async Task<(List<TrustDto>, int)> Search(int page, int count, string name, string ukPrn, string companiesHouseNumber, CancellationToken cancellationToken)
         {
-            var trusts = await _trustRepository.Search(page, count, name, ukPrn, companiesHouseNumber, cancellationToken).ConfigureAwait(false);
+            var (trusts, recordCount) = await _trustRepository.Search(page, count, name, ukPrn, companiesHouseNumber, cancellationToken).ConfigureAwait(false);
 
-            return (trusts.Select(x => MapToTrustDto(x)).ToList(), trusts.Count);
+            return (trusts.Select(x => MapToTrustDto(x)).ToList(), recordCount);
         }
 
         public async Task<List<TrustDto>> GetByUkprns(string[] ukprns, CancellationToken cancellationToken)
diff --git a/Dfe.Academies.Domain/Dfe.Academies.Domain.csproj b/Dfe.Academies.Domain/Dfe.Academies.Domain.csproj
@@ -7,7 +7,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.2" />
+    <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.4" />
   </ItemGroup>
 
 </Project>
diff --git a/Dfe.Academies.Domain/Trust/ITrustRepository.cs b/Dfe.Academies.Domain/Trust/ITrustRepository.cs
@@ -7,7 +7,7 @@ public interface ITrustRepository : IGenericRepository<Trust>
         Task<Trust?> GetTrustByUkprn(string ukprn, CancellationToken cancellationToken);
         Task<Trust?> GetTrustByCompaniesHouseNumber(string companiesHouseNumber, CancellationToken cancellationToken);
         Task<List<Trust>> GetTrustsByUkprns(string[] ukprns, CancellationToken cancellationToken);
-        Task<List<Trust>> Search(int page, int count, string name, string ukPrn,
+        Task<(List<Trust>, int)> Search(int page, int count, string name, string ukPrn,
          string companiesHouseNumber, CancellationToken cancellationToken);
     }
 }
diff --git a/TramsDataApi.Test/TramsDataApi.Test.csproj b/TramsDataApi.Test/TramsDataApi.Test.csproj
@@ -16,7 +16,7 @@
         <PackageReference Include="AutoFixture.AutoMoq" Version="4.18.0" />
         <PackageReference Include="AutoFixture.Idioms" Version="4.18.0" />
         <PackageReference Include="AutoFixture.Xunit2" Version="4.18.0" />
-        <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.2" />
+        <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.4" />
         <PackageReference Include="FluentAssertions" Version="6.11.0" />
         <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="6.0.19" />
         <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="7.0.0" />
diff --git a/TramsDataApi/Controllers/V4/EstablishmentsController.cs b/TramsDataApi/Controllers/V4/EstablishmentsController.cs
@@ -3,12 +3,10 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Dfe.Academies.Application.Queries.Establishment;
-using Dfe.Academies.Contracts.Establishments;
+using Dfe.Academies.Contracts.V4.Establishments;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 using Swashbuckle.AspNetCore.Annotations;
-using TramsDataApi.RequestModels;
-using TramsDataApi.ResponseModels;
 
 namespace TramsDataApi.Controllers.V4
 {
diff --git a/TramsDataApi/Controllers/V4/TrustsController.cs b/TramsDataApi/Controllers/V4/TrustsController.cs
@@ -3,7 +3,8 @@
 using System.Threading;
 using System.Threading.Tasks;
 using Dfe.Academies.Application.Queries.Trust;
-using Dfe.Academies.Contracts.Trusts;
+using Dfe.Academies.Contracts.V4;
+using Dfe.Academies.Contracts.V4.Trusts;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 using Swashbuckle.AspNetCore.Annotations;
@@ -96,7 +97,7 @@ public async Task<ActionResult<TrustDto>> GetTrustByCompaniesHouseNumber(string
         [Route("trusts")]        
         [SwaggerOperation(Summary = "Search Trusts", Description = "Returns a list of Trusts based on search criteria.")]
         [SwaggerResponse(200, "Successfully executed the search and returned Trusts.")]
-        public async Task<ActionResult<ApiResponseV2<TrustDto>>> SearchTrusts(string groupName, string ukPrn, string companiesHouseNumber, CancellationToken cancellationToken, int page = 1, int count = 10)
+        public async Task<ActionResult<PagedDataResponse<TrustDto>>> SearchTrusts(string groupName, string ukPrn, string companiesHouseNumber, CancellationToken cancellationToken, int page = 1, int count = 10)
         {
             _logger.LogInformation(
                 "Searching for trusts by groupName \"{name}\", UKPRN \"{prn}\", companiesHouseNumber \"{number}\", page {page}, count {count}",
@@ -111,8 +112,8 @@ public async Task<ActionResult<ApiResponseV2<TrustDto>>> SearchTrusts(string gro
 
             _logger.LogDebug(JsonSerializer.Serialize(trusts));
 
-            var pagingResponse = PagingResponseFactory.Create(page, count, recordCount, Request);
-            var response = new ApiResponseV2<TrustDto>(trusts, pagingResponse);
+            var pagingResponse = PagingResponseFactory.CreateV4PagingResponse(page, count, recordCount, Request);
+            var response = new PagedDataResponse<TrustDto>(trusts, pagingResponse);
 
             return Ok(response);
         }
diff --git a/TramsDataApi/ResponseModels/PagingResponseFactory.cs b/TramsDataApi/ResponseModels/PagingResponseFactory.cs
@@ -31,5 +31,30 @@ public static PagingResponse Create(int page, int count, int recordCount, HttpRe
 
             return pagingResponse;
         }
+
+        public static Dfe.Academies.Contracts.V4.PagingResponse CreateV4PagingResponse(int page, int count, int recordCount, HttpRequest request)
+        {
+            var pagingResponse = new Dfe.Academies.Contracts.V4.PagingResponse
+            {
+                RecordCount = recordCount,
+                Page = page
+            };
+
+            if ((count * page) >= recordCount) return pagingResponse;
+
+            var queryAttributes = request.Query
+                .Where(q => q.Key != nameof(page) && q.Key != nameof(count))
+                .Select(q => new KeyValuePair<string, string>(q.Key, q.Value));
+
+            var queryBuilder = new QueryBuilder(queryAttributes)
+            {
+                {nameof(page), $"{page + 1}"},
+                {nameof(count), $"{count}"}
+            };
+
+            pagingResponse.NextPageUrl = $"{request.Path}{queryBuilder}";
+
+            return pagingResponse;
+        }
     }
 }
diff --git a/TramsDataApi/TramsDataApi.csproj b/TramsDataApi/TramsDataApi.csproj
@@ -6,7 +6,7 @@
     </PropertyGroup>
     <ItemGroup>
         <PackageReference Include="CsvHelper" Version="30.0.1" />
-        <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.2" />
+        <PackageReference Include="Dfe.Academies.Contracts" Version="1.0.4" />
         <PackageReference Include="Dfe.Academisation.CorrelationIdMiddleware" Version="2.0.2" />
         <PackageReference Include="FluentValidation" Version="11.6.0" />
         <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.21.0" />

Original file line number	Diff line number	Diff line change
`@@ -35,13 +35,13 @@ public async Task<List<Trust>> GetTrustsByUkprns(string[] ukprns, CancellationTo`
`35`	`35`	`return trusts;`
`36`	`36`	`}`
`37`	`37`
`38`		`- public async Task<List<Trust>> Search(int page, int count, string name, string ukPrn, string companiesHouseNumber, CancellationToken cancellationToken)`
	`38`	`+ public async Task<(List<Trust>, int)> Search(int page, int count, string name, string ukPrn, string companiesHouseNumber, CancellationToken cancellationToken)`
`39`	`39`	`{`
`40`	`40`	`if (name == null && ukPrn == null && companiesHouseNumber == null)`
`41`	`41`	`{`
`42`	`42`	`List<Trust> allTrusts = await dbSet.OrderBy(trust => trust.GroupUID).Skip((page - 1) * count)`
`43`	`43`	`.Take(count).ToListAsync(cancellationToken).ConfigureAwait(false);`
`44`		`- return allTrusts;`
	`44`	`+ return (allTrusts, allTrusts.Count);`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`IOrderedQueryable<Trust> filteredGroups = dbSet`
`@@ -54,7 +54,7 @@ public async Task<List<Trust>> Search(int page, int count, string name, string u`
`54`	`54`	`))`
`55`	`55`	`.OrderBy(trust => trust.GroupUID);`
`56`	`56`
`57`		`- return await filteredGroups.Skip((page - 1) * count).Take(count).ToListAsync(cancellationToken).ConfigureAwait(false);`
	`57`	`+ return (await filteredGroups.Skip((page - 1) * count).Take(count).ToListAsync(cancellationToken).ConfigureAwait(false), filteredGroups.Count());`
`58`	`58`	`}`
`59`	`59`	`}`
`60`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-using Dfe.Academies.Contracts.Establishments;`
	`1`	`+using Dfe.Academies.Contracts.V4;`
	`2`	`+using Dfe.Academies.Contracts.V4.Establishments;`
`2`	`3`
`3`	`4`	`namespace Dfe.Academies.Application.Builders`
`4`	`5`	`{`
`@@ -128,7 +129,7 @@ public EstablishmentDtoBuilder WithMISEstablishment(Domain.Establishment.Establi`
`128`	`129`
`129`	`130`	`public EstablishmentDtoBuilder WithAddress(Domain.Establishment.Establishment establishment)`
`130`	`131`	`{`
`131`		`- _dto.Address = new Contracts.Trusts.AddressDto()`
	`132`	`+ _dto.Address = new AddressDto()`
`132`	`133`	`{`
`133`	`134`	`Street = establishment?.AddressLine1,`
`134`	`135`	`Town = establishment?.Town,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using Dfe.Academies.Contracts.Trusts;`
	`1`	`+using Dfe.Academies.Contracts.V4.Trusts;`
`2`	`2`
`3`	`3`	`namespace Dfe.Academies.Application.Queries.Trust`
`4`	`4`	`{`