Add interfaces for GitLabClient and all inner clients (#130)

Author: ap0llo

src/GitLabApiClient/BranchClient.cs

@@ -10,7 +10,7 @@
 
 namespace GitLabApiClient
 {
-    public sealed class BranchClient
+    public sealed class BranchClient : IBranchClient
     {
         private readonly GitLabHttpFacade _httpFacade;
         private readonly BranchQueryBuilder _branchQueryBuilder;

src/GitLabApiClient/CommitsClient.cs

@@ -10,7 +10,7 @@
 
 namespace GitLabApiClient
 {
-    public sealed class CommitsClient
+    public sealed class CommitsClient : ICommitsClient
     {
         private readonly GitLabHttpFacade _httpFacade;
         private readonly CommitQueryBuilder _commitQueryBuilder;

src/GitLabApiClient/FilesClient.cs

@@ -7,7 +7,7 @@
 
 namespace GitLabApiClient
 {
-    public sealed class FilesClient
+    public sealed class FilesClient : IFilesClient
     {
         private readonly GitLabHttpFacade _httpFacade;
 

src/GitLabApiClient/GitLabClient.cs

@@ -15,7 +15,7 @@ namespace GitLabApiClient
     /// <summary>
     /// A client for the GitLab API v4. You can read more about the api here: https://docs.gitlab.com/ce/api/README.html.
     /// </summary>
-    public sealed class GitLabClient
+    public sealed class GitLabClient : IGitLabClient
     {
         private readonly GitLabHttpFacade _httpFacade;
 
@@ -83,87 +83,87 @@ public GitLabClient(string hostUrl, string authenticationToken = "", HttpMessage
         /// <summary>
         /// Access GitLab's issues API.
         /// </summary>
-        public IssuesClient Issues { get; }
+        public IIssuesClient Issues { get; }
 
         /// <summary>
         /// Access GitLab's uploads API.
         /// </summary>
-        public UploadsClient Uploads { get; }
+        public IUploadsClient Uploads { get; }
 
         /// <summary>
         /// Access GitLab's merge requests API.
         /// </summary>
-        public MergeRequestsClient MergeRequests { get; }
+        public IMergeRequestsClient MergeRequests { get; }
 
         /// <summary>
         /// Access GitLab's projects API.
         /// </summary>
-        public ProjectsClient Projects { get; }
+        public IProjectsClient Projects { get; }
 
         /// <summary>
         /// Access GitLab's users API.
         /// </summary>
-        public UsersClient Users { get; }
+        public IUsersClient Users { get; }
 
         /// <summary>
         /// Access GitLab's groups API.
         /// </summary>
-        public GroupsClient Groups { get; }
+        public IGroupsClient Groups { get; }
 
         /// <summary>
         /// Access GitLab's branches API.
         /// </summary>
-        public BranchClient Branches { get; }
+        public IBranchClient Branches { get; }
 
         /// <summary>
         /// Access GitLab's release API.
         /// </summary>
-        public ReleaseClient Releases { get; }
+        public IReleaseClient Releases { get; }
 
         /// <summary>
         /// Access GitLab's tags API.
         /// </summary>
-        public TagClient Tags { get; }
+        public ITagClient Tags { get; }
 
         /// <summary>
         /// Access GitLab's webhook API.
         /// </summary>
-        public WebhookClient Webhooks { get; }
+        public IWebhookClient Webhooks { get; }
 
         /// <summary>
         /// Access GitLab's commits API.
         /// </summary>
-        public CommitsClient Commits { get; }
+        public ICommitsClient Commits { get; }
 
         /// <summary>
         /// Access GitLab's trees API.
         /// </summary>
-        public TreesClient Trees { get; }
+        public ITreesClient Trees { get; }
 
         /// <summary>
         /// Access GitLab's files API.
         /// </summary>
-        public FilesClient Files { get; }
+        public IFilesClient Files { get; }
 
         /// <summary>
         /// Access GitLab's Markdown API.
         /// </summary>
-        public MarkdownClient Markdown { get; }
+        public IMarkdownClient Markdown { get; }
 
         /// <summary>
         /// Acess GitLab's Pipeline API.
         /// </summary>
-        public PipelineClient Pipelines { get; }
+        public IPipelineClient Pipelines { get; }
 
         /// <summary>
         /// Access GitLab's Runners API.
         /// </summary>
-        public RunnersClient Runners { get; }
+        public IRunnersClient Runners { get; }
 
         /// <summary>
         /// Access GitLab's ToDo-List API.
         /// </summary>
-        public ToDoListClient ToDoList { get; }
+        public IToDoListClient ToDoList { get; }
 
         /// <summary>
         /// Provides a client connection to make rest requests to HTTP endpoints.

src/GitLabApiClient/GroupsClient.cs

@@ -20,7 +20,7 @@ namespace GitLabApiClient
     /// <exception cref="GitLabException">Thrown if request to GitLab API does not indicate success</exception>
     /// <exception cref="HttpRequestException">Thrown if request to GitLab API fails</exception>
     /// </summary>
-    public sealed class GroupsClient
+    public sealed class GroupsClient : IGroupsClient
     {
         private readonly GitLabHttpFacade _httpFacade;
         private readonly GroupsQueryBuilder _queryBuilder;

src/GitLabApiClient/IBranchClient.cs

@@ -0,0 +1,81 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using GitLabApiClient.Internal.Http;
+using GitLabApiClient.Internal.Paths;
+using GitLabApiClient.Internal.Queries;
+using GitLabApiClient.Models.Branches.Requests;
+using GitLabApiClient.Models.Branches.Responses;
+using GitLabApiClient.Models.Projects.Responses;
+
+namespace GitLabApiClient
+{
+    public interface IBranchClient
+    {/// <summary>
+     /// Retrieves a single branch
+     /// </summary>
+     /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+     /// <param name="branchName">The branch name.</param>
+     /// <returns></returns>
+        Task<Branch> GetAsync(ProjectId projectId, string branchName);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="options">Query options <see cref="BranchQueryOptions"/></param>
+        /// <returns></returns>
+        Task<IList<Branch>> GetAsync(ProjectId projectId, Action<BranchQueryOptions> options);
+
+        /// <summary>
+        /// Creates a branch
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="request">Create branch request</param>
+        /// <returns></returns>
+        Task<Branch> CreateAsync(ProjectId projectId, CreateBranchRequest request);
+
+        /// <summary>
+        /// Deletes a branch
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="branchName">The branch, you want deleted.</param>
+        Task DeleteBranch(ProjectId projectId, string branchName);
+
+        /// <summary>
+        /// Deletes the merged branches
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        Task DeleteMergedBranches(ProjectId projectId);
+
+        /// <summary>
+        /// Retrieve a single protected branch information.
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="branchName">The protected branch</param>
+        /// <returns>A protected branch</returns>
+        Task<ProtectedBranch> GetProtectedBranchesAsync(ProjectId projectId, string branchName);
+
+        /// <summary>
+        /// Retrieves a list of Protected Branches from a project.
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <returns>List of protected branches.</returns>
+        Task<IList<ProtectedBranch>> GetProtectedBranchesAsync(ProjectId projectId);
+
+        /// <summary>
+        /// Protect a branch
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="request">Protect branch request <see cref="ProtectBranchRequest"/>.</param>
+        /// <returns>The newly protected branch.</returns>
+        Task<ProtectedBranch> ProtectBranchAsync(ProjectId projectId, ProtectBranchRequest request);
+
+        /// <summary>
+        /// Unprotect a branch
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="branchName">The Branch, you want to unprotect.</param>
+        Task UnprotectBranchAsync(ProjectId projectId, string branchName);
+    }
+}

src/GitLabApiClient/ICommitsClient.cs

@@ -0,0 +1,57 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using GitLabApiClient.Internal.Http;
+using GitLabApiClient.Internal.Paths;
+using GitLabApiClient.Internal.Queries;
+using GitLabApiClient.Models.Commits.Requests;
+using GitLabApiClient.Models.Commits.Responses;
+using GitLabApiClient.Models.Projects.Responses;
+
+namespace GitLabApiClient
+{
+    public interface ICommitsClient
+    {
+        /// <summary>
+        /// Get a commit from commit sha
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="sha">The commit hash or name of a repository branch or tag</param>
+        /// <returns></returns>
+        Task<Commit> GetAsync(ProjectId projectId, string sha);
+
+        /// <summary>
+        /// Retrieve a list of commits from a project
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="options">Query Options <see cref="CommitQueryOptions"/>.</param>
+        /// <returns></returns>
+        Task<IList<Commit>> GetAsync(ProjectId projectId, Action<CommitQueryOptions> options = null);
+
+        /// <summary>
+        /// Retrieve a list of references (from branch or / and tag) that this commit belongs to
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="options">Query Options <see cref="CommitRefsQueryOptions"/>.</param>
+        /// <param name="sha">The commit hash or name of a repository branch or tag</param>
+        /// <returns></returns>
+        Task<IList<CommitRef>> GetRefsAsync(ProjectId projectId, string sha, Action<CommitRefsQueryOptions> options);
+
+        /// <summary>
+        /// Retrieve a list of differences in this commit
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="sha">The commit hash or name of a repository branch or tag</param>
+        /// <returns></returns>
+        Task<IList<Diff>> GetDiffsAsync(ProjectId projectId, string sha);
+
+        /// <summary>
+        /// Retrieve a list of statuses in this commit
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        /// <param name="options">Query Options <see cref="CommitStatusesQueryOptions"/>.</param>
+        /// <param name="sha">The commit hash</param>
+        /// <returns></returns>
+        Task<IList<CommitStatuses>> GetStatusesAsync(ProjectId projectId, string sha, Action<CommitStatusesQueryOptions> options = null);
+    }
+}

src/GitLabApiClient/IFilesClient.cs

@@ -0,0 +1,11 @@
+using System.Threading.Tasks;
+using GitLabApiClient.Internal.Paths;
+using GitLabApiClient.Models.Files.Responses;
+
+namespace GitLabApiClient
+{
+    public interface IFilesClient
+    {
+        Task<File> GetAsync(ProjectId projectId, string filePath, string reference = "master");
+    }
+}