I think this is a better way to setup the underlying baseUri on IConn…

…eciton, to achieve managemet console access rather than requiring a specific GitHubClient that cant call normal API's Instead, the management client methods can check the base Url and if it contains /api/v3/ they can set their relative endpoint Uri to include a leading "/" which will cause the /api/v3/ to be removed.
octokit · Apr 15, 2016 · b83cf88 · b83cf88
1 parent fa08997
commit b83cf88
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 47 deletions.
diff --git a/Octokit.Tests.Integration/Clients/Enterprise/EnterpriseManagementConsoleClientTests.cs b/Octokit.Tests.Integration/Clients/Enterprise/EnterpriseManagementConsoleClientTests.cs
@@ -10,7 +10,7 @@ public class EnterpriseManagementConsoleClientTests
 
     public EnterpriseManagementConsoleClientTests()
     {
-        _github = EnterpriseHelper.GetAuthenticatedManagementConsoleClient();
+        _github = EnterpriseHelper.GetAuthenticatedClient();
     }
 
     [GitHubEnterpriseTest]

diff --git a/Octokit.Tests.Integration/EnterpriseHelper.cs b/Octokit.Tests.Integration/EnterpriseHelper.cs
@@ -169,11 +169,6 @@ public static IGitHubClient GetAuthenticatedClient()
             };
         }
 
-        public static IGitHubClient GetAuthenticatedManagementConsoleClient()
-        {
-            return new GitHubClient(new ProductHeaderValue("OctokitEnterpriseTests"), GitHubEnterpriseUrl, true);
-        }
-
         public static IGitHubClient GetBasicAuthClient()
         {
             return new GitHubClient(new ProductHeaderValue("OctokitEnterpriseTests"), GitHubEnterpriseUrl)

diff --git a/Octokit/Clients/Enterprise/EnterpriseManagementConsoleClient.cs b/Octokit/Clients/Enterprise/EnterpriseManagementConsoleClient.cs
@@ -15,6 +15,21 @@ public EnterpriseManagementConsoleClient(IApiConnection apiConnection)
             : base(apiConnection)
         { }
 
+        public Uri CorrectEndpointForManagementConsole(Uri endpoint)
+        {
+            Ensure.ArgumentNotNull(endpoint, "endpoint");
+
+            if (ApiConnection.Connection.BaseAddress != null &&
+                ApiConnection.Connection.BaseAddress.ToString().EndsWith("/api/v3/", StringComparison.OrdinalIgnoreCase))
+            {
+                // We need to get rid of the /api/v3/ for ManagementConsole requests
+                // if we specify the endpoint starting with a leading slash, that will achieve this
+                return string.Concat("/", endpoint.ToString()).FormatUri();
+            }
+
+            return endpoint;
+        }
+
         /// <summary>
         /// Gets GitHub Enterprise Maintenance Mode Status
         /// </summary>
@@ -27,6 +42,7 @@ public Task<MaintenanceModeResponse> GetMaintenanceMode(string managementConsole
             Ensure.ArgumentNotNullOrEmptyString(managementConsolePassword, "managementConsolePassword");
 
             var endpoint = ApiUrls.EnterpriseManagementConsoleMaintenance(managementConsolePassword);
+            endpoint = CorrectEndpointForManagementConsole(endpoint);
 
             return ApiConnection.Get<MaintenanceModeResponse>(endpoint);
         }
@@ -44,6 +60,7 @@ public Task<MaintenanceModeResponse> EditMaintenanceMode(UpdateMaintenanceReques
             Ensure.ArgumentNotNullOrEmptyString(managementConsolePassword, "managementConsolePassword");
 
             var endpoint = ApiUrls.EnterpriseManagementConsoleMaintenance(managementConsolePassword);
+            endpoint = CorrectEndpointForManagementConsole(endpoint);
 
             return ApiConnection.Post<MaintenanceModeResponse>(endpoint, maintenance.AsNamedFormEncodingString());
         }

diff --git a/Octokit/GitHubClient.cs b/Octokit/GitHubClient.cs
@@ -52,23 +52,7 @@ public GitHubClient(ProductHeaderValue productInformation, ICredentialStore cred
         /// The address to point this client to. Typically used for GitHub Enterprise 
         /// instances</param>
         public GitHubClient(ProductHeaderValue productInformation, Uri baseAddress)
-            : this(productInformation, baseAddress, false)
-        {
-        }
-
-        /// <summary>
-        /// Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.
-        /// </summary>
-        /// <param name="productInformation">
-        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
-        /// the user agent for analytics purposes.
-        /// </param>
-        /// <param name="baseAddress">
-        /// The address to point this client to. Typically used for GitHub Enterprise 
-        /// instances</param>
-        /// <param name="managementConsole">Specifies if this connection is for accessing the GitHub Enterprise management console</param>
-        public GitHubClient(ProductHeaderValue productInformation, Uri baseAddress, bool managementConsole)
-            : this(new Connection(productInformation, FixUpBaseUri(baseAddress, managementConsole)))
+            : this(new Connection(productInformation, FixUpBaseUri(baseAddress)))
         {
         }
 
@@ -84,24 +68,7 @@ public GitHubClient(ProductHeaderValue productInformation, Uri baseAddress, bool
         /// The address to point this client to. Typically used for GitHub Enterprise 
         /// instances</param>
         public GitHubClient(ProductHeaderValue productInformation, ICredentialStore credentialStore, Uri baseAddress)
-            : this(productInformation, credentialStore, baseAddress, false)
-        {
-        }
-
-        /// <summary>
-        /// Create a new instance of the GitHub API v3 client pointing to the specified baseAddress.
-        /// </summary>
-        /// <param name="productInformation">
-        /// The name (and optionally version) of the product using this library. This is sent to the server as part of
-        /// the user agent for analytics purposes.
-        /// </param>
-        /// <param name="credentialStore">Provides credentials to the client when making requests</param>
-        /// <param name="baseAddress">
-        /// The address to point this client to. Typically used for GitHub Enterprise 
-        /// instances</param>
-        /// <param name="managementConsole">Specifies if this connection is for accessing the GitHub Enterprise management console</param>
-        public GitHubClient(ProductHeaderValue productInformation, ICredentialStore credentialStore, Uri baseAddress, bool managementConsole)
-            : this(new Connection(productInformation, FixUpBaseUri(baseAddress, managementConsole), credentialStore))
+            : this(new Connection(productInformation, FixUpBaseUri(baseAddress), credentialStore))
         {
         }
 
@@ -329,7 +296,7 @@ public IReleasesClient Release
         /// </remarks>
         public IEnterpriseClient Enterprise { get; private set; }
 
-        static Uri FixUpBaseUri(Uri uri, bool managementConsole)
+        static Uri FixUpBaseUri(Uri uri)
         {
             Ensure.ArgumentNotNull(uri, "uri");
 
@@ -338,11 +305,6 @@ static Uri FixUpBaseUri(Uri uri, bool managementConsole)
                 return GitHubApiUrl;
             }
 
-            if (managementConsole)
-            {
-                return uri;
-            }
-
             return new Uri(uri, new Uri("/api/v3/", UriKind.Relative));
         }
     }