From d4fc49c8d1e68eb5956a3ffc9ba051deabb7a70b Mon Sep 17 00:00:00 2001
From: Alex Hyett <alex@hyett.me>
Date: Fri, 7 Jul 2023 11:09:41 +0100
Subject: [PATCH] Moved request objects to Contract project

---
 .../AuthorRequest.cs                                     | 2 +-
 .../BookRequest.cs                                       | 2 +-
 .../GitHubActionsDemo.Api.Contract.csproj                | 9 +++++++++
 .../PageRequest.cs}                                      | 4 ++--
 src/GitHubActionsDemo.Api.Sdk/Class1.cs                  | 6 ++++++
 .../GitHubActionsDemo.Api.Sdk.csproj                     | 9 +++++++++
 .../Controllers/AuthorsController.cs                     | 8 ++++----
 src/GitHubActionsDemo.Api/Controllers/BooksController.cs | 8 ++++----
 src/GitHubActionsDemo.Api/GitHubActionsDemo.Api.csproj   | 1 +
 src/GitHubActionsDemo.Api/Mappers/AuthorMapper.cs        | 1 +
 src/GitHubActionsDemo.Api/Mappers/BookMapper.cs          | 1 +
 src/GitHubActionsDemo.Api/Models/PagedResult.cs          | 0
 .../Models/Validators/AuthorRequestValidator.cs          | 2 +-
 .../Models/Validators/BookRequestValidator.cs            | 2 +-
 .../Models/Validators/PageParametersValidator.cs         | 4 ++--
 src/GitHubActionsDemo.Api/Program.cs                     | 4 ++--
 .../AuthorsControllerTests.cs                            | 5 +++--
 .../LibraryServiceTests.cs                               | 2 ++
 18 files changed, 50 insertions(+), 20 deletions(-)
 rename src/{GitHubActionsDemo.Api/Models => GitHubActionsDemo.Api.Contract}/AuthorRequest.cs (73%)
 rename src/{GitHubActionsDemo.Api/Models => GitHubActionsDemo.Api.Contract}/BookRequest.cs (78%)
 create mode 100644 src/GitHubActionsDemo.Api.Contract/GitHubActionsDemo.Api.Contract.csproj
 rename src/{GitHubActionsDemo.Api/Models/PageParameters.cs => GitHubActionsDemo.Api.Contract/PageRequest.cs} (56%)
 create mode 100644 src/GitHubActionsDemo.Api.Sdk/Class1.cs
 create mode 100644 src/GitHubActionsDemo.Api.Sdk/GitHubActionsDemo.Api.Sdk.csproj
 delete mode 100644 src/GitHubActionsDemo.Api/Models/PagedResult.cs

