Add Reactive implementation and unit tests

octokit · Feb 22, 2016 · bd10379 · bd10379
1 parent c56588d
commit bd10379
Show file tree

Hide file tree

Showing 7 changed files with 548 additions and 24 deletions.
diff --git a/Octokit.Reactive/Clients/IObservableUserAdministrationClient.cs b/Octokit.Reactive/Clients/IObservableUserAdministrationClient.cs
@@ -5,51 +5,134 @@
 namespace Octokit.Reactive
 {
     /// <summary>
-    /// A client for GitHub's User Administration API.
+    /// A client for GitHub's User Administration API (GitHub Enterprise)
     /// </summary>
     /// <remarks>
     /// See the <a href="https://developer.github.com/v3/users/administration/">Administration API documentation</a> for more details.
     /// </remarks>
     public interface IObservableUserAdministrationClient
     {
         /// <summary>
-        /// Promotes ordinary user to a site administrator.
+        /// Create a new user (must be Site Admin user).
         /// </summary>
         /// <remarks>
-        /// https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#create-a-new-user">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="newUser">The <see cref="NewUser"/> object describing the user to create</param>
+        /// <returns>The created <see cref="User"/> object</returns>
+        IObservable<User> Create(NewUser newUser);
+
+        /// <summary>
+        /// Rename an existing user (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#rename-an-existing-user">API documentation</a>
+        /// for more information.
+        /// Note that this queues a request to rename a user, rather than execute it straight away
+        /// </remarks>
+        /// <param name="login">The username to rename</param>
+        /// <param name="userRename">The <see cref="UserRename"/> request, specifying the new login</param>
+        /// <returns>A <see cref="UserRenameResponse"/> object indicating the queued task message and Url to the user</returns>
+        IObservable<UserRenameResponse> Rename(string login, UserRename userRename);
+
+        /// <summary>
+        /// Create an impersonation OAuth token (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#create-an-impersonation-oauth-token">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="login">The user to impersonate</param>
+        /// <param name="newImpersonationToken">The <see cref="NewImpersonationToken"/> request specifying the required scopes</param>
+        /// <returns>An <see cref="Authorization"/> object containing the impersonation token</returns>
+        IObservable<Authorization> CreateImpersonationToken(string login, NewImpersonationToken newImpersonationToken);
+
+        /// <summary>
+        /// Deletes an impersonation OAuth token (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#delete-an-impersonation-oauth-token">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="login">The user to remove impersonation token from</param>
+        /// <returns></returns>
+        IObservable<Unit> DeleteImpersonationToken(string login);
+
+        /// <summary>
+        /// Promotes ordinary user to a site administrator (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator">API documentation</a>
+        /// for more information.
         /// </remarks>
         /// <param name="login">The user to promote to administrator.</param>
         /// <returns></returns>
         IObservable<Unit> Promote(string login);
 
         /// <summary>
-        /// Demotes a site administrator to an ordinary user.
+        /// Demotes a site administrator to an ordinary user (must be Site Admin user).
         /// </summary>
         /// <remarks>
-        /// https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user
+        /// See the <a href="https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user">API documentation</a>
+        /// for more information.
         /// </remarks>
         /// <param name="login">The user to demote from administrator.</param>
         /// <returns></returns>
         IObservable<Unit> Demote(string login);
 
         /// <summary>
-        /// Suspends a user.
+        /// Suspends a user (must be Site Admin user).
         /// </summary>
         /// <remarks>
-        /// https://developer.github.com/v3/users/administration/#suspend-a-user
+        /// See the <a href="https://developer.github.com/v3/users/administration/#suspend-a-user">API documentation</a>
+        /// for more information.
         /// </remarks>
         /// <param name="login">The user to suspend.</param>
         /// <returns></returns>
         IObservable<Unit> Suspend(string login);
 
         /// <summary>
-        /// Unsuspends a user.
+        /// Unsuspends a user (must be Site Admin user).
         /// </summary>
         /// <remarks>
-        /// https://developer.github.com/v3/users/administration/#unsuspend-a-user
+        /// See the <a href="https://developer.github.com/v3/users/administration/#unsuspend-a-user">API documentation</a>
+        /// for more information.
         /// </remarks>
         /// <param name="login">The user to unsuspend.</param>
         /// <returns></returns>
         IObservable<Unit> Unsuspend(string login);
+
+        /// <summary>
+        /// List all public keys (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#list-all-public-keys">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <returns></returns>
+        IObservable<PublicKey> ListAllPublicKeys();
+
+        /// <summary>
+        /// Delete a user (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#delete-a-user">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="login">The user to delete</param>
+        /// <returns></returns>
+        IObservable<Unit> Delete(string login);
+
+        /// <summary>
+        /// Delete a public key (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#delete-a-public-key">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="keyId">The key to delete</param>
+        /// <returns></returns>
+        IObservable<Unit> DeletePublicKey(int keyId);
     }
 }
