Added opportunity to retrieve merge request notes and time statistics (#115)

Co-authored-by: Joseph Petersen <josephp90@gmail.com>

Author: dremerdt

src/GitLabApiClient/GitLabClient.cs

@@ -38,6 +38,7 @@ public GitLabClient(string hostUrl, string authenticationToken = "")
 
             var projectQueryBuilder = new ProjectsQueryBuilder();
             var projectIssueNotesQueryBuilder = new ProjectIssueNotesQueryBuilder();
+            var projectMergeRequestsNotesQueryBuilder = new ProjectMergeRequestsNotesQueryBuilder();
             var issuesQueryBuilder = new IssuesQueryBuilder();
             var mergeRequestsQueryBuilder = new MergeRequestsQueryBuilder();
             var projectMilestonesQueryBuilder = new MilestonesQueryBuilder();
@@ -58,7 +59,7 @@ public GitLabClient(string hostUrl, string authenticationToken = "")
 
             Issues = new IssuesClient(_httpFacade, issuesQueryBuilder, projectIssueNotesQueryBuilder);
             Uploads = new UploadsClient(_httpFacade);
-            MergeRequests = new MergeRequestsClient(_httpFacade, mergeRequestsQueryBuilder, projectMergeRequestsQueryBuilder);
+            MergeRequests = new MergeRequestsClient(_httpFacade, mergeRequestsQueryBuilder, projectMergeRequestsQueryBuilder, projectMergeRequestsNotesQueryBuilder);
             Projects = new ProjectsClient(_httpFacade, projectQueryBuilder, projectMilestonesQueryBuilder, jobQueryBuilder);
             Users = new UsersClient(_httpFacade);
             Groups = new GroupsClient(_httpFacade, groupsQueryBuilder, projectsGroupsQueryBuilder, projectMilestonesQueryBuilder, groupLabelsQueryBuilder);

src/GitLabApiClient/Internal/Queries/ProjectMergeRequestsNotesQueryBuilder.cs

@@ -0,0 +1,31 @@
+using System;
+using GitLabApiClient.Models;
+using GitLabApiClient.Models.Notes.Requests;
+
+namespace GitLabApiClient.Internal.Queries
+{
+    internal class ProjectMergeRequestsNotesQueryBuilder : QueryBuilder<MergeRequestNotesQueryOptions>
+    {
+        protected override void BuildCore(MergeRequestNotesQueryOptions options)
+        {
+            if (options.SortOrder != SortOrder.Descending)
+                Add("sort", GetSortOrderQueryValue(options.SortOrder));
+
+            if (options.Order != NoteOrder.CreatedAt)
+                Add("order_by", GetNoteOrderQueryValue(options.Order));
+        }
+
+        private static string GetNoteOrderQueryValue(NoteOrder order)
+        {
+            switch (order)
+            {
+                case NoteOrder.CreatedAt:
+                    return "created_at";
+                case NoteOrder.UpdatedAt:
+                    return "updated_at";
+                default:
+                    throw new NotSupportedException($"Order {order} is not supported");
+            }
+        }
+    }
+}

src/GitLabApiClient/MergeRequestsClient.cs

@@ -7,6 +7,8 @@
 using GitLabApiClient.Internal.Queries;
 using GitLabApiClient.Models.MergeRequests.Requests;
 using GitLabApiClient.Models.MergeRequests.Responses;
+using GitLabApiClient.Models.Notes.Requests;
+using GitLabApiClient.Models.Notes.Responses;
 using GitLabApiClient.Models.Projects.Responses;
 
 namespace GitLabApiClient
@@ -22,15 +24,18 @@ public sealed class MergeRequestsClient
         private readonly GitLabHttpFacade _httpFacade;
         private readonly MergeRequestsQueryBuilder _mergeRequestsQueryBuilder;
         private readonly ProjectMergeRequestsQueryBuilder _projectMergeRequestsQueryBuilder;
+        private readonly ProjectMergeRequestsNotesQueryBuilder _projectMergeRequestNotesQueryBuilder;
 
         internal MergeRequestsClient(
             GitLabHttpFacade httpFacade,
             MergeRequestsQueryBuilder mergeRequestsQueryBuilder,
-            ProjectMergeRequestsQueryBuilder projectMergeRequestsQueryBuilder)
+            ProjectMergeRequestsQueryBuilder projectMergeRequestsQueryBuilder,
+            ProjectMergeRequestsNotesQueryBuilder projectMergeRequestNotesQueryBuilder)
         {
             _httpFacade = httpFacade;
             _mergeRequestsQueryBuilder = mergeRequestsQueryBuilder;
             _projectMergeRequestsQueryBuilder = projectMergeRequestsQueryBuilder;
+            _projectMergeRequestNotesQueryBuilder = projectMergeRequestNotesQueryBuilder;
         }
 
         /// <summary>
