Merge pull request #7 from Cabazure/options

Rename ClientPagainationOptions to PagedRequestOptions
Cabazure · Aug 6, 2024 · 8cc2a1e · 8cc2a1e
2 parents 8e0beaf + e8835e0
commit 8cc2a1e
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ Apart from the data parameters, the following parameter types are supported:
 | Parameter Type            | Description                                                             |
 | ------------------------- | ---------------------------------------------------------------------- |
 | `ClientRequestOptions`    | Allowing the caller to specify further request options.                |
-| `ClientPaginationOptions` | Allowing the caller to specify further request and pagination options. |
+| `PagedRequestOptions` | Allowing the caller to specify further request and pagination options. |
 | `CancellationToken`       | Allowing the caller to cancel the async call to the endpoint.          |
 
 ### 2. Adding a bootstrap

diff --git a/...Client.Runtime/ClientPaginationOptions.cs → ...ure.Client.Runtime/PagedRequestOptions.cs b/...Client.Runtime/ClientPaginationOptions.cs → ...ure.Client.Runtime/PagedRequestOptions.cs
@@ -3,7 +3,7 @@
 /// <summary>
 /// Options for a client request, that supports pagination.
 /// </summary>
-public class ClientPaginationOptions : ClientRequestOptions
+public class PagedRequestOptions : ClientRequestOptions
 {
     /// <summary>
     /// The maximum number of items to return, sent via the x-max-item-count header.

diff --git a/src/Cabazure.Client/Descriptors/EndpointMethodDescriptor.cs b/src/Cabazure.Client/Descriptors/EndpointMethodDescriptor.cs
@@ -71,7 +71,7 @@ public record EndpointMethodDescriptor(
 
             if (parameterType
                 is TypeConstants.ClientRequestOptions
-                or TypeConstants.ClientPaginationOptions)
+                or TypeConstants.PagedRequestOptions)
             {
                 optionsParameter = parameterName;
                 continue;

diff --git a/src/Cabazure.Client/EmbeddedSource/Builder/MessageRequestBuilder.g.cs b/src/Cabazure.Client/EmbeddedSource/Builder/MessageRequestBuilder.g.cs
@@ -69,14 +69,14 @@ public IMessageRequestBuilder WithRequestOptions(
                 id);
         }
 
-        if (options is ClientPaginationOptions { ContinuationToken: { } token })
+        if (options is PagedRequestOptions { ContinuationToken: { } token })
         {
             WithHeader(
                 HeaderContinuation,
                 token);
         }
 
-        if (options is ClientPaginationOptions { MaxItemCount: { } maxCount })
+        if (options is PagedRequestOptions { MaxItemCount: { } maxCount })
         {
             WithHeader(
                 HeaderMaxItemCount,

diff --git a/src/Cabazure.Client/TypeConstants.cs b/src/Cabazure.Client/TypeConstants.cs
@@ -5,7 +5,7 @@ public static class TypeConstants
     public const string ClientEndpointAttribute = "Cabazure.Client.ClientEndpointAttribute";
     public const string ClientInitializationAttribute = "Cabazure.Client.ClientInitializationAttribute";
     public const string ClientRequestOptions = "Cabazure.Client.ClientRequestOptions";
-    public const string ClientPaginationOptions = "Cabazure.Client.ClientPaginationOptions";
+    public const string PagedRequestOptions = "Cabazure.Client.PagedRequestOptions";
     public const string GetAttribute = "Cabazure.Client.GetAttribute";
     public const string PostAttribute = "Cabazure.Client.PostAttribute";
     public const string PutAttribute = "Cabazure.Client.PutAttribute";

diff --git a/test/Cabazure.Client.IntegrationTests/ListEndpointTests.cs b/test/Cabazure.Client.IntegrationTests/ListEndpointTests.cs
@@ -16,7 +16,7 @@ public interface IListEndpoint
         [Get(RouteTemplate)]
         Task<PagedResponse<string[]>> ExecuteAsync(
             [Query("s")] string search,
-            ClientPaginationOptions options,
+            PagedRequestOptions options,
             CancellationToken cancellationToken);
     }
 
@@ -49,7 +49,7 @@ internal async Task Should_Create_HttpClient(
         [Frozen] IHttpClientFactory factory,
         ListEndpoint sut,
         string id,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         await sut.ExecuteAsync(
@@ -67,7 +67,7 @@ internal async Task Should_Create_Request(
         [Frozen] IMessageRequestFactory requestFactory,
         ListEndpoint sut,
         string id,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         await sut.ExecuteAsync(
@@ -86,7 +86,7 @@ internal async Task Should_Send_Request(
         [Frozen] HttpRequestMessage request,
         ListEndpoint sut,
         string id,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         await sut.ExecuteAsync(
@@ -105,7 +105,7 @@ internal async Task Should_Create_Builder_From_Response(
         [Frozen] HttpResponseMessage response,
         ListEndpoint sut,
         string id,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         await sut.ExecuteAsync(
@@ -123,7 +123,7 @@ internal async Task Should_Add_QueryParameter(
         [Frozen] IMessageRequestBuilder builder,
         ListEndpoint sut,
         string search,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         await sut.ExecuteAsync(
@@ -137,11 +137,11 @@ await sut.ExecuteAsync(
     }
 
     [Theory, AutoNSubstituteData]
-    internal async Task Should_Add_ClientPaginationOptions_To_Builder(
+    internal async Task Should_Add_PagedRequestOptions_To_Builder(
         [Frozen] IMessageRequestBuilder builder,
         ListEndpoint sut,
         string search,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         await sut.ExecuteAsync(
@@ -160,7 +160,7 @@ internal async Task Should_Set_Timeout_On_HttpClient(
         [Frozen, Substitute] HttpClient client,
         ListEndpoint sut,
         string item,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         TimeSpan timeout,
         CancellationToken cancellationToken)
     {
@@ -182,7 +182,7 @@ internal async Task Should_Configure_SuccessResponse(
         [Frozen] IMessageResponseBuilder builder,
         ListEndpoint sut,
         string item,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         await sut.ExecuteAsync(
@@ -200,7 +200,7 @@ internal async Task Should_Create_Result(
         [Frozen] IMessageResponseBuilder builder,
         ListEndpoint sut,
         string item,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         await sut.ExecuteAsync(
@@ -221,7 +221,7 @@ internal async Task Should_Return_Result(
         ListEndpoint sut,
         PagedResponse<string[]> response,
         string item,
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         builder

diff --git a/test/Cabazure.Client.Runtime.Tests/Builder/MessageRequestBuilderTest.cs b/test/Cabazure.Client.Runtime.Tests/Builder/MessageRequestBuilderTest.cs
@@ -165,7 +165,7 @@ internal void Should_Include_CorrelationId_Header(
     [Theory, AutoNSubstituteData]
     internal void Should_Include_MacItemCount_Header(
         MessageRequestBuilder sut,
-        ClientPaginationOptions options)
+        PagedRequestOptions options)
     {
         sut.WithRequestOptions(options);
 
@@ -183,7 +183,7 @@ internal void Should_Include_MacItemCount_Header(
     [Theory, AutoNSubstituteData]
     internal void Should_Include_Continuation_Header(
         MessageRequestBuilder sut,
-        ClientPaginationOptions options)
+        PagedRequestOptions options)
     {
         sut.WithRequestOptions(options);
 

diff --git a/...ions_Parameter#TestEndpoint.g.verified.cs → ...ions_Parameter#TestEndpoint.g.verified.cs b/...ions_Parameter#TestEndpoint.g.verified.cs → ...ions_Parameter#TestEndpoint.g.verified.cs
@@ -19,7 +19,7 @@ public TestEndpoint(
     }
 
     public async Task<EndpointResponse<string[]>> ExecuteAsync(
-        ClientPaginationOptions options)
+        PagedRequestOptions options)
     {
         var client = factory.CreateClient("ClientName");
 

diff --git a/...s/ClientEndpointGeneratorTests.CanGenerate_Pagination_Endpoint#TestEndpoint.g.verified.cs b/...s/ClientEndpointGeneratorTests.CanGenerate_Pagination_Endpoint#TestEndpoint.g.verified.cs
@@ -21,7 +21,7 @@ public TestEndpoint(
     }
 
     public async Task<PagedResponse<string[]>> ExecuteAsync(
-        ClientPaginationOptions options,
+        PagedRequestOptions options,
         CancellationToken cancellationToken)
     {
         var client = factory.CreateClient("ClientName");

diff --git a/test/Cabazure.Client.Tests/ClientEndpointGeneratorTests.cs b/test/Cabazure.Client.Tests/ClientEndpointGeneratorTests.cs
@@ -38,14 +38,14 @@ public Task<EndpointResponse<string[]>> ExecuteAsync(
             """);
 
     [Fact]
-    public Task CanGenerate_ClientPaginationOptions_Parameter()
+    public Task CanGenerate_PagedRequestOptions_Parameter()
         => TestHelper.VerifyEndpoint("""
             [ClientEndpoint("ClientName")]
             public interface ITestEndpoint
             {
                 [Get("/items")]
                 public Task<EndpointResponse<string[]>> ExecuteAsync(
-                    ClientPaginationOptions options);
+                    PagedRequestOptions options);
             }
             """);
 
@@ -224,7 +224,7 @@ public interface ITestEndpoint
             {
                 [Get("/routes")]
                 public Task<PagedResponse<string[]>> ExecuteAsync(
-                    ClientPaginationOptions options,
+                    PagedRequestOptions options,
                     CancellationToken cancellationToken);
             }
             """);

diff --git a/...urceGeneratorTests.CanGenerate_EmbeddedSource#Builder.MessageRequestBuilder.g.verified.cs b/...urceGeneratorTests.CanGenerate_EmbeddedSource#Builder.MessageRequestBuilder.g.verified.cs
@@ -70,14 +70,14 @@ public IMessageRequestBuilder WithRequestOptions(
                 id);
         }
 
-        if (options is ClientPaginationOptions { ContinuationToken: { } token })
+        if (options is PagedRequestOptions { ContinuationToken: { } token })
         {
             WithHeader(
                 HeaderContinuation,
                 token);
         }
 
-        if (options is ClientPaginationOptions { MaxItemCount: { } maxCount })
+        if (options is PagedRequestOptions { MaxItemCount: { } maxCount })
         {
             WithHeader(
                 HeaderMaxItemCount,