diff --git a/Octokit.Reactive/Clients/ObservableUserAdministrationClient.cs b/Octokit.Reactive/Clients/ObservableUserAdministrationClient.cs
@@ -7,9 +7,16 @@
 
 namespace Octokit.Reactive
 {
+    /// <summary>
+    /// A client for GitHub's User Administration API (GitHub Enterprise)
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="https://developer.github.com/v3/users/administration/">Administration API documentation</a> for more details.
+    /// </remarks>
     public class ObservableUserAdministrationClient : IObservableUserAdministrationClient
     {
         readonly IUserAdministrationClient _client;
+        readonly IConnection _connection;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ObservableUserAdministrationClient"/> class.
@@ -20,13 +27,74 @@ public ObservableUserAdministrationClient(IGitHubClient client)
             Ensure.ArgumentNotNull(client, "client");
 
             _client = client.User.Administration;
+            _connection = client.Connection;
         }
 
         /// <summary>
-        /// Promotes ordinary user to a site administrator.
+        /// Create a new user (must be Site Admin user).
         /// </summary>
         /// <remarks>
-        /// https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#create-a-new-user">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="newUser">The <see cref="NewUser"/> object describing the user to create</param>
+        /// <returns>The created <see cref="User"/> object</returns>
+        public IObservable<User> Create(NewUser newUser)
+        {
+            return _client.Create(newUser).ToObservable();
+        }
+
+        /// <summary>
+        /// Rename an existing user (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#rename-an-existing-user">API documentation</a>
+        /// for more information.
+        /// Note that this queues a request to rename a user, rather than execute it straight away
+        /// </remarks>
+        /// <param name="login">The username to rename</param>
+        /// <param name="userRename">The <see cref="UserRename"/> request, specifying the new login</param>
+        /// <returns>A <see cref="UserRenameResponse"/> object indicating the queued task message and Url to the user</returns>
+        public IObservable<UserRenameResponse> Rename(string login, UserRename userRename)
+        {
+            return _client.Rename(login, userRename).ToObservable();
+        }
+
+        /// <summary>
+        /// Create an impersonation OAuth token (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#create-an-impersonation-oauth-token">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="login">The user to impersonate</param>
+        /// <param name="newImpersonationToken">The <see cref="NewImpersonationToken"/> request specifying the required scopes</param>
+        /// <returns>An <see cref="Authorization"/> object containing the impersonation token</returns>
+        public IObservable<Authorization> CreateImpersonationToken(string login, NewImpersonationToken newImpersonationToken)
+        {
+            return _client.CreateImpersonationToken(login, newImpersonationToken).ToObservable();
+        }
+
+        /// <summary>
+        /// Deletes an impersonation OAuth token (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#delete-an-impersonation-oauth-token">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="login">The user to remove impersonation token from</param>
+        /// <returns></returns>
+        public IObservable<Unit> DeleteImpersonationToken(string login)
+        {
+            return _client.DeleteImpersonationToken(login).ToObservable();
+        }
+
+        /// <summary>
+        /// Promotes ordinary user to a site administrator (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator">API documentation</a>
+        /// for more information.
         /// </remarks>
         /// <param name="login">The user to promote to administrator.</param>
         /// <returns></returns>
@@ -36,10 +104,11 @@ public IObservable<Unit> Promote(string login)
         }
 
         /// <summary>
-        /// Demotes a site administrator to an ordinary user.
+        /// Demotes a site administrator to an ordinary user (must be Site Admin user).
         /// </summary>
         /// <remarks>
-        /// https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user
+        /// See the <a href="https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user">API documentation</a>
+        /// for more information.
         /// </remarks>
         /// <param name="login">The user to demote from administrator.</param>
         /// <returns></returns>
@@ -49,10 +118,11 @@ public IObservable<Unit> Demote(string login)
         }
 
         /// <summary>
-        /// Suspends a user.
+        /// Suspends a user (must be Site Admin user).
         /// </summary>
         /// <remarks>
-        /// https://developer.github.com/v3/users/administration/#suspend-a-user
+        /// See the <a href="https://developer.github.com/v3/users/administration/#suspend-a-user">API documentation</a>
+        /// for more information.
         /// </remarks>
         /// <param name="login">The user to suspend.</param>
         /// <returns></returns>
