Add IRepositoryClient.CompareAsync (#873)

Co-authored-by: Émile Dupont-Foisy <emile.dupont-foisy@ubisoft.com>

Author: Hastaroth1

NGitLab.Mock/Clients/RepositoryClient.cs

@@ -2,6 +2,8 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using NGitLab.Mock.Internals;
 using NGitLab.Models;
 
@@ -131,4 +133,9 @@ public CompareResults Compare(CompareQuery query)
     {
         throw new NotImplementedException();
     }
+
+    public Task<CompareResults> CompareAsync(CompareQuery query, CancellationToken cancellationToken = default)
+    {
+        throw new NotImplementedException();
+    }
 }

NGitLab/IRepositoryClient.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Threading;
+using System.Threading.Tasks;
 using NGitLab.Models;
 
 namespace NGitLab;
@@ -53,4 +55,7 @@ public interface IRepositoryClient
     /// Compare two branches/tags/commit hashes
     /// </summary>
     CompareResults Compare(CompareQuery query);
+
+    /// <inheritdoc cref="Compare"/>
+    Task<CompareResults> CompareAsync(CompareQuery query, CancellationToken cancellationToken = default);
 }

NGitLab/Impl/RepositoryClient.cs

@@ -3,6 +3,8 @@
 using System.Globalization;
 using System.IO;
 using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
 using NGitLab.Extensions;
 using NGitLab.Models;
 
@@ -110,6 +112,11 @@ public CompareResults Compare(CompareQuery query)
         return _api.Get().To<CompareResults>(_repoPath + $@"/compare?from={query.Source}&to={query.Target}");
     }
 
+    public Task<CompareResults> CompareAsync(CompareQuery query, CancellationToken cancellationToken = default)
+    {
+        return _api.Get().ToAsync<CompareResults>(_repoPath + $@"/compare?from={query.Source}&to={query.Target}", cancellationToken);
+    }
+
     public Commit GetCommit(Sha1 sha) => _api.Get().To<Commit>(_repoPath + "/commits/" + sha);
 
     public IEnumerable<Diff> GetCommitDiff(Sha1 sha) => _api.Get().GetAll<Diff>(_repoPath + "/commits/" + sha + "/diff");

NGitLab/PublicAPI.Unshipped.txt

@@ -876,6 +876,7 @@ NGitLab.Impl.RepositoryClient
 NGitLab.Impl.RepositoryClient.Branches.get -> NGitLab.IBranchClient
 NGitLab.Impl.RepositoryClient.Commits.get -> System.Collections.Generic.IEnumerable<NGitLab.Models.Commit>
 NGitLab.Impl.RepositoryClient.Compare(NGitLab.Models.CompareQuery query) -> NGitLab.Models.CompareResults
+NGitLab.Impl.RepositoryClient.CompareAsync(NGitLab.Models.CompareQuery query, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<NGitLab.Models.CompareResults>
 NGitLab.Impl.RepositoryClient.Contributors.get -> NGitLab.IContributorClient
 NGitLab.Impl.RepositoryClient.Files.get -> NGitLab.IFilesClient
 NGitLab.Impl.RepositoryClient.GetArchive(System.Action<System.IO.Stream> parser) -> void
@@ -1110,6 +1111,7 @@ NGitLab.IRepositoryClient
 NGitLab.IRepositoryClient.Branches.get -> NGitLab.IBranchClient
 NGitLab.IRepositoryClient.Commits.get -> System.Collections.Generic.IEnumerable<NGitLab.Models.Commit>
 NGitLab.IRepositoryClient.Compare(NGitLab.Models.CompareQuery query) -> NGitLab.Models.CompareResults
+NGitLab.IRepositoryClient.CompareAsync(NGitLab.Models.CompareQuery query, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<NGitLab.Models.CompareResults>
 NGitLab.IRepositoryClient.Contributors.get -> NGitLab.IContributorClient
 NGitLab.IRepositoryClient.Files.get -> NGitLab.IFilesClient
 NGitLab.IRepositoryClient.GetArchive(System.Action<System.IO.Stream> parser) -> void