Merge pull request #102 from doluk/master

Allow coc.py to handle API requests for unlimited&uncached API endpoints

Author: mathsman5133

coc/client.py

@@ -138,6 +138,7 @@ class Client:
         "cache_max_size",
         "stats_max_size",
         "http",
+        "realtime",
         "_ready",
         "correct_tags",
         "load_game_data",
@@ -166,6 +167,7 @@ def __init__(
         cache_max_size: int = 10000,
         stats_max_size: int = 1000,
         load_game_data: LoadGameData = LoadGameData(default=True),
+        realtime = False,
         **_,
     ):
 
@@ -186,6 +188,7 @@ def __init__(
         self.stats_max_size = stats_max_size
 
         self.http = None  # set in method login()
+        self.realtime = realtime
         self.correct_tags = correct_tags
         self.load_game_data = load_game_data
 
@@ -586,7 +589,12 @@ async def get_clan_war(self, clan_tag: str, cls: Type[ClanWar] = ClanWar, **kwar
             clan_tag = correct_tag(clan_tag)
 
         try:
-            data = await self.http.get_clan_current_war(clan_tag)
+            realtime = kwargs.get("realtime")
+        except KeyError:
+            realtime = None
+
+        try:
+            data = await self.http.get_clan_current_war(clan_tag, realtime=realtime)
         except Forbidden as exception:
             raise PrivateWarLog(exception.response, exception.reason) from exception
 
@@ -693,7 +701,12 @@ async def get_league_group(
             clan_tag = correct_tag(clan_tag)
 
         try:
-            data = await self.http.get_clan_war_league_group(clan_tag)
+            realtime = kwargs.get("realtime")
+        except KeyError:
+            realtime = None
+
+        try:
+            data = await self.http.get_clan_war_league_group(clan_tag, realtime=realtime)
         except Forbidden as exception:
             raise PrivateWarLog(exception.response, exception.reason) from exception
         except asyncio.TimeoutError:
@@ -741,7 +754,12 @@ async def get_league_war(self, war_tag: str, cls: Type[ClanWar] = ClanWar, **kwa
             war_tag = correct_tag(war_tag)
 
         try:
-            data = await self.http.get_cwl_wars(war_tag)
+            realtime = kwargs.get("realtime")
+        except KeyError:
+            realtime = None
+
+        try:
+            data = await self.http.get_cwl_wars(war_tag, realtime=realtime)
         except Forbidden as exception:
             raise PrivateWarLog(exception.response, exception.reason) from exception
 
@@ -869,7 +887,7 @@ async def get_current_war(
             return get_war
 
         try:
-            league_group = await self.get_league_group(clan_tag)
+            league_group = await self.get_league_group(clan_tag,**kwargs)
         except (NotFound, GatewayError) as exception:
             # either they're not in cwl (NotFound)
             # or it's an API bug where league group endpoint will timeout when the clan is searching (GatewayError)

coc/http.py

@@ -166,18 +166,18 @@ class HTTPClient:
 
     # pylint: disable=too-many-arguments, missing-docstring, protected-access, too-many-branches
     def __init__(
-        self,
-        client,
-        loop,
-        email,
-        password,
-        key_names,
-        key_count,
-        key_scopes,
-        throttle_limit,
-        throttler=BasicThrottler,
-        cache_max_size=10000,
-        stats_max_size=1000,
+            self,
+            client,
+            loop,
+            email,
+            password,
+            key_names,
+            key_count,
+            key_scopes,
+            throttle_limit,
+            throttler=BasicThrottler,
+            cache_max_size=10000,
+            stats_max_size=1000
     ):
         self.client = client
         self.loop = loop
@@ -187,7 +187,6 @@ def __init__(
         self.key_count = key_count
         self.key_scopes = key_scopes
         self.throttle_limit = throttle_limit
-
         per_second = key_count * throttle_limit
 
         self.__session = None
@@ -226,7 +225,7 @@ async def request(self, route, **kwargs):
         url = route.url
 
         headers = {
-            "Accept": "application/json",
+            "Accept"       : "application/json",
             "authorization": "Bearer {}".format(next(self.keys)),
         }
         kwargs["headers"] = headers
@@ -237,7 +236,7 @@ async def request(self, route, **kwargs):
         cache_control_key = route.url
         cache = self.cache
         # the cache will be cleaned once it becomes stale / a new object is available from the api.
-        if cache is not None:
+        if cache is not None and not self.client.realtime:
             try:
                 return cache[cache_control_key]
             except KeyError:
@@ -261,7 +260,7 @@ async def request(self, route, **kwargs):
                             # set a callback to remove the item from cache once it's stale.
                             delta = int(response.headers["Cache-Control"].strip("max-age="))
                             data["_response_retry"] = delta
-                            if cache is not None:
+                            if cache is not None and not self.client.realtime:
                                 self.cache[cache_control_key] = data
                                 LOG.debug("Cache-Control max age: %s seconds, key: %s", delta, cache_control_key)
                                 self.loop.call_later(delta, self._cache_remove, cache_control_key)
@@ -294,8 +293,8 @@ async def request(self, route, **kwargs):
                             raise NotFound(response, data)
                         if response.status == 429:
                             LOG.error(
-                                "We have been rate-limited by the API. "
-                                "Reconsider the number of requests you are allowing per second."
+                                    "We have been rate-limited by the API. "
+                                    "Reconsider the number of requests you are allowing per second."
                             )
                             raise HTTPException(response, data)
 
@@ -346,14 +345,20 @@ def get_clan_members(self, tag):
     def get_clan_warlog(self, tag):
         return self.request(Route("GET", "/clans/{}/warlog".format(tag)))
 
-    def get_clan_current_war(self, tag):
-        return self.request(Route("GET", "/clans/{}/currentwar".format(tag)))
+    def get_clan_current_war(self, tag, realtime = None):
+        return self.request(Route("GET", "/clans/{}/currentwar".format(tag) + (
+                                         '?realtime=true' if realtime or (realtime is None and self.client.realtime)
+                                         else '')))
 
-    def get_clan_war_league_group(self, tag):
-        return self.request(Route("GET", "/clans/{}/currentwar/leaguegroup".format(tag)))
+    def get_clan_war_league_group(self, tag, realtime = None):
+        return self.request(Route("GET", "/clans/{}/currentwar/leaguegroup".format(tag) + (
+                                         '?realtime=true' if realtime or (realtime is None and self.client.realtime)
+                                         else '')))
 
-    def get_cwl_wars(self, war_tag):
-        return self.request(Route("GET", "/clanwarleagues/wars/{}".format(war_tag)))
+    def get_cwl_wars(self, war_tag, realtime = None):
+        return self.request(Route("GET", "/clanwarleagues/wars/{}".format(war_tag) + (
+                                         '?realtime=true' if realtime or (realtime is None and self.client.realtime)
+                                         else '')))
 
     # locations
 
@@ -433,17 +438,17 @@ async def initialise_keys(self):
         if len(self._keys) < self.key_count:
             for key in (k for k in keys if k["name"] == self.key_names and ip not in k["cidrRanges"]):
                 LOG.info(
-                    "Deleting key with the name %s and IP %s (not matching our current IP address).",
-                    self.key_names, key["cidrRanges"],
+                        "Deleting key with the name %s and IP %s (not matching our current IP address).",
+                        self.key_names, key["cidrRanges"],
                 )
                 await session.post("https://developer.clashofclans.com/api/apikey/revoke", json={"id": key["id"]})
 
             while len(self._keys) < self.key_count and len(keys) < KEY_MAXIMUM:
                 data = {
-                    "name": self.key_names,
+                    "name"       : self.key_names,
                     "description": "Created on {}".format(datetime.now().strftime("%c")),
-                    "cidrRanges": [ip],
-                    "scopes": [self.key_scopes],
+                    "cidrRanges" : [ip],
+                    "scopes"     : [self.key_scopes],
                 }
 
                 LOG.info("Creating key with data %s.", str(data))
@@ -462,9 +467,9 @@ async def initialise_keys(self):
         if len(self._keys) == 0:
             await self.close()
             raise RuntimeError(
-                "There are {} API keys already created and none match a key_name of '{}'."
-                "Please specify a key_name kwarg, or go to 'https://developer.clashofclans.com' to delete "
-                "unused keys.".format(len(keys), self.key_names)
+                    "There are {} API keys already created and none match a key_name of '{}'."
+                    "Please specify a key_name kwarg, or go to 'https://developer.clashofclans.com' to delete "
+                    "unused keys.".format(len(keys), self.key_names)
             )
 
         await session.close()