Merge pull request #1198 from dampir/issue1149

Add ApiOption overloads to methods on IAuthorizationsClient

Octokit.Reactive/Clients/IObservableAuthorizationsClient.cs

@@ -13,11 +13,24 @@ public interface IObservableAuthorizationsClient
         /// See <a href="http://developer.github.com/v3/oauth/#list-your-authorizations">API documentation</a> for more
         /// details.
         /// </remarks>
-        /// <returns>An <see cref="Authorization"/></returns>
+        /// <returns>A list of <see cref="Authorization"/>s for the authenticated user.</returns>
         [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
             Justification = "It's an API call, so it's not a property.")]
         IObservable<Authorization> GetAll();
 
+        /// <summary>
+        /// Get all <see cref="Authorization"/>s for the authenticated user. This method requires basic auth.
+        /// </summary>
+        /// <remarks>
+        /// See <a href="http://developer.github.com/v3/oauth/#list-your-authorizations">API documentation</a> for more
+        /// details.
+        /// </remarks>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns>A list of <see cref="Authorization"/>s for the authenticated user.</returns>
+        [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
+            Justification = "It's an API call, so it's not a property.")]
+        IObservable<Authorization> GetAll(ApiOptions options);
+
         /// <summary>
         /// Get a specific <see cref="Authorization"/> for the authenticated user. This method requires basic auth.
         /// </summary>

Octokit.Reactive/Clients/ObservableAssigneesClient.cs

@@ -25,10 +25,7 @@ public ObservableAssigneesClient(IGitHubClient client)
         /// <returns></returns>
         public IObservable<User> GetAllForRepository(string owner, string name)
         {
-            Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
-            Ensure.ArgumentNotNullOrEmptyString(name, "name");
-
-            return _connection.GetAndFlattenAllPages<User>(ApiUrls.Assignees(owner, name));
+            return GetAllForRepository(owner, name, ApiOptions.None);
         }
 
         /// <summary>

Octokit.Reactive/Clients/ObservableAuthorizationsClient.cs

@@ -25,10 +25,26 @@ public ObservableAuthorizationsClient(IGitHubClient client)
         /// See <a href="http://developer.github.com/v3/oauth/#list-your-authorizations">API documentation</a> for more
         /// details.
         /// </remarks>
-        /// <returns>An <see cref="Authorization"/></returns>
+        /// <returns>A list of <see cref="Authorization"/>s for the authenticated user.</returns>
         public IObservable<Authorization> GetAll()
         {
-            return _connection.GetAndFlattenAllPages<Authorization>(ApiUrls.Authorizations());
+            return GetAll(ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Get all <see cref="Authorization"/>s for the authenticated user. This method requires basic auth.
+        /// </summary>
+        /// <remarks>
+        /// See <a href="http://developer.github.com/v3/oauth/#list-your-authorizations">API documentation</a> for more
+        /// details.
+        /// </remarks>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns>A list of <see cref="Authorization"/>s for the authenticated user.</returns>
+        public IObservable<Authorization> GetAll(ApiOptions options)
+        {
+            Ensure.ArgumentNotNull(options, "options");
+
+            return _connection.GetAndFlattenAllPages<Authorization>(ApiUrls.Authorizations(), options);
         }
 
         /// <summary>

Octokit.Tests.Integration/Clients/AuthorizationClientTests.cs

@@ -1,5 +1,4 @@
-using System;
-using System.Threading.Tasks;
+using System.Threading.Tasks;
 using Xunit;
 
 namespace Octokit.Tests.Integration.Clients
@@ -13,7 +12,7 @@ public async Task CanCreatePersonalToken()
             var note = Helper.MakeNameWithTimestamp("Testing authentication");
             var newAuthorization = new NewAuthorization(
                 note,
-                new string[] { "user" });
+                new[] { "user" });
 
             var created = await github.Authorization.Create(newAuthorization);
 
@@ -27,14 +26,47 @@ public async Task CanCreatePersonalToken()
             Assert.Equal(created.Note, get.Note);
         }
 
+        [IntegrationTest]
+        public async Task CanGetAuthorization()
+        {
+            var github = Helper.GetBasicAuthClient();
+
+            var authorizations = await github.Authorization.GetAll();
+            Assert.NotEmpty(authorizations);
+        }
+
+        [IntegrationTest]
+        public async Task CanGetAuthorizationWithApiOptions()
+        {
+            var github = Helper.GetBasicAuthClient();
+
+            var authorizations = await github.Authorization.GetAll(ApiOptions.None);
+            Assert.NotEmpty(authorizations);
+        }
+
+        [IntegrationTest]
+        public async Task ReturnsNotEmptyAuthorizationsWithoutStart()
+        {
+            var github = Helper.GetBasicAuthClient();
+
+            var options = new ApiOptions
+            {
+                PageSize = 5,
+                PageCount = 1
+            };
+
+            var authorizations = await github.Authorization.GetAll(options);
+            Assert.NotEmpty(authorizations);
+        }
+
         [IntegrationTest]
         public async Task CannotCreatePersonalTokenWhenUsingOauthTokenCredentials()
         {
             var github = Helper.GetAuthenticatedClient();
             var note = Helper.MakeNameWithTimestamp("Testing authentication");
             var newAuthorization = new NewAuthorization(
                 note,
-                new string[] { "user" });
+                new[] { "user" });
 
             var error = Assert.ThrowsAsync<ForbiddenException>(() => github.Authorization.Create(newAuthorization));
             Assert.True(error.Result.Message.Contains("username and password Basic Auth"));

