Merge pull request #1190 from dampir/issue1182

Add ApiOption overloads to methods on IUserEmailsClient

Octokit.Reactive/Clients/IObservableUserEmailsClient.cs

@@ -22,6 +22,17 @@ public interface IObservableUserEmailsClient
         [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
         IObservable<EmailAddress> GetAll();
 
+        /// <summary>
+        /// Gets all email addresses for the authenticated user.
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
+        /// </remarks>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns>The <see cref="EmailAddress"/>es for the authenticated user.</returns>
+        [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
+        IObservable<EmailAddress> GetAll(ApiOptions options);
+
         /// <summary>
         /// Adds email addresses for the authenticated user.
         /// </summary>

Octokit.Reactive/Clients/ObservableUserEmailsClient.cs

@@ -34,7 +34,22 @@ public ObservableUserEmailsClient(IGitHubClient client)
         /// <returns>The <see cref="EmailAddress"/>es for the authenticated user.</returns>
         public IObservable<EmailAddress> GetAll()
         {
-            return _connection.GetAndFlattenAllPages<EmailAddress>(ApiUrls.Emails());
+            return GetAll(ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets all email addresses for the authenticated user.
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
+        /// </remarks>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns>The <see cref="EmailAddress"/>es for the authenticated user.</returns>
+        public IObservable<EmailAddress> GetAll(ApiOptions options)
+        {
+            Ensure.ArgumentNotNull(options, "options");
+
+            return _connection.GetAndFlattenAllPages<EmailAddress>(ApiUrls.Emails(), options);
         }
 
         /// <summary>

Octokit.Tests.Integration/Clients/UserEmailsClientTests.cs

@@ -6,15 +6,42 @@ namespace Octokit.Tests.Integration.Clients
 {
     public class UserEmailsClientTests
     {
+        private readonly IUserEmailsClient _emailClient;
+
+        public UserEmailsClientTests()
+        {
+            var github = Helper.GetAuthenticatedClient();
+            _emailClient = github.User.Email;
+        }
+
         [IntegrationTest]
         public async Task CanGetEmail()
         {
-            var github = Helper.GetAuthenticatedClient();
+            var emails = await _emailClient.GetAll();
+            Assert.NotEmpty(emails);
+        }
 
-            var emails = await github.User.Email.GetAll();
+        [IntegrationTest]
+        public async Task CanGetEmailWithApiOptions()
+        {
+            var emails = await _emailClient.GetAll(ApiOptions.None);
             Assert.NotEmpty(emails);
         }
 
+        [IntegrationTest]
+        public async Task ReturnsCorrectCountOfEmailsWithoutStart()
+        {
+            var options = new ApiOptions
+            {
+                PageSize = 5,
+                PageCount = 1
+            };
+
+            var emails = await _emailClient.GetAll(options);
+
+            Assert.NotEmpty(emails);
+        }
+
         const string testEmailAddress = "[email protected]";
 
         [IntegrationTest(Skip = "this isn't passing in CI - i hate past me right now")]

Octokit.Tests.Integration/Reactive/ObservableUserEmailsClientTests.cs

@@ -7,15 +7,40 @@ namespace Octokit.Tests.Integration
 {
     public class ObservableUserEmailsClientTests
     {
-        [IntegrationTest]
-        public async Task CanGetEmail()
+        readonly ObservableUserEmailsClient _emailClient;
+
+        public ObservableUserEmailsClientTests()
         {
             var github = Helper.GetAuthenticatedClient();
 
-            var client = new ObservableUserEmailsClient(github);
+            _emailClient = new ObservableUserEmailsClient(github);
+        }
 
-            var email = await client.GetAll();
+        [IntegrationTest]
+        public async Task CanGetEmail()
+        {
+            var email = await _emailClient.GetAll();
             Assert.NotNull(email);
         }
+
+        [IntegrationTest]
+        public async Task CanGetEmailWithApiOptions()
+        {
+            var email = await _emailClient.GetAll(ApiOptions.None);
+            Assert.NotNull(email);
+        }
+
+        [IntegrationTest]
+        public async Task ReturnsCorrectCountOfEmailsWithoutStart()
+        {
+            var options = new ApiOptions
+            {
+                PageSize = 5,
+                PageCount = 1
+            };
+
+            var emails = await _emailClient.GetAll(options).ToList();
+            Assert.NotEmpty(emails);
+        }
     }
 }

Octokit.Tests/Clients/UserEmailsClientTests.cs

@@ -1,7 +1,7 @@
-using NSubstitute;
-using System;
+using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
+using NSubstitute;
 using Xunit;
 
 namespace Octokit.Tests.Clients
@@ -19,7 +19,20 @@ public void GetsCorrectUrl()
                 client.GetAll();
 
                 connection.Received(1)
-                    .GetAll<EmailAddress>(Arg.Is<Uri>(u => u.ToString() == "user/emails"));
+                    .GetAll<EmailAddress>(Arg.Is<Uri>(u => u.ToString() == "user/emails"),
+                        Args.ApiOptions);
+            }
+
+            [Fact]
+            public void GetsCorrectUrlWithApiOptions()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new UserEmailsClient(connection);
+
+                client.GetAll(ApiOptions.None);
+
+                connection.Received(1)
+                    .GetAll<EmailAddress>(Arg.Is<Uri>(u => u.ToString() == "user/emails"), Args.ApiOptions);
             }
         }
 

Octokit.Tests/Reactive/ObservableUserEmailsClientTests.cs

@@ -1,7 +1,7 @@
-using NSubstitute;
-using Octokit.Reactive;
-using System;
+using System;
 using System.Collections.Generic;
+using NSubstitute;
+using Octokit.Reactive;
 using Xunit;
 
 namespace Octokit.Tests
@@ -18,25 +18,35 @@ private static ObservableUserEmailsClient CreateFixtureWithNonReactiveClient()
 
         public class TheGetAllMethod
         {
+            private static readonly Uri _expectedUri = new Uri("user/emails", UriKind.Relative);
+
             [Fact]
             public void GetsCorrectUrl()
             {
-                var expectedUri = new Uri("user/emails", UriKind.Relative);
                 var github = Substitute.For<IGitHubClient>();
                 var client = new ObservableUserEmailsClient(github);
 
                 client.GetAll();
 
-                github.Connection.Received(1).GetResponse<List<EmailAddress>>(expectedUri);
+                github.Connection.Received(1).Get<List<EmailAddress>>(_expectedUri,
+                    Arg.Is<Dictionary<string, string>>(dictionary => dictionary.Count == 0), null);
+            }
+
+            [Fact]
+            public void GetsCorrectUrlWithApiOption()
+            {
+                var github = Substitute.For<IGitHubClient>();
+                var client = new ObservableUserEmailsClient(github);
+
+                client.GetAll(ApiOptions.None);
+
+                github.Connection.Received(1).Get<List<EmailAddress>>(_expectedUri,
+                    Arg.Is<Dictionary<string, string>>(dictionary => dictionary.Count == 0), null);
             }
         }
 
         public class TheAddMethod
         {
-            public IGitHubClient GitHubClient;
-
-            public ObservableUserEmailsClient Client;
-
             [Fact]
             public void CallsAddOnClient()
             {

Octokit/Clients/IUserEmailsClient.cs

@@ -22,6 +22,17 @@ public interface IUserEmailsClient
         [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
         Task<IReadOnlyList<EmailAddress>> GetAll();
 
+        /// <summary>
+        /// Gets all email addresses for the authenticated user.
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
+        /// </remarks>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns>The <see cref="EmailAddress"/>es for the authenticated user.</returns>
+        [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
+        Task<IReadOnlyList<EmailAddress>> GetAll(ApiOptions options);
+
         /// <summary>
         /// Adds email addresses for the authenticated user.
         /// </summary>

Octokit/Clients/UserEmailsClient.cs

@@ -30,7 +30,21 @@ public UserEmailsClient(IApiConnection apiConnection)
         /// <returns>The <see cref="EmailAddress"/>es for the authenticated user.</returns>
         public Task<IReadOnlyList<EmailAddress>> GetAll()
         {
-            return ApiConnection.GetAll<EmailAddress>(ApiUrls.Emails());
+            return GetAll(ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets all email addresses for the authenticated user.
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
+        /// </remarks>
+        /// <returns>The <see cref="EmailAddress"/>es for the authenticated user.</returns>
+        public Task<IReadOnlyList<EmailAddress>> GetAll(ApiOptions options)
+        {
+            Ensure.ArgumentNotNull(options, "options");
+
+            return ApiConnection.GetAll<EmailAddress>(ApiUrls.Emails(), options);
         }
 
         /// <summary>

Octokit/Models/Request/ApiOptions.cs

@@ -58,5 +58,4 @@ internal string DebuggerDisplay
             }
         }
     }
-
 }