Add support to get raw file content as byte[] (#2151)

Octokit.Reactive/Clients/IObservableRepositoryContentsClient.cs

@@ -137,6 +137,17 @@ public interface IObservableRepositoryContentsClient
         /// <param name="name">The name of the repository</param>
         IObservable<RepositoryContent> GetAllContents(string owner, string name);
 
+        /// <summary>
+        /// Returns the raw content of the file at the given <paramref name="path"/> or <c>null</c> if the path is a directory.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/contents/#get-contents">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="path">The content path</param>
+        IObservable<byte[]> GetRawContent(string owner, string name, string path);
+
         /// <summary>
         /// Returns the contents of the root directory in a repository.
         /// </summary>
@@ -156,6 +167,18 @@ public interface IObservableRepositoryContentsClient
         /// <param name="path">The content path</param>
         IObservable<RepositoryContent> GetAllContentsByRef(string owner, string name, string reference, string path);
 
+        /// <summary>
+        /// Returns the raw content of the file at the given <paramref name="path"/> or <c>null</c> if the path is a directory.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/contents/#get-contents">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="path">The content path</param>
+        /// <param name="reference">The name of the commit/branch/tag.</param>
+        IObservable<byte[]> GetRawContentByRef(string owner, string name, string path, string reference);
+
         /// <summary>
         /// Returns the contents of a file or directory in a repository.
         /// </summary>

Octokit.Reactive/Clients/ObservableRepositoryContentsClient.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Reactive;
+using System.Reactive.Linq;
 using System.Reactive.Threading.Tasks;
 using Octokit.Reactive.Internal;
 
@@ -238,6 +239,28 @@ public IObservable<RepositoryContent> GetAllContents(string owner, string name)
                 .GetAndFlattenAllPages<RepositoryContent>(ApiUrls.RepositoryContent(owner, name, string.Empty));
         }
 
+        /// <summary>
+        /// Returns the raw content of the file at the given <paramref name="path"/> or <c>null</c> if the path is a directory.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/contents/#get-contents">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="path">The content path</param>
+        public IObservable<byte[]> GetRawContent(string owner, string name, string path)
+        {
+            Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
+            Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
+            Ensure.ArgumentNotNullOrEmptyString(path, nameof(path));
+
+            return _client
+                .Connection
+                .GetRaw(ApiUrls.RepositoryContent(owner, name, path), null)
+                .ToObservable()
+                .Select(e => e.Body);
+        }
+
         /// <summary>
         /// Returns the contents of the root directory in a repository.
         /// </summary>
@@ -270,6 +293,30 @@ public IObservable<RepositoryContent> GetAllContentsByRef(string owner, string n
             return _client.Connection.GetAndFlattenAllPages<RepositoryContent>(ApiUrls.RepositoryContent(owner, name, path, reference));
         }
 
+        /// <summary>
+        /// Returns the raw content of the file at the given <paramref name="path"/> or <c>null</c> if the path is a directory.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/contents/#get-contents">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="path">The content path</param>
+        /// <param name="reference">The name of the commit/branch/tag.</param>
+        public IObservable<byte[]> GetRawContentByRef(string owner, string name, string path, string reference)
+        {
+            Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
+            Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
+            Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
+            Ensure.ArgumentNotNullOrEmptyString(path, nameof(path));
+
+            return _client
+                .Connection
+                .GetRaw(ApiUrls.RepositoryContent(owner, name, path, reference), null)
+                .ToObservable()
+                .Select(e => e.Body);
+        }
+
         /// <summary>
         /// Returns the contents of a file or directory in a repository.
         /// </summary>

Octokit.Tests/Clients/RepositoryContentsClientTests.cs

@@ -217,6 +217,39 @@ public async Task EnsuresNonNullArguments()
             }
         }
 
+        public class TheGetRawContentMethod
+        {
+            [Fact]
+            public async Task ReturnsRawContent()
+            {
+                var result = new byte[] { 1, 2, 3 };
+
+                var connection = Substitute.For<IApiConnection>();
+                connection.GetRaw(Args.Uri, default).Returns(result);
+                var contentsClient = new RepositoryContentsClient(connection);
+
+                var rawContent = await contentsClient.GetRawContent("fake", "repo", "path/to/file.txt");
+
+                connection.Received().GetRaw(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/contents/path/to/file.txt"), null);
+                Assert.Same(result, rawContent);
+            }
+
+            [Fact]
+            public async Task EnsuresNonNullArguments()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new RepositoryContentsClient(connection);
+
+                await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetRawContent(null, "name", "path"));
+                await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetRawContent("owner", null, "path"));
+                await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetRawContent("owner", "name", null));
+
+                await Assert.ThrowsAsync<ArgumentException>(() => client.GetRawContent("", "name", "path"));
+                await Assert.ThrowsAsync<ArgumentException>(() => client.GetRawContent("owner", "", "path"));
+                await Assert.ThrowsAsync<ArgumentException>(() => client.GetRawContent("owner", "name", ""));
+            }
+        }
+
         public class TheGetContentsByRefMethod
         {
             [Fact]
@@ -311,6 +344,41 @@ public async Task EnsuresNonNullArguments()
             }
         }
 
+        public class TheGetRawContentByRefMethod
+        {
+            [Fact]
+            public async Task ReturnsRawContent()
+            {
+                var result = new byte[] { 1, 2, 3 };
+
+                var connection = Substitute.For<IApiConnection>();
+                connection.GetRaw(Args.Uri, default).Returns(result);
+                var contentsClient = new RepositoryContentsClient(connection);
+
+                var rawContent = await contentsClient.GetRawContentByRef("fake", "repo", "path/to/file.txt", "reference");
+
+                connection.Received().GetRaw(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/contents/path/to/file.txt?ref=reference"), null);
+                Assert.Same(result, rawContent);
+            }
+
+            [Fact]
+            public async Task EnsuresNonNullArguments()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new RepositoryContentsClient(connection);
+
+                await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetRawContentByRef(null, "name", "path", "reference"));
+                await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetRawContentByRef("owner", null, "path", "reference"));
+                await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetRawContentByRef("owner", "name", null, "reference"));
+                await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetRawContentByRef("owner", "name", "path", null));
+
+                await Assert.ThrowsAsync<ArgumentException>(() => client.GetRawContentByRef("", "name", "path", "reference"));
+                await Assert.ThrowsAsync<ArgumentException>(() => client.GetRawContentByRef("owner", "", "path", "reference"));
+                await Assert.ThrowsAsync<ArgumentException>(() => client.GetRawContentByRef("owner", "name", "", "reference"));
+                await Assert.ThrowsAsync<ArgumentException>(() => client.GetRawContentByRef("owner", "name", "path", ""));
+            }
+        }
+
         public class TheCreateFileMethod
         {
             [Fact]

Octokit.Tests/Reactive/ObservableRepositoryContentsClientTests.cs

@@ -274,6 +274,45 @@ public void EnsuresNonNullArguments()
             }
         }
 
+        public class TheGetRawContentMethod
+        {
+            [Fact]
+            public async Task ReturnsRawContent()
+            {
+                var result = new byte[] { 1, 2, 3 };
+
+                var connection = Substitute.For<IConnection>();
+                var gitHubClient = new GitHubClient(connection);
+                var contentsClient = new ObservableRepositoryContentsClient(gitHubClient);
+                IApiResponse<byte[]> response = new ApiResponse<byte[]>
+                (
+                    new Response { ApiInfo = new ApiInfo(new Dictionary<string, Uri>(), new List<string>(), new List<string>(), "etag", new RateLimit()) },
+                    result
+                );
+                connection.GetRaw(Args.Uri, default).Returns(response);
+
+                var rawContent = await contentsClient.GetRawContent("fake", "repo", "path/to/file.txt");
+
+                connection.Received().GetRaw(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/contents/path/to/file.txt"), null);
+                Assert.Same(result, rawContent);
+            }
+
+            [Fact]
+            public void EnsuresNonNullArguments()
+            {
+                var gitHubClient = Substitute.For<IGitHubClient>();
+                var client = new ObservableRepositoryContentsClient(gitHubClient);
+
+                Assert.Throws<ArgumentNullException>(() => client.GetRawContent(null, "name", "path"));
+                Assert.Throws<ArgumentNullException>(() => client.GetRawContent("owner", null, "path"));
+                Assert.Throws<ArgumentNullException>(() => client.GetRawContent("owner", "name", null));
+
+                Assert.Throws<ArgumentException>(() => client.GetRawContent("", "name", "path"));
+                Assert.Throws<ArgumentException>(() => client.GetRawContent("owner", "", "path"));
+                Assert.Throws<ArgumentException>(() => client.GetRawContent("owner", "name", ""));
+            }
+        }
+
         public class TheGetContentsByRefMethod
         {
             [Fact]
@@ -396,6 +435,47 @@ public void EnsuresNonNullArguments()
             }
         }
 