Octokit.Tests.Integration/Octokit.Tests.Integration.csproj

@@ -138,6 +138,7 @@
     <Compile Include="Reactive\Enterprise\ObservableEnterpriseSearchIndexingClientTests.cs" />
     <Compile Include="Reactive\Enterprise\ObservableEnterpriseOrganizationClientTests.cs" />
     <Compile Include="Reactive\ObservableAssigneesClientTests.cs" />
+    <Compile Include="Reactive\ObservableAuthorizationsClientTests.cs" />
     <Compile Include="Reactive\ObservableIssuesClientTests.cs" />
     <Compile Include="Reactive\ObservableMilestonesClientTests.cs" />
     <Compile Include="Reactive\ObservableReleaseClientTests.cs" />

Octokit.Tests.Integration/Reactive/ObservableAuthorizationsClientTests.cs

@@ -0,0 +1,46 @@
+using System.Reactive.Linq;
+using System.Threading.Tasks;
+using Octokit.Reactive;
+using Xunit;
+
+namespace Octokit.Tests.Integration.Reactive
+{
+    public class ObservableAuthorizationsClientTests
+    {
+        readonly ObservableAuthorizationsClient _authorizationsClient;
+
+        public ObservableAuthorizationsClientTests()
+        {
+            var github = Helper.GetBasicAuthClient();
+
+            _authorizationsClient = new ObservableAuthorizationsClient(github);
+        }
+
+        [IntegrationTest]
+        public async Task CanGetAuthorization()
+        {
+            var authorization = await _authorizationsClient.GetAll();
+            Assert.NotNull(authorization);
+        }
+
+        [IntegrationTest]
+        public async Task CanGetAuthorizationWithApiOptions()
+        {
+            var authorization = await _authorizationsClient.GetAll(ApiOptions.None);
+            Assert.NotNull(authorization);
+        }
+
+        [IntegrationTest]
+        public async Task ReturnsNotEmptyAuthorizationsWithoutStart()
+        {
+            var options = new ApiOptions
+            {
+                PageSize = 5,
+                PageCount = 1
+            };
+
+            var authorizations = await _authorizationsClient.GetAll(options).ToList();
+            Assert.NotEmpty(authorizations);
+        }
+    }
+}

Octokit.Tests/Clients/AssigneesClientTests.cs

@@ -4,14 +4,13 @@
 using System.Threading.Tasks;
 using NSubstitute;
 using Octokit.Internal;
-using Octokit.Tests.Helpers;
 using Xunit;
 
 namespace Octokit.Tests.Clients
 {
     public class AssigneesClientTests
     {
-        public class TheGetForRepositoryMethod
+        public class TheGetAllMethod
         {
             [Fact]
             public void RequestsCorrectUrl()
@@ -28,6 +27,28 @@ public void RequestsCorrectUrl()
                     Args.ApiOptions);
             }
 
+            [Fact]
+            public void RequestsCorrectUrlWithApiOptions()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new AssigneesClient(connection);
+
+                var options = new ApiOptions
+                {
+                    PageCount = 1,
+                    PageSize = 1,
+                    StartPage = 1
+                };
+
+                client.GetAllForRepository("fake", "repo", options);
+
+                connection.Received().GetAll<User>(
+                    Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/assignees"),
+                    null,
+                    AcceptHeaders.StableVersion,
+                    options);
+            }
+
             [Fact]
             public async Task EnsuresNonNullArguments()
             {
@@ -37,6 +58,7 @@ public async Task EnsuresNonNullArguments()
                 await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAllForRepository(null, ""));
                 await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAllForRepository("owner", null));
                 await Assert.ThrowsAsync<ArgumentException>(() => client.GetAllForRepository("", null));
+                await Assert.ThrowsAsync<ArgumentNullException>(() => client.GetAllForRepository("owner", "name", null));
             }
         }
 

Octokit.Tests/Clients/AuthorizationsClientTests.cs

@@ -26,7 +26,7 @@ public void ThrowsForBadArgs()
         public class TheGetAllMethod
         {
             [Fact]
-            public void GetsAListOfAuthorizations()
+            public void RequestsCorrectUrl()
             {
                 var client = Substitute.For<IApiConnection>();
                 var authEndpoint = new AuthorizationsClient(client);
@@ -37,6 +37,35 @@ public void GetsAListOfAuthorizations()
                     Arg.Is<Uri>(u => u.ToString() == "authorizations"),
                     Args.ApiOptions);
             }
