Merge pull request #774 from alfhenrik/getallpublicrepos-since

Add `since` parameter for public repositories

Octokit.Reactive/Clients/IObservableRepositoriesClient.cs

@@ -49,7 +49,19 @@ public interface IObservableRepositoriesClient
         [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
             Justification = "Makes a network request")]
         IObservable<Repository> GetAllPublic();
-
+
+        /// <summary>
+        /// Retrieves every public <see cref="Repository"/> since the last repository seen.
+        /// </summary>
+        /// <remarks>
+        /// The default page size on GitHub.com is 30.
+        /// </remarks>
+        /// <param name="request">Search parameters of the last repository seen</param>
+        /// <returns>A <see cref="IReadOnlyPagedCollection{Repository}"/> of <see cref="Repository"/>.</returns>
+        [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
+            Justification = "Makes a network request")]
+        IObservable<Repository> GetAllPublic(PublicRepositoryRequest request);
+
         /// <summary>
         /// Retrieves every <see cref="Repository"/> that belongs to the current user.
         /// </summary>

Octokit.Reactive/Clients/ObservableRepositoriesClient.cs

@@ -102,6 +102,21 @@ public IObservable<Repository> GetAllPublic()
             return _connection.GetAndFlattenAllPages<Repository>(ApiUrls.AllPublicRepositories());
         }
 
+        /// <summary>
+        /// Retrieves every public <see cref="Repository"/> since the last repository seen.
+        /// </summary>
+        /// <remarks>
+        /// The default page size on GitHub.com is 30.
+        /// </remarks>
+        /// <param name="request">Search parameters of the last repository seen</param>
+        /// <returns>A <see cref="IReadOnlyPagedCollection{Repository}"/> of <see cref="Repository"/>.</returns>
+        public IObservable<Repository> GetAllPublic(PublicRepositoryRequest request)
+        {
+            Ensure.ArgumentNotNull(request, "request");
+
+            return _connection.GetAndFlattenAllPages<Repository>(ApiUrls.AllPublicRepositories(), request.ToParametersDictionary());
+        }
+
         /// <summary>
         /// Retrieves every <see cref="Repository"/> that belongs to the current user.
         /// </summary>

Octokit.Tests.Integration/Clients/RepositoriesClientTests.cs

@@ -552,6 +552,21 @@ public async Task ReturnsAllPublicRepositories()
 
             Assert.True(repositories.Count > 80);
         }
+
+        [IntegrationTest]
+        public async Task ReturnsAllPublicRepositoriesSinceLastSeen()
+        {
+            var github = Helper.GetAuthenticatedClient();
+
+            var request = new PublicRepositoryRequest(32732250);
+            var repositories = await github.Repository.GetAllPublic(request);
+
+            Assert.NotNull(repositories);
+            Assert.True(repositories.Any());
+            Assert.Equal(32732252, repositories[0].Id);
+            Assert.False(repositories[0].Private);
+            Assert.Equal("zad19", repositories[0].Name);
+        }
     }
 
     public class TheGetAllForOrgMethod

Octokit.Tests.Integration/Reactive/ObservableRepositoriesClientTests.cs

@@ -1,4 +1,5 @@
-using System.Reactive.Linq;
+using System.Linq;
+using System.Reactive.Linq;
 using System.Threading.Tasks;
 using Octokit.Reactive;
 using Xunit;
@@ -27,5 +28,22 @@ public async Task ReturnsSpecifiedRepository()
                 Assert.False(repository2.Fork);
             }
         }
+
+        public class TheGetAllPublicSinceMethod
+        {
+            [IntegrationTest(Skip = "This will take a very long time to return, so will skip it for now.")]
+            public async Task ReturnsAllPublicReposSinceLastSeen()
+            {
+                var github = Helper.GetAuthenticatedClient();
+
+                var client = new ObservableRepositoriesClient(github);
+                var request = new PublicRepositoryRequest(32732250);
+                var repositories = await client.GetAllPublic(request).ToArray();
+                Assert.NotEmpty(repositories);
+                Assert.Equal(32732252, repositories[0].Id);
+                Assert.False(repositories[0].Private);
+                Assert.Equal("zad19", repositories[0].Name);
+            }
+        }
     }
 }

Octokit.Tests/Clients/RepositoriesClientTests.cs

@@ -273,6 +273,37 @@ public void RequestsTheCorrectUrlAndReturnsRepositories()
             } 
         }
 