@@ -62,16 +132,58 @@ public IObservable<Unit> Suspend(string login)
         }
 
         /// <summary>
-        /// Unsuspends a user.
+        /// Unsuspends a user (must be Site Admin user).
         /// </summary>
         /// <remarks>
-        /// https://developer.github.com/v3/users/administration/#unsuspend-a-user
+        /// See the <a href="https://developer.github.com/v3/users/administration/#unsuspend-a-user">API documentation</a>
+        /// for more information.
         /// </remarks>
         /// <param name="login">The user to unsuspend.</param>
         /// <returns></returns>
         public IObservable<Unit> Unsuspend(string login)
         {
             return _client.Unsuspend(login).ToObservable();
         }
+
+        /// <summary>
+        /// List all public keys (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#list-all-public-keys">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <returns></returns>
+        public IObservable<PublicKey> ListAllPublicKeys()
+        {
+            return _connection.GetAndFlattenAllPages<PublicKey>(ApiUrls.UserAdministrationPublicKeys());
+        }
+
+        /// <summary>
+        /// Delete a user (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#delete-a-user">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="login">The user to delete</param>
+        /// <returns></returns>
+        public IObservable<Unit> Delete(string login)
+        {
+            return _client.Delete(login).ToObservable();
+        }
+
+        /// <summary>
+        /// Delete a public key (must be Site Admin user).
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/enterprise/2.5/v3/users/administration/#delete-a-public-key">API documentation</a>
+        /// for more information.
+        /// </remarks>
+        /// <param name="keyId">The key to delete</param>
+        /// <returns></returns>
+        public IObservable<Unit> DeletePublicKey(int keyId)
+        {
+            return _client.DeletePublicKey(keyId).ToObservable();
+        }
     }
 }
diff --git a/Octokit.Tests.Integration/Helpers/ObservableGithubClientExtensions.cs b/Octokit.Tests.Integration/Helpers/ObservableGithubClientExtensions.cs
@@ -27,5 +27,19 @@ internal async static Task<RepositoryContext> CreateRepositoryContext(this IObse
 
             return new RepositoryContext(repo);
         }
+
+        internal async static Task<EnterpriseTeamContext> CreateEnterpriseTeamContext(this IObservableGitHubClient client, string organization, NewTeam newTeam)
+        {
+            var team = await client.Organization.Team.Create(organization, newTeam);
+
+            return new EnterpriseTeamContext(team);
+        }
+
+        internal async static Task<EnterpriseUserContext> CreateEnterpriseUserContext(this IObservableGitHubClient client, NewUser newUser)
+        {
+            var user = await client.User.Administration.Create(newUser);
+
+            return new EnterpriseUserContext(user);
+        }
     }
 }
diff --git a/Octokit.Tests.Integration/Octokit.Tests.Integration.csproj b/Octokit.Tests.Integration/Octokit.Tests.Integration.csproj
@@ -145,6 +145,7 @@
     <Compile Include="Helper.cs" />
     <Compile Include="Clients\UsersClientTests.cs" />
     <Compile Include="Reactive\ObservableRespositoryDeployKeysClientTests.cs" />
+    <Compile Include="Reactive\ObservableUserAdministrationClientTests.cs" />
     <Compile Include="Reactive\ObservableUserEmailsClientTests.cs" />
     <Compile Include="Reactive\ObservableTeamsClientTests.cs" />
     <Compile Include="RedirectTests.cs" />

diff --git a/Octokit.Tests.Integration/Reactive/Enterprise/ObservableEnterpriseLdapClientTests.cs b/Octokit.Tests.Integration/Reactive/Enterprise/ObservableEnterpriseLdapClientTests.cs
@@ -20,11 +20,10 @@ public class ObservableEnterpriseLdapClientTests : IDisposable
 
         public ObservableEnterpriseLdapClientTests()
         {
-            var gitHub = EnterpriseHelper.GetAuthenticatedClient();
-            _github = new ObservableGitHubClient(gitHub);
+            _github = new ObservableGitHubClient(EnterpriseHelper.GetAuthenticatedClient());
 
             NewTeam newTeam = new NewTeam(Helper.MakeNameWithTimestamp("test-team")) { Description = "Test Team" };
-            _context = gitHub.CreateEnterpriseTeamContext(EnterpriseHelper.Organization, newTeam).Result;
+            _context = _github.CreateEnterpriseTeamContext(EnterpriseHelper.Organization, newTeam).Result;
         }
 
         [GitHubEnterpriseTest]