+
+            [Fact]
+            public void RequestsCorrectUrlWithApiOptions()
+            {
+                var client = Substitute.For<IApiConnection>();
+                var authEndpoint = new AuthorizationsClient(client);
+
+                var options = new ApiOptions
+                {
+                    StartPage = 1,
+                    PageSize = 1,
+                    PageCount = 1
+                };
+
+                authEndpoint.GetAll(options);
+
+                client.Received().GetAll<Authorization>(
+                    Arg.Is<Uri>(u => u.ToString() == "authorizations"),
+                    options);
+            }
+
+            [Fact]
+            public async Task EnsuresArgumentsNotNull()
+            {
+                var client = Substitute.For<IApiConnection>();
+                var authEndpoint = new AuthorizationsClient(client);
+
+                await Assert.ThrowsAsync<ArgumentNullException>(() => authEndpoint.GetAll(null));
+            }
         }
 
         public class TheGetMethod

Octokit.Tests/Clients/ReleasesClientTests.cs

@@ -24,13 +24,35 @@ public void RequestsCorrectUrl()
                     Args.ApiOptions);
             }
 
+            [Fact]
+            public void RequestsCorrectUrlWithApiOptions()
+            {
+                var client = Substitute.For<IApiConnection>();
+                var releasesClient = new ReleasesClient(client);
+
+                var options = new ApiOptions
+                {
+                    PageSize = 1,
+                    PageCount = 1,
+                    StartPage = 1
+                };
+
+                releasesClient.GetAll("fake", "repo", options);
+
+                client.Received().GetAll<Release>(Arg.Is<Uri>(u => u.ToString() == "repos/fake/repo/releases"),
+                    null,
+                    "application/vnd.github.v3",
+                    options);
+            }
+
             [Fact]
             public async Task EnsuresNonNullArguments()
             {
                 var releasesClient = new ReleasesClient(Substitute.For<IApiConnection>());
 
                 await Assert.ThrowsAsync<ArgumentNullException>(() => releasesClient.GetAll(null, "name"));
                 await Assert.ThrowsAsync<ArgumentNullException>(() => releasesClient.GetAll("owner", null));
+                await Assert.ThrowsAsync<ArgumentNullException>(() => releasesClient.GetAll("owner", "name", null));
             }
         }
 

Octokit.Tests/Clients/UserEmailsClientTests.cs

@@ -11,7 +11,7 @@ public class UserEmailsClientTests
         public class TheGetAllMethod
         {
             [Fact]
-            public void GetsCorrectUrl()
+            public void RequestsCorrectUrl()
             {
                 var connection = Substitute.For<IApiConnection>();
                 var client = new UserEmailsClient(connection);
@@ -24,15 +24,31 @@ public void GetsCorrectUrl()
             }
 
             [Fact]
-            public void GetsCorrectUrlWithApiOptions()
+            public void RequestsCorrectUrlWithApiOptions()
             {
                 var connection = Substitute.For<IApiConnection>();
                 var client = new UserEmailsClient(connection);
 
-                client.GetAll(ApiOptions.None);
+                var options = new ApiOptions
+                {
+                    PageCount = 1,
+                    PageSize = 1,
+                    StartPage = 1
+                };
+
+                client.GetAll(options);
 
                 connection.Received(1)
-                    .GetAll<EmailAddress>(Arg.Is<Uri>(u => u.ToString() == "user/emails"), Args.ApiOptions);
+                    .GetAll<EmailAddress>(Arg.Is<Uri>(u => u.ToString() == "user/emails"),
+                        options);
+            }
+
+            [Fact]
+            public async Task EnsuresNonNullArguments()
+            {
+                var releasesClient = new UserEmailsClient(Substitute.For<IApiConnection>());
+
+                await Assert.ThrowsAsync<ArgumentNullException>(() => releasesClient.GetAll(null));
             }
         }
 

Octokit.Tests/Octokit.Tests.csproj

@@ -198,6 +198,7 @@
     <Compile Include="Reactive\Enterprise\ObservableEnterpriseSearchIndexingClientTests.cs" />
     <Compile Include="Reactive\Enterprise\ObservableEnterpriseOrganizationClientTests.cs" />
     <Compile Include="Reactive\Enterprise\ObservableEnterpriseLicenseClientTests.cs" />
+    <Compile Include="Reactive\ObservableAuthorizationsClientTests.cs" />
     <Compile Include="Reactive\ObservableBlobClientTests.cs" />
     <Compile Include="Reactive\ObservableCommitsClientTests.cs" />
     <Compile Include="Reactive\ObservableDeploymentsClientTests.cs" />