diff --git a/src/GitHubActionsDemo.Api/Models/AuthorRequest.cs b/src/GitHubActionsDemo.Api.Contract/AuthorRequest.cs
similarity index 73%
rename from src/GitHubActionsDemo.Api/Models/AuthorRequest.cs
rename to src/GitHubActionsDemo.Api.Contract/AuthorRequest.cs
index 1ab4593..f41a04b 100644
--- a/src/GitHubActionsDemo.Api/Models/AuthorRequest.cs
+++ b/src/GitHubActionsDemo.Api.Contract/AuthorRequest.cs
@@ -1,4 +1,4 @@
-namespace GitHubActionsDemo.Api.Models;
+namespace GitHubActionsDemo.Api.Contract;
 
 public class AuthorRequest
 {
diff --git a/src/GitHubActionsDemo.Api/Models/BookRequest.cs b/src/GitHubActionsDemo.Api.Contract/BookRequest.cs
similarity index 78%
rename from src/GitHubActionsDemo.Api/Models/BookRequest.cs
rename to src/GitHubActionsDemo.Api.Contract/BookRequest.cs
index d84d225..6b4fbcf 100644
--- a/src/GitHubActionsDemo.Api/Models/BookRequest.cs
+++ b/src/GitHubActionsDemo.Api.Contract/BookRequest.cs
@@ -1,4 +1,4 @@
-namespace GitHubActionsDemo.Api.Models;
+namespace GitHubActionsDemo.Api.Contract;
 
 public class BookRequest
 {
diff --git a/src/GitHubActionsDemo.Api.Contract/GitHubActionsDemo.Api.Contract.csproj b/src/GitHubActionsDemo.Api.Contract/GitHubActionsDemo.Api.Contract.csproj
new file mode 100644
index 0000000..4658cbf
--- /dev/null
+++ b/src/GitHubActionsDemo.Api.Contract/GitHubActionsDemo.Api.Contract.csproj
@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>
diff --git a/src/GitHubActionsDemo.Api/Models/PageParameters.cs b/src/GitHubActionsDemo.Api.Contract/PageRequest.cs
similarity index 56%
rename from src/GitHubActionsDemo.Api/Models/PageParameters.cs
rename to src/GitHubActionsDemo.Api.Contract/PageRequest.cs
index c48337b..c024086 100644
--- a/src/GitHubActionsDemo.Api/Models/PageParameters.cs
+++ b/src/GitHubActionsDemo.Api.Contract/PageRequest.cs
@@ -1,6 +1,6 @@
-namespace GitHubActionsDemo.Api.Models;
+namespace GitHubActionsDemo.Api.Contract;
 
-public class PageParameters
+public class PageRequest
 {
     public int Page { get; set; } = 1;
     public int PageSize { get; set; } = 10;
diff --git a/src/GitHubActionsDemo.Api.Sdk/Class1.cs b/src/GitHubActionsDemo.Api.Sdk/Class1.cs
new file mode 100644
index 0000000..f3cdf9f
--- /dev/null
+++ b/src/GitHubActionsDemo.Api.Sdk/Class1.cs
@@ -0,0 +1,6 @@
+namespace GitHubActionsDemo.Api.Sdk;
+
+public class Class1
+{
+
+}
diff --git a/src/GitHubActionsDemo.Api.Sdk/GitHubActionsDemo.Api.Sdk.csproj b/src/GitHubActionsDemo.Api.Sdk/GitHubActionsDemo.Api.Sdk.csproj
new file mode 100644
index 0000000..4658cbf
--- /dev/null
+++ b/src/GitHubActionsDemo.Api.Sdk/GitHubActionsDemo.Api.Sdk.csproj
@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>
diff --git a/src/GitHubActionsDemo.Api/Controllers/AuthorsController.cs b/src/GitHubActionsDemo.Api/Controllers/AuthorsController.cs
index 0703906..3ee84d2 100644
--- a/src/GitHubActionsDemo.Api/Controllers/AuthorsController.cs
+++ b/src/GitHubActionsDemo.Api/Controllers/AuthorsController.cs
@@ -1,4 +1,4 @@
-using GitHubActionsDemo.Api.Models;
+using GitHubActionsDemo.Api.Contract;
 using GitHubActionsDemo.Api.Mappers;
 using GitHubActionsDemo.Service;
 using Microsoft.AspNetCore.Mvc;
@@ -12,12 +12,12 @@ public class AuthorsController : BaseController
 {
     private readonly ILibraryService _libraryService;
     private readonly IValidator<AuthorRequest> _authorValidator;
-    private readonly IValidator<PageParameters> _pageValidator;
+    private readonly IValidator<PageRequest> _pageValidator;
 
     public AuthorsController(
         ILibraryService libraryService,
         IValidator<AuthorRequest> authorValidator,
-        IValidator<PageParameters> pageValidator
+        IValidator<PageRequest> pageValidator
     )
     {
         _libraryService = libraryService ?? throw new ArgumentNullException(nameof(libraryService));
@@ -53,7 +53,7 @@ public class AuthorsController : BaseController
     }
 
     [HttpGet]
-    public async Task<IResult> GetAuthorsAsync([FromQuery] PageParameters parameters)
+    public async Task<IResult> GetAuthorsAsync([FromQuery] PageRequest parameters)
     {
         var validationResult = await _pageValidator.ValidateAsync(parameters);
 
diff --git a/src/GitHubActionsDemo.Api/Controllers/BooksController.cs b/src/GitHubActionsDemo.Api/Controllers/BooksController.cs
index b7bb018..edab700 100644
--- a/src/GitHubActionsDemo.Api/Controllers/BooksController.cs
+++ b/src/GitHubActionsDemo.Api/Controllers/BooksController.cs
@@ -1,4 +1,4 @@
-using GitHubActionsDemo.Api.Models;
+using GitHubActionsDemo.Api.Contract;
 using GitHubActionsDemo.Api.Mappers;
 using GitHubActionsDemo.Service;
 using Microsoft.AspNetCore.Mvc;
@@ -12,12 +12,12 @@ public class BooksController : BaseController
 {
     private readonly ILibraryService _libraryService;
     private readonly IValidator<BookRequest> _bookValidator;
-    private readonly IValidator<PageParameters> _pageValidator;
+    private readonly IValidator<PageRequest> _pageValidator;
 
     public BooksController(
         ILibraryService libraryService,
         IValidator<BookRequest> bookValidator,
-        IValidator<PageParameters> pageValidator
+        IValidator<PageRequest> pageValidator
     )
     {
         _libraryService = libraryService ?? throw new ArgumentNullException(nameof(libraryService));
@@ -26,7 +26,7 @@ public class BooksController : BaseController
     }
 
     [HttpGet]
-    public async Task<IResult> GetBooksAsync([FromQuery] PageParameters parameters)
+    public async Task<IResult> GetBooksAsync([FromQuery] PageRequest parameters)
     {
         var validationResult = await _pageValidator.ValidateAsync(parameters);
 
diff --git a/src/GitHubActionsDemo.Api/GitHubActionsDemo.Api.csproj b/src/GitHubActionsDemo.Api/GitHubActionsDemo.Api.csproj
index c48f0b4..89cf809 100644
--- a/src/GitHubActionsDemo.Api/GitHubActionsDemo.Api.csproj
+++ b/src/GitHubActionsDemo.Api/GitHubActionsDemo.Api.csproj
@@ -19,6 +19,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\GitHubActionsDemo.Api.Contract\GitHubActionsDemo.Api.Contract.csproj" />
     <ProjectReference Include="..\GitHubActionsDemo.Service\GitHubActionsDemo.Service.csproj" />
     <ProjectReference Include="..\GitHubActionsDemo.Persistance\GitHubActionsDemo.Persistance.csproj" />
   </ItemGroup>
diff --git a/src/GitHubActionsDemo.Api/Mappers/AuthorMapper.cs b/src/GitHubActionsDemo.Api/Mappers/AuthorMapper.cs
index a2b42f4..ad925af 100644
--- a/src/GitHubActionsDemo.Api/Mappers/AuthorMapper.cs
+++ b/src/GitHubActionsDemo.Api/Mappers/AuthorMapper.cs
@@ -1,3 +1,4 @@
+using GitHubActionsDemo.Api.Contract;
 using GitHubActionsDemo.Api.Models;
 using GitHubActionsDemo.Service.Models;
 
diff --git a/src/GitHubActionsDemo.Api/Mappers/BookMapper.cs b/src/GitHubActionsDemo.Api/Mappers/BookMapper.cs
index f2ac907..92ffbef 100644
--- a/src/GitHubActionsDemo.Api/Mappers/BookMapper.cs
+++ b/src/GitHubActionsDemo.Api/Mappers/BookMapper.cs
@@ -1,3 +1,4 @@
+using GitHubActionsDemo.Api.Contract;
 using GitHubActionsDemo.Api.Models;
 using GitHubActionsDemo.Service.Models;
 
diff --git a/src/GitHubActionsDemo.Api/Models/PagedResult.cs b/src/GitHubActionsDemo.Api/Models/PagedResult.cs
deleted file mode 100644
index e69de29..0000000
diff --git a/src/GitHubActionsDemo.Api/Models/Validators/AuthorRequestValidator.cs b/src/GitHubActionsDemo.Api/Models/Validators/AuthorRequestValidator.cs
index 8fa3824..65f41a8 100644
--- a/src/GitHubActionsDemo.Api/Models/Validators/AuthorRequestValidator.cs
+++ b/src/GitHubActionsDemo.Api/Models/Validators/AuthorRequestValidator.cs
@@ -1,5 +1,5 @@
 using FluentValidation;
-
+using GitHubActionsDemo.Api.Contract;
 namespace GitHubActionsDemo.Api.Models.Validators;
 
 public class AuthorRequestValidator : AbstractValidator<AuthorRequest>
diff --git a/src/GitHubActionsDemo.Api/Models/Validators/BookRequestValidator.cs b/src/GitHubActionsDemo.Api/Models/Validators/BookRequestValidator.cs
index 84a6d31..c77d2ff 100644
--- a/src/GitHubActionsDemo.Api/Models/Validators/BookRequestValidator.cs
+++ b/src/GitHubActionsDemo.Api/Models/Validators/BookRequestValidator.cs
@@ -1,5 +1,5 @@
 using FluentValidation;
-
+using GitHubActionsDemo.Api.Contract;
 namespace GitHubActionsDemo.Api.Models.Validators;
 
 public class BookRequestValidator : AbstractValidator<BookRequest>
diff --git a/src/GitHubActionsDemo.Api/Models/Validators/PageParametersValidator.cs b/src/GitHubActionsDemo.Api/Models/Validators/PageParametersValidator.cs
index dac0bf7..2a09bca 100644
--- a/src/GitHubActionsDemo.Api/Models/Validators/PageParametersValidator.cs
+++ b/src/GitHubActionsDemo.Api/Models/Validators/PageParametersValidator.cs
@@ -1,8 +1,8 @@
 using FluentValidation;
-
+using GitHubActionsDemo.Api.Contract;
 namespace GitHubActionsDemo.Api.Models.Validators;
 
-public class PageParametersValidator : AbstractValidator<PageParameters>
+public class PageParametersValidator : AbstractValidator<PageRequest>
 {
     public PageParametersValidator()
     {
diff --git a/src/GitHubActionsDemo.Api/Program.cs b/src/GitHubActionsDemo.Api/Program.cs
index 090a4b7..c7ef2cb 100644
--- a/src/GitHubActionsDemo.Api/Program.cs
+++ b/src/GitHubActionsDemo.Api/Program.cs
@@ -2,7 +2,7 @@ using GitHubActionsDemo.Service.Infrastructure;
 using GitHubActionsDemo.Persistance.Infrastructure;
 using Serilog;
 using FluentValidation;
-using GitHubActionsDemo.Api.Models;
+using GitHubActionsDemo.Api.Contract;
 using GitHubActionsDemo.Api.Models.Validators;
 
 var builder = WebApplication.CreateBuilder(args);
@@ -15,7 +15,7 @@ builder.Logging.AddSerilog(logger);
 
 builder.Services.AddScoped<IValidator<AuthorRequest>, AuthorRequestValidator>();
 builder.Services.AddScoped<IValidator<BookRequest>, BookRequestValidator>();
-builder.Services.AddScoped<IValidator<PageParameters>, PageParametersValidator>();
+builder.Services.AddScoped<IValidator<PageRequest>, PageParametersValidator>();
 
 builder.Services.AddControllers();
 builder.Services.AddEndpointsApiExplorer();
diff --git a/test/GitHubActionsDemo.Api.Tests/AuthorsControllerTests.cs b/test/GitHubActionsDemo.Api.Tests/AuthorsControllerTests.cs
index e6f0102..4da9dc0 100644
--- a/test/GitHubActionsDemo.Api.Tests/AuthorsControllerTests.cs
+++ b/test/GitHubActionsDemo.Api.Tests/AuthorsControllerTests.cs
@@ -1,6 +1,7 @@
 using System.Net;
 using FluentValidation;
 using FluentValidation.Results;
+using GitHubActionsDemo.Api.Contract;
 using GitHubActionsDemo.Api.Controllers;
 using GitHubActionsDemo.Api.Models;
 using GitHubActionsDemo.Service;
@@ -13,7 +14,7 @@ public class AuthorsControllerTests
 {
     private readonly Mock<ILibraryService> _libraryService;
     private readonly Mock<IValidator<AuthorRequest>> _authorValidator;
-    private readonly Mock<IValidator<PageParameters>> _pageValidator;
+    private readonly Mock<IValidator<PageRequest>> _pageValidator;
 
     private readonly AuthorsController _sut;
 
@@ -21,7 +22,7 @@ public class AuthorsControllerTests
     {
         _libraryService = new Mock<ILibraryService>();
         _authorValidator = new Mock<IValidator<AuthorRequest>>();
-        _pageValidator = new Mock<IValidator<PageParameters>>();
+        _pageValidator = new Mock<IValidator<PageRequest>>();
         _sut = new AuthorsController(_libraryService.Object, _authorValidator.Object, _pageValidator.Object);
     }
 
diff --git a/test/GitHubActionsDemo.Service.Tests/LibraryServiceTests.cs b/test/GitHubActionsDemo.Service.Tests/LibraryServiceTests.cs
index 67f777d..3c0adbd 100644
--- a/test/GitHubActionsDemo.Service.Tests/LibraryServiceTests.cs
+++ b/test/GitHubActionsDemo.Service.Tests/LibraryServiceTests.cs
@@ -66,4 +66,6 @@ public class LibraryServiceTests
         result.AsT0.Value.Title.ShouldBe(newBook.Title);
         result.AsT0.Value.Isbn.ShouldBe(newBook.Isbn);
     }
+
+    // TODO: Note in a production application there would be a complete set of unit tests here.
 }
\ No newline at end of file