From 498c2aa0a5a4a06d05095303530f28c4f16a07cc Mon Sep 17 00:00:00 2001
From: Gamer025 <33846895+Gamer025@users.noreply.github.com>
Date: Sun, 28 Aug 2022 16:12:27 +0200
Subject: [PATCH] Add ability to pass ApiOptions to PullRequestsClient.Files
 (#2553)

* Add ability to pass ApiOptions to PullRequestsClient.Files

* Change Reactive PullRequestClient + Fix Test Mocking
---
 .../Clients/IObservablePullRequestsClient.cs  | 19 ++++++++++++
 .../Clients/ObservablePullRequestsClient.cs   | 31 +++++++++++++++++--
 .../Clients/PullRequestsClientTests.cs        |  4 +--
 .../ObservablePullRequestsClientTests.cs      |  8 ++---
 Octokit/Clients/IPullRequestsClient.cs        | 19 ++++++++++++
 Octokit/Clients/PullRequestsClient.cs         | 31 +++++++++++++++++--
 6 files changed, 101 insertions(+), 11 deletions(-)

diff --git a/Octokit.Reactive/Clients/IObservablePullRequestsClient.cs b/Octokit.Reactive/Clients/IObservablePullRequestsClient.cs
index 997d662212..510769f8da 100644
--- a/Octokit.Reactive/Clients/IObservablePullRequestsClient.cs
+++ b/Octokit.Reactive/Clients/IObservablePullRequestsClient.cs
@@ -231,6 +231,16 @@ public interface IObservablePullRequestsClient
         /// <param name="number">The pull request number</param>
         IObservable<PullRequestCommit> Commits(long repositoryId, int number);
 
+        /// <summary>
+        /// Get the list of files on a pull request.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="number">The pull request number</param>
+        /// <param name="options">Options for changing the API response</param>
+        IObservable<PullRequestFile> Files(string owner, string name, int number, ApiOptions options);
+
         /// <summary>
         /// Get the list of files on a pull request.
         /// </summary>
@@ -240,6 +250,15 @@ public interface IObservablePullRequestsClient
         /// <param name="number">The pull request number</param>
         IObservable<PullRequestFile> Files(string owner, string name, int number);
 
+        /// <summary>
+        /// Get the list of files on a pull request.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
+        /// <param name="repositoryId">The Id of the repository</param>
+        /// <param name="number">The pull request number</param>
+        /// <param name="options">Options for changing the API response</param>
+        IObservable<PullRequestFile> Files(long repositoryId, int number, ApiOptions options);
+
         /// <summary>
         /// Get the list of files on a pull request.
         /// </summary>
diff --git a/Octokit.Reactive/Clients/ObservablePullRequestsClient.cs b/Octokit.Reactive/Clients/ObservablePullRequestsClient.cs
index 0f34376011..5b41a65aac 100644
--- a/Octokit.Reactive/Clients/ObservablePullRequestsClient.cs
+++ b/Octokit.Reactive/Clients/ObservablePullRequestsClient.cs
@@ -359,12 +359,37 @@ public IObservable<PullRequestCommit> Commits(long repositoryId, int number)
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The pull request number</param>
-        public IObservable<PullRequestFile> Files(string owner, string name, int number)
+        /// <param name="options">Options for changing the API response</param>
+        public IObservable<PullRequestFile> Files(string owner, string name, int number, ApiOptions options)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
             Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
 
-            return _connection.GetAndFlattenAllPages<PullRequestFile>(ApiUrls.PullRequestFiles(owner, name, number));
+            return _connection.GetAndFlattenAllPages<PullRequestFile>(ApiUrls.PullRequestFiles(owner, name, number), options);
+        }
+
+        /// <summary>
+        /// Get the list of files on a pull request.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="number">The pull request number</param>
+        public IObservable<PullRequestFile> Files(string owner, string name, int number)
+        {
+            return Files(owner, name, number, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Get the list of files on a pull request.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
+        /// <param name="repositoryId">The Id of the repository</param>
+        /// <param name="number">The pull request number</param>
+        /// <param name="options">Options for changing the API response</param>
+        public IObservable<PullRequestFile> Files(long repositoryId, int number, ApiOptions options)
+        {
+            return _connection.GetAndFlattenAllPages<PullRequestFile>(ApiUrls.PullRequestFiles(repositoryId, number), options);
         }
 
         /// <summary>
@@ -375,7 +400,7 @@ public IObservable<PullRequestFile> Files(string owner, string name, int number)
         /// <param name="number">The pull request number</param>
         public IObservable<PullRequestFile> Files(long repositoryId, int number)
         {
-            return _connection.GetAndFlattenAllPages<PullRequestFile>(ApiUrls.PullRequestFiles(repositoryId, number));
+            return Files(repositoryId, number, ApiOptions.None);
         }
     }
 }
