support id, path or object of groups and project (#68)

* support id, path or object of groups and project

Library should handle path encoding

* formatting 😓

* less braces

* xml-doc it

* xml-doc it, take two

* update test project target and dependencies

* fix fluent assertion usage

* fix xUnit Initialize and Dispose needs to be annotated with Fact

* Implement implicit operators, revert BaseUrl pattern

* Add solution items

* add csharp_space_in_singleline_method as true to match dotnet format

* fix formatting

* fix copy paste error in commit query builder

* fix missing fluent assertion usage, missed due to WIP being too large

Commit more often!

* remove the last base url method 😓

* fixup pipeline client

* skip mono

* truly skip mono on travis

* use coverlet.collector to generate opencover

* chocolatey install no progress

Author: jetersen

.editorconfig

@@ -180,6 +180,9 @@ csharp_style_var_for_built_in_types = false:error
 # http://kent-boogaart.com/blog/editorconfig-reference-for-c-developers#csharp_style_var_when_type_is_apparent
 csharp_style_var_when_type_is_apparent = true:error
 
+# https://www.jetbrains.com/help/resharper/EditorConfig_CSHARP_SpacesPageSchema.html#resharper_csharp_space_in_singleline_method
+csharp_space_in_singleline_method = true
+
 # http://kent-boogaart.com/blog/editorconfig-reference-for-c-developers#dotnet_sort_system_directives_first
 dotnet_sort_system_directives_first = true
 

.travis.yml

@@ -1,15 +1,13 @@
 language: csharp
-mono: 5.2.0
-dotnet: 2.0.0
-dist: trusty
+mono: none
+dotnet: 3.0.100
+dist: bionic
 sudo: required
-install:
- - export FrameworkPathOverride=$(dirname $(which mono))/../lib/mono/4.5/
 services:
  - docker
 script:
  - dotnet build
- - (cd ./test/GitLabApiClient.Test && dotnet test)
+ - dotnet test
 cache:
   directories:
   - $HOME/.nuget

GitLabApiClient.sln

@@ -1,11 +1,19 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.26730.3
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.29324.140
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GitLabApiClient", "src\GitLabApiClient\GitLabApiClient.csproj", "{92D1EE01-7A8D-4EFC-B856-54C0E0645454}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitLabApiClient.Test", "test\GitLabApiClient.Test\GitLabApiClient.Test.csproj", "{11F0436A-3BAC-4C3F-9E59-2F271730A5C8}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "GitLabApiClient.Test", "test\GitLabApiClient.Test\GitLabApiClient.Test.csproj", "{11F0436A-3BAC-4C3F-9E59-2F271730A5C8}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{6E176091-1CD1-475A-AB85-C1735D9422BD}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+		.travis.yml = .travis.yml
+		appveyor.yml = appveyor.yml
+		build.ps1 = build.ps1
+	EndProjectSection
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

appveyor.yml

@@ -8,10 +8,10 @@ environment:
   # Don't report back to the mothership
   DOTNET_CLI_TELEMETRY_OPTOUT: 1
 
-
 skip_branch_with_pr: true
 
 before_build:
+  - ps: cinst -y codecov --no-progress
   - ps: dotnet tool install -g dotnet-format
   - ps: dotnet format --check --dry-run
 

coverletArgs.runsettings

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<RunSettings>
+  <DataCollectionRunSettings>
+    <DataCollectors>
+      <DataCollector friendlyName="XPlat code coverage">
+        <Configuration>
+          <Format>opencover</Format>
+          <Exclude>[GitLabApiClient.Test*]*</Exclude>
+          <Include>[GitLabApiClient*]*</Include>
+          <SingleHit>false</SingleHit>
+        </Configuration>
+      </DataCollector>
+    </DataCollectors>
+  </DataCollectionRunSettings>
+</RunSettings>

src/GitLabApiClient/BranchClient.cs

@@ -2,9 +2,11 @@
 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
 {
@@ -21,10 +23,22 @@ internal BranchClient(
             _branchQueryBuilder = branchQueryBuilder;
         }
 
-        public async Task<Branch> GetAsync(string projectId, string branchName) =>
+        /// <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>
+        public async Task<Branch> GetAsync(ProjectId projectId, string branchName) =>
             await _httpFacade.Get<Branch>($"projects/{projectId}/repository/branches/{branchName}");
 
-        public async Task<IList<Branch>> GetAsync(string projectId, Action<BranchQueryOptions> options)
+        /// <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>
+        public async Task<IList<Branch>> GetAsync(ProjectId projectId, Action<BranchQueryOptions> options)
         {
             var queryOptions = new BranchQueryOptions();
             options?.Invoke(queryOptions);
@@ -33,25 +47,62 @@ public async Task<IList<Branch>> GetAsync(string projectId, Action<BranchQueryOp
             return await _httpFacade.GetPagedList<Branch>(url);
         }
 
-        public async Task<Branch> CreateAsync(CreateBranchRequest request) =>
-            await _httpFacade.Post<Branch>($"projects/{request.ProjectId}/repository/branches", request);
+        /// <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>
+        public async Task<Branch> CreateAsync(ProjectId projectId, CreateBranchRequest request) =>
+            await _httpFacade.Post<Branch>($"projects/{projectId}/repository/branches", request);
 
-        public async Task DeleteBranch(DeleteBranchRequest request) =>
-            await _httpFacade.Delete($"projects/{request.ProjectId}/repository/branches/{request.BranchName}");
+        /// <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>
+        public async Task DeleteBranch(ProjectId projectId, string branchName) =>
+            await _httpFacade.Delete($"projects/{projectId}/repository/branches/{branchName}");
 
-        public async Task DeleteMergedBranches(DeleteMergedBranchesRequest request) =>
-            await _httpFacade.Delete($"projects/{request.ProjectId}/repository/merged_branches");
+        /// <summary>
+        /// Deletes the merged branches
+        /// </summary>
+        /// <param name="projectId">The ID, path or <see cref="Project"/> of the project.</param>
+        public async Task DeleteMergedBranches(ProjectId projectId) =>
+            await _httpFacade.Delete($"projects/{projectId}/repository/merged_branches");
 
-        public async Task<ProtectedBranch> GetProtectedBranchesAsync(string projectId, string branchName) =>
+        /// <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>
+        public async Task<ProtectedBranch> GetProtectedBranchesAsync(ProjectId projectId, string branchName) =>
             await _httpFacade.Get<ProtectedBranch>($"projects/{projectId}/protected_branches/{branchName}");
 
-        public async Task<IList<ProtectedBranch>> GetProtectedBranchesAsync(string projectId) =>
+        /// <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>
+        public async Task<IList<ProtectedBranch>> GetProtectedBranchesAsync(ProjectId projectId) =>
             await _httpFacade.GetPagedList<ProtectedBranch>($"projects/{projectId}/protected_branches");
 
-        public async Task<ProtectedBranch> ProtectBranchAsync(ProtectBranchRequest request) =>
-            await _httpFacade.Post<ProtectedBranch>($"projects/{request.ProjectId}/protected_branches", request);
+        /// <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>
+        public async Task<ProtectedBranch> ProtectBranchAsync(ProjectId projectId, ProtectBranchRequest request) =>
+            await _httpFacade.Post<ProtectedBranch>($"projects/{projectId}/protected_branches", request);
 
-        public async Task UnprotectBranchAsync(string projectId, string branchName) =>
+        /// <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>
+        public async Task UnprotectBranchAsync(ProjectId projectId, string branchName) =>
             await _httpFacade.Delete($"projects/{projectId}/protected_branches/{branchName}");
     }
 }

src/GitLabApiClient/CommitsClient.cs

@@ -2,9 +2,11 @@
 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
 {
@@ -19,21 +21,28 @@ internal CommitsClient(GitLabHttpFacade httpFacade, CommitQueryBuilder commitQue
             _commitQueryBuilder = commitQueryBuilder;
         }
 
-        public async Task<Commit> GetAsync(string projectId, string sha) =>
-           await _httpFacade.Get<Commit>(CommitsBaseUrl(projectId) + "/" + sha);
+        /// <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>
+        public async Task<Commit> GetAsync(ProjectId projectId, string sha) =>
+           await _httpFacade.Get<Commit>($"projects/{projectId}/repository/commits/{sha}");
 
-        public async Task<IList<Commit>> GetAsync(string projectId, Action<CommitQueryOptions> options)
+        /// <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>
+        public async Task<IList<Commit>> GetAsync(ProjectId projectId, Action<CommitQueryOptions> options = null)
         {
-            var queryOptions = new CommitQueryOptions(projectId);
+            var queryOptions = new CommitQueryOptions();
             options?.Invoke(queryOptions);
 
-            string url = _commitQueryBuilder.Build(CommitsBaseUrl(projectId), queryOptions);
+            string url = _commitQueryBuilder.Build($"projects/{projectId}/repository/commits", queryOptions);
             return await _httpFacade.GetPagedList<Commit>(url);
         }
-
-        private static string CommitsBaseUrl(string projectId)
-        {
-            return $"projects/{projectId}/repository/commits";
-        }
     }
 }

src/GitLabApiClient/GitLabApiClient.csproj

@@ -1,7 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netstandard2.0;net452</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' != 'Unix'">netstandard2.0;net452</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' == 'Unix'">netstandard2.0</TargetFrameworks>
     <Version>1.0.0</Version>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <AssemblyVersion>1.0.0.0</AssemblyVersion>