+
+        public class TheGetAllPublicSinceMethod
+        {
+            [Fact]
+            public void RequestsTheCorrectUrl()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new RepositoriesClient(connection);
+
+                client.GetAllPublic(new PublicRepositoryRequest(364));
+
+                connection.Received()
+                    .GetAll<Repository>(Arg.Is<Uri>(u => u.ToString() == "/repositories"),
+                        Arg.Any<Dictionary<string, string>>());
+            }
+
+            [Fact]
+            public void SendsTheCorrectParameter()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new RepositoriesClient(connection);
+
+                client.GetAllPublic(new PublicRepositoryRequest(364));
+
+                connection.Received()
+                    .GetAll<Repository>(Arg.Is<Uri>(u => u.ToString() == "/repositories"),
+                        Arg.Is<Dictionary<string, string>>(d => d.Count == 1
+                            && d["since"] == "364"));
+            }
+        }
+
         public class TheGetAllForCurrentMethod
         {
             [Fact]

Octokit.Tests/Reactive/ObservableRepositoriesClientTests.cs

@@ -158,6 +158,65 @@ public async Task StopsMakingNewRequestsWhenTakeIsFulfilled()
             }
         }
 
+        public class TheGetAllPublicRepositoriesSinceMethod
+        {
+            [Fact]
+            public async Task ReturnsEveryPageOfRepositories()
+            {
+                var firstPageUrl = new Uri("/repositories", UriKind.Relative);
+                var secondPageUrl = new Uri("https://example.com/page/2");
+                var firstPageLinks = new Dictionary<string, Uri> { { "next", secondPageUrl } };
+                IApiResponse<List<Repository>> firstPageResponse = new ApiResponse<List<Repository>>(
+                    CreateResponseWithApiInfo(firstPageLinks),
+                    new List<Repository>
+                    {
+                        new Repository(364),
+                        new Repository(365),
+                        new Repository(366)
+                    });
+
+                var thirdPageUrl = new Uri("https://example.com/page/3");
+                var secondPageLinks = new Dictionary<string, Uri> { { "next", thirdPageUrl } };
+                IApiResponse<List<Repository>> secondPageResponse = new ApiResponse<List<Repository>>
+                (
+                    CreateResponseWithApiInfo(secondPageLinks),
+                    new List<Repository>
+                    {
+                        new Repository(367),
+                        new Repository(368),
+                        new Repository(369)
+                    });
+
+                IApiResponse<List<Repository>> lastPageResponse = new ApiResponse<List<Repository>>(
+                    new Response(),
+                    new List<Repository>
+                    {
+                        new Repository(370)
+                    });
+
+                var gitHubClient = Substitute.For<IGitHubClient>();
+                gitHubClient.Connection.Get<List<Repository>>(firstPageUrl,
+                    Arg.Is<Dictionary<string, string>>(d => d.Count == 1
+                        && d["since"] == "364"), null)
+                    .Returns(Task.FromResult(firstPageResponse));
+                gitHubClient.Connection.Get<List<Repository>>(secondPageUrl, null, null)
+                    .Returns(Task.FromResult(secondPageResponse));
+                gitHubClient.Connection.Get<List<Repository>>(thirdPageUrl, null, null)
+                    .Returns(Task.FromResult(lastPageResponse));
+
+                var repositoriesClient = new ObservableRepositoriesClient(gitHubClient);
+
+                var results = await repositoriesClient.GetAllPublic(new PublicRepositoryRequest(364)).ToArray();
+
+                Assert.Equal(7, results.Length);
+                gitHubClient.Connection.Received(1).Get<List<Repository>>(firstPageUrl, 
+                    Arg.Is<Dictionary<string, string>>(d=>d.Count == 1
+                    && d["since"] == "364"), null);
+                gitHubClient.Connection.Received(1).Get<List<Repository>>(secondPageUrl, null, null);
+                gitHubClient.Connection.Received(1).Get<List<Repository>>(thirdPageUrl, null, null);
+            }
+        }
+
         public class TheGetAllBranchesMethod
         {
             [Fact]

Octokit/Clients/IRepositoriesClient.cs

@@ -109,6 +109,20 @@ public interface IRepositoriesClient
             Justification = "Makes a network request")]
         Task<IReadOnlyList<Repository>> GetAllPublic();
 
+
+        /// <summary>
+        /// Gets all public repositories since the integer ID of the last Repository that you've seen.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/#list-all-public-repositories">API documentation</a> for more information.
+        /// The default page size on GitHub.com is 30.
+        /// </remarks>
+        /// <param name="request">Search parameters of the last repository seen</param>
+        /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="IReadOnlyPagedCollection{Repository}"/> of <see cref="Repository"/>.</returns>
+        Task<IReadOnlyList<Repository>> GetAllPublic(PublicRepositoryRequest request);
+
         /// <summary>
         /// Gets all repositories owned by the current user.
         /// </summary>

