IGitHubApiStatusService.IsAbuseRateLimit

Author: TheCodeTraveler

Src/GitHubApiStatus.UnitTests/Tests/Base/BaseTest.cs

@@ -15,7 +15,7 @@ abstract class BaseTest
 
         readonly static HttpClient _client = CreateGitHubHttpClient(new AuthenticationHeaderValue(GitHubConstants.AuthScheme, GitHubConstants.PersonalAccessToken), new ProductHeaderValue(nameof(GitHubApiStatus)));
 
-        protected GitHubApiStatusService GitHubApiStatusService { get; } = new GitHubApiStatusService(_client);
+        protected IGitHubApiStatusService GitHubApiStatusService { get; } = new GitHubApiStatusService(_client);
 
         [SetUp]
         protected virtual Task BeforeEachTest() => Task.CompletedTask;
@@ -36,9 +36,9 @@ protected static HttpResponseHeaders CreateHttpResponseHeaders(in int rateLimit,
             {
                 Headers =
                 {
-                    { GitHubApiStatusService.RateLimitHeader, rateLimit.ToString() },
-                    { GitHubApiStatusService.RateLimitResetHeader,  GetTimeInUnixEpochSeconds(rateLimitResetTime).ToString() },
-                    { GitHubApiStatusService.RateLimitRemainingHeader, remainingRequestCount.ToString() }
+                    { GitHubApiStatus.GitHubApiStatusService.RateLimitHeader, rateLimit.ToString() },
+                    { GitHubApiStatus.GitHubApiStatusService.RateLimitResetHeader,  GetTimeInUnixEpochSeconds(rateLimitResetTime).ToString() },
+                    { GitHubApiStatus.GitHubApiStatusService.RateLimitRemainingHeader, remainingRequestCount.ToString() }
                 }
             };
 

Src/GitHubApiStatus.UnitTests/Tests/GetApiRateLimitsTests_NoCancellationToken.cs

@@ -18,14 +18,15 @@ public async Task GetApiRateLimits_ValidRestApiRequest()
             GitHubApiRateLimits gitHubApiRateLimits_Initial, gitHubApiRateLimits_Final;
 
             var startTime = DateTimeOffset.UtcNow;
+            var gitHubApiStatusService = (GitHubApiStatusService)GitHubApiStatusService;
 
             //Act
-            gitHubApiRateLimits_Initial = await GitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
+            gitHubApiRateLimits_Initial = await gitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
             restApiStatus_Initial = gitHubApiRateLimits_Initial.RestApi;
 
             await SendValidRestApiRequest().ConfigureAwait(false);
 
-            gitHubApiRateLimits_Final = await GitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
+            gitHubApiRateLimits_Final = await gitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
             restApiStatus_Final = gitHubApiRateLimits_Final.RestApi;
 
             //Assert
@@ -61,14 +62,15 @@ public async Task GetApiRateLimits_ValidGraphQLApiRequest()
             GitHubApiRateLimits gitHubApiRateLimits_Initial, gitHubApiRateLimits_Final;
 
             var startTime = DateTimeOffset.UtcNow;
+            var gitHubApiStatusService = (GitHubApiStatusService)GitHubApiStatusService;
 
             //Act
-            gitHubApiRateLimits_Initial = await GitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
+            gitHubApiRateLimits_Initial = await gitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
             graphQLApiStatus_Initial = gitHubApiRateLimits_Initial.GraphQLApi;
 
             await SendValidGraphQLApiRequest().ConfigureAwait(false);
 
-            gitHubApiRateLimits_Final = await GitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
+            gitHubApiRateLimits_Final = await gitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
             graphQLApiStatus_Final = gitHubApiRateLimits_Final.GraphQLApi;
 
             //Assert
@@ -103,14 +105,15 @@ public async Task GetApiRateLimits_ValidSearchApiRequest()
             GitHubApiRateLimits gitHubApiRateLimits_Initial, gitHubApiRateLimits_Final;
 
             var startTime = DateTimeOffset.UtcNow;
+            var gitHubApiStatusService = (GitHubApiStatusService)GitHubApiStatusService;
 
             //Act
-            gitHubApiRateLimits_Initial = await GitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
+            gitHubApiRateLimits_Initial = await gitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
             searchApiStatus_Initial = gitHubApiRateLimits_Initial.SearchApi;
 
             await SendValidSearchApiRequest().ConfigureAwait(false);
 
-            gitHubApiRateLimits_Final = await GitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
+            gitHubApiRateLimits_Final = await gitHubApiStatusService.GetApiRateLimits().ConfigureAwait(false);
             searchApiStatus_Final = gitHubApiRateLimits_Final.SearchApi;
 
             //Assert
@@ -141,12 +144,13 @@ public async Task GetApiRateLimits_ValidSearchApiRequest()
         public void GetApiRateLimits_InvalidBearerToken()
         {
             //Arrange
-            GitHubApiStatusService.SetAuthenticationHeaderValue(new AuthenticationHeaderValue(GitHubConstants.AuthScheme, "abc 123"));
+            var gitHubApiStatusService = (GitHubApiStatusService)GitHubApiStatusService;
+            gitHubApiStatusService.SetAuthenticationHeaderValue(new AuthenticationHeaderValue(GitHubConstants.AuthScheme, "abc 123"));
 
             //Act
 
             //Assert
-            var httpRequestException = Assert.ThrowsAsync<HttpRequestException>(() => GitHubApiStatusService.GetApiRateLimits());
+            var httpRequestException = Assert.ThrowsAsync<HttpRequestException>(() => gitHubApiStatusService.GetApiRateLimits());
             Assert.IsTrue(httpRequestException.Message.Contains("Unauthorized"));
         }
     }

Src/GitHubApiStatus/Interfaces/IGitHubApiStatusService.cs

@@ -53,6 +53,14 @@ public interface IGitHubApiStatusService
         /// <returns>Number of GitHub API Requests Remaining</returns>
         int GetRemainingRequestCount(in HttpResponseHeaders httpResponseHeaders);
 
+        /// <summary>
+        /// Determines Whether GitHub's Abuse Rate Limit Has Been Reached
+        /// </summary>
+        /// <param name="httpResponseHeaders">HttpResponseHeaders from GitHub API Response</param>
+        /// <param name="delta">Time Remaining in Retry-After Header</param>
+        /// <returns></returns>
+        bool IsAbuseRateLimit(in HttpResponseHeaders httpResponseHeaders, out TimeSpan? delta);
+
         /// <summary>
         /// Determines Whether GitHub's Maximum API Limit Has Been Reached
         /// </summary>