Upload files (#27)

* Added methods to upload a file to gitlab for later use in markdown aware fields.

* Fixed typo caused by ReSharpers refactoring.

* Form-part name ist now set as required.

* Moved projectId property to Request model to ensure that pattern is the same verywhere.

Author: yankun

src/GitLabApiClient/GitLabClient.cs

@@ -44,6 +44,7 @@ public GitLabClient(string hostUrl, string authenticationToken = "")
             var projectsGroupsQueryBuilder = new ProjectsGroupQueryBuilder();
 
             Issues = new IssuesClient(_httpFacade, issuesQueryBuilder, projectIssuesQueryBuilder, projectIssueNotesQueryBuilder);
+            Uploads = new UploadsClient(_httpFacade);
             MergeRequests = new MergeRequestsClient(_httpFacade, mergeRequestsQueryBuilder, projectMergeRequestsQueryBuilder);
             Projects = new ProjectsClient(_httpFacade, projectQueryBuilder, projectMilestonesQueryBuilder);
             Users = new UsersClient(_httpFacade);
@@ -55,6 +56,11 @@ public GitLabClient(string hostUrl, string authenticationToken = "")
         /// </summary>
         public IssuesClient Issues { get; }
 
+        /// <summary>
+        /// Access GitLab's uploads API.
+        /// </summary>
+        public UploadsClient Uploads { get; }
+
         /// <summary>
         /// Access GitLab's merge requests API.
         /// </summary>

src/GitLabApiClient/Internal/Http/GitLabHttpFacade.cs

@@ -3,6 +3,8 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using GitLabApiClient.Internal.Http.Serialization;
+using GitLabApiClient.Models.Uploads.Requests;
+using GitLabApiClient.Models.Uploads.Responses;
 using GitLabApiClient.Models.Users.Responses;
 
 namespace GitLabApiClient.Internal.Http
@@ -40,6 +42,9 @@ public Task<T> Post<T>(string uri, object data = null) where T : class =>
         public Task Post(string uri, object data = null) =>
             _requestor.Post(uri, data);
 
+        public Task<Upload> PostFile(string uri, CreateUploadRequest uploadRequest) =>
+            _requestor.PostFile(uri, uploadRequest);
+
         public Task<T> Put<T>(string uri, object data) =>
             _requestor.Put<T>(uri, data);
 

src/GitLabApiClient/Internal/Http/GitlabApiRequestor.cs

@@ -1,8 +1,12 @@
 using System;
+using System.Globalization;
+using System.IO;
 using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Threading.Tasks;
 using GitLabApiClient.Internal.Http.Serialization;
+using GitLabApiClient.Models.Uploads.Requests;
+using GitLabApiClient.Models.Uploads.Responses;
 
 namespace GitLabApiClient.Internal.Http
 {
@@ -39,6 +43,20 @@ public async Task Post(string url, object data = null)
 			await EnsureSuccessStatusCode(responseMessage);
 		}
 
+        public async Task<Upload> PostFile(string url, CreateUploadRequest uploadRequest)
+        {
+            using (var uploadContent =
+                new MultipartFormDataContent($"Upload----{DateTime.Now.Ticks}"))
+            {
+                uploadContent.Add(new StreamContent(uploadRequest.Stream), "file", uploadRequest.FileName);
+
+                var responseMessage = await _client.PostAsync(url, uploadContent);
+                await EnsureSuccessStatusCode(responseMessage);
+
+                return await ReadResponse<Upload>(responseMessage);
+            }
+        }
+
         public async Task<T> Put<T>(string url, object data)
         {
             StringContent content = SerializeToString(data);
@@ -47,7 +65,7 @@ public async Task<T> Put<T>(string url, object data)
             return await ReadResponse<T>(responseMessage);
         }
 
-		public async Task Put(string url, object data)
+        public async Task Put(string url, object data)
 		{
 			StringContent content = SerializeToString(data);
 			var responseMessage = await _client.PutAsync(url, content);

src/GitLabApiClient/Models/Uploads/Requests/CreateUploadRequest.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+
+namespace GitLabApiClient.Models.Uploads.Requests
+{
+    /// <summary>
+    /// A upload (file) for Gitlab, which can be embedded via markdown
+    /// </summary>
+    public sealed class CreateUploadRequest
+    {
+        public CreateUploadRequest(string projectId, Stream stream, string fileName)
+        {
+            projectId = projectId;
+            Stream = stream;
+            FileName = fileName;
+        }
+
+        public string ProjectId { get; }
+
+        /// <summary>
+        /// The stream to be uploaded
+        /// </summary>
+        public Stream Stream { get; }
+
+        /// <summary>
+        /// The name of the file being uploaded
+        /// </summary>
+        public string FileName { get; }
+    }
+}

src/GitLabApiClient/Models/Uploads/Responses/Upload.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.Text;
+using Newtonsoft.Json;
+
+namespace GitLabApiClient.Models.Uploads.Responses
+{
+    public sealed class Upload
+    {
+        [JsonConstructor]
+        public Upload(string alt, string url, string markdown)
+        {
+            Alt = alt;
+            Url = url;
+            Markdown = markdown;
+        }
+
+        public string Alt { get; }
+        public string Url { get; }
+        public string Markdown { get; }
+    }
+}

src/GitLabApiClient/UploadsClient.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.Threading.Tasks;
+using GitLabApiClient.Internal.Http;
+using GitLabApiClient.Models.Uploads.Requests;
+using GitLabApiClient.Models.Uploads.Responses;
+
+namespace GitLabApiClient
+{
+    /// <summary>
+    /// Uploads a file to a project. This file can later be used in issues or everywhere else, where you can write markdown.
+    /// After uploading the file, use the <see cref="Upload.Markdown"/> property.
+    /// </summary>
+    public sealed class UploadsClient
+    {
+        private readonly GitLabHttpFacade _httpFacade;
+
+        internal UploadsClient(GitLabHttpFacade httpFacade) =>
+            _httpFacade = httpFacade;
+
+        /// <summary>
+        /// Uploadses a file for the provided project. 
+        /// </summary>
+        /// <param name="projectId">The id of the project</param>
+        /// <param name="uploadRequest">The upload request containing the filename and stream to be uploaded</param>
+        /// <returns>A <see cref="Upload"/> object.
+        /// Use the <see cref="Upload.Markdown"/> property to place the image in your markdown text.
+        /// </returns>
+        public async Task<Upload> UploadFile(CreateUploadRequest uploadRequest)
+        {
+            return await _httpFacade.PostFile($"projects/{uploadRequest.ProjectId}/uploads", uploadRequest);
+        }
+    }
+}

test/GitLabApiClient.Test/GitLabApiClient.Test.csproj

@@ -11,6 +11,12 @@
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
     <OutputPath>..\bin\Release\</OutputPath>
   </PropertyGroup>
+  <ItemGroup>
+    <None Remove="Ressources\gitlabtest.png" />
+  </ItemGroup>
+  <ItemGroup>
+    <EmbeddedResource Include="Ressources\gitlabtest.png" />
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="FluentAssertions" Version="4.19.4" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0" />

test/GitLabApiClient.Test/Ressources/gitlabtest.png

@@ -0,0 +1,44 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+using System.Threading.Tasks;
+using FluentAssertions;
+using GitLabApiClient.Models.Uploads.Requests;
+using GitLabApiClient.Test.Utilities;
+using Xunit;
+using static GitLabApiClient.Test.Utilities.GitLabApiHelper;
+
+namespace GitLabApiClient.Test
+{
+    [Trait("Category", "LinuxIntegration")]
+    [Collection("GitLabContainerFixture")]
+    public class UploadsClientTest
+    {
+        private readonly UploadsClient _sut = new UploadsClient(
+            GetFacade());
+
+        [Fact]
+        public async Task UploadFile()
+        {
+            var assembly = Assembly.GetExecutingAssembly();
+            var resourceName = assembly.GetManifestResourceNames()
+                .Single(str => str.EndsWith("gitlabtest.png"));
+            var fileName = $"{Guid.NewGuid()}";
+            var fileNameWithExtension = $"{fileName}.png";
+
+            using (Stream stream = assembly.GetManifestResourceStream(resourceName))
+            {
+                var upload = await _sut.UploadFile(
+                    new CreateUploadRequest(TestGroupTextId, stream, fileNameWithExtension));
+
+                upload.Alt.Should().Be(fileName, "Provided Alt tag should only contain the filename without the extension.");
+                upload.Alt.Should().EndWith(fileName, "Provided Url should end with the filename provided to the upload method.");
+                upload.Alt.Should().EndWith(fileName, "Provided Markdown should end with the filename provided to the upload method.");
+                upload.Alt.Should().StartWith($"![{fileName}]", "Provided markdown should start with ![{fileName without extension}].");
+            }
+        }
+    }
+}