Octokit/Clients/RepositoriesClient.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Globalization;
 #if NET_45
 using System.Collections.Generic;
 #endif
@@ -187,6 +188,24 @@ public Task<IReadOnlyList<Repository>> GetAllPublic()
             return ApiConnection.GetAll<Repository>(ApiUrls.AllPublicRepositories());
         }
 
+        /// <summary>
+        /// Gets all public repositories since the integer ID of the last Repository that you've seen.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/#list-all-public-repositories">API documentation</a> for more information.
+        /// The default page size on GitHub.com is 30.
+        /// </remarks>
+        /// <param name="request">Search parameters of the last repository seen</param>
+        /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
+        /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
+        /// <returns>A <see cref="IReadOnlyPagedCollection{Repository}"/> of <see cref="Repository"/>.</returns>
+        public Task<IReadOnlyList<Repository>> GetAllPublic(PublicRepositoryRequest request)
+        {
+            Ensure.ArgumentNotNull(request, "request");
+
+            return ApiConnection.GetAll<Repository>(ApiUrls.AllPublicRepositories(), request.ToParametersDictionary());
+        }
+
         /// <summary>
         /// Gets all repositories owned by the current user.
         /// </summary>

Octokit/Models/Request/PublicRepositoryRequest.cs

@@ -0,0 +1,31 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Globalization;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Octokit
+{
+    [DebuggerDisplay("{DebuggerDisplay,nq}")]
+    public class PublicRepositoryRequest : RequestParameters
+    {
+        public PublicRepositoryRequest(int since)
+        {
+            Ensure.ArgumentNotNull(since, "since");
+
+            Since = since;
+        }
+
+        public long Since { get; set; }
+
+        internal string DebuggerDisplay
+        {
+            get
+            {
+                return String.Format(CultureInfo.InvariantCulture, "Since: {0} ", Since);
+            }
+        }
+    }
+}

Octokit/Octokit-Mono.csproj

@@ -382,6 +382,7 @@
     <Compile Include="Models\Response\License.cs" />
     <Compile Include="Models\Response\LicenseMetadata.cs" />
     <Compile Include="Models\Response\PullRequestFile.cs" />
+    <Compile Include="Models\Request\PublicRepositoryRequest.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
 </Project>

Octokit/Octokit-MonoAndroid.csproj

@@ -394,6 +394,7 @@
     <Compile Include="Models\Response\License.cs" />
     <Compile Include="Models\Response\LicenseMetadata.cs" />
     <Compile Include="Models\Response\PullRequestFile.cs" />
+    <Compile Include="Models\Request\PublicRepositoryRequest.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath)\Novell\Novell.MonoDroid.CSharp.targets" />
 </Project>

Octokit/Octokit-Monotouch.csproj

@@ -387,6 +387,7 @@
     <Compile Include="Models\Response\License.cs" />
     <Compile Include="Models\Response\LicenseMetadata.cs" />
     <Compile Include="Models\Response\PullRequestFile.cs" />
+    <Compile Include="Models\Request\PublicRepositoryRequest.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath)\Xamarin\iOS\Xamarin.MonoTouch.CSharp.targets" />
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />

Octokit/Octokit-Portable.csproj

@@ -380,6 +380,7 @@
     <Compile Include="Models\Response\License.cs" />
     <Compile Include="Models\Response\LicenseMetadata.cs" />
     <Compile Include="Models\Response\PullRequestFile.cs" />
+    <Compile Include="Models\Request\PublicRepositoryRequest.cs" />
   </ItemGroup>
   <ItemGroup>
     <CodeAnalysisDictionary Include="..\CustomDictionary.xml">

Octokit/Octokit-netcore45.csproj

@@ -384,6 +384,7 @@
     <Compile Include="Models\Response\License.cs" />
     <Compile Include="Models\Response\LicenseMetadata.cs" />
     <Compile Include="Models\Response\PullRequestFile.cs" />
+    <Compile Include="Models\Request\PublicRepositoryRequest.cs" />
   </ItemGroup>
   <ItemGroup>
     <CodeAnalysisDictionary Include="..\CustomDictionary.xml">

Octokit/Octokit.csproj

@@ -83,6 +83,7 @@
     <Compile Include="Http\ProductHeaderValue.cs" />
     <Compile Include="Models\Request\GistFileUpdate.cs" />
     <Compile Include="Models\Request\NewMerge.cs" />
+    <Compile Include="Models\Request\PublicRepositoryRequest.cs" />
     <Compile Include="Models\Request\ReleaseAssetUpload.cs" />
     <Compile Include="Models\Request\RepositoryRequest.cs" />
     <Compile Include="Models\Request\Signature.cs" />