+        public class TheGetRawContentByRefMethod
+        {
+            [Fact]
+            public async Task ReturnsRawContent()
+            {
+                var result = new byte[] { 1, 2, 3 };
+
+                var connection = Substitute.For<IConnection>();
+                var gitHubClient = new GitHubClient(connection);
+                var contentsClient = new ObservableRepositoryContentsClient(gitHubClient);
+                IApiResponse<byte[]> response = new ApiResponse<byte[]>
+                (
+                    new Response { ApiInfo = new ApiInfo(new Dictionary<string, Uri>(), new List<string>(), new List<string>(), "etag", new RateLimit()) },
+                    result
+                );
+                connection.GetRaw(Args.Uri, default).Returns(response);
+
+                var rawContent = await contentsClient.GetRawContentByRef("fake", "repo", "path/to/file.txt", "reference");
+
+                connection.Received().GetRaw(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/contents/path/to/file.txt?ref=reference"), null);
+                Assert.Same(result, rawContent);
+            }
+
+            [Fact]
+            public void EnsuresNonNullArguments()
+            {
+                var gitHubClient = Substitute.For<IGitHubClient>();
+                var client = new ObservableRepositoryContentsClient(gitHubClient);
+
+                Assert.Throws<ArgumentNullException>(() => client.GetRawContentByRef(null, "name", "path", "reference"));
+                Assert.Throws<ArgumentNullException>(() => client.GetRawContentByRef("owner", null, "path", "reference"));
+                Assert.Throws<ArgumentNullException>(() => client.GetRawContentByRef("owner", "name", null, "reference"));
+                Assert.Throws<ArgumentNullException>(() => client.GetRawContentByRef("owner", "name", "path", null));
+
+                Assert.Throws<ArgumentException>(() => client.GetRawContentByRef("", "name", "path", "reference"));
+                Assert.Throws<ArgumentException>(() => client.GetRawContentByRef("owner", "", "path", "reference"));
+                Assert.Throws<ArgumentException>(() => client.GetRawContentByRef("owner", "name", "", "reference"));
+                Assert.Throws<ArgumentException>(() => client.GetRawContentByRef("owner", "name", "path", ""));
+            }
+        }
+
         public class TheCreateFileMethod
         {
             [Fact]

Octokit/Clients/IRepositoryContentsClient.cs

@@ -25,6 +25,17 @@ public interface IRepositoryContentsClient
         [ExcludeFromPaginationApiOptionsConventionTest("Pagination not supported by GitHub API (tested 29/08/2017)")]
         Task<IReadOnlyList<RepositoryContent>> GetAllContents(string owner, string name, string path);
 
+        /// <summary>
+        /// Returns the raw content of the file at the given <paramref name="path"/> or <c>null</c> if the path is a directory.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/contents/#get-contents">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="path">The content path</param>
+        Task<byte[]> GetRawContent(string owner, string name, string path);
+
         /// <summary>
         /// Returns the contents of a file or directory in a repository.
         /// </summary>
@@ -70,6 +81,18 @@ public interface IRepositoryContentsClient
         [ExcludeFromPaginationApiOptionsConventionTest("Pagination not supported by GitHub API (tested 29/08/2017)")]
         Task<IReadOnlyList<RepositoryContent>> GetAllContentsByRef(string owner, string name, string path, string reference);
 
+        /// <summary>
+        /// Returns the raw content of the file at the given <paramref name="path"/> or <c>null</c> if the path is a directory.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/contents/#get-contents">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="path">The content path</param>
+        /// <param name="reference">The name of the commit/branch/tag.</param>
+        Task<byte[]> GetRawContentByRef(string owner, string name, string path, string reference);
+
         /// <summary>
         /// Returns the contents of a file or directory in a repository.
         /// </summary>

Octokit/Clients/RepositoryContentsClient.cs

@@ -41,6 +41,27 @@ public Task<IReadOnlyList<RepositoryContent>> GetAllContents(string owner, strin
             return ApiConnection.GetAll<RepositoryContent>(url);
         }
 
+        /// <summary>
+        /// Returns the raw content of the file at the given <paramref name="path"/> or <c>null</c> if the path is a directory.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/contents/#get-contents">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="path">The content path</param>
+        [ManualRoute("GET", "repos/{owner}/{repo}/contents/{path}")]
+        public Task<byte[]> GetRawContent(string owner, string name, string path)
+        {
+            Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
+            Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
+            Ensure.ArgumentNotNullOrEmptyString(path, nameof(path));
+
+            var url = ApiUrls.RepositoryContent(owner, name, path);
+
+            return ApiConnection.GetRaw(url, null);
+        }
+
         /// <summary>
         /// Returns the contents of a file or directory in a repository.
         /// </summary>
@@ -112,13 +133,32 @@ public Task<IReadOnlyList<RepositoryContent>> GetAllContentsByRef(string owner,
             Ensure.ArgumentNotNullOrEmptyString(path, nameof(path));
             Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
 
-            var url = (path == "/")
-                ? ApiUrls.RepositoryContent(owner, name, "", reference)
-                : ApiUrls.RepositoryContent(owner, name, path, reference);
-
+            var url = ApiUrls.RepositoryContent(owner, name, path, reference);
             return ApiConnection.GetAll<RepositoryContent>(url);
         }
 
+        /// <summary>
+        /// Returns the raw content of the file at the given <paramref name="path"/> or <c>null</c> if the path is a directory.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/contents/#get-contents">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="path">The content path</param>
+        /// <param name="reference">The name of the commit/branch/tag.</param>
+        [ManualRoute("GET", "repos/{owner}/{repo}/contents/{path}?ref={ref}")]
+        public Task<byte[]> GetRawContentByRef(string owner, string name, string path, string reference)
+        {
+            Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
+            Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
+            Ensure.ArgumentNotNullOrEmptyString(path, nameof(path));
+            Ensure.ArgumentNotNullOrEmptyString(reference, nameof(reference));
+
+            var url = ApiUrls.RepositoryContent(owner, name, path, reference);
+            return ApiConnection.GetRaw(url, null);
+        }
+
         /// <summary>
         /// Returns the contents of a file or directory in a repository.
         /// </summary>

Octokit/Helpers/AcceptHeaders.cs

@@ -13,6 +13,12 @@ public static class AcceptHeaders
 
         public const string CommitReferenceSha1MediaType = "application/vnd.github.v3.sha";
 
+        /// <summary>
+        /// Support for retrieving raw file content with the <see cref="IConnection.GetRaw"/> method.
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/repos/contents/#custom-media-types</remarks>
+        public const string RawContentMediaType = "application/vnd.github.v3.raw";
+
         public const string StarCreationTimestamps = "application/vnd.github.v3.star+json";
 
         public const string MigrationsApiPreview = "application/vnd.github.wyandotte-preview+json";