diff --git a/Octokit.Tests/Clients/PullRequestsClientTests.cs b/Octokit.Tests/Clients/PullRequestsClientTests.cs
index 2f10009ad5..362ac6ae91 100644
--- a/Octokit.Tests/Clients/PullRequestsClientTests.cs
+++ b/Octokit.Tests/Clients/PullRequestsClientTests.cs
@@ -461,7 +461,7 @@ public async Task RequestsCorrectUrl()
                 await client.Files("fake", "repo", 42);
 
                 connection.Received()
-                    .GetAll<PullRequestFile>(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/pulls/42/files"));
+                    .GetAll<PullRequestFile>(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/pulls/42/files"), Args.ApiOptions);
             }
 
             [Fact]
@@ -473,7 +473,7 @@ public async Task RequestsCorrectUrlWithRepositoryId()
                 await client.Files(1, 42);
 
                 connection.Received()
-                    .GetAll<PullRequestFile>(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/42/files"));
+                    .GetAll<PullRequestFile>(Arg.Is<Uri>(u => u.ToString() == "repositories/1/pulls/42/files"), Args.ApiOptions);
             }
 
             [Fact]
diff --git a/Octokit.Tests/Reactive/ObservablePullRequestsClientTests.cs b/Octokit.Tests/Reactive/ObservablePullRequestsClientTests.cs
index c48529d53c..c6b2932df6 100644
--- a/Octokit.Tests/Reactive/ObservablePullRequestsClientTests.cs
+++ b/Octokit.Tests/Reactive/ObservablePullRequestsClientTests.cs
@@ -704,7 +704,7 @@ public async Task FetchesAllFilesForPullRequest()
                     CreateResponse(HttpStatusCode.OK),
                     new List<PullRequestFile> { file }
                 );
-                connection.Get<List<PullRequestFile>>(Args.Uri, null)
+                connection.Get<List<PullRequestFile>>(Args.Uri, Arg.Any<IDictionary<string, string>>())
                     .Returns(Task.FromResult(response));
                 gitHubClient.Connection.Returns(connection);
                 var client = new ObservablePullRequestsClient(gitHubClient);
@@ -713,7 +713,7 @@ public async Task FetchesAllFilesForPullRequest()
 
                 Assert.Equal(1, files.Count);
                 Assert.Same(file, files[0]);
-                connection.Received().Get<List<PullRequestFile>>(new Uri(expectedUrl, UriKind.Relative), null);
+                connection.Received().Get<List<PullRequestFile>>(new Uri(expectedUrl, UriKind.Relative), Arg.Any<IDictionary<string, string>>());
             }
 
             [Fact]
@@ -728,7 +728,7 @@ public async Task FetchesAllFilesForPullRequestWithRepositoryId()
                     CreateResponse(HttpStatusCode.OK),
                     new List<PullRequestFile> { file }
                 );
-                connection.Get<List<PullRequestFile>>(Args.Uri, null)
+                connection.Get<List<PullRequestFile>>(Args.Uri, Arg.Any<IDictionary<string, string>>())
                     .Returns(Task.FromResult(response));
                 gitHubClient.Connection.Returns(connection);
                 var client = new ObservablePullRequestsClient(gitHubClient);
@@ -737,7 +737,7 @@ public async Task FetchesAllFilesForPullRequestWithRepositoryId()
 
                 Assert.Equal(1, files.Count);
                 Assert.Same(file, files[0]);
