Adding functionality to query installations for user

octokit · Aug 7, 2018 · a80e226 · a80e226
1 parent 90b0a7c
commit a80e226
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 0 deletions.
diff --git a/Octokit.Tests/Clients/GitHubAppsClientTests.cs b/Octokit.Tests/Clients/GitHubAppsClientTests.cs
@@ -101,5 +101,40 @@ public void PostsToCorrectUrl()
                 connection.Received().Post<AccessToken>(Arg.Is<Uri>(u => u.ToString() == "installations/3141/access_tokens"), string.Empty, "application/vnd.github.machine-man-preview+json");
             }
         }
+
+        public class TheGetAllInstallationsForUserMethod
+        {
+            [Fact]
+            public void GetsFromCorrectUrl()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new GitHubAppsClient(connection);
+
+                client.GetAllInstallationsForUser();
+
+                connection.Received().GetAll<Installation>(Arg.Is<Uri>(u => u.ToString() == "user/installations"), null, "application/vnd.github.machine-man-preview+json");
+            }
+        }
+
+        public class TheGetInstallationsForUserMethod
+        {
+            [Fact]
+            public void GetsFromCorrectUrl()
+            {
+                var connection = Substitute.For<IApiConnection>();
+                var client = new GitHubAppsClient(connection);
+
+                var options = new ApiOptions
+                {
+                    PageSize = 1,
+                    PageCount = 1,
+                    StartPage = 1
+                };
+
+                client.GetInstallationsForUser(options);
+
+                connection.Received().GetAll<Installation>(Arg.Is<Uri>(u => u.ToString() == "user/installations"), null, "application/vnd.github.machine-man-preview+json", options);
+            }
+        }
     }
 }
diff --git a/Octokit/Clients/GitHubAppsClient.cs b/Octokit/Clients/GitHubAppsClient.cs
@@ -78,5 +78,25 @@ public Task<AccessToken> CreateInstallationToken(long installationId)
         {
             return ApiConnection.Post<AccessToken>(ApiUrls.AccessTokens(installationId), string.Empty, AcceptHeaders.GitHubAppsPreview);
         }
+
+        /// <summary>
+        /// List installations for user
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/apps/#list-installations-for-user</remarks>
+        public Task<IReadOnlyList<Installation>> GetAllInstallationsForUser()
+        {
+            return ApiConnection.GetAll<Installation>(ApiUrls.UserInstallations(), null, AcceptHeaders.GitHubAppsPreview);
+        }
+
+        /// <summary>
+        /// List installations for user
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/apps/#list-installations-for-user</remarks>
+        public Task<IReadOnlyList<Installation>> GetInstallationsForUser(ApiOptions options)
+        {
+            Ensure.ArgumentNotNull(options, nameof(options));
+
+            return ApiConnection.GetAll<Installation>(ApiUrls.UserInstallations(), null, AcceptHeaders.GitHubAppsPreview, options);
+        }
     }
 }
diff --git a/Octokit/Clients/IGitHubAppsClient.cs b/Octokit/Clients/IGitHubAppsClient.cs
@@ -54,5 +54,17 @@ public interface IGitHubAppsClient
         /// </remarks>
         /// <param name="installationId">The Id of the GitHub App Installation</param>
         Task<AccessToken> CreateInstallationToken(long installationId);
+
+        /// <summary>
+        /// List installations for user
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/apps/#list-installations-for-user</remarks>
+        Task<IReadOnlyList<Installation>> GetAllInstallationsForUser();
+
+        /// <summary>
+        /// List installations for user
+        /// </summary>
+        /// <remarks>https://developer.github.com/v3/apps/#list-installations-for-user</remarks>
+        Task<IReadOnlyList<Installation>> GetInstallationsForUser(ApiOptions options);
     }
 }
diff --git a/Octokit/Helpers/ApiUrls.cs b/Octokit/Helpers/ApiUrls.cs
@@ -324,6 +324,15 @@ public static Uri Installation(long installationId)
             return "app/installations/{0}".FormatUri(installationId);
         }
 
+        /// <summary>
+        /// Returns the <see cref="Uri"/> that returns all the installations in repositories the user has explicit permission to access
+        /// </summary>
+        /// <returns></returns>
+        public static Uri UserInstallations()
+        {
+            return "user/installations".FormatUri();
+        }
+
         /// <summary>
         /// Returns the <see cref="Uri"/> that returns all of the issues  across all the authenticated user’s visible
         /// repositories including owned repositories, member repositories, and organization repositories: