Allow optional passing of rate_limit in kwargs

* Checks if the rate limit is exceeded, throws exception if True
* TODO: Change this to a *middleware* that also increments the counter after a request

Author: jcxldn

xbox/webapi/api/client.py

@@ -28,6 +28,8 @@
 from xbox.webapi.api.provider.usersearch import UserSearchProvider
 from xbox.webapi.api.provider.userstats import UserStatsProvider
 from xbox.webapi.authentication.manager import AuthenticationManager
+from xbox.webapi.common.exceptions import RateLimitExceededException
+from xbox.webapi.common.ratelimits import RateLimit
 
 log = logging.getLogger("xbox.api")
 
@@ -55,6 +57,9 @@ async def request(
         extra_params = kwargs.pop("extra_params", None)
         extra_data = kwargs.pop("extra_data", None)
 
+        # Rate limit object
+        rate_limits: RateLimit = kwargs.pop("rate_limits", None)
+
         if include_auth:
             # Ensure tokens valid
             await self._auth_mgr.refresh_tokens()
@@ -78,6 +83,11 @@ async def request(
             data = data or {}
             data.update(extra_data)
 
+        if rate_limits:
+            # Check if rate limits have been exceeded for this endpoint
+            if rate_limits.is_exceeded():
+                raise RateLimitExceededException("Rate limit exceeded", rate_limits)
+
         return await self._auth_mgr.session.request(
             method, url, **kwargs, headers=headers, params=params, data=data
         )