-                connection.Received().Get<List<PullRequestFile>>(new Uri(expectedUrl, UriKind.Relative), null);
+                connection.Received().Get<List<PullRequestFile>>(new Uri(expectedUrl, UriKind.Relative), Arg.Any<IDictionary<string, string>>());
             }
 
             [Fact]
diff --git a/Octokit/Clients/IPullRequestsClient.cs b/Octokit/Clients/IPullRequestsClient.cs
index e35d22d6e7..01e42c7ca2 100644
--- a/Octokit/Clients/IPullRequestsClient.cs
+++ b/Octokit/Clients/IPullRequestsClient.cs
@@ -228,6 +228,16 @@ public interface IPullRequestsClient
         /// <param name="number">The pull request number</param>
         Task<IReadOnlyList<PullRequestCommit>> Commits(long repositoryId, int number);
 
+        /// <summary>
+        /// Get the list of files on a pull request.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="number">The pull request number</param>
+        /// <param name="options">Options for changing the API response</param>
+        Task<IReadOnlyList<PullRequestFile>> Files(string owner, string name, int number, ApiOptions options);
+
         /// <summary>
         /// Get the list of files on a pull request.
         /// </summary>
@@ -237,6 +247,15 @@ public interface IPullRequestsClient
         /// <param name="number">The pull request number</param>
         Task<IReadOnlyList<PullRequestFile>> Files(string owner, string name, int number);
 
+        /// <summary>
+        /// Get the list of files on a pull request.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
+        /// <param name="repositoryId">The Id of the repository</param>
+        /// <param name="number">The pull request number</param>
+        /// <param name="options">Options for changing the API response</param>
+        Task<IReadOnlyList<PullRequestFile>> Files(long repositoryId, int number, ApiOptions options);
+
         /// <summary>
         /// Get the list of files on a pull request.
         /// </summary>
diff --git a/Octokit/Clients/PullRequestsClient.cs b/Octokit/Clients/PullRequestsClient.cs
index 34bf1cda62..bcfcfe9a11 100644
--- a/Octokit/Clients/PullRequestsClient.cs
+++ b/Octokit/Clients/PullRequestsClient.cs
@@ -425,11 +425,25 @@ public Task<IReadOnlyList<PullRequestCommit>> Commits(long repositoryId, int num
         /// <param name="number">The pull request number</param>
         [ManualRoute("GET", "/repos/{owner}/{repo}/pulls/{pull_number}/files")]
         public Task<IReadOnlyList<PullRequestFile>> Files(string owner, string name, int number)
+        {
+            return Files(owner, name, number, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Get the list of files on a pull request.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="number">The pull request number</param>
+        /// <param name="options">Options for changing the API response</param>
+        [ManualRoute("GET", "/repos/{owner}/{repo}/pulls/{pull_number}/files")]
+        public Task<IReadOnlyList<PullRequestFile>> Files(string owner, string name, int number, ApiOptions options)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
             Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
 
-            return ApiConnection.GetAll<PullRequestFile>(ApiUrls.PullRequestFiles(owner, name, number));
+            return ApiConnection.GetAll<PullRequestFile>(ApiUrls.PullRequestFiles(owner, name, number), options);
         }
 
         /// <summary>
@@ -441,7 +455,20 @@ public Task<IReadOnlyList<PullRequestFile>> Files(string owner, string name, int
         [ManualRoute("GET", "/repositories/{id}/pulls/{number}/files")]
         public Task<IReadOnlyList<PullRequestFile>> Files(long repositoryId, int number)
         {
-            return ApiConnection.GetAll<PullRequestFile>(ApiUrls.PullRequestFiles(repositoryId, number));
+            return Files(repositoryId, number, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Get the list of files on a pull request.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/pulls/#list-pull-requests-files</remarks>
+        /// <param name="repositoryId">The Id of the repository</param>
+        /// <param name="number">The pull request number</param>
+        /// <param name="options">Options for changing the API response</param>
+        [ManualRoute("GET", "/repositories/{id}/pulls/{number}/files")]
+        public Task<IReadOnlyList<PullRequestFile>> Files(long repositoryId, int number, ApiOptions options)
+        {
+            return ApiConnection.GetAll<PullRequestFile>(ApiUrls.PullRequestFiles(repositoryId, number), options);
         }
     }
 }