Merge pull request #152 from mathsman5133/g5_2.2.2_candidate

G5 2.2.2 candidate

Author: majordoobie

coc/clans.py

@@ -107,6 +107,8 @@ class Clan(BaseClan):
         The clan's versus trophy count. This is calculated according to members' versus trophy counts.
     required_trophies: :class:`int`
         The minimum trophies required to apply to this clan.
+    required_townhall: :class:`int`
+        The minimum townhall level required to apply to this clan.
     war_frequency: :class:`str`
         The frequency for when this clan goes to war.
         For example, this could be ``always``.
@@ -159,6 +161,7 @@ class Clan(BaseClan):
         "capital_district_cls",
         "war_league",
         "chat_language",
+        "required_townhall",
 
         "_cs_labels",
         "_cs_members",
@@ -197,6 +200,7 @@ def _from_data(self, data: dict) -> None:
         self.description: str = data_get("description")
         self.war_league = try_enum(WarLeague, data=data_get("warLeague"))
         self.chat_language = try_enum(ChatLanguage, data=data_get("chatLanguage"))
+        self.required_townhall = data_get("requiredTownhallLevel")
 
         label_cls = self.label_cls
         self._iter_labels = (label_cls(data=ldata, client=self._client) for ldata in data_get("labels", []))

coc/client.py

@@ -23,6 +23,7 @@
 """
 import asyncio
 import logging
+from enum import Enum
 
 from itertools import cycle
 from pathlib import Path
@@ -67,6 +68,16 @@
 BUILDING_FILE_PATH = Path(__file__).parent.joinpath(Path("static/buildings.json"))
 
 
+class ClashAccountScopes(Enum):
+    """
+    Values represent the scope required for each type of user. A USER is
+    anyone who has access to the API. A REAL user is a user with special
+    access from SuperCell with realtime scope access.
+    """
+    USER = "clash"
+    REAL = "clash:*:verifytoken,realtime"
+
+
 class Client:
     """This is the client connection used to interact with the Clash of Clans API.
 
@@ -120,6 +131,11 @@ class Client:
     load_game_data: :class:`LoadGameData`
         The option for how coc.py will load game data. See :ref:`initialising_game_data` for more info.
 
+    realtime: :class:`bool`
+        Some developers are given special access to an uncached API access by
+        Super Cell. If you are one of those developers, your account will have
+        special flags that will only be interpreted by coc.py if you set this
+        bool to True.
 
     Attributes
     ----------
@@ -158,7 +174,6 @@ def __init__(
         *,
         key_count: int = 1,
         key_names: str = "Created with coc.py Client",
-        key_scopes: str = "clash",
         throttle_limit: int = 10,
         loop: asyncio.AbstractEventLoop = None,
         correct_tags: bool = True,
@@ -168,7 +183,7 @@ def __init__(
         cache_max_size: int = 10000,
         stats_max_size: int = 1000,
         load_game_data: LoadGameData = LoadGameData(default=True),
-        realtime = False,
+        realtime=False,
         **_,
     ):
 
@@ -180,7 +195,7 @@ def __init__(
             raise RuntimeError("Key count must be within {}-{}".format(KEY_MINIMUM, KEY_MAXIMUM))
 
         self.key_names = key_names
-        self.key_scopes = key_scopes
+        self.key_scopes = ClashAccountScopes.REAL.value if realtime else ClashAccountScopes.USER.value
         self.throttle_limit = throttle_limit
         self.throttler = throttler
         self.connector = connector
@@ -190,6 +205,7 @@ def __init__(
 
         self.http = None  # set in method login()
         self.realtime = realtime
+
         self.correct_tags = correct_tags
         self.load_game_data = load_game_data
 
@@ -253,6 +269,8 @@ def _create_holders(self):
     async def login(self, email: str, password: str) -> None:
         """Retrieves all keys and creates an HTTP connection ready for use.
 
+        @Deprecated
+
         Parameters
         ----------
         email : str

coc/enums.py

@@ -111,6 +111,7 @@ class Resource(Enum):
     "Super Witch",
     "Ice Hound",
     "Super Bowler",
+    "Super Miner",
 ]
 
 HOME_TROOP_ORDER = HOME_TROOP_ORDER + SIEGE_MACHINE_ORDER

coc/http.py

@@ -480,6 +480,11 @@ async def initialise_keys(self):
 
                     resp = await session.post("https://developer.clashofclans.com/api/apikey/create", json=data)
                     key = await resp.json()
+
+                    if resp.status != 200:
+                        LOG.error(key.get("description"))
+                        raise ValueError(key.get("description"))
+
                     self._keys.append(key["key"]["key"])
 
             if len(keys) == 10 and len(self._keys) < self.key_count:

coc/static/pets.json

@@ -16,6 +16,7 @@
     ("pets.json", None),
     ("spells.json", None),
     ("supers.json", None),
+    ("townhall_levels.json", None),
     ("lang/texts_EN.json", "texts_EN.json"),
 ]
 

coc/static/texts_EN.json

@@ -344,7 +344,13 @@ def get_season_end(month: Optional[int] = None, year: Optional[int] = None) -> d
         The end of the season.
     """
     if month and year:
-        return get_season_start(month + 1, year)
+        if month == 12:
+            next_month = 1
+            next_year = year + 1
+        else:
+            next_month = month + 1
+            next_year = year
+        return get_season_start(next_month, next_year)
 
     now = datetime.utcnow()
     end = get_season_start(now.month, now.year)

coc/static/update_static.py

@@ -104,7 +104,7 @@ def _from_data(self, data: dict) -> None:
 
         if self._war:
             self.max_stars: int = self._war.team_size * 3
-            self.total_attacks: int = self._war.team_size * 2
+            self.total_attacks: int = self._war.team_size * self._war.attacks_per_member
         else:
             self.max_stars: int = (data_get("teamSize") or 0) * 3
             self.total_attacks: int = (data_get("teamSize") or 0) * 3

coc/utils.py

@@ -103,7 +103,7 @@ def _from_data(self, data: dict) -> None:
         self.start_time = try_enum(Timestamp, data=data_get("startTime"))
         self.end_time = try_enum(Timestamp, data=data_get("endTime"))
         self.war_tag: str = data_get("tag")
-        if data_get("attacksPerMember") is None and self.is_cwl:
+        if data_get("attacksPerMember") is None or self.is_cwl:
             self.attacks_per_member: int = 1
         else:
             self.attacks_per_member: int = data_get("attacksPerMember")