Bump version: 0.23.4.6 → 0.23.4.7

.gitignore

@@ -102,5 +102,4 @@ ENV/
 
 debug/
 log/
-docs/
 *dump.json

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+
+default_language_version:
+    python: python3.7

LICENSE

@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

Makefile

@@ -76,7 +76,6 @@ servedocs: docs ## compile the docs watching for changes
 
 release: dist ## package and upload a release
 	twine upload dist/*
-	clean
 
 dist: clean ## builds source and wheel package
 	python setup.py sdist

README.rst

@@ -34,4 +34,3 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
 
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
-

docs/erepublik.rst

@@ -0,0 +1,61 @@
+erepublik package
+=================
+
+Submodules
+----------
+
+erepublik.access\_points module
+-------------------------------
+
+.. automodule:: erepublik.access_points
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+erepublik.citizen module
+------------------------
+
+.. automodule:: erepublik.citizen
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+erepublik.classes module
+------------------------
+
+.. automodule:: erepublik.classes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+erepublik.constants module
+--------------------------
+
+.. automodule:: erepublik.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+erepublik.types module
+----------------------
+
+.. automodule:: erepublik.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+erepublik.utils module
+----------------------
+
+.. automodule:: erepublik.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: erepublik
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/index.html

@@ -393,7 +393,7 @@
         }
 
         config.air = air.checked;
-        config.ground = ground.cehcked;
+        config.ground = ground.checked;
         config.boosters = boosters.checked;
         config.continuous_fighting = continuous_fighting.checked;
         config.next_energy = next_energy.checked;
@@ -402,10 +402,9 @@
         config.travel_to_fight = travel_to_fight.checked;
         config.epic_hunt = epic_hunt.checked;
         config.epic_hunt_ebs = config.epic_hunt ? epic_hunt_ebs.checked : config.epic_hunt;
+        config.maverick = false;
 
         // Advanced
-
-
         let telegram = document.getElementById('telegram'); // Generated
         config.telegram = telegram.checked;
         let telegram_chat_id = document.getElementById('telegram_chat_id'); // Generated

docs/modules.rst

@@ -0,0 +1,7 @@
+erepublik
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   erepublik

docs/usage.rst

@@ -7,4 +7,3 @@ To use eRepublik script in a project::
     from erepublik import Citizen
     player = Citizen('email@domain.com', 'password')
     player.update_all()
-

erepublik/__init__.py

@@ -4,7 +4,7 @@
 
 __author__ = """Eriks Karls"""
 __email__ = 'eriks@72.lv'
-__version__ = '0.23.4'
+__version__ = '0.23.4.7'
 
 from erepublik import classes, constants, utils
 from erepublik.citizen import Citizen

erepublik/access_points.py

@@ -305,11 +305,11 @@ class ErepublikEconomyAPI(CitizenBaseAPI):
         return self.post(f"{self.url}/main/buyGoldItems", data=data)
 
     def _post_economy_activate_booster(self, quality: int, duration: int, kind: str) -> Response:
-        data = dict(type=kind, quality=quality, duration=duration, fromInventory=True)
+        data = dict(type=kind, quality=quality, duration=duration, fromInventory=True, _token=self.token)
         return self.post(f"{self.url}/economy/activateBooster", data=data)
 
     def _post_economy_activate_house(self, quality: int) -> Response:
-        data = {"action": "activate", "quality": quality, "type": "house", "_token": self.token}
+        data = dict(action="activate", quality=quality, type="house", _token=self.token)
         return self.post(f"{self.url}/economy/activateHouse", data=data)
 
     def _post_economy_donate_items_action(self, citizen_id: int, amount: int, industry: int,
@@ -595,6 +595,10 @@ class ErepublikProfileAPI(CitizenBaseAPI):
         data = dict(_token=self.token, rewardId=reward_id)
         return self.post(f"{self.url}/main/weekly-challenge-collect-reward", data=data)
 
+    def _post_main_weekly_challenge_collect_all(self, max_reward_id: int) -> Response:
+        data = dict(_token=self.token, maxRewardId=max_reward_id)
+        return self.post(f"{self.url}/main/weekly-challenge-collect-all", data=data)
+
     def _post_main_profile_update(self, action: str, params: str):
         data = {"action": action, "params": params, "_token": self.token}
         return self.post(f"{self.url}/main/profile-update", data=data)

erepublik/citizen.py

@@ -2,7 +2,7 @@ import re
 import sys
 import warnings
 import weakref
-from datetime import datetime, timedelta, time
+from datetime import datetime, time, timedelta
 from decimal import Decimal
 from itertools import product
 from threading import Event
@@ -11,7 +11,7 @@ from typing import Any, Dict, List, NoReturn, Optional, Set, Tuple, Union
 
 from requests import HTTPError, RequestException, Response
 
-from . import access_points, classes, constants, utils, types
+from . import access_points, classes, constants, types, utils
 from .classes import OfferItem
 
 
@@ -20,7 +20,7 @@ class BaseCitizen(access_points.CitizenAPI):
     _last_inventory_update: datetime = constants.min_datetime
 
     promos: Dict[str, datetime] = None
-    inventory: classes.Inventory
+    _inventory: classes.Inventory
     ot_points: int = 0
 
     food: Dict[str, int] = {"q1": 0, "q2": 0, "q3": 0, "q4": 0, "q5": 0, "q6": 0, "q7": 0, "total": 0}
@@ -63,7 +63,7 @@ class BaseCitizen(access_points.CitizenAPI):
 
         self.config.email = email
         self.config.password = password
-        self.inventory = classes.Inventory()
+        self._inventory = classes.Inventory()
         self.wheel_of_fortune = False
 
     def get_csrf_token(self):
@@ -238,17 +238,18 @@ class BaseCitizen(access_points.CitizenAPI):
 
     def update_inventory(self):
         """
-        Updates class properties and returns structured inventory.
-        Return structure: {status: {used: int, total: int}, items: {active/final/raw: {item_token:{quality: data}}}
-        If item kind is damageBoosters or aircraftDamageBoosters then kind is renamed to kind+quality and duration is
-        used as quality.
+        Updates citizen inventory
         """
         self._update_inventory_data(self._get_economy_inventory_items().json())
 
+    @property
+    def inventory(self) -> classes.Inventory:
+        return self.get_inventory()
+
     def get_inventory(self, force: bool = False) -> classes.Inventory:
         if utils.good_timedelta(self._last_inventory_update, timedelta(minutes=2)) < self.now or force:
             self.update_inventory()
-        return self.inventory
+        return self._inventory
 
     def _update_inventory_data(self, inv_data: Dict[str, Any]):
         if not isinstance(inv_data, dict):
@@ -264,8 +265,8 @@ class BaseCitizen(access_points.CitizenAPI):
 
         status = inv_data.get("inventoryStatus", {})
         if status:
-            self.inventory.used = status.get("usedStorage")
-            self.inventory.total = status.get("totalStorage")
+            self._inventory.used = status.get("usedStorage")
+            self._inventory.total = status.get("totalStorage")
         data = inv_data.get('inventoryItems', {})
         if not data:
             return
@@ -287,8 +288,9 @@ class BaseCitizen(access_points.CitizenAPI):
                 if item_data.get('attributes').get('expirationInfo'):
                     expire_info = item_data.get('attributes').get('expirationInfo')
                     expiration_info = [_expire_value_to_python(v) for v in expire_info['value']]
-                icon = item_data['icon'] if item_data[
-                    'icon'] else "//www.erepublik.net/images/modules/manager/tab_storage.png"
+                if not item_data.get('icon') and item_data.get('isPackBooster'):
+                    item_data['icon'] = f"//www.erepublik.com/images/icons/boosters/52px/{item_data.get('type')}.png"
+                icon = item_data['icon'] if item_data['icon'] else "//www.erepublik.net/images/modules/manager/tab_storage.png"
                 inv_item: types.InvFinalItem = dict(
                     name=item_data.get("name"), time_left=item_data['active']['time_left'], icon=icon,
                     kind=kind, expiration=expiration_info, quality=item_data.get("quality", 0)
@@ -308,7 +310,7 @@ class BaseCitizen(access_points.CitizenAPI):
 
                 if item_data.get('type'):
                     #  in ['damageBoosters', "aircraftDamageBoosters", 'prestigePointsBoosters']
-                    if item_data.get('type').endswith('Boosters'):
+                    if item_data.get('isBooster'):
                         is_booster = True
                         kind = item_data['type']
 
@@ -433,11 +435,11 @@ class BaseCitizen(access_points.CitizenAPI):
                 offers[kind] = {}
 
             offers[kind].update(offer_data)
-        self.inventory.active = active_items
-        self.inventory.final = final_items
-        self.inventory.boosters = boosters
-        self.inventory.raw = raw_materials
-        self.inventory.offers = offers
+        self._inventory.active = active_items
+        self._inventory.final = final_items
+        self._inventory.boosters = boosters
+        self._inventory.raw = raw_materials
+        self._inventory.offers = offers
         self.food["total"] = sum([self.food[q] * constants.FOOD_ENERGY[q] for q in constants.FOOD_ENERGY])
 
     def write_log(self, *args, **kwargs):
@@ -1055,7 +1057,7 @@ class CitizenEconomy(CitizenTravel):
 
     def check_house_durability(self) -> Dict[int, datetime]:
         ret = {}
-        inv = self.get_inventory()
+        inv = self.inventory
         for house_quality, active_house in inv.active.get('House', {}).items():
             till = utils.good_timedelta(self.now, timedelta(seconds=active_house['time_left']))
             ret.update({house_quality: till})
@@ -1064,7 +1066,7 @@ class CitizenEconomy(CitizenTravel):
     def buy_and_activate_house(self, q: int) -> Optional[Dict[int, datetime]]:
         original_region = self.details.current_country, self.details.current_region
         ok_to_activate = False
-        inv = self.get_inventory()
+        inv = self.inventory
         if not inv.final.get('House', {}).get(q, {}):
             countries = [self.details.citizenship, ]
             if self.details.current_country != self.details.citizenship:
@@ -1119,8 +1121,7 @@ class CitizenEconomy(CitizenTravel):
         r: Dict[str, Any] = self._post_economy_activate_house(quality).json()
         self._update_inventory_data(r)
         if r.get("status") and not r.get("error"):
-            inventory = self.get_inventory()
-            house = inventory.active.get('House', {}).get(quality)
+            house = self.inventory.active.get('House', {}).get(quality)
             time_left = timedelta(seconds=house["time_left"])
             active_until = utils.good_timedelta(self.now, time_left)
             self._report_action(
@@ -1201,13 +1202,12 @@ class CitizenEconomy(CitizenTravel):
 
         _inv_qlt = quality if industry in [1, 2, 3, 4, 23] else 0
         final_kind = industry in [1, 2, 4, 23]
-        inventory = self.get_inventory()
-        items = (inventory.final if final_kind else inventory.raw).get(constants.INDUSTRIES[industry],
-                                                                       {_inv_qlt: {'amount': 0}})
+        items = (self.inventory.final if final_kind else self.inventory.raw).get(constants.INDUSTRIES[industry],
+                                                                                 {_inv_qlt: {'amount': 0}})
         if items[_inv_qlt]['amount'] < amount:
-            inventory = self.get_inventory(True)
-            items = (inventory.final if final_kind else inventory.raw).get(constants.INDUSTRIES[industry],
-                                                                           {_inv_qlt: {'amount': 0}})
+            self.update_inventory()
+            items = (self.inventory.final if final_kind else self.inventory.raw).get(constants.INDUSTRIES[industry],
+                                                                                     {_inv_qlt: {'amount': 0}})
             if items[_inv_qlt]['amount'] < amount:
                 self._report_action("ECONOMY_SELL_PRODUCTS", "Unable to sell! Not enough items in storage!",
                                     kwargs=dict(inventory=items[_inv_qlt], amount=amount))
@@ -1773,7 +1773,8 @@ class CitizenMilitary(CitizenTravel):
             yield battle, battle_zone, side
 
     def find_battle_and_fight(self):
-        if self.should_fight()[0]:
+        count = self.should_fight()[0]
+        if count:
             self.write_log("Checking for battles to fight in...")
             for battle, division, side in self.find_battle_to_fight():
 
@@ -1800,7 +1801,7 @@ class CitizenMilitary(CitizenTravel):
 
                 if self.change_division(battle, division):
                     self.set_default_weapon(battle, division)
-                    self.fight(battle, division, side)
+                    self.fight(battle, division, side, count)
                     self.travel_to_residence()
                     break
 
@@ -1852,7 +1853,7 @@ class CitizenMilitary(CitizenTravel):
                     self.write_log(f"Hits: {total_hits:>4} | Damage: {total_damage}")
                     ok_to_fight = False
                     if total_damage:
-                        self.reporter.report_fighting(battle, not side.is_defender, division, total_damage, total_hits)
+                        self.report_fighting(battle, not side.is_defender, division, total_damage, total_hits)
                         # self.reporter.report_action('FIGHT', dict(battle_id=battle.id, side=side, dmg=total_damage,
                         #                                           air=battle.has_air, hits=total_hits,
                         #                                           round=battle.zone_id,
@@ -2018,7 +2019,7 @@ class CitizenMilitary(CitizenTravel):
 
         return utils.calculate_hit(0, rang, True, elite, ne, 0, 20 if weapon else 0)
 
-    def activate_damage_booster(self, ground: bool = True):
+    def activate_damage_booster(self, ground: bool = True) -> int:
         kind = 'damageBoosters' if ground else 'aircraftDamageBoosters'
         if self.config.boosters and not self.get_active_damage_booster(ground):
             booster: Optional[types.InvFinalItem] = None
@@ -2030,14 +2031,15 @@ class CitizenMilitary(CitizenTravel):
                         break
                 break
             if booster:
+                kind = 'damage' if ground else 'air_damage'
                 self._report_action("MILITARY_BOOSTER", f"Activated {booster['name']}")
-                self._post_economy_activate_booster(booster['quality'], booster['durability'],
-                                                    'damage' if ground else 'air_damage')
+                resp = self._post_economy_activate_booster(booster['quality'], booster['durability'], kind).json()
+                self._update_inventory_data(resp)
+        return self.get_active_damage_booster(ground)
 
     def get_active_damage_booster(self, ground: bool = True) -> int:
         kind = 'damageBoosters' if ground else 'aircraftDamageBoosters'
-        inventory = self.get_inventory()
-        boosters = inventory.active.get(kind, {})
+        boosters = self.inventory.active.get(kind, {})
         quality = 0
         for q, boost in boosters.items():
             if boost['quality'] * 10 > quality:
@@ -2050,13 +2052,16 @@ class CitizenMilitary(CitizenTravel):
     def get_active_air_damage_booster(self) -> int:
         return self.get_active_damage_booster(False)
 
-    def activate_battle_effect(self, battle_id: int, kind: str) -> Response:
+    def activate_battle_effect(self, battle_id: int, kind: str) -> bool:
         self._report_action('MILITARY_BOOSTER', f'Activated {kind} booster')
-        return self._post_main_activate_battle_effect(battle_id, kind, self.details.citizen_id)
+        resp = self._post_main_activate_battle_effect(battle_id, kind, self.details.citizen_id).json()
+        return not resp.get('error')
 
-    def activate_pp_booster(self, pp_item: types.InvFinalItem) -> Response:
+    def activate_pp_booster(self, pp_item: types.InvFinalItem) -> bool:
         self._report_action('MILITARY_BOOSTER', f'Activated {pp_item["name"]}')
-        return self._post_economy_activate_booster(pp_item['quality'], pp_item['durability'], 'prestige_points')
+        resp = self._post_economy_activate_booster(pp_item['quality'], pp_item['durability'], 'prestige_points').json()
+        self._update_inventory_data(resp)
+        return pp_item.get('kind') in self.inventory.active
 
     def _rw_choose_side(self, battle: classes.Battle, side: classes.BattleSide) -> Response:
         return self._post_main_battlefield_travel(side.id, battle.id)
@@ -2217,6 +2222,11 @@ class CitizenMilitary(CitizenTravel):
                 if division.wall['dom'] == 50 or division.wall['dom'] > 98:
                     yield division, division.wall['for'] == battle.invader.country.id
 
+    def report_fighting(self, battle: classes.Battle, invader: bool, division: classes.BattleDivision, damage: float, hits: int):
+        self.reporter.report_fighting(battle, invader, division, damage, hits)
+        if self.config.telegram:
+            self.telegram.report_fight(battle, invader, division, damage, hits)
+
 
 class CitizenPolitics(BaseCitizen):
     def get_country_parties(self, country: constants.Country = None) -> dict:
@@ -2616,17 +2626,21 @@ class Citizen(CitizenAnniversary, CitizenCompanies, CitizenLeaderBoard,
         data = self._get_main_weekly_challenge_data().json()
         self.details.pp = data.get("player", {}).get("prestigePoints", 0)
         self.details.next_pp.clear()
+        max_collectable_id = data.get('maxRewardId')
+        should_collect = False
         for reward in data.get("rewards", {}).get("normal", {}):
             status = reward.get("status", "")
             if status == "rewarded":
                 continue
             elif status == "completed":
-                self._post_main_weekly_challenge_reward(reward.get("id", 0))
+                should_collect = True
             elif reward.get("icon", "") == "energy_booster":
                 pps = re.search(r"Reach (\d+) Prestige Points to unlock the following reward: \+1 Energy",
                                 reward.get("tooltip", ""))
                 if pps:
                     self.details.next_pp.append(int(pps.group(1)))
+        if should_collect:
+            self._post_main_weekly_challenge_collect_all(max_collectable_id)
 
     def should_fight(self, silent: bool = True) -> Tuple[int, str, bool]:
         count, log_msg, force_fight = super().should_fight()
@@ -2669,10 +2683,12 @@ class Citizen(CitizenAnniversary, CitizenCompanies, CitizenLeaderBoard,
             else:
                 start_time = utils.good_timedelta(start_time.replace(minute=0), timedelta(hours=1))
             while not self.stop_threads.is_set():
-                self.update_citizen_info()
                 start_time = utils.good_timedelta(start_time, timedelta(minutes=30))
+                self.update_citizen_info()
+                self.update_weekly_challenge()
                 self.send_state_update()
                 self.send_inventory_update()
+                self.update_companies()
                 self.send_my_companies_update()
                 sleep_seconds = (start_time - self.now).total_seconds()
                 self.stop_threads.wait(sleep_seconds if sleep_seconds > 0 else 0)
@@ -2687,7 +2703,7 @@ class Citizen(CitizenAnniversary, CitizenCompanies, CitizenLeaderBoard,
         self.reporter.send_state_update(**data)
 
     def send_inventory_update(self):
-        self.reporter.report_action("INVENTORY", json_val=self.get_inventory(True).as_dict)
+        self.reporter.report_action("INVENTORY", json_val=self.inventory.as_dict)
 
     def send_my_companies_update(self):
         self.reporter.report_action('COMPANIES', json_val=self.my_companies.as_dict)

erepublik/classes.py

@@ -7,7 +7,7 @@ from typing import Any, Dict, Generator, Iterable, List, NamedTuple, NoReturn, T
 
 from requests import Response, Session, post
 
-from . import constants, utils, types
+from . import constants, types, utils
 
 __all__ = ['Battle', 'BattleDivision', 'BattleSide', 'Company', 'Config', 'Details', 'Energy', 'ErepublikException',
            'ErepublikNetworkException', 'EnergyToFight',
@@ -974,7 +974,7 @@ class TelegramReporter:
         self._last_time = utils.good_timedelta(utils.now(), datetime.timedelta(minutes=-5))
         self._last_full_energy_report = utils.good_timedelta(utils.now(), datetime.timedelta(minutes=-30))
         if self.__queue:
-            self.send_message("\n\n––––––––––––––––––––––\n\n".join(self.__queue))
+            self.send_message("Telegram initialized")
 
     def send_message(self, message: str) -> bool:
         self.__queue.append(message)
@@ -1002,13 +1002,19 @@ class TelegramReporter:
         new_line = '\n' if multiple else ''
         self.send_message(f"New award: {new_line}*{msg}*")
 
+    def report_fight(self, battle: "Battle", invader: bool, division: "BattleDivision", damage: float, hits: int):
+        side_txt = (battle.invader if invader else battle.defender).country.iso
+        self.send_message(f"*Fight report*:\n{int(damage):,d} dmg ({hits} hits) in"
+                          f" [battle {battle.id} for {battle.region_name[:16]}]({battle.link}) in d{division.div} on "
+                          f"{side_txt} side")
+
     def __send_messages(self):
         while self._next_time > utils.now():
             if self.__thread_stopper.is_set():
                 break
             self.__thread_stopper.wait(utils.get_sleep_seconds(self._next_time))
 
-        message = "\n\n––––––––––––––––––––––\n\n".join(self.__queue)
+        message = "\n––––––––––––––––––––––\n\n".join(self.__queue)
         if self.player_name:
             message = f"Player *{self.player_name}*\n" + message
         response = post(self.api_url, json=dict(chat_id=self.chat_id, text=message, parse_mode="Markdown"))
@@ -1030,7 +1036,7 @@ class OfferItem(NamedTuple):
 class Inventory:
     final: types.InvFinal
     active: types.InvFinal
-    boosters: types.InvFinal
+    boosters: types.InvBooster
     raw: types.InvRaw
     market: types.InvRaw
     used: int

erepublik/types.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Dict, Union, List
+from typing import Dict, List, Union
 
 InvFinalItem = Dict[str, Union[str, int, List[Dict[str, Union[int, datetime]]]]]
 InvBooster = Dict[str, Dict[int, Dict[int, InvFinalItem]]]

requirements_dev.txt

@@ -5,14 +5,15 @@ flake8==3.8.4
 ipython>=7.19.0
 isort==5.7.0
 pip==20.3.3
+pre-commit==2.9.3
+pur==5.3.0
 PyInstaller==4.1
-pytz>=2020.0
+PySocks==1.7.1
 pytest==6.2.1
+pytz>=2020.5
+requests>=2.25.1
 responses==0.12.1
 setuptools==51.1.1
 Sphinx==3.4.2
-requests>=2.24.0,<2.26.0
-PySocks==1.7.1
 twine==3.3.0
 wheel==0.36.2
-pur==5.3.0

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.23.4
+current_version = 0.23.4.7
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)\.?(?P<dev>\d+)?
@@ -37,4 +37,3 @@ warn_unused_configs = True
 [isort]
 multi_line_output = 2
 line_length = 120
-not_skip = __init__.py

setup.py

@@ -50,6 +50,6 @@ setup(
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/eeriks/erepublik/',
-    version='0.23.4',
+    version='0.23.4.7',
     zip_safe=False,
 )