@@ -107,5 +112,21 @@ public async Task<MergeRequest> AcceptAsync(ProjectId projectId, int mergeReques
         /// <param name="mergeRequestId">The Internal Merge Request Id.</param>
         public async Task DeleteAsync(ProjectId projectId, int mergeRequestId) =>
             await _httpFacade.Delete($"projects/{projectId}/merge_requests/{mergeRequestId}");
+
+        /// <summary>
+        /// Retrieves notes (comments) of a merge request.
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="mergeRequestIid">Iid of the merge request.</param>
+        /// <param name="options">MergeRequestNotes retrieval options.</param>
+        /// <returns>Merge requests satisfying options.</returns>
+        public async Task<IList<Note>> GetNotesAsync(ProjectId projectId, int mergeRequestIid, Action<MergeRequestNotesQueryOptions> options = null)
+        {
+            var queryOptions = new MergeRequestNotesQueryOptions();
+            options?.Invoke(queryOptions);
+
+            string url = _projectMergeRequestNotesQueryBuilder.Build($"projects/{projectId}/merge_requests/{mergeRequestIid}/notes", queryOptions);
+            return await _httpFacade.GetPagedList<Note>(url);
+        }
     }
 }

src/GitLabApiClient/Models/MergeRequests/Responses/MergeRequest.cs

@@ -82,5 +82,8 @@ public sealed class MergeRequest : ModifiableObject
 
         [JsonProperty("work_in_progress")]
         public bool WorkInProgress { get; set; }
+
+        [JsonProperty("time_stats")]
+        public MergeRequestTimeStatistic TimeStats { get; set; }
     }
 }

src/GitLabApiClient/Models/MergeRequests/Responses/MergeRequestTimeStatistic.cs

@@ -0,0 +1,19 @@
+using Newtonsoft.Json;
+
+namespace GitLabApiClient.Models.MergeRequests.Responses
+{
+    public class MergeRequestTimeStatistic
+    {
+        [JsonProperty("time_estimate")]
+        public int TimeEstimate { get; set; }
+
+        [JsonProperty("total_time_spent")]
+        public int TotalTimeSpent { get; set; }
+
+        [JsonProperty("human_time_estimate")]
+        public string HumanTimeEstimate { get; set; }
+
+        [JsonProperty("human_total_time_spent")]
+        public string HumanTotalTimeSpent { get; set; }
+    }
+}

src/GitLabApiClient/Models/Notes/Requests/MergeRequestNotesQueryOptions.cs

@@ -0,0 +1,20 @@
+namespace GitLabApiClient.Models.Notes.Requests
+{
+    /// <summary>
+    /// Options for note (comment) listing
+    /// </summary>
+    public sealed class MergeRequestNotesQueryOptions
+    {
+        internal MergeRequestNotesQueryOptions() { }
+
+        /// <summary>
+        /// Return merge request notes sorted in asc or desc order. Default is desc
+        /// </summary>
+        public SortOrder SortOrder { get; set; } = SortOrder.Descending;
+
+        /// <summary>
+        /// Return merge request notes ordered by created_at or updated_at fields. Default is created_at
+        /// </summary>
+        public NoteOrder Order { get; set; } = NoteOrder.CreatedAt;
+    }
+}

test/GitLabApiClient.Test/MergeRequestClientTest.cs

@@ -17,7 +17,8 @@ namespace GitLabApiClient.Test
     public class MergeRequestClientTest : IAsyncLifetime
     {
         private readonly MergeRequestsClient _sut = new MergeRequestsClient(
-            GitLabApiHelper.GetFacade(), new MergeRequestsQueryBuilder(), new ProjectMergeRequestsQueryBuilder());
+            GitLabApiHelper.GetFacade(), new MergeRequestsQueryBuilder(), new ProjectMergeRequestsQueryBuilder(),
+            new ProjectMergeRequestsNotesQueryBuilder());
 
         [Fact]
         public async Task CreatedMergeRequestCanBeRetrieved()