Bump version: 0.23.4.3 → 0.23.4.4

`{"stock":10.494533,"consume":10.5}` rounds to 0

.editorconfig

@@ -19,3 +19,8 @@ insert_final_newline = false
 
 [Makefile]
 indent_style = tab
+
+[*.py]
+line_length=120
+multi_line_output=0
+balanced_wrapping=True

.github/ISSUE_TEMPLATE.md

@@ -1,6 +1,6 @@
-* eRepublik script version:
+*   eRepublik script version:
-* Python version:
+*   Python version:
-* Operating System:
+*   Operating System:
 
 ### Description
 
@@ -9,7 +9,7 @@ Tell us what happened, what went wrong, and what you expected to happen.
 
 ### What I Did
 
-```
+``` python
 Paste the command(s) you ran and the output.
 If there was a crash, please include the traceback here.
 ```

.github/workflows/pythonpackage.yml

@@ -0,0 +1,33 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements_dev.txt
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pip install pytest
+        pytest

.gitignore

@@ -37,7 +37,6 @@ pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
-.tox/
 .coverage
 .coverage.*
 .cache
@@ -85,7 +84,7 @@ celerybeat-schedule
 
 # virtualenv
 .venv
-venv/
+venv*/
 ENV/
 
 # Spyder project settings
@@ -103,4 +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

.travis.yml

@@ -1,14 +0,0 @@
-# Config file for automatic testing at travis-ci.org
-
-language: python
-python:
-  - 3.7
-  - 3.6
-
-# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
-install: pip install -U tox-travis
-
-# Command to run tests, e.g. python setup.py test
-script: tox
-
-

CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/eeriks/erepublik_script/issues.
+Report bugs at https://github.com/eeriks/erepublik/issues.
 
 If you are reporting a bug, please include:
 
@@ -23,12 +23,6 @@ If you are reporting a bug, please include:
 * Any details about your local setup that might be helpful in troubleshooting.
 * Detailed steps to reproduce the bug.
 
-Fix Bugs
-~~~~~~~~
-
-Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
-wanted" is open to whoever wants to implement it.
-
 Implement Features
 ~~~~~~~~~~~~~~~~~~
 
@@ -45,7 +39,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/eeriks/erepublik_script/issues.
+The best way to send feedback is to file an issue at https://github.com/eeriks/erepublik/issues.
 
 If you are proposing a feature:
 
@@ -59,10 +53,10 @@ Get Started!
 
 Ready to contribute? Here's how to set up `erepublik` for local development.
 
-1. Fork the `erepublik_script` repo on GitHub.
+1. Fork the `erepublik` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone git@github.com:your_name_here/erepublik_script.git
+    $ git clone git@github.com:your_name_here/erepublik.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
@@ -76,14 +70,14 @@ Ready to contribute? Here's how to set up `erepublik` for local development.
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8 and the
+5. When you're done making changes, check that your changes pass flake8, isort and the
-   tests, including testing other Python versions with tox::
+   tests::
 
     $ flake8 erepublik tests
-    $ python setup.py test or py.test
+    $ isort erepublik
-    $ tox
+    $ python setup.py test
 
-   To get flake8 and tox, just pip install them into your virtualenv.
+   To get flake8 and isort, just pip install them into your virtualenv.
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -103,7 +97,7 @@ Before you submit a pull request, check that it meets these guidelines:
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
 3. The pull request should work for Python 3.7.1. Check
-   https://travis-ci.org/eeriks/erepublik_script/pull_requests
+   https://travis-ci.org/eeriks/erepublik/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
 Tips
@@ -112,7 +106,7 @@ Tips
 To run a subset of tests::
 
 
-    $ python -m unittest tests.test_erepublik_script
+    $ python -m unittest tests.test_erepublik
 
 Deploying
 ---------

HISTORY.rst

@@ -2,6 +2,126 @@
 History
 =======
 
+0.23.4 (2021-01-05)
+-------------------
+* Added expiration data to inventory items
+* Inventory is now based on `classes.Inventory`
+* Requirement update to make them more flexible regarding versions required
+* Restructured inventory
+
+0.23.3 (2020-12-17)
+-------------------
+* Fixed carpet bombing
+* Fixed hits done amount when fighting on ground
+* Minor requirement updates
+* Minor tweaks to method signatures
+* Fixed buy food if unable to work or train because not enough energy and not enough food
+* Fixed applications for party presidency and congress if not a party member
+* Removed tox
+* Updates to github.io config generator
+* Fixed `Citizen.concurrency_available` stuck in unset state if exception is being raised while doing concurrency task
+
+0.23.2 (2020-12-01)
+-------------------
+* Added concurrency checks to guard against simultaneous fighting/wam'ing/traveling
+* For concurrency checking use `utils.wait_for_lock` decorator
+
+0.23.1 (2020-12-01)
+-------------------
+* Separated battle finding logic from CitizenMilitary.find_battle_and_fight method
+* Base dmg calculations
+* Get max hit value for divisions on current side
+* Added method to get division stats
+* Wheel of fortune updates
+
+0.23.0 (2020-11-26)
+-------------------
+* ***0.23 - last officially supported version for Python 3.7.***
+* Added `Config.maverick` switch, to allow/deny automated fighting in non native divisions if the player has MaverickPack
+* Added `CitizenMedia.get_article(article_id:int)` method to get article data
+* Added `CitizenMedia.delete_article(article_id:int)` method to delete article
+* Fixed `CitizenTravel.travel_to_region(region_id:int)` method
+* Added `CitizenAnniversary.collect_map_quest_node(node_id:int, extra:bool=False)` to collect also extra rewards
+* Fixed `CitizenTasks.work()` when employer out of money - resign and find a new job
+* Fixed `CitizenEconomy.post_market_offer()`
+
+0.22.3 (2020-11-16)
+-------------------
+* Fixed round to even bug when doing wam and not enough raw.
+* Added meta industry airplaneRaw
+* Added method `Citizen.buy_market_offer(OfferItem, amount=None)` to directly buy market offer with included travel to country and back.
+
+0.22.2 (2020-11-09)
+-------------------
+* Allow querying market offers for q2-q5 aircrafts
+* Added "Ticket" industry
+
+0.22.1 (2020-11-04)
+-------------------
+* Requirement update
+* Unified product naming in inventory and other places based on `erepublik.constants.INDUSTRIES` values
+* `erepublik.Citizen` parameter `auto_login` now defaults to `False`
+* Continued work on more verbose action and result logging
+
+0.22.0 (2020-10-22)
+-------------------
+* Ability to dump session and restore from file
+* Proxy support
+* Inventory updates
+* Remove market offers
+* Memory and network optimizations
+* Python 3.6 supported
+
+0.20.0 (2020-06-15)
+-------------------
+* Massive restructuring
+* Restricted IP check
+* Bomb deploy improvements
+* More verbose action logging
+* Division switching for maverick scripts
+* New medal endpoint is correctly parsed
+* WAM/Employ modularized
+
+
+0.19.0 (2020-01-13)
+-------------------
+* Created method for current products on sale.
+* Updated inventory to also include products on sale
+* set_default_weapon() - eRepublik should return list with all available weapon qualities, but when a battle is just launched, they return only dict with barehands
+* fight() - no longer calls self.set_default_weapon()
+* find_battle_and_fight() - now calls self.set_default_weapon() just before fighting
+* update_war_info() - returns previous battle list if responses 'last_updated' isn't more than 30s old
+* get_battle_for_war(war_id) - returns Battle instance for specific war, if battle is active for given war
+* Citizen.get_raw_surplus() fixed and moved to Citizen.my_companies.get_wam_raw_usage()
+* Implemented division switching
+* improved multi bomb deploy with auto traveling,
+* Citizen.fight() simplified battle data gathering logic -> Citizen.shoot logic improved
+
+
+0.17.0 (2019-11-21)
+-------------------
+
+* 12th anniversary's endpoints added
+* Telegram message queue optimisation
+* WC end fighting energy bugfix
+* More strict fighting limiting before week change
+* Improved and fixed ground damage booster usage
+
+
+0.16.0 (2019-09-29)
+-------------------
+
+* Telegram notification integration
+* Improved serialization to JSON
+* When failing to do WAM because of not enough food - buy food
+* Buy food buys 48h worth instead of 24h energy
+
+
+0.15.3 (2019-08-24)
+-------------------
+
+* Update after eRepublik changed campaign apis
+
 
 0.15.0 (2019-07-30)
 -------------------
@@ -15,6 +135,7 @@ History
 
 * Wall post comment endpoints updated with comment create endpoints.
 
+
 0.1.0 (2019-07-19)
 ------------------
 

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

@@ -43,9 +43,10 @@ clean-pyc: ## remove Python file artifacts
 	find . -name '*.pyo' -exec rm -f {} +
 	find . -name '*~' -exec rm -f {} +
 	find . -name '__pycache__' -exec rm -fr {} +
+	rm -rf debug/
+	rm -rf log/
 
 clean-test: ## remove test and coverage artifacts
-	rm -fr .tox/
 	rm -f .coverage
 	rm -fr htmlcov/
 	rm -fr .pytest_cache
@@ -56,9 +57,6 @@ lint: ## check style with flake8
 test: ## run tests quickly with the default Python
 	python setup.py test
 
-test-all: ## run tests on every Python version with tox
-	tox
-
 coverage: ## check code coverage quickly with the default Python
 	coverage run --source erepublik setup.py test
 	coverage report -m

README.rst

@@ -6,16 +6,20 @@ eRepublik script
 .. image:: https://img.shields.io/pypi/v/erepublik.svg
         :target: https://pypi.python.org/pypi/erepublik
 
-.. image:: https://readthedocs.org/projects/erepublik_script/badge/?version=latest
+.. image:: https://readthedocs.org/projects/erepublik/badge/?version=latest
-        :target: https://erepublik_script.readthedocs.io/en/latest/?badge=latest
+        :target: https://erepublik.readthedocs.io/en/latest/?badge=latest
         :alt: Documentation Status
 
+.. image:: https://api.codacy.com/project/badge/Grade/eaa7ae43d23f4c0abab65c3bde89475a
+        :target: https://app.codacy.com/manual/eeriks/erepublik?utm_source=github.com&utm_medium=referral&utm_content=eeriks/erepublik&utm_campaign=Badge_Grade_Dashboard
+        :alt: Codacy Badge
+
 
 Python package for automated eRepublik playing
 
 
 * Free software: MIT license
-* Documentation: https://erepublik.readthedocs.io.
+* Documentation: https://erepublik.readthedocs.io/en/latest/
 
 
 Features

config.json

@@ -33,4 +33,4 @@
  "travel_to_fight": true,
  "wam": true,
  "work": true
-}
+}

docs/conf.py

@@ -23,6 +23,7 @@ import sys
 sys.path.insert(0, os.path.abspath('..'))
 
 import erepublik
+import edx_theme
 
 # -- General configuration ---------------------------------------------
 
@@ -32,7 +33,7 @@ import erepublik
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'edx_theme']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -84,7 +85,8 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'edx_theme'
+html_theme_path = [edx_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the
@@ -158,6 +160,3 @@ texinfo_documents = [
      'One line description of project.',
      'Miscellaneous'),
 ]
-
-
-

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

@@ -0,0 +1,508 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="description" content="">
+    <meta name="author" content="Eriks Karls">
+    <meta name="generator" content="Jekyll v4.0.1">
+    <title>eBot configuration</title>
+    <!-- CSS only -->
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/css/bootstrap.min.css" integrity="sha384-TX8t27EcRE3e/ihU7zmQxVncDAy5uIKz4rEkgIXeMed4M0jlfIDPvg6uqKI2xXr2" crossorigin="anonymous">
+
+    <!-- JS, Popper.js, and jQuery -->
+    <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
+    <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js" integrity="sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN" crossorigin="anonymous"></script>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/js/bootstrap.min.js" integrity="sha384-w1Q4orYjBQndcko6MimVbzY0tgp4pWB4lZ7lr30WKz0vr/aWKhXdBNmNb5D92v7s" crossorigin="anonymous"></script>
+</head>
+<body>
+<div class="container">
+    <div class="p-3 text-center">
+        <h1>eBot configuration file generator</h1>
+<!--        <h2>-->
+<!--            <span class="d-inline d-sm-none d-md-none d-lg-none d-xl-none">XS</span>-->
+<!--            <span class="d-none d-sm-inline d-md-none d-lg-none d-xl-none">SM</span>-->
+<!--            <span class="d-none d-sm-none d-md-inline d-lg-none d-xl-none">MD</span>-->
+<!--            <span class="d-none d-sm-none d-md-none d-lg-inline d-xl-none">LG</span>-->
+<!--            <span class="d-none d-sm-none d-md-none d-lg-none d-xl-inline">XL</span>-->
+<!--        </h2>-->
+    </div>
+    <div class="row pt-4">
+        <div class="col-12">
+            <form>
+                <div class="row">
+                    <div class="col-12 col-sm-8 col-md-6">
+                        <h3>Login data</h3>
+                        <div class="form-group">
+                            <label for="email" class="hidden"></label><input type="email" class="form-control" onchange="updateJson()" id="email" placeholder="E-mail...">
+                            <label for="password" class="hidden"></label><input type="password" class="form-control" onchange="updateJson()" id="password" disabled placeholder="Password..."
+                                   aria-describedby="passwordHelpBlock">
+                            <small id="passwordHelpBlock" class="form-text text-muted"><strong>NEVER</strong> enter Your passwords on 3rd party sites and <strong class="text-upper">DO NOT</strong> reuse Your
+                                password!</small>
+                        </div>
+                    </div>
+                    <div class="col-6 col-sm-4 col-md-3">
+                        <h3>Basic tasks</h3>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="work" checked>
+                            <label class="custom-control-label" for="work">Work</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="train" checked>
+                            <label class="custom-control-label" for="train">Train</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="ot" checked>
+                            <label class="custom-control-label" for="ot">Work overtime</label>
+                        </div>
+                    </div>
+                </div>
+
+                <div class="row">
+                    <div class="col-12 col-sm-6">
+                        <h3>Production</h3>
+                        <div class="form-group">
+                            <div class="custom-control custom-switch">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="wam" checked>
+                                <label class="custom-control-label" for="wam">Work as manager</label>
+                            </div>
+                            <div class="custom-control custom-switch">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="employees">
+                                <label class="custom-control-label" for="employees">Employ employees</label>
+                            </div>
+                            <div class="custom-control custom-switch">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_buy_raw" checked>
+                                <label class="custom-control-label" for="auto_buy_raw">Auto buy missing RAW</label>
+                            </div>
+                        </div>
+                        <div class="form-group">
+                            <h6 class="">Auto sell produced products</h6>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_frm">
+                                <label class="custom-control-label" for="auto_sell_frm">Food Raw</label>
+                            </div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_food">
+                                <label class="custom-control-label" for="auto_sell_food">Food</label>
+                            </div>
+                            <div class="clearfix"></div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_wrm">
+                                <label class="custom-control-label" for="auto_sell_wrm">Weapon Raw</label>
+                            </div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_weapons">
+                                <label class="custom-control-label" for="auto_sell_weapons">Weapon</label>
+                            </div>
+                            <div class="clearfix"></div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_hrm">
+                                <label class="custom-control-label" for="auto_sell_hrm">House Raw</label>
+                            </div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_house">
+                                <label class="custom-control-label" for="auto_sell_house">House</label>
+                            </div>
+                            <div class="clearfix"></div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_arm">
+                                <label class="custom-control-label" for="auto_sell_arm">Aircraft Raw</label>
+                            </div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_air">
+                                <label class="custom-control-label" for="auto_sell_air">Aircraft Weapon</label>
+                            </div>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="auto_sell_all">
+                            <label class="custom-control-label" for="auto_sell_all">Auto sell all (also from inventory)</label>
+                        </div>
+                    </div>
+
+                    <div class="col-12 col-sm-6">
+                        <h3>Fighting</h3>
+                        <div class="form-group">
+                            <div class="custom-control custom-switch">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="fight" checked>
+                                <label class="custom-control-label" for="fight">Fight</label>
+                            </div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="air" checked>
+                                <label class="custom-control-label" for="air">Air</label>
+                            </div>
+                            <div class="custom-control custom-switch custom-control-inline">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="ground">
+                                <label class="custom-control-label" for="ground">Ground</label>
+                            </div>
+                            <div class="custom-control custom-switch">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="boosters">
+                                <label class="custom-control-label" for="boosters">Use ground boosters</label>
+                            </div>
+                            <div class="custom-control custom-switch">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="continuous_fighting">
+                                <label class="custom-control-label" for="continuous_fighting">Continue fighting all FF in round</label>
+                            </div>
+                            <div class="custom-control custom-switch">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="next_energy" checked>
+                                <label class="custom-control-label" for="next_energy">Fight for next WC +1hp/6min if reachable by FF</label>
+                            </div>
+                        </div>
+                        <div class="form-group">
+                            <div class="form-check form-check-inline">
+                                <input type="radio" class="form-check-input" onchange="updateJson()" id="all_in" name="fight_amount" value="all_in">
+                                <label class="form-check-label" for="all_in">All energy</label>
+                            </div>
+                            <div class="form-check form-check-inline">
+                                <input type="radio" class="form-check-input" onchange="updateJson()" id="h_energy" name="fight_amount" value="h_energy" checked>
+                                <label class="form-check-label" for="h_energy">1h energy</label>
+                            </div>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="rw_def_side" checked>
+                            <label class="custom-control-label" for="rw_def_side">In RWs fight on right side (occupier/defender)</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="travel_to_fight" checked>
+                            <label class="custom-control-label" for="travel_to_fight">Travel to fight</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="epic_hunt">
+                            <label class="custom-control-label" for="epic_hunt">Hunt epics</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="epic_hunt_ebs">
+                            <label class="custom-control-label" for="epic_hunt_ebs">Spend <small>[all]</small> EBs in epics</label>
+                        </div>
+                    </div>
+                    <div class="col-12 col-sm-6">
+                        <h3 class="mt-4">Misc</h3>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="renew_houses" checked>
+                            <label class="custom-control-label" for="renew_houses">Auto renew houses</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="random_sleep" checked>
+                            <label class="custom-control-label" for="random_sleep">Random sleep</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="buy_gold">
+                            <label class="custom-control-label" for="buy_gold">Auto buy 10g</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="interactive" checked>
+                            <label class="custom-control-label" for="interactive">Interactive</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="debug">
+                            <label class="custom-control-label" for="debug">Debug</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="spin_wheel_of_fortune">
+                            <label class="custom-control-label" for="spin_wheel_of_fortune">Auto spin 10% of cc in WheelOfFortune</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="congress">
+                            <label class="custom-control-label" for="congress">Auto candidate for congress</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="party_president">
+                            <label class="custom-control-label" for="party_president">Auto candidate for party presidency</label>
+                        </div>
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="contribute_cc">
+                            <label class="custom-control-label" for="contribute_cc">Contribute cc to country's account (weekly)</label>
+                        </div>
+                    </div>
+                    <div class="col-12 col-sm-6">
+                        <h3 class="mt-4">Advanced</h3>
+
+                        <div class="form-group">
+                            <div class="custom-control custom-switch">
+                                <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="telegram">
+                                <label class="custom-control-label" for="telegram">Notify trough Telegram</label>
+                            </div>
+
+                            <label for="telegram_chat_id">Telegram's chat ID</label>
+                            <input type="text" class="form-control" onchange="updateJson()" id="telegram_chat_id" placeholder="Chat ID">
+                            <label for="telegram_token">Telegram Bot token</label>
+                            <input type="text" class="form-control" onchange="updateJson()" id="telegram_token" placeholder="864251270:AAFzZZdjspI-kIgJVk4gF3TViGFoHnf8H4o">
+                            <small id="telegramTokenHelp" class="form-text text-muted">Only enter token if You want to use your own Telegram bot for notification sending</small>
+                        </div>
+
+                        <div class="custom-control custom-switch">
+                            <input type="checkbox" class="custom-control-input" onchange="updateJson()" id="proxy">
+                            <label class="custom-control-label" for="proxy">Use proxy</label>
+                        </div>
+                        <label for="proxy_kind">Proxy kind</label>
+                        <div class="form-group">
+                            <select class="form-control custom-select" id="proxy_kind">
+                                <option value="socks" selected>SOCKS5</option>
+                                <option value="http">HTTP</option>
+                            </select>
+                        </div>
+                        <div class="form-group">
+                            <label for="proxy_host">Proxy hostname or IP address</label>
+                            <input type="text" class="form-control" onchange="updateJson()" id="proxy_host" placeholder="localhost">
+                        </div>
+                        <div class="form-group">
+                            <label for="proxy_port">Proxy port</label>
+                            <input type="text" class="form-control" onchange="updateJson()" id="proxy_port" placeholder="8080">
+                        </div>
+                        <div class="form-group">
+                            <label for="proxy_user">Proxy username (optional)</label>
+                            <input type="text" class="form-control" onchange="updateJson()" id="proxy_user" placeholder="user">
+                        </div>
+                        <div class="form-group">
+                            <label for="proxy_password">Proxy password (optional)</label>
+                            <input type="password" class="form-control" onchange="updateJson()" id="proxy_password" placeholder="password" disabled>
+                            <small id="proxyHelpBlock" class="form-text text-muted"><strong>NEVER</strong> enter Your passwords on 3rd party sites and <strong class="text-upper">DO NOT</strong> reuse Your password!</small>
+                        </div>
+                    </div>
+                </div>
+            </form>
+        </div>
+        <div class="col-12">
+            <pre id="json-output"></pre>
+        </div>
+    </div>
+</div>
+<script>
+    function disable(element){
+        element.checked = false;
+        element.disabled = true;
+        element.value = null;
+    }
+
+    function updateJson() {
+        let config = {};
+        let email = document.getElementById('email'); // Generated
+        config.email = email.value;
+        config.password = "";
+        let work = document.getElementById('work'); // Generated
+        config.work = work.checked;
+        let train = document.getElementById('train'); // Generated
+        config.train = train.checked;
+        let ot = document.getElementById('ot'); // Generated
+        config.ot = ot.checked;
+        let renew_houses = document.getElementById('renew_houses'); // Generated
+        config.renew_houses = renew_houses.checked;
+        let random_sleep = document.getElementById('random_sleep'); // Generated
+        config.random_sleep = random_sleep.checked;
+        let spin_wheel_of_fortune = document.getElementById('spin_wheel_of_fortune'); // Generated
+        config.spin_wheel_of_fortune = spin_wheel_of_fortune.checked;
+        let congress = document.getElementById('congress'); // Generated
+        config.congress = congress.checked;
+        let party_president = document.getElementById('party_president'); // Generated
+        config.party_president = party_president.checked;
+        let contribute_cc = document.getElementById('contribute_cc'); // Generated
+        config.contribute_cc = contribute_cc.checked ? 10000 : false;
+        let buy_gold = document.getElementById('buy_gold'); // Generated
+        config.buy_gold = buy_gold.checked;
+        let interactive = document.getElementById('interactive'); // Generated
+        config.interactive = interactive.checked;
+        let debug = document.getElementById('debug'); // Generated
+        config.debug = debug.checked;
+        let wam = document.getElementById('wam'); // Generated
+        config.wam = wam.checked;
+        let employees = document.getElementById('employees'); // Generated
+        config.employees = employees.checked;
+
+        let auto_buy_raw = document.getElementById('auto_buy_raw'); // Generated
+        let auto_sell_all = document.getElementById('auto_sell_all'); // Generated
+        let auto_sell_frm = document.getElementById('auto_sell_frm'); // Generated
+        let auto_sell_food = document.getElementById('auto_sell_food'); // Generated
+        let auto_sell_wrm = document.getElementById('auto_sell_wrm'); // Generated
+        let auto_sell_weapons = document.getElementById('auto_sell_weapons'); // Generated
+        let auto_sell_hrm = document.getElementById('auto_sell_hrm'); // Generated
+        let auto_sell_house = document.getElementById('auto_sell_house'); // Generated
+        let auto_sell_arm = document.getElementById('auto_sell_arm'); // Generated
+        let auto_sell_air = document.getElementById('auto_sell_air'); // Generated
+        if (config.wam || config.employees) {
+            auto_buy_raw.disabled = false;
+            auto_sell_all.disabled = false;
+            auto_sell_frm.disabled = false;
+            auto_sell_food.disabled = false;
+            auto_sell_wrm.disabled = false;
+            auto_sell_weapons.disabled = false;
+            auto_sell_hrm.disabled = false;
+            auto_sell_house.disabled = false;
+            auto_sell_arm.disabled = false;
+            auto_sell_air.disabled = false;
+        } else {
+            disable(auto_buy_raw);
+            disable(auto_sell_all);
+            disable(auto_sell_food);
+            disable(auto_sell_weapons);
+            disable(auto_sell_house);
+            disable(auto_sell_air);
+            disable(auto_sell_frm);
+            disable(auto_sell_wrm);
+            disable(auto_sell_hrm);
+            disable(auto_sell_arm);
+        }
+        config.auto_buy_raw = auto_buy_raw.checked;
+        config.auto_sell_all = auto_sell_all.checked;
+        config.auto_sell = [];
+        if (auto_sell_food.checked) config.auto_sell.push("food");
+        if (auto_sell_weapons.checked) config.auto_sell.push("weapon");
+        if (auto_sell_house.checked) config.auto_sell.push("house");
+        if (auto_sell_air.checked) config.auto_sell.push("airplane");
+        if (auto_sell_frm.checked) config.auto_sell.push("foodRaw");
+        if (auto_sell_wrm.checked) config.auto_sell.push("weaponRaw");
+        if (auto_sell_hrm.checked) config.auto_sell.push("houseRaw");
+        if (auto_sell_arm.checked) config.auto_sell.push("airplaneRaw");
+
+        let fight = document.getElementById('fight'); // Generated
+        config.fight = fight.checked;
+        let air = document.getElementById('air'); // Generated
+        let ground = document.getElementById('ground'); // Generated
+        let boosters = document.getElementById('boosters'); // Generated
+        let continuous_fighting = document.getElementById('continuous_fighting'); // Generated
+        let next_energy = document.getElementById('next_energy'); // Generated
+        let all_in = document.getElementById('all_in'); // Generated
+        let h_energy = document.getElementById('h_energy'); // Generated
+        let rw_def_side = document.getElementById('rw_def_side'); // Generated
+        let travel_to_fight = document.getElementById('travel_to_fight'); // Generated
+        let epic_hunt = document.getElementById('epic_hunt'); // Generated
+        let epic_hunt_ebs = document.getElementById('epic_hunt_ebs'); // Generated
+        if (config.fight) {
+            air.disabled = false;
+            ground.disabled = false;
+            boosters.disabled = false;
+            continuous_fighting.disabled = false;
+            next_energy.disabled = false;
+            all_in.disabled = false;
+            h_energy.disabled = false;
+            rw_def_side.disabled = false;
+            travel_to_fight.disabled = false;
+            epic_hunt.disabled = false;
+            epic_hunt_ebs.disabled = false;
+            if (!epic_hunt.checked) disable(epic_hunt_ebs);
+        } else {
+            disable(air);
+            disable(ground);
+            disable(boosters);
+            disable(continuous_fighting);
+            disable(next_energy);
+            disable(all_in);
+            disable(h_energy);
+            disable(rw_def_side);
+            disable(travel_to_fight);
+            disable(epic_hunt);
+            disable(epic_hunt_ebs);
+        }
+
+        config.air = air.checked;
+        config.ground = ground.checked;
+        config.boosters = boosters.checked;
+        config.continuous_fighting = continuous_fighting.checked;
+        config.next_energy = next_energy.checked;
+        config.all_in = all_in.checked;
+        config.rw_def_side = rw_def_side.checked;
+        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
+        let telegram_token = document.getElementById('telegram_token'); // Generated
+        if (config.telegram) {
+            telegram_chat_id.disabled = false;
+            telegram_token.disabled = false;
+        } else {
+            disable(telegram_chat_id);
+            disable(telegram_token);
+        }
+        config.telegram_chat_id = telegram_chat_id.value;
+        config.telegram_token = telegram_token.value;
+
+        let _proxy = {};
+        let proxy = document.getElementById('proxy'); // Generated
+        let proxy_kind = document.getElementById('proxy_kind'); // Generated
+        let proxy_host = document.getElementById('proxy_host'); // Generated
+        let proxy_port = document.getElementById('proxy_port'); // Generated
+        let proxy_user = document.getElementById('proxy_user'); // Generated
+
+        if (proxy.checked) {
+            proxy_kind.disabled = false;
+            proxy_host.disabled = false;
+            proxy_port.disabled = false;
+            proxy_user.disabled = false;
+        } else {
+            disable(proxy_kind);
+            disable(proxy_host);
+            disable(proxy_port);
+            disable(proxy_user);
+        }
+        _proxy.kind = proxy_kind.value;
+        _proxy.host = proxy_host.value;
+        _proxy.port = proxy_port.value;
+        _proxy.username = proxy_user.value;
+        _proxy.password = ""
+        if (proxy.checked) {
+            delete config._proxy;
+            config.proxy = _proxy;
+        } else {
+            delete config.proxy;
+            config._proxy = {
+                'kind': 'socks or http',
+                'host': 'localhost',
+                'port': 8080,
+                'username': 'optional',
+                'password': 'optional'
+            }
+        }
+        let pre = document.getElementById('json-output');
+        pre.textContent = JSON.stringify(config, null, 2);
+    }
+    updateJson();
+
+
+</script>
+</body>
+</html>
+
+
+<!--
+
+{
+  "email": "",
+  "password": "",
+  "work": true,
+  "train": true,
+  "ot": true,
+  "renew_houses": true,
+  "random_sleep": true,
+  "buy_gold": true,
+  "interactive": true,
+  "debug": true,
+  "wam": true,
+  "employees": true,
+  "auto_buy_raw": true,
+  "auto_sell_all": true,
+  "auto_sell": [
+    "food",
+    "weapon",
+    "house",
+    "airplane",
+    "foodRaw",
+    "weaponRaw",
+    "houseRaw",
+    "airplaneRaw"
+  ],
+  "fight": true,
+  "air": true,
+  "boosters": true,
+  "continuous_fighting": true,
+  "next_energy": true,
+  "all_in": false,
+  "rw_def_side": true,
+  "travel_to_fight": true,
+  "epic_hunt": true,
+  "epic_hunt_ebs": true
+}
+
+ -->

docs/installation.rst

@@ -32,13 +32,13 @@ You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/eeriks/erepublik_script
+    $ git clone git://github.com/eeriks/erepublik
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl  -OL https://github.com/eeriks/erepublik_script/tarball/master
+    $ curl  -OL https://github.com/eeriks/erepublik/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
@@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
     $ python setup.py install
 
 
-.. _Github repo: https://github.com/eeriks/erepublik_script
+.. _Github repo: https://github.com/eeriks/erepublik
-.. _tarball: https://github.com/eeriks/erepublik_script/tarball/master
+.. _tarball: https://github.com/eeriks/erepublik/tarball/master

docs/make.bat

@@ -1,36 +1,36 @@
-@ECHO OFF
+@ECHO OFF
-
+
-pushd %~dp0
+pushd %~dp0
-
+
-REM Command file for Sphinx documentation
+REM Command file for Sphinx documentation
-
+
-if "%SPHINXBUILD%" == "" (
+if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=python -msphinx
+	set SPHINXBUILD=python -msphinx
-)
+)
-set SOURCEDIR=.
+set SOURCEDIR=.
-set BUILDDIR=_build
+set BUILDDIR=_build
-set SPHINXPROJ=erepublik_script
+set SPHINXPROJ=erepublik
-
+
-if "%1" == "" goto help
+if "%1" == "" goto help
-
+
-%SPHINXBUILD% >NUL 2>NUL
+%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
+if errorlevel 9009 (
-	echo.
+	echo.
-	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
-	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.then set the SPHINXBUILD environment variable to point to the full
-	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
-	echo.Sphinx directory to PATH.
+	echo.Sphinx directory to PATH.
-	echo.
+	echo.
-	echo.If you don't have Sphinx installed, grab it from
+	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
+	echo.http://sphinx-doc.org/
-	exit /b 1
+	exit /b 1
-)
+)
-
+
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-goto end
+goto end
-
+
-:help
+:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
-
+
-:end
+:end
-popd
+popd

docs/modules.rst

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

docs/usage.rst

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

erepublik/__init__.py

@@ -4,7 +4,9 @@
 
 __author__ = """Eriks Karls"""
 __email__ = 'eriks@72.lv'
-__version__ = '0.15.1'
+__version__ = '0.23.4.4'
 
-from erepublik import classes, utils
+from erepublik import classes, constants, utils
 from erepublik.citizen import Citizen
+
+__all__ = ["classes", "utils", "Citizen", 'constants']

erepublik/access_points.py

@@ -0,0 +1,701 @@
+import datetime
+import random
+import time
+from typing import Any, Dict, List, Mapping, Union
+
+from requests import Response, Session
+
+from . import constants, utils
+
+__all__ = ['SlowRequests', 'CitizenAPI']
+
+
+class SlowRequests(Session):
+    last_time: datetime.datetime
+    timeout: datetime.timedelta = datetime.timedelta(milliseconds=500)
+    uas: List[str] = [
+        # Chrome
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36',
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36',
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36',
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.106 Safari/537.36',
+        'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36',
+        'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.125 Safari/537.36',
+        'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36',
+        'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.106 Safari/537.36',
+
+        # FireFox
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:83.0) Gecko/20100101 Firefox/83.0',
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:82.0) Gecko/20100101 Firefox/82.0',
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:81.0) Gecko/20100101 Firefox/81.0',
+        'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:80.0) Gecko/20100101 Firefox/80.0',
+        'Mozilla/5.0 (X11; Linux x86_64; rv:83.0) Gecko/20100101 Firefox/83.0',
+        'Mozilla/5.0 (X11; Linux x86_64; rv:82.0) Gecko/20100101 Firefox/82.0',
+        'Mozilla/5.0 (X11; Linux x86_64; rv:81.0) Gecko/20100101 Firefox/81.0',
+        'Mozilla/5.0 (X11; Linux x86_64; rv:80.0) Gecko/20100101 Firefox/80.0',
+    ]
+    debug: bool = False
+
+    def __init__(self, proxies: Dict[str, str] = None):
+        super().__init__()
+        if proxies:
+            self.proxies = proxies
+        self.request_log_name = utils.get_file(utils.now().strftime("debug/requests_%Y-%m-%d.log"))
+        self.last_time = utils.now()
+        self.headers.update({
+            'User-Agent': random.choice(self.uas)
+        })
+
+    @property
+    def as_dict(self):
+        return dict(last_time=self.last_time, timeout=self.timeout, user_agent=self.headers['User-Agent'],
+                    request_log_name=self.request_log_name, debug=self.debug)
+
+    def request(self, method, url, *args, **kwargs):
+        self._slow_down_requests()
+        self._log_request(url, method, **kwargs)
+        resp = super().request(method, url, *args, **kwargs)
+        self._log_response(url, resp)
+        return resp
+
+    def _slow_down_requests(self):
+        ltt = utils.good_timedelta(self.last_time, self.timeout)
+        if ltt > utils.now():
+            seconds = (ltt - utils.now()).total_seconds()
+            time.sleep(seconds if seconds > 0 else 0)
+        self.last_time = utils.now()
+
+    def _log_request(self, url, method, data=None, json=None, params=None, **kwargs):
+        if self.debug:
+            args = {}
+            kwargs.pop('allow_redirects', None)
+            if kwargs:
+                args.update({'kwargs': kwargs})
+
+            if data:
+                args.update({"data": data})
+
+            if json:
+                args.update({"json": json})
+
+            if params:
+                args.update({"params": params})
+
+            body = f"[{utils.now().strftime('%F %T')}]\tURL: '{url}'\tMETHOD: {method}\tARGS: {args}\n"
+            with open(self.request_log_name, 'ab') as file:
+                file.write(body.encode("UTF-8"))
+            pass
+
+    def _log_response(self, url, resp, redirect: bool = False):
+        from erepublik import Citizen
+        if self.debug:
+            if resp.history and not redirect:
+                for hist_resp in resp.history:
+                    self._log_request(hist_resp.request.url, "REDIRECT")
+                    self._log_response(hist_resp.request.url, hist_resp, redirect=True)
+
+            fd_path = 'debug/requests'
+            fd_time = self.last_time.strftime('%Y/%m/%d/%H-%M-%S')
+            fd_name = utils.slugify(url[len(Citizen.url):])
+            fd_extra = "_REDIRECT" if redirect else ""
+
+            try:
+                utils.json.loads(resp.text)
+                fd_ext = 'json'
+            except utils.json.JSONDecodeError:
+                fd_ext = 'html'
+
+            filename = f'{fd_path}/{fd_time}_{fd_name}{fd_extra}.{fd_ext}'
+            utils.write_file(filename, resp.text)
+        pass
+
+
+class CitizenBaseAPI:
+    url: str = "https://www.erepublik.com/en"
+    _req: SlowRequests
+    token: str
+
+    def __init__(self):
+        """ Class for unifying eRepublik known endpoints and their required/optional parameters """
+        self._req = SlowRequests()
+        self.token = ""
+
+    def post(self, url: str, data=None, json=None, **kwargs) -> Response:
+        return self._req.post(url, data, json, **kwargs)
+
+    def get(self, url: str, **kwargs) -> Response:
+        return self._req.get(url, **kwargs)
+
+    def _get_main(self) -> Response:
+        return self.get(self.url)
+
+    def set_socks_proxy(self, host: str, port: int, username: str = None, password: str = None):
+        url = f'socks5://{username}:{password}@{host}:{port}' if username and password else f'socks5://{host}:{port}'
+        self._req.proxies = dict(http=url, https=url)
+
+    def set_http_proxy(self, host: str, port: int, username: str = None, password: str = None):
+        url = f'http://{username}:{password}@{host}:{port}' if username and password else f'socks5://{host}:{port}'
+        self._req.proxies = dict(http=url)
+
+
+class ErepublikAnniversaryAPI(CitizenBaseAPI):
+    def _post_main_collect_anniversary_reward(self) -> Response:
+        return self.post(f"{self.url}/main/collect-anniversary-reward", data={"_token": self.token})
+
+    # 12th anniversary endpoints
+    def _get_anniversary_quest_data(self) -> Response:
+        return self.get(f"{self.url}/main/anniversaryQuestData")
+
+    def _post_map_rewards_unlock(self, node_id: int) -> Response:
+        data = {'nodeId': node_id, '_token': self.token}
+        return self.post(f"{self.url}/main/map-rewards-unlock", data=data)
+
+    def _post_map_rewards_speedup(self, node_id: int, currency_amount: int) -> Response:
+        data = {'nodeId': node_id, '_token': self.token, "currencyCost": currency_amount}
+        return self.post(f"{self.url}/main/map-rewards-speedup", data=data)
+
+    def _post_map_rewards_claim(self, node_id: int, extra: bool = False) -> Response:
+        data = {'nodeId': node_id, '_token': self.token}
+        if extra:
+            data['claimExtra'] = 1
+        return self.post(f"{self.url}/main/map-rewards-claim", data=data)
+
+    def _post_main_wheel_of_fortune_spin(self, cost) -> Response:
+        return self.post(f"{self.url}/main/wheeloffortune-spin", data={'_token': self.token, "_currentCost": cost})
+
+    def _post_main_wheel_of_fortune_build(self) -> Response:
+        return self.post(f"{self.url}/main/wheeloffortune-build", data={'_token': self.token})
+
+
+class ErepublikArticleAPI(CitizenBaseAPI):
+    def _get_main_article_json(self, article_id: int) -> Response:
+        return self.get(f"{self.url}/main/articleJson/{article_id}")
+
+    def _get_main_delete_article(self, article_id: int) -> Response:
+        return self.get(f"{self.url}/main/delete-article/{article_id}/1")
+
+    def _post_main_article_comments(self, article_id: int, page: int = 1) -> Response:
+        data = dict(_token=self.token, articleId=article_id, page=page)
+        if page:
+            data.update({'page': page})
+        return self.post(f"{self.url}/main/articleComments", data=data)
+
+    def _post_main_article_comments_create(self, message: str, article_id: int, parent: int = 0) -> Response:
+        data = dict(_token=self.token, message=message, articleId=article_id)
+        if parent:
+            data.update({"parentId": parent})
+        return self.post(f"{self.url}/main/articleComments/create", data=data)
+
+    def _post_main_donate_article(self, article_id: int, amount: int) -> Response:
+        data = dict(_token=self.token, articleId=article_id, amount=amount)
+        return self.post(f"{self.url}/main/donate-article", data=data)
+
+    def _post_main_write_article(self, title: str, content: str, country_id: int, kind_id: int) -> Response:
+        data = dict(_token=self.token, article_name=title, article_body=content, article_location=country_id,
+                    article_category=kind_id)
+        return self.post(f"{self.url}/main/write-article", data=data)
+
+    def _post_main_vote_article(self, article_id: int) -> Response:
+        data = dict(_token=self.token, articleId=article_id)
+        return self.post(f"{self.url}/main/vote-article", data=data)
+
+
+class ErepublikCompanyAPI(CitizenBaseAPI):
+    def _post_economy_assign_to_holding(self, factory_id: int, holding_id: int) -> Response:
+        data = dict(_token=self.token, factoryId=factory_id, action="assign", holdingCompanyId=holding_id)
+        return self.post(f"{self.url}/economy/assign-to-holding", data=data)
+
+    def _post_economy_create_company(self, industry_id: int, building_type: int = 1) -> Response:
+        data = {"_token": self.token, "company[industry_id]": industry_id, "company[building_type]": building_type}
+        return self.post(f"{self.url}/economy/create-company", data=data,
+                         headers={"Referer": f"{self.url}/economy/create-company"})
+
+    def _get_economy_inventory_items(self) -> Response:
+        return self.get(f"{self.url}/economy/inventory-items/")
+
+    def _get_economy_job_market_json(self, country_id: int) -> Response:
+        return self.get(f"{self.url}/economy/job-market-json/{country_id}/1/desc")
+
+    def _get_economy_my_companies(self) -> Response:
+        return self.get(f"{self.url}/economy/myCompanies")
+
+    def _post_economy_train(self, tg_ids: List[int]) -> Response:
+        data: Dict[str, Union[int, str]] = {}
+        for idx, tg_id in enumerate(tg_ids):
+            data["grounds[%i][id]" % idx] = tg_id
+            data["grounds[%i][train]" % idx] = 1
+        if data:
+            data['_token'] = self.token
+        return self.post(f"{self.url}/economy/train", data=data)
+
+    def _post_economy_upgrade_company(self, factory: int, level: int, pin: str = None) -> Response:
+        data = dict(_token=self.token, type="upgrade", companyId=factory, level=level, pin="" if pin is None else pin)
+        return self.post(f"{self.url}/economy/upgrade-company", data=data)
+
+    def _post_economy_work(self, action_type: str, wam: List[int] = None, employ: Dict[int, int] = None) -> Response:
+        data: Dict[str, Union[int, str]] = dict(action_type=action_type, _token=self.token)
+        if action_type == "production":
+            if employ is None:
+                employ = {}
+            if wam is None:
+                wam = []
+            max_idx = 0
+            for company_id in sorted(wam or []):
+                data.update({
+                    f"companies[{max_idx}][id]": company_id,
+                    f"companies[{max_idx}][employee_works]": employ.pop(company_id, 0),
+                    f"companies[{max_idx}][own_work]": 1
+                })
+                max_idx += 1
+            for company_id in sorted(employ or []):
+                data.update({
+                    f"companies[{max_idx}][id]": company_id,
+                    f"companies[{max_idx}][employee_works]": employ.pop(company_id, 0),
+                    f"companies[{max_idx}][own_work]": 0
+                })
+                max_idx += 1
+        return self.post(f"{self.url}/economy/work", data=data)
+
+    def _post_economy_work_overtime(self) -> Response:
+        data = dict(action_type="workOvertime", _token=self.token)
+        return self.post(f"{self.url}/economy/workOvertime", data=data)
+
+    def _post_economy_job_market_apply(self, citizen_id: int, salary: float) -> Response:
+        data = dict(_token=self.token, citizenId=citizen_id, salary=salary)
+        return self.post(f"{self.url}/economy/job-market-apply", data=data)
+
+    def _post_economy_resign(self) -> Response:
+        return self.post(f"{self.url}/economy/resign",
+                         headers={"Content-Type": "application/x-www-form-urlencoded"},
+                         data={"_token": self.token, "action_type": "resign"})
+
+    def _post_economy_sell_company(self, factory_id: int, pin: int = None, sell: bool = True) -> Response:
+        data = dict(_token=self.token, pin="" if pin is None else pin)
+        if sell:
+            data.update({"sell": "sell"})
+        else:
+            data.update({"dissolve": factory_id})
+        return self.post(f"{self.url}/economy/sell-company/{factory_id}",
+                         data=data, headers={"Referer": self.url})
+
+
+class ErepublikCountryAPI(CitizenBaseAPI):
+    def _get_country_military(self, country_name: str) -> Response:
+        return self.get(f"{self.url}/country/military/{country_name}")
+
+    def _post_main_country_donate(self, country_id: int, action: str, value: Union[int, float],
+                                  quality: int = None) -> Response:
+        data = dict(countryId=country_id, action=action, _token=self.token, value=value, quality=quality)
+        return self.post(f"{self.url}/main/country-donate", data=data,
+                         headers={"Referer": f"{self.url}/country/economy/Latvia"})
+
+
+class ErepublikEconomyAPI(CitizenBaseAPI):
+    def _get_economy_citizen_accounts(self, organisation_id: int) -> Response:
+        return self.get(f"{self.url}/economy/citizen-accounts/{organisation_id}")
+
+    def _get_economy_my_market_offers(self) -> Response:
+        return self.get(f"{self.url}/economy/myMarketOffers")
+
+    def _get_main_job_data(self) -> Response:
+        return self.get(f"{self.url}/main/job-data")
+
+    def _post_main_buy_gold_items(self, currency: str, item: str, amount: int) -> Response:
+        data = dict(itemId=item, currency=currency, amount=amount, _token=self.token)
+        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)
+        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}
+        return self.post(f"{self.url}/economy/activateHouse", data=data)
+
+    def _post_economy_donate_items_action(self, citizen_id: int, amount: int, industry: int,
+                                          quality: int) -> Response:
+        data = dict(citizen_id=citizen_id, amount=amount, industry_id=industry, quality=quality, _token=self.token)
+        return self.post(f"{self.url}/economy/donate-items-action", data=data,
+                         headers={"Referer": f"{self.url}/economy/donate-items/{citizen_id}"})
+
+    def _post_economy_donate_money_action(self, citizen_id: int, amount: float = 0.0,
+                                          currency: int = 62) -> Response:
+        data = dict(citizen_id=citizen_id, _token=self.token, currency_id=currency, amount=amount)
+        return self.post(f"{self.url}/economy/donate-money-action", data=data,
+                         headers={"Referer": f"{self.url}/economy/donate-money/{citizen_id}"})
+
+    def _post_economy_exchange_purchase(self, amount: float, currency: int, offer: int) -> Response:
+        data = dict(_token=self.token, amount=amount, currencyId=currency, offerId=offer)
+        return self.post(f"{self.url}/economy/exchange/purchase/", data=data)
+
+    def _post_economy_exchange_retrieve(self, personal: bool, page: int, currency: int) -> Response:
+        data = dict(_token=self.token, personalOffers=int(personal), page=page, currencyId=currency)
+        return self.post(f"{self.url}/economy/exchange/retrieve/", data=data)
+
+    def _post_economy_game_tokens_market(self, action: str) -> Response:
+        assert action in ['retrieve', ]
+        data = dict(_token=self.token, action=action)
+        return self.post(f"{self.url}/economy/gameTokensMarketAjax", data=data)
+
+    def _post_economy_marketplace(self, country: int, industry: int, quality: int,
+                                  order_asc: bool = True) -> Response:
+        data = dict(countryId=country, industryId=industry, quality=quality, ajaxMarket=1,
+                    orderBy="price_asc" if order_asc else "price_desc", _token=self.token)
+        return self.post(f"{self.url}/economy/marketplaceAjax", data=data)
+
+    def _post_economy_marketplace_actions(self, action: str, **kwargs) -> Response:
+        if action == 'buy':
+            data = dict(_token=self.token, offerId=kwargs['offer'], amount=kwargs['amount'],
+                        orderBy="price_asc", currentPage=1, buyAction=1)
+        elif action == 'sell':
+            data = dict(_token=self.token, countryId=kwargs["country_id"], price=kwargs["price"],
+                        industryId=kwargs["industry"], quality=kwargs["quality"], amount=kwargs['amount'],
+                        sellAction='postOffer')
+        elif action == 'delete':
+            data = dict(_token=self.token, offerId=kwargs["offer_id"], sellAction='deleteOffer')
+        else:
+            raise ValueError(f"Action '{action}' is not supported! Only 'buy/sell/delete' actions are available")
+        return self.post(f"{self.url}/economy/marketplaceActions", data=data)
+
+
+class ErepublikLeaderBoardAPI(CitizenBaseAPI):
+    def _get_main_leaderboards_damage_aircraft_rankings(self, country_id: int, weeks: int = 0,
+                                                        mu_id: int = 0) -> Response:  # noqa
+        return self.get(f"{self.url}/main/leaderboards-damage-aircraft-rankings/{country_id}/{weeks}/{mu_id}/0")
+
+    def _get_main_leaderboards_damage_rankings(self, country_id: int, weeks: int = 0, mu_id: int = 0,
+                                               div: int = 0) -> Response:  # noqa
+        return self.get(f"{self.url}/main/leaderboards-damage-rankings/{country_id}/{weeks}/{mu_id}/{div}")
+
+    def _get_main_leaderboards_kills_aircraft_rankings(self, country_id: int, weeks: int = 0,
+                                                       mu_id: int = 0) -> Response:  # noqa
+        return self.get(f"{self.url}/main/leaderboards-kills-aircraft-rankings/{country_id}/{weeks}/{mu_id}/0")
+
+    def _get_main_leaderboards_kills_rankings(self, country_id: int, weeks: int = 0, mu_id: int = 0,
+                                              div: int = 0) -> Response:  # noqa
+        return self.get(f"{self.url}/main/leaderboards-kills-rankings/{country_id}/{weeks}/{mu_id}/{div}")
+
+
+class ErepublikLocationAPI(CitizenBaseAPI):
+    def _get_main_city_data_residents(self, city_id: int, page: int = 1, params: Mapping[str, Any] = None) -> Response:
+        if params is None:
+            params = {}
+        return self.get(f"{self.url}/main/city-data/{city_id}/residents", params={"currentPage": page, **params})
+
+
+class ErepublikMilitaryAPI(CitizenBaseAPI):
+    def _get_military_battle_stats(self, battle_id: int, division: int, division_id: int):
+        return self.get(f"{self.url}/military/battle-stats/{battle_id}/{division}/{division_id}")
+
+    def _get_military_battlefield_choose_side(self, battle_id: int, side_id: int) -> Response:
+        return self.get(f"{self.url}/military/battlefield-choose-side/{battle_id}/{side_id}")
+
+    def _get_military_show_weapons(self, battle_id: int) -> Response:
+        return self.get(f"{self.url}/military/show-weapons", params={'_token': self.token, 'battleId': battle_id})
+
+    def _get_military_campaigns(self) -> Response:
+        return self.get(f"{self.url}/military/campaigns-new/")
+
+    def _get_military_campaigns_json_list(self) -> Response:
+        return self.get(f"{self.url}/military/campaignsJson/list")
+
+    def _get_military_campaigns_json_citizen(self) -> Response:
+        return self.get(f"{self.url}/military/campaignsJson/citizen")
+
+    def _get_military_unit_data(self, unit_id: int, **kwargs) -> Response:
+        params = {"groupId": unit_id, "panel": "members", **kwargs}
+        return self.get(f"{self.url}/military/military-unit-data/", params=params)
+
+    def _post_main_activate_battle_effect(self, battle_id: int, kind: str, citizen_id: int) -> Response:
+        data = dict(battleId=battle_id, citizenId=citizen_id, type=kind, _token=self.token)
+        return self.post(f"{self.url}/main/fight-activateBattleEffect", data=data)
+
+    def _post_main_battlefield_travel(self, side_id: int, battle_id: int) -> Response:
+        data = dict(_token=self.token, sideCountryId=side_id, battleId=battle_id)
+        return self.post(f"{self.url}/main/battlefieldTravel", data=data)
+
+    def _post_main_battlefield_change_division(self, battle_id: int, division_id: int) -> Response:
+        data = dict(_token=self.token, battleZoneId=division_id, battleId=battle_id)
+        return self.post(f"{self.url}/main/battlefieldTravel", data=data)
+
+    def _get_wars_show(self, war_id: int) -> Response:
+        return self.get(f"{self.url}/wars/show/{war_id}")
+
+    def _post_military_fight_activate_booster(self, battle_id: int, quality: int, duration: int, kind: str) -> Response:
+        data = dict(type=kind, quality=quality, duration=duration, battleId=battle_id, _token=self.token)
+        return self.post(f"{self.url}/military/fight-activateBooster", data=data)
+
+    def _post_military_change_weapon(self, battle_id: int, battle_zone: int, weapon_level: int, ) -> Response:
+        data = dict(battleId=battle_id, _token=self.token, battleZoneId=battle_zone, customizationLevel=weapon_level)
+        return self.post(f"{self.url}/military/change-weapon", data=data)
+
+    def _post_military_battle_console(self, battle_id: int, action: str, page: int = 1, **kwargs) -> Response:
+        data = dict(battleId=battle_id, action=action, _token=self.token)
+        if action == "battleStatistics":
+            data.update(round=kwargs["round_id"], zoneId=kwargs["round_id"], leftPage=page, rightPage=page,
+                        division=kwargs["division"], type=kwargs.get("type", 'damage'), )
+        elif action == "warList":
+            data.update(page=page)
+        return self.post(f"{self.url}/military/battle-console", data=data)
+
+    def _post_military_deploy_bomb(self, battle_id: int, division_id: int, side_id: int, bomb_id: int) -> Response:
+        data = dict(battleId=battle_id, battleZoneId=division_id, sideId=side_id, sideCountryId=side_id,
+                    bombId=bomb_id, _token=self.token)
+        return self.post(f"{self.url}/military/deploy-bomb", data=data)
+
+    def _post_military_fight_air(self, battle_id: int, side_id: int, zone_id: int) -> Response:
+        data = dict(sideId=side_id, battleId=battle_id, _token=self.token, battleZoneId=zone_id)
+        return self.post(f"{self.url}/military/fight-shoooot/{battle_id}", data=data)
+
+    def _post_military_fight_ground(self, battle_id: int, side_id: int, zone_id: int) -> Response:
+        data = dict(sideId=side_id, battleId=battle_id, _token=self.token, battleZoneId=zone_id)
+        return self.post(f"{self.url}/military/fight-shooot/{battle_id}", data=data)
+
+    def _post_fight_deploy_deploy_report_data(self, deployment_id: int):
+        data = dict(_token=self.token, deploymentId=deployment_id)
+        return self.post(f"{self.url}/military/fightDeploy-deployReportData", json=data)
+
+
+class ErepublikPoliticsAPI(CitizenBaseAPI):
+    def _get_candidate_party(self, party_slug: str) -> Response:
+        return self.get(f"{self.url}/candidate/{party_slug}")
+
+    def _get_main_party_members(self, party_id: int) -> Response:
+        return self.get(f"{self.url}/main/party-members/{party_id}")
+
+    def _get_main_rankings_parties(self, country_id: int) -> Response:
+        return self.get(f"{self.url}/main/rankings-parties/1/{country_id}")
+
+    def _post_candidate_for_congress(self, presentation: str = "") -> Response:
+        data = dict(_token=self.token, presentation=presentation)
+        return self.post(f"{self.url}/candidate-for-congress", data=data)
+
+    def _get_presidential_elections(self, country_id: int, timestamp: int) -> Response:
+        return self.get(f"{self.url}/main/presidential-elections/{country_id}/{timestamp}")
+
+    def _post_propose_president_candidate(self, party_slug: str, citizen_id: int) -> Response:
+        return self.post(f"{self.url}/propose-president-candidate/{party_slug}",
+                         data=dict(_token=self.token, citizen=citizen_id))
+
+    def _get_auto_propose_president_candidate(self, party_slug: str) -> Response:
+        return self.get(f"{self.url}/auto-propose-president-candidate/{party_slug}")
+
+
+class ErepublikPresidentAPI(CitizenBaseAPI):
+    def _post_wars_attack_region(self, war_id: int, region_id: int, region_name: str) -> Response:
+        data = {'_token': self.token, 'warId': war_id, 'regionName': region_name, 'regionNameConfirm': region_name}
+        return self.post(f'{self.url}/wars/attack-region/{war_id}/{region_id}', data=data)
+
+    def _post_new_war(self, self_country_id: int, attack_country_id: int, debate: str = "") -> Response:
+        data = dict(requirments=1, _token=self.token, debate=debate,
+                    countryNameConfirm=constants.COUNTRIES[attack_country_id].link)
+        return self.post(f"{self.url}/{constants.COUNTRIES[self_country_id].link}/new-war", data=data)
+
+    def _post_new_donation(self, country_id: int, amount: int, org_name: str, debate: str = "") -> Response:
+        data = dict(requirments=1, _token=self.token, debate=debate, currency=1, value=amount, commit='Propose',
+                    type_name=org_name)
+        return self.post(f"{self.url}/{constants.COUNTRIES[country_id].link}/new-donation", data=data)
+
+
+class ErepublikProfileAPI(CitizenBaseAPI):
+    def _get_main_citizen_hovercard(self, citizen_id: int) -> Response:
+        return self.get(f"{self.url}/main/citizen-hovercard/{citizen_id}")
+
+    def _get_main_citizen_profile_json(self, citizen_id: int) -> Response:
+        return self.get(f"{self.url}/main/citizen-profile-json/{citizen_id}")
+
+    def _get_main_citizen_notifications(self) -> Response:
+        return self.get(f"{self.url}/main/citizenDailyAssistant")
+
+    def _get_main_citizen_daily_assistant(self) -> Response:
+        return self.get(f"{self.url}/main/citizenNotifications")
+
+    def _get_main_messages_paginated(self, page: int = 1) -> Response:
+        return self.get(f"{self.url}/main/messages-paginated/{page}")
+
+    def _get_main_money_donation_accept(self, donation_id: int) -> Response:
+        return self.get(f"{self.url}/main/money-donation/accept/{donation_id}", params={"_token": self.token})
+
+    def _get_main_money_donation_reject(self, donation_id: int) -> Response:
+        return self.get(f"{self.url}/main/money-donation/reject/{donation_id}", params={"_token": self.token})
+
+    def _get_main_notifications_ajax_community(self, page: int = 1) -> Response:
+        return self.get(f"{self.url}/main/notificationsAjax/community/{page}")
+
+    def _get_main_notifications_ajax_system(self, page: int = 1) -> Response:
+        return self.get(f"{self.url}/main/notificationsAjax/system/{page}")
+
+    def _get_main_notifications_ajax_report(self, page: int = 1) -> Response:
+        return self.get(f"{self.url}/main/notificationsAjax/report/{page}")
+
+    def _get_main_training_grounds_json(self) -> Response:
+        return self.get(f"{self.url}/main/training-grounds-json")
+
+    def _get_main_weekly_challenge_data(self) -> Response:
+        return self.get(f"{self.url}/main/weekly-challenge-data")
+
+    def _post_main_citizen_add_remove_friend(self, citizen: int, add: bool) -> Response:
+        data = dict(_token=self.token, citizenId=citizen, url="//www.erepublik.com/en/main/citizen-addRemoveFriend")
+        if add:
+            data.update({"action": "addFriend"})
+        else:
+            data.update({"action": "removeFriend"})
+        return self.post(f"{self.url}/main/citizen-addRemoveFriend", data=data)
+
+    def _post_main_daily_task_reward(self) -> Response:
+        return self.post(f"{self.url}/main/daily-tasks-reward", data=dict(_token=self.token))
+
+    def _post_delete_message(self, msg_id: list) -> Response:
+        data = {"_token": self.token, "delete_message[]": msg_id}
+        return self.post(f"{self.url}/main/messages-delete", data)
+
+    def _post_eat(self, color: str) -> Response:
+        data = dict(_token=self.token, buttonColor=color)
+        return self.post(f"{self.url}/main/eat", params=data)
+
+    def _post_main_global_alerts_close(self, alert_id: int) -> Response:
+        data = dict(_token=self.token, alert_id=alert_id)
+        return self.post(f"{self.url}/main/global-alerts/close", data=data)
+
+    def _post_forgot_password(self, email: str) -> Response:
+        data = dict(_token=self.token, email=email, commit="Reset password")
+        return self.post(f"{self.url}/forgot-password", data=data)
+
+    def _post_login(self, email: str, password: str) -> Response:
+        data = dict(csrf_token=self.token, citizen_email=email, citizen_password=password, remember='on')
+        return self.post(f"{self.url}/login", data=data)
+
+    def _post_main_messages_alert(self, notification_ids: List[int]) -> Response:
+        data = {"_token": self.token, "delete_alerts[]": notification_ids, "deleteAllAlerts": "1", "delete": "Delete"}
+        return self.post(f"{self.url}/main/messages-alerts/1", data=data)
+
+    def _post_main_notifications_ajax_community(self, notification_ids: List[int], page: int = 1) -> Response:
+        data = {"_token": self.token, "delete_alerts[]": notification_ids}
+        return self.post(f"{self.url}/main/notificationsAjax/community/{page}", data=data)
+
+    def _post_main_notifications_ajax_system(self, notification_ids: List[int], page: int = 1) -> Response:
+        data = {"_token": self.token, "delete_alerts[]": notification_ids}
+        return self.post(f"{self.url}/main/notificationsAjax/system/{page}", data=data)
+
+    def _post_main_notifications_ajax_report(self, notification_ids: List[int], page: int = 1) -> Response:
+        data = {"_token": self.token, "delete_alerts[]": notification_ids}
+        return self.post(f"{self.url}/main/notificationsAjax/report/{page}", data=data)
+
+    def _post_main_messages_compose(self, subject: str, body: str, citizens: List[int]) -> Response:
+        url_pk = 0 if len(citizens) > 1 else str(citizens[0])
+        data = dict(citizen_name=",".join([str(x) for x in citizens]),
+                    citizen_subject=subject, _token=self.token, citizen_message=body)
+        return self.post(f"{self.url}/main/messages-compose/{url_pk}", data=data)
+
+    def _post_military_group_missions(self) -> Response:
+        data = dict(action="check", _token=self.token)
+        return self.post(f"{self.url}/military/group-missions", data=data)
+
+    def _post_main_weekly_challenge_reward(self, reward_id: int) -> Response:
+        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)
+
+
+class ErepublikTravelAPI(CitizenBaseAPI):
+    def _post_main_travel(self, check: str, **kwargs) -> Response:
+        data = dict(_token=self.token, check=check, **kwargs)
+        return self.post(f"{self.url}/main/travel", data=data)
+
+    def _post_main_travel_data(self, **kwargs) -> Response:
+        return self.post(f"{self.url}/main/travelData", data=dict(_token=self.token, **kwargs))
+
+
+class ErepublikWallPostAPI(CitizenBaseAPI):
+    # ## Country
+
+    def _post_main_country_comment_retrieve(self, post_id: int) -> Response:
+        data = {"_token": self.token, "postId": post_id}
+        return self.post(f"{self.url}/main/country-comment/retrieve/json", data=data)
+
+    def _post_main_country_comment_create(self, post_id: int, comment_message: str) -> Response:
+        data = {"_token": self.token, "postId": post_id, 'comment_message': comment_message}
+        return self.post(f"{self.url}/main/country-comment/create/json", data=data)
+
+    def _post_main_country_post_create(self, body: str, post_as: int) -> Response:
+        data = {"_token": self.token, "post_message": body, "post_as": post_as}
+        return self.post(f"{self.url}/main/country-post/create/json", data=data)
+
+    def _post_main_country_post_retrieve(self) -> Response:
+        data = {"_token": self.token, "page": 1, "switchedFrom": False}
+        return self.post(f"{self.url}/main/country-post/retrieve/json", data=data)
+
+    # ## Military Unit
+
+    def _post_main_military_unit_comment_retrieve(self, post_id: int) -> Response:
+        data = {"_token": self.token, "postId": post_id}
+        return self.post(f"{self.url}/main/military-unit-comment/retrieve/json", data=data)
+
+    def _post_main_military_unit_comment_create(self, post_id: int, comment_message: str) -> Response:
+        data = {"_token": self.token, "postId": post_id, 'comment_message': comment_message}
+        return self.post(f"{self.url}/main/military-unit-comment/create/json", data=data)
+
+    def _post_main_military_unit_post_create(self, body: str, post_as: int) -> Response:
+        data = {"_token": self.token, "post_message": body, "post_as": post_as}
+        return self.post(f"{self.url}/main/military-unit-post/create/json", data=data)
+
+    def _post_main_military_unit_post_retrieve(self) -> Response:
+        data = {"_token": self.token, "page": 1, "switchedFrom": False}
+        return self.post(f"{self.url}/main/military-unit-post/retrieve/json", data=data)
+
+    # ## Party
+
+    def _post_main_party_comment_retrieve(self, post_id: int) -> Response:
+        data = {"_token": self.token, "postId": post_id}
+        return self.post(f"{self.url}/main/party-comment/retrieve/json", data=data)
+
+    def _post_main_party_comment_create(self, post_id: int, comment_message: str) -> Response:
+        data = {"_token": self.token, "postId": post_id, 'comment_message': comment_message}
+        return self.post(f"{self.url}/main/party-comment/create/json", data=data)
+
+    def _post_main_party_post_create(self, body: str) -> Response:
+        data = {"_token": self.token, "post_message": body}
+        return self.post(f"{self.url}/main/party-post/create/json", data=data)
+
+    def _post_main_party_post_retrieve(self) -> Response:
+        data = {"_token": self.token, "page": 1, "switchedFrom": False}
+        return self.post(f"{self.url}/main/party-post/retrieve/json", data=data)
+
+    # ## Friend's Wall
+
+    def _post_main_wall_comment_retrieve(self, post_id: int) -> Response:
+        data = {"_token": self.token, "postId": post_id}
+        return self.post(f"{self.url}/main/wall-comment/retrieve/json", data=data)
+
+    def _post_main_wall_comment_create(self, post_id: int, comment_message: str) -> Response:
+        data = {"_token": self.token, "postId": post_id, 'comment_message': comment_message}
+        return self.post(f"{self.url}/main/wall-comment/create/json", data=data)
+
+    def _post_main_wall_post_create(self, body: str) -> Response:
+        data = {"_token": self.token, "post_message": body}
+        return self.post(f"{self.url}/main/wall-post/create/json", data=data)
+
+    def _post_main_wall_post_retrieve(self) -> Response:
+        data = {"_token": self.token, "page": 1, "switchedFrom": False}
+        return self.post(f"{self.url}/main/wall-post/retrieve/json", data=data)
+
+    # ## Medal posting
+    def _post_main_wall_post_automatic(self, message: str, achievement_id: int) -> Response:
+        return self.post(f"{self.url}/main/wall-post/automatic", data=dict(_token=self.token, message=message,
+                                                                           achievementId=achievement_id))
+
+
+class CitizenAPI(
+    ErepublikArticleAPI, ErepublikCountryAPI, ErepublikCompanyAPI, ErepublikEconomyAPI,
+    ErepublikLeaderBoardAPI, ErepublikLocationAPI, ErepublikMilitaryAPI, ErepublikProfileAPI,
+    ErepublikPresidentAPI, ErepublikPoliticsAPI, ErepublikAnniversaryAPI, ErepublikWallPostAPI,
+    ErepublikTravelAPI
+):
+    pass

erepublik/constants.py

@@ -0,0 +1,191 @@
+import datetime
+from typing import Dict, Optional, Union
+
+import pytz
+
+__all__ = ["erep_tz", 'min_datetime', "max_datetime", "Country", "AIR_RANKS", "COUNTRIES", "FOOD_ENERGY",
+           "GROUND_RANKS", "GROUND_RANK_POINTS", "INDUSTRIES", "TERRAINS"]
+
+erep_tz = pytz.timezone('US/Pacific')
+min_datetime = erep_tz.localize(datetime.datetime(2007, 11, 20))
+max_datetime = erep_tz.localize(datetime.datetime(2281, 9, 4))
+
+
+class Country:
+    id: int
+    name: str
+    link: str
+    iso: str
+
+    def __init__(self, country_id: int, name: str, link: str, iso: str):
+        self.id = country_id
+        self.name = name
+        self.link = link
+        self.iso = iso
+
+    def __hash__(self):
+        return hash((self.id, self.name))
+
+    def __repr__(self):
+        return f"Country({self.id}, '{self.name}', '{self.link}', '{self.iso}')"
+
+    def __str__(self):
+        return f"#{self.id} {self.name}"
+
+    def __format__(self, format_spec):
+        return self.iso
+
+    def __int__(self):
+        return self.id
+
+    def __eq__(self, other):
+        if isinstance(other, (int, float)):
+            return self.id == int(other)
+        else:
+            try:
+                return self.id == int(other)
+            except ValueError:
+                return self == other
+
+    @property
+    def as_dict(self):
+        return dict(id=self.id, name=self.name, iso=self.iso)
+
+
+class Industries:
+    __by_name = {'food': 1, 'weapon': 2, 'ticket': 3, 'house': 4, 'aircraft': 23,
+                 'foodraw': 7, 'weaponraw': 12, 'houseraw': 18, 'aircraftraw': 24, 'airplaneraw': 24,
+                 'frm': 7, 'wrm': 12, 'hrm': 18, 'arm': 24,
+                 'frm q1': 7, 'frm q2': 8, 'frm q3': 9, 'frm q4': 10, 'frm q5': 11,
+                 'wrm q1': 12, 'wrm q2': 13, 'wrm q3': 14, 'wrm q4': 15, 'wrm q5': 16,
+                 'hrm q1': 18, 'hrm q2': 19, 'hrm q3': 20, 'hrm q4': 21, 'hrm q5': 22,
+                 'arm q1': 24, 'arm q2': 25, 'arm q3': 26, 'arm q4': 27, 'arm q5': 28}
+    __by_id = {1: "Food", 2: "Weapon", 3: "Ticket", 4: "House", 23: "Aircraft",
+               7: "foodRaw", 8: "FRM q2", 9: "FRM q3", 10: "FRM q4", 11: "FRM q5",
+               12: "weaponRaw", 13: "WRM q2", 14: "WRM q3", 15: "WRM q4", 16: "WRM q5",
+               17: "houseRaw", 18: "houseRaw", 19: "HRM q2", 20: "HRM q3", 21: "HRM q4", 22: "HRM q5",
+               24: "aircraftRaw", 25: "ARM q2", 26: "ARM q3", 27: "ARM q4", 28: "ARM q5"}
+
+    def __getitem__(self, item) -> Optional[Union[int, str]]:
+        if isinstance(item, int):
+            return self.__by_id.get(item, None)
+        elif isinstance(item, str):
+            return self.__by_name.get(item.lower(), None)
+        return
+
+    def __getattr__(self, item) -> Optional[Union[int, str]]:
+        return self[item]
+
+    @property
+    def as_dict(self):
+        return dict(by_id=self.__by_id, by_name=self.__by_name)
+
+
+AIR_RANKS: Dict[int, str] = {
+    1: "Airman", 2: "Airman 1st Class", 3: "Airman 1st Class*", 4: "Airman 1st Class**", 5: "Airman 1st Class***",
+    6: "Airman 1st Class****", 7: "Airman 1st Class*****", 8: "Senior Airman", 9: "Senior Airman*",
+    10: "Senior Airman**", 11: "Senior Airman***", 12: "Senior Airman****", 13: "Senior Airman*****",
+    14: "Staff Sergeant", 15: "Staff Sergeant*", 16: "Staff Sergeant**", 17: "Staff Sergeant***",
+    18: "Staff Sergeant****", 19: "Staff Sergeant*****", 20: "Aviator", 21: "Aviator*", 22: "Aviator**",
+    23: "Aviator***", 24: "Aviator****", 25: "Aviator*****", 26: "Flight Lieutenant", 27: "Flight Lieutenant*",
+    28: "Flight Lieutenant**", 29: "Flight Lieutenant***", 30: "Flight Lieutenant****", 31: "Flight Lieutenant*****",
+    32: "Squadron Leader", 33: "Squadron Leader*", 34: "Squadron Leader**", 35: "Squadron Leader***",
+    36: "Squadron Leader****", 37: "Squadron Leader*****", 38: "Chief Master Sergeant", 39: "Chief Master Sergeant*",
+    40: "Chief Master Sergeant**", 41: "Chief Master Sergeant***", 42: "Chief Master Sergeant****",
+    43: "Chief Master Sergeant*****", 44: "Wing Commander", 45: "Wing Commander*", 46: "Wing Commander**",
+    47: "Wing Commander***", 48: "Wing Commander****", 49: "Wing Commander*****", 50: "Group Captain",
+    51: "Group Captain*", 52: "Group Captain**", 53: "Group Captain***", 54: "Group Captain****",
+    55: "Group Captain*****", 56: "Air Commodore", 57: "Air Commodore*", 58: "Air Commodore**", 59: "Air Commodore***",
+    60: "Air Commodore****", 61: "Air Commodore*****",
+}
+
+COUNTRIES: Dict[int, Country] = {
+    1: Country(1, 'Romania', 'Romania', 'ROU'), 9: Country(9, 'Brazil', 'Brazil', 'BRA'),
+    10: Country(10, 'Italy', 'Italy', 'ITA'), 11: Country(11, 'France', 'France', 'FRA'),
+    12: Country(12, 'Germany', 'Germany', 'DEU'), 13: Country(13, 'Hungary', 'Hungary', 'HUN'),
+    14: Country(14, 'China', 'China', 'CHN'), 15: Country(15, 'Spain', 'Spain', 'ESP'),
+    23: Country(23, 'Canada', 'Canada', 'CAN'), 24: Country(24, 'USA', 'USA', 'USA'),
+    26: Country(26, 'Mexico', 'Mexico', 'MEX'), 27: Country(27, 'Argentina', 'Argentina', 'ARG'),
+    28: Country(28, 'Venezuela', 'Venezuela', 'VEN'), 29: Country(29, 'United Kingdom', 'United-Kingdom', 'GBR'),
+    30: Country(30, 'Switzerland', 'Switzerland', 'CHE'), 31: Country(31, 'Netherlands', 'Netherlands', 'NLD'),
+    32: Country(32, 'Belgium', 'Belgium', 'BEL'), 33: Country(33, 'Austria', 'Austria', 'AUT'),
+    34: Country(34, 'Czech Republic', 'Czech-Republic', 'CZE'), 35: Country(35, 'Poland', 'Poland', 'POL'),
+    36: Country(36, 'Slovakia', 'Slovakia', 'SVK'), 37: Country(37, 'Norway', 'Norway', 'NOR'),
+    38: Country(38, 'Sweden', 'Sweden', 'SWE'), 39: Country(39, 'Finland', 'Finland', 'FIN'),
+    40: Country(40, 'Ukraine', 'Ukraine', 'UKR'), 41: Country(41, 'Russia', 'Russia', 'RUS'),
+    42: Country(42, 'Bulgaria', 'Bulgaria', 'BGR'), 43: Country(43, 'Turkey', 'Turkey', 'TUR'),
+    44: Country(44, 'Greece', 'Greece', 'GRC'), 45: Country(45, 'Japan', 'Japan', 'JPN'),
+    47: Country(47, 'South Korea', 'South-Korea', 'KOR'), 48: Country(48, 'India', 'India', 'IND'),
+    49: Country(49, 'Indonesia', 'Indonesia', 'IDN'), 50: Country(50, 'Australia', 'Australia', 'AUS'),
+    51: Country(51, 'South Africa', 'South-Africa', 'ZAF'),
+    52: Country(52, 'Republic of Moldova', 'Republic-of-Moldova', 'MDA'),
+    53: Country(53, 'Portugal', 'Portugal', 'PRT'), 54: Country(54, 'Ireland', 'Ireland', 'IRL'),
+    55: Country(55, 'Denmark', 'Denmark', 'DNK'), 56: Country(56, 'Iran', 'Iran', 'IRN'),
+    57: Country(57, 'Pakistan', 'Pakistan', 'PAK'), 58: Country(58, 'Israel', 'Israel', 'ISR'),
+    59: Country(59, 'Thailand', 'Thailand', 'THA'), 61: Country(61, 'Slovenia', 'Slovenia', 'SVN'),
+    63: Country(63, 'Croatia', 'Croatia', 'HRV'), 64: Country(64, 'Chile', 'Chile', 'CHL'),
+    65: Country(65, 'Serbia', 'Serbia', 'SRB'), 66: Country(66, 'Malaysia', 'Malaysia', 'MYS'),
+    67: Country(67, 'Philippines', 'Philippines', 'PHL'), 68: Country(68, 'Singapore', 'Singapore', 'SGP'),
+    69: Country(69, 'Bosnia and Herzegovina', 'Bosnia-Herzegovina', 'BiH'),
+    70: Country(70, 'Estonia', 'Estonia', 'EST'), 80: Country(80, 'Montenegro', 'Montenegro', 'MNE'),
+    71: Country(71, 'Latvia', 'Latvia', 'LVA'), 72: Country(72, 'Lithuania', 'Lithuania', 'LTU'),
+    73: Country(73, 'North Korea', 'North-Korea', 'PRK'), 74: Country(74, 'Uruguay', 'Uruguay', 'URY'),
+    75: Country(75, 'Paraguay', 'Paraguay', 'PRY'), 76: Country(76, 'Bolivia', 'Bolivia', 'BOL'),
+    77: Country(77, 'Peru', 'Peru', 'PER'), 78: Country(78, 'Colombia', 'Colombia', 'COL'),
+    79: Country(79, 'Republic of Macedonia (FYROM)', 'Republic-of-Macedonia-FYROM', 'MKD'),
+    81: Country(81, 'Republic of China (Taiwan)', 'Republic-of-China-Taiwan', 'TWN'),
+    82: Country(82, 'Cyprus', 'Cyprus', 'CYP'), 167: Country(167, 'Albania', 'Albania', 'ALB'),
+    83: Country(83, 'Belarus', 'Belarus', 'BLR'), 84: Country(84, 'New Zealand', 'New-Zealand', 'NZL'),
+    164: Country(164, 'Saudi Arabia', 'Saudi-Arabia', 'SAU'), 165: Country(165, 'Egypt', 'Egypt', 'EGY'),
+    166: Country(166, 'United Arab Emirates', 'United-Arab-Emirates', 'UAE'),
+    168: Country(168, 'Georgia', 'Georgia', 'GEO'), 169: Country(169, 'Armenia', 'Armenia', 'ARM'),
+    170: Country(170, 'Nigeria', 'Nigeria', 'NGA'), 171: Country(171, 'Cuba', 'Cuba', 'CUB')
+}
+
+FOOD_ENERGY: Dict[str, int] = dict(q1=2, q2=4, q3=6, q4=8, q5=10, q6=12, q7=20)
+
+GROUND_RANKS: Dict[int, str] = {
+    1: "Recruit", 2: "Private", 3: "Private*", 4: "Private**", 5: "Private***",
+    6: "Corporal", 7: "Corporal*", 8: "Corporal**", 9: "Corporal***",
+    10: "Sergeant", 11: "Sergeant*", 12: "Sergeant**", 13: "Sergeant***",
+    14: "Lieutenant", 15: "Lieutenant*", 16: "Lieutenant**", 17: "Lieutenant***",
+    18: "Captain", 19: "Captain*", 20: "Captain**", 21: "Captain***",
+    22: "Major", 23: "Major*", 24: "Major**", 25: "Major***",
+    26: "Commander", 27: "Commander*", 28: "Commander**", 29: "Commander***",
+    30: "Lt Colonel", 31: "Lt Colonel*", 32: "Lt Colonel**", 33: "Lt Colonel***",
+    34: "Colonel", 35: "Colonel*", 36: "Colonel**", 37: "Colonel***",
+    38: "General", 39: "General*", 40: "General**", 41: "General***",
+    42: "Field Marshal", 43: "Field Marshal*", 44: "Field Marshal**", 45: "Field Marshal***",
+    46: "Supreme Marshal", 47: "Supreme Marshal*", 48: "Supreme Marshal**", 49: "Supreme Marshal***",
+    50: "National Force", 51: "National Force*", 52: "National Force**", 53: "National Force***",
+    54: "World Class Force", 55: "World Class Force*", 56: "World Class Force**", 57: "World Class Force***",
+    58: "Legendary Force", 59: "Legendary Force*", 60: "Legendary Force**", 61: "Legendary Force***",
+    62: "God of War", 63: "God of War*", 64: "God of War**", 65: "God of War***",
+    66: "Titan", 67: "Titan*", 68: "Titan**", 69: "Titan***",
+    70: "Legends I", 71: "Legends II", 72: "Legends III", 73: "Legends IV", 74: "Legends V", 75: "Legends VI",
+    76: "Legends VII", 77: "Legends VIII", 78: "Legends IX", 79: "Legends X", 80: "Legends XI", 81: "Legends XII",
+    82: "Legends XIII", 83: "Legends XIV", 84: "Legends XV", 85: "Legends XVI", 86: "Legends XVII", 87: "Legends XVIII",
+    88: "Legends XIX", 89: "Legends XX",
+}
+
+GROUND_RANK_POINTS: Dict[int, int] = {
+    1: 0, 2: 15, 3: 45, 4: 80, 5: 120, 6: 170, 7: 250, 8: 350, 9: 450, 10: 600, 11: 800, 12: 1000,
+    13: 1400, 14: 1850, 15: 2350, 16: 3000, 17: 3750, 18: 5000, 19: 6500, 20: 9000, 21: 12000,
+    22: 15500, 23: 20000, 24: 25000, 25: 31000, 26: 40000, 27: 52000, 28: 67000, 29: 85000,
+    30: 110000, 31: 140000, 32: 180000, 33: 225000, 34: 285000, 35: 355000, 36: 435000, 37: 540000,
+    38: 660000, 39: 800000, 40: 950000, 41: 1140000, 42: 1350000, 43: 1600000, 44: 1875000,
+    45: 2185000, 46: 2550000, 47: 3000000, 48: 3500000, 49: 4150000, 50: 4900000, 51: 5800000,
+    52: 7000000, 53: 9000000, 54: 11500000, 55: 14500000, 56: 18000000, 57: 22000000, 58: 26500000,
+    59: 31500000, 60: 37000000, 61: 43000000, 62: 50000000, 63: 100000000, 64: 200000000,
+    65: 500000000, 66: 1000000000, 67: 2000000000, 68: 4000000000, 69: 10000000000, 70: 20000000000,
+    71: 30000000000, 72: 40000000000, 73: 50000000000, 74: 60000000000, 75: 70000000000,
+    76: 80000000000, 77: 90000000000, 78: 100000000000, 79: 110000000000, 80: 120000000000,
+    81: 130000000000, 82: 140000000000, 83: 150000000000, 84: 160000000000, 85: 170000000000,
+    86: 180000000000, 87: 190000000000, 88: 200000000000, 89: 210000000000
+}
+
+INDUSTRIES = Industries()
+
+TERRAINS: Dict[int, str] = {0: "Standard", 1: 'Industrial', 2: 'Urban', 3: 'Suburbs', 4: 'Airport', 5: 'Plains',
+                            6: 'Wasteland', 7: 'Mountains', 8: 'Beach', 9: 'Swamp', 10: 'Mud', 11: 'Hills',
+                            12: 'Jungle', 13: 'Forest', 14: 'Desert'}

erepublik/types.py

@@ -0,0 +1,7 @@
+from datetime import datetime
+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]]]
+InvFinal = Dict[str, Dict[int, InvFinalItem]]
+InvRaw = Dict[str, Dict[int, Dict[str, Union[str, int]]]]

erepublik/utils.py

@@ -1,147 +1,72 @@
 import datetime
 import inspect
-import json
 import os
 import re
 import sys
+import textwrap
 import time
 import traceback
 import unicodedata
-from collections import deque
+import warnings
 from decimal import Decimal
-from json import JSONEncoder
 from pathlib import Path
-from typing import Union, Any, List, NoReturn, Mapping
+from typing import Any, Dict, List, Union
 
-import pytz
 import requests
-from requests import Response
 
-__all__ = ["FOOD_ENERGY", "COMMIT_ID", "COUNTRIES", "erep_tz",
+from . import __version__, constants
-           "now", "localize_dt", "localize_timestamp", "good_timedelta", "eday_from_date", "date_from_eday",
-           "get_sleep_seconds", "interactive_sleep", "silent_sleep",
-           "write_silent_log", "write_interactive_log", "get_file", "write_file",
-           "send_email", "normalize_html_json", "process_error", ]
 
+try:
+    import simplejson as json
+except ImportError:
+    import json
 
-FOOD_ENERGY = dict(q1=2, q2=4, q3=6, q4=8, q5=10, q6=12, q7=20)
+__all__ = ['VERSION', 'calculate_hit', 'caught_error', 'date_from_eday', 'eday_from_date', 'deprecation',
-COMMIT_ID = "7b92e19"
+           'get_air_hit_dmg_value', 'get_file', 'get_ground_hit_dmg_value', 'get_sleep_seconds', 'good_timedelta',
+           'interactive_sleep', 'json', 'localize_dt', 'localize_timestamp', 'normalize_html_json', 'now',
+           'process_error', 'process_warning', 'send_email', 'silent_sleep', 'slugify', 'write_file', 'write_request',
+           'write_interactive_log', 'write_silent_log', 'get_final_hit_dmg', 'wait_for_lock']
 
-erep_tz = pytz.timezone('US/Pacific')
+if not sys.version_info >= (3, 6):
-AIR_RANKS = {1: "Airman", 2: "Airman 1st Class", 3: "Airman 1st Class*", 4: "Airman 1st Class**",
+    raise AssertionError('This script requires Python version 3.6 and higher\n'
-             5: "Airman 1st Class***", 6: "Airman 1st Class****", 7: "Airman 1st Class*****",
+                         'But Your version is v{}.{}.{}'.format(*sys.version_info))
-             8: "Senior Airman", 9: "Senior Airman*", 10: "Senior Airman**", 11: "Senior Airman***",
-             12: "Senior Airman****", 13: "Senior Airman*****",
-             14: "Staff Sergeant", 15: "Staff Sergeant*", 16: "Staff Sergeant**", 17: "Staff Sergeant***",
-             18: "Staff Sergeant****", 19: "Staff Sergeant*****",
-             20: "Aviator", 21: "Aviator*", 22: "Aviator**", 23: "Aviator***", 24: "Aviator****", 25: "Aviator*****",
-             26: "Flight Lieutenant", 27: "Flight Lieutenant*", 28: "Flight Lieutenant**", 29: "Flight Lieutenant***",
-             30: "Flight Lieutenant****", 31: "Flight Lieutenant*****",
-             32: "Squadron Leader", 33: "Squadron Leader*", 34: "Squadron Leader**", 35: "Squadron Leader***",
-             36: "Squadron Leader****", 37: "Squadron Leader*****",
-             38: "Chief Master Sergeant", 39: "Chief Master Sergeant*", 40: "Chief Master Sergeant**",
-             41: "Chief Master Sergeant***", 42: "Chief Master Sergeant****", 43: "Chief Master Sergeant*****",
-             44: "Wing Commander", 45: "Wing Commander*", 46: "Wing Commander**", 47: "Wing Commander***",
-             48: "Wing Commander****", 49: "Wing Commander*****",
-             50: "Group Captain", 51: "Group Captain*", 52: "Group Captain**", 53: "Group Captain***",
-             54: "Group Captain****", 55: "Group Captain*****",
-             56: "Air Commodore", 57: "Air Commodore*", 58: "Air Commodore**", 59: "Air Commodore***",
-             60: "Air Commodore****", 61: "Air Commodore*****", }
 
-GROUND_RANKS = {1: "Recruit", 2: "Private", 3: "Private*", 4: "Private**", 5: "Private***", 6: "Corporal",
+VERSION: str = __version__
-                7: "Corporal*", 8: "Corporal**", 9: "Corporal***",
-                10: "Sergeant", 11: "Sergeant*", 12: "Sergeant**", 13: "Sergeant***", 14: "Lieutenant",
-                15: "Lieutenant*", 16: "Lieutenant**", 17: "Lieutenant***",
-                18: "Captain", 19: "Captain*", 20: "Captain**", 21: "Captain***", 22: "Major", 23: "Major*",
-                24: "Major**", 25: "Major***",
-                26: "Commander", 27: "Commander*", 28: "Commander**", 29: "Commander***", 30: "Lt Colonel",
-                31: "Lt Colonel*", 32: "Lt Colonel**", 33: "Lt Colonel***",
-                34: "Colonel", 35: "Colonel*", 36: "Colonel**", 37: "Colonel***", 38: "General", 39: "General*",
-                40: "General**", 41: "General***",
-                42: "Field Marshal", 43: "Field Marshal*", 44: "Field Marshal**", 45: "Field Marshal***",
-                46: "Supreme Marshal", 47: "Supreme Marshal*", 48: "Supreme Marshal**", 49: "Supreme Marshal***",
-                50: "National Force", 51: "National Force*", 52: "National Force**", 53: "National Force***",
-                54: "World Class Force", 55: "World Class Force*", 56: "World Class Force**",
-                57: "World Class Force***", 58: "Legendary Force", 59: "Legendary Force*", 60: "Legendary Force**",
-                61: "Legendary Force***",
-                62: "God of War", 63: "God of War*", 64: "God of War**", 65: "God of War***", 66: "Titan", 67: "Titan*",
-                68: "Titan**", 69: "Titan***",
-                70: "Legends I", 71: "Legends II", 72: "Legends III", 73: "Legends IV", 74: "Legends V",
-                75: "Legends VI", 76: "Legends VII", 77: "Legends VIII", 78: "Legends IX", 79: "Legends X",
-                80: "Legends XI", 81: "Legends XII", 82: "Legends XIII", 83: "Legends XIV", 84: "Legends XV",
-                85: "Legends XVI", 86: "Legends XVII", 87: "Legends XVIII", 88: "Legends XIX", 89: "Legends XX", }
-
-COUNTRIES = {1: 'Romania', 9: 'Brazil', 10: 'Italy', 11: 'France', 12: 'Germany', 13: 'Hungary', 14: 'China',
-             15: 'Spain', 23: 'Canada', 24: 'USA', 26: 'Mexico', 27: 'Argentina', 28: 'Venezuela', 29: 'United Kingdom',
-             30: 'Switzerland', 31: 'Netherlands', 32: 'Belgium', 33: 'Austria', 34: 'Czech Republic', 35: 'Poland',
-             36: 'Slovakia', 37: 'Norway', 38: 'Sweden', 39: 'Finland', 40: 'Ukraine', 41: 'Russia', 42: 'Bulgaria',
-             43: 'Turkey', 44: 'Greece', 45: 'Japan', 47: 'South Korea', 48: 'India', 49: 'Indonesia', 50: 'Australia',
-             51: 'South Africa', 52: 'Republic of Moldova', 53: 'Portugal', 54: 'Ireland', 55: 'Denmark', 56: 'Iran',
-             57: 'Pakistan', 58: 'Israel', 59: 'Thailand', 61: 'Slovenia', 63: 'Croatia', 64: 'Chile', 65: 'Serbia',
-             66: 'Malaysia', 67: 'Philippines', 68: 'Singapore', 69: 'Bosnia and Herzegovina', 70: 'Estonia',
-             71: 'Latvia', 72: 'Lithuania', 73: 'North Korea', 74: 'Uruguay', 75: 'Paraguay', 76: 'Bolivia', 77: 'Peru',
-             78: 'Colombia', 79: 'Republic of Macedonia (FYROM)', 80: 'Montenegro', 81: 'Republic of China (Taiwan)',
-             82: 'Cyprus', 83: 'Belarus', 84: 'New Zealand', 164: 'Saudi Arabia', 165: 'Egypt',
-             166: 'United Arab Emirates', 167: 'Albania', 168: 'Georgia', 169: 'Armenia', 170: 'Nigeria', 171: 'Cuba'}
-
-COUNTRY_LINK = {1: 'Romania', 9: 'Brazil', 11: 'France', 12: 'Germany', 13: 'Hungary', 82: 'Cyprus', 168: 'Georgia',
-                15: 'Spain', 23: 'Canada', 26: 'Mexico', 27: 'Argentina', 28: 'Venezuela', 80: 'Montenegro', 24: 'USA',
-                29: 'United-Kingdom', 50: 'Australia', 47: 'South-Korea',171: 'Cuba', 79: 'Republic-of-Macedonia-FYROM',
-                30: 'Switzerland', 31: 'Netherlands', 32: 'Belgium', 33: 'Austria', 34: 'Czech-Republic', 35: 'Poland',
-                36: 'Slovakia', 37: 'Norway', 38: 'Sweden', 39: 'Finland', 40: 'Ukraine', 41: 'Russia', 42: 'Bulgaria',
-                43: 'Turkey', 44: 'Greece', 45: 'Japan', 48: 'India', 49: 'Indonesia', 78: 'Colombia', 68: 'Singapore',
-                51: 'South Africa', 52: 'Republic-of-Moldova', 53: 'Portugal', 54: 'Ireland', 55: 'Denmark', 56: 'Iran',
-                57: 'Pakistan', 58: 'Israel', 59: 'Thailand', 61: 'Slovenia', 63: 'Croatia', 64: 'Chile', 65: 'Serbia',
-                66: 'Malaysia', 67: 'Philippines', 70: 'Estonia', 165: 'Egypt', 14: 'China', 77: 'Peru', 10: 'Italy',
-                71: 'Latvia', 72: 'Lithuania', 73: 'North-Korea', 74: 'Uruguay', 75: 'Paraguay', 76: 'Bolivia',
-                81: 'Republic-of-China-Taiwan', 166: 'United-Arab-Emirates', 167: 'Albania', 69: 'Bosnia-Herzegovina',
-                169: 'Armenia', 83: 'Belarus', 84: 'New-Zealand', 164: 'Saudi-Arabia', 170: 'Nigeria', }
-
-
-class MyJSONEncoder(JSONEncoder):
-    def default(self, o):
-        if isinstance(o, Decimal):
-            return float("{:.02f}".format(o))
-        elif isinstance(o, datetime.datetime):
-            return dict(__type__='datetime', year=o.year, month=o.month, day=o.day, hour=o.hour, minute=o.minute,
-                        second=o.second, microsecond=o.microsecond)
-        elif isinstance(o, datetime.date):
-            return dict(__type__='date', year=o.year, month=o.month, day=o.day)
-        elif isinstance(o, datetime.timedelta):
-            return dict(__type__='timedelta', days=o.days, seconds=o.seconds,
-                        microseconds=o.microseconds, total_seconds=o.total_seconds())
-        elif isinstance(o, Response):
-            return dict(headers=o.headers.__dict__, url=o.url, text=o.text)
-        elif hasattr(o, '__dict__'):
-            return o.__dict__
-        elif isinstance(o, deque):
-            return list(o)
-        return super().default(o)
 
 
 def now() -> datetime.datetime:
-    return datetime.datetime.now(erep_tz).replace(microsecond=0)
+    return datetime.datetime.now(constants.erep_tz).replace(microsecond=0)
 
 
 def localize_timestamp(timestamp: int) -> datetime.datetime:
-    return datetime.datetime.fromtimestamp(timestamp, erep_tz)
+    return datetime.datetime.fromtimestamp(timestamp, constants.erep_tz)
 
 
 def localize_dt(dt: Union[datetime.date, datetime.datetime]) -> datetime.datetime:
-    try:
+    if isinstance(dt, datetime.datetime):
-        try:
+        return constants.erep_tz.localize(dt)
-            return erep_tz.localize(dt)
+    elif isinstance(dt, datetime.date):
-        except AttributeError:
+        return constants.erep_tz.localize(datetime.datetime.combine(dt, datetime.time(0, 0, 0)))
-            return erep_tz.localize(datetime.datetime.combine(dt, datetime.time(0, 0, 0)))
+    else:
-    except ValueError:
+        raise TypeError(f"Argument dt must be and instance of datetime.datetime or datetime.date not {type(dt)}")
-        return dt.astimezone(erep_tz)
 
 
 def good_timedelta(dt: datetime.datetime, td: datetime.timedelta) -> datetime.datetime:
-    return erep_tz.normalize(dt + td)
+    """Normalize timezone aware datetime object after timedelta to correct jumps over DST switches
+
+    :param dt: Timezone aware datetime object
+    :type dt: datetime.datetime
+    :param td: timedelta object
+    :type td: datetime.timedelta
+    :return: datetime object with correct timezone when jumped over DST
+    :rtype: datetime.datetime
+    """
+    return constants.erep_tz.normalize(dt + td)
 
 
-def eday_from_date(date: Union[datetime.date, datetime.datetime] = now()) -> int:
+def eday_from_date(date: Union[datetime.date, datetime.datetime] = None) -> int:
+    if date is None:
+        date = now()
     if isinstance(date, datetime.date):
         date = datetime.datetime.combine(date, datetime.time(0, 0, 0))
     return (date - datetime.datetime(2007, 11, 20, 0, 0, 0)).days
@@ -151,9 +76,9 @@ def date_from_eday(eday: int) -> datetime.date:
     return localize_dt(datetime.date(2007, 11, 20)) + datetime.timedelta(days=eday)
 
 
-def get_sleep_seconds(time_untill: datetime.datetime) -> int:
+def get_sleep_seconds(time_until: datetime.datetime) -> int:
     """ time_until aware datetime object Wrapper for sleeping until """
-    sleep_seconds = int((time_untill - now()).total_seconds())
+    sleep_seconds = int((time_until - now()).total_seconds())
     return sleep_seconds if sleep_seconds > 0 else 0
 
 
@@ -170,7 +95,7 @@ def interactive_sleep(sleep_seconds: int):
         #     seconds = seconds % 30 if seconds % 30 else 30
         else:
             seconds = 1
-        sys.stdout.write("\rSleeping for {:4} more seconds".format(sleep_seconds))
+        sys.stdout.write(f"\rSleeping for {sleep_seconds:4} more seconds")
         sys.stdout.flush()
         time.sleep(seconds)
         sleep_seconds -= seconds
@@ -182,7 +107,8 @@ silent_sleep = time.sleep
 
 def _write_log(msg, timestamp: bool = True, should_print: bool = False):
     erep_time_now = now()
-    txt = "[{}] {}".format(erep_time_now.strftime('%F %T'), msg) if timestamp else msg
+    txt = f"[{erep_time_now.strftime('%F %T')}] {msg}" if timestamp else msg
+    txt = "\n".join(["\n".join(textwrap.wrap(line, 120)) for line in txt.splitlines()])
     if not os.path.isdir('log'):
         os.mkdir('log')
     with open("log/%s.log" % erep_time_now.strftime('%F'), 'a', encoding="utf-8") as f:
@@ -192,10 +118,12 @@ def _write_log(msg, timestamp: bool = True, should_print: bool = False):
 
 
 def write_interactive_log(*args, **kwargs):
+    kwargs.pop("should_print", None)
     _write_log(should_print=True, *args, **kwargs)
 
 
 def write_silent_log(*args, **kwargs):
+    kwargs.pop("should_print", None)
     _write_log(should_print=False, *args, **kwargs)
 
 
@@ -226,11 +154,13 @@ def get_file(filepath: str) -> str:
 def write_file(filename: str, content: str) -> int:
     filename = get_file(filename)
     with open(filename, 'ab') as f:
-        return f.write(content.encode("utf-8"))
+        ret = f.write(content.encode("utf-8"))
+    return ret
 
 
 def write_request(response: requests.Response, is_error: bool = False):
     from erepublik import Citizen
+
     # Remove GET args from url name
     url = response.url
     last_index = url.index("?") if "?" in url else len(response.url)
@@ -245,22 +175,22 @@ def write_request(response: requests.Response, is_error: bool = False):
         ext = "html"
 
     if not is_error:
-        filename = "debug/requests/{}_{}.{}".format(now().strftime('%F_%H-%M-%S'), name, ext)
+        filename = f"debug/requests/{now().strftime('%F_%H-%M-%S')}_{name}.{ext}"
         write_file(filename, html)
     else:
-        return {"name": "{}_{}.{}".format(now().strftime('%F_%H-%M-%S'), name, ext),
+        return {"name": f"{now().strftime('%F_%H-%M-%S')}_{name}.{ext}",
                 "content": html.encode('utf-8'),
                 "mimetype": "application/json" if ext == "json" else "text/html"}
 
 
-def send_email(name: str, content: List[Any], player=None, local_vars: Mapping[Any, Any] = None,
+def send_email(name: str, content: List[Any], player=None, local_vars: Dict[str, Any] = None,
                promo: bool = False, captcha: bool = False):
     if local_vars is None:
         local_vars = {}
     from erepublik import Citizen
 
     file_content_template = "<html><head><title>{title}</title></head><body>{body}</body></html>"
-    if isinstance(player, Citizen):
+    if isinstance(player, Citizen) and player.r:
         resp = write_request(player.r, is_error=True)
     else:
         resp = {"name": "None.html", "mimetype": "text/html",
@@ -269,14 +199,14 @@ def send_email(name: str, content: List[Any], player=None, local_vars: Mapping[A
     if promo:
         resp = {"name": "%s.html" % name, "mimetype": "text/html",
                 "content": file_content_template.format(title="Promo", body="<br/>".join(content))}
-        subject = "[eBot][{}] Promos: {}".format(now().strftime('%F %T'), name)
+        subject = f"[eBot][{now().strftime('%F %T')}] Promos: {name}"
 
     elif captcha:
         resp = {"name": "%s.html" % name, "mimetype": "text/html",
                 "content": file_content_template.format(title="ReCaptcha", body="<br/>".join(content))}
-        subject = "[eBot][{}] RECAPTCHA: {}".format(now().strftime('%F %T'), name)
+        subject = f"[eBot][{now().strftime('%F %T')}] RECAPTCHA: {name}"
     else:
-        subject = "[eBot][%s] Bug trace: %s" % (now().strftime('%F %T'), name)
+        subject = f"[eBot][{now().strftime('%F %T')}] Bug trace: {name}"
 
     body = "".join(traceback.format_stack()) + \
            "\n\n" + \
@@ -296,8 +226,17 @@ def send_email(name: str, content: List[Any], player=None, local_vars: Mapping[A
     if local_vars:
         if "state_thread" in local_vars:
             local_vars.pop('state_thread', None)
-        files.append(('file', ("local_vars.json", json.dumps(local_vars, indent=2,
+
-                                                             cls=MyJSONEncoder, sort_keys=True), "application/json")))
+        if isinstance(local_vars.get('self'), Citizen):
+            local_vars['self'] = repr(local_vars['self'])
+        if isinstance(local_vars.get('player'), Citizen):
+            local_vars['player'] = repr(local_vars['player'])
+        if isinstance(local_vars.get('citizen'), Citizen):
+            local_vars['citizen'] = repr(local_vars['citizen'])
+
+        from erepublik.classes import MyJSONEncoder
+        files.append(('file', ("local_vars.json", json.dumps(local_vars, cls=MyJSONEncoder),
+                               "application/json")))
     if isinstance(player, Citizen):
         files.append(('file', ("instance.json", player.to_json(indent=True), "application/json")))
     requests.post('https://pasts.72.lv', data=data, files=files)
@@ -311,11 +250,54 @@ def normalize_html_json(js: str) -> str:
     return js
 
 
+def caught_error(e: Exception):
+    process_error(str(e), "Unclassified", sys.exc_info(), interactive=False)
+
+
 def process_error(log_info: str, name: str, exc_info: tuple, citizen=None, commit_id: str = None,
-                  interactive: bool = False):
+                  interactive: bool = None):
     """
     Process error logging and email sending to developer
     :param interactive: Should print interactively
+    :type interactive: bool
+    :param log_info: String to be written in output
+    :type log_info: str
+    :param name: String Instance name
+    :type name: str
+    :param exc_info: tuple output from sys.exc_info()
+    :type exc_info: tuple
+    :param citizen: Citizen instance
+    :type citizen: Citizen
+    :param commit_id: Caller's code version's commit id
+    :type commit_id: str
+    """
+    type_, value_, traceback_ = exc_info
+    content = [log_info]
+    content += [f"eRepublik version {VERSION}"]
+    if commit_id:
+        content += [f"Commit id {commit_id}"]
+    content += [str(value_), str(type_), ''.join(traceback.format_tb(traceback_))]
+
+    if interactive:
+        write_interactive_log(log_info)
+    elif interactive is not None:
+        write_silent_log(log_info)
+    trace = inspect.trace()
+    if trace:
+        local_vars = trace[-1][0].f_locals
+        if local_vars.get('__name__') == '__main__':
+            local_vars.update({'commit_id': local_vars.get('COMMIT_ID'),
+                               'interactive': local_vars.get('INTERACTIVE'),
+                               'version': local_vars.get('__version__'),
+                               'config': local_vars.get('CONFIG')})
+    else:
+        local_vars = dict()
+    send_email(name, content, citizen, local_vars=local_vars)
+
+
+def process_warning(log_info: str, name: str, exc_info: tuple, citizen=None, commit_id: str = None):
+    """
+    Process error logging and email sending to developer
     :param log_info: String to be written in output
     :param name: String Instance name
     :param exc_info: tuple output from sys.exc_info()
@@ -323,23 +305,17 @@ def process_error(log_info: str, name: str, exc_info: tuple, citizen=None, commi
     :param commit_id: Code's version by commit id
     """
     type_, value_, traceback_ = exc_info
-    bugtrace = [] if not commit_id else ["Commit id: %s" % commit_id, ]
+    content = [log_info]
-    bugtrace += [str(value_), str(type_), ''.join(traceback.format_tb(traceback_))]
+    if commit_id:
+        content += ["Commit id: %s" % commit_id]
+    content += [str(value_), str(type_), ''.join(traceback.format_tb(traceback_))]
 
-    if interactive:
-        write_interactive_log(log_info)
-    else:
-        write_silent_log(log_info)
     trace = inspect.trace()
     if trace:
-        trace = trace[-1][0].f_locals
+        local_vars = trace[-1][0].f_locals
     else:
-        trace = dict()
+        local_vars = dict()
-    send_email(name, bugtrace, citizen, local_vars=trace)
+    send_email(name, content, citizen, local_vars=local_vars)
-
-
-def report_promo(kind: str, time_untill: datetime.datetime) -> NoReturn:
-    requests.post('https://api.erep.lv/promos/add/', data=dict(kind=kind, time_untill=time_untill))
 
 
 def slugify(value, allow_unicode=False) -> str:
@@ -354,5 +330,82 @@ def slugify(value, allow_unicode=False) -> str:
         value = unicodedata.normalize('NFKC', value)
     else:
         value = unicodedata.normalize('NFKD', value).encode('ascii', 'ignore').decode('ascii')
-    value = re.sub(r'[^\w\s-]', '', value).strip().lower()
+    value = re.sub(r'[^\w\s-]', '_', value).strip().lower()
     return re.sub(r'[-\s]+', '-', value)
+
+
+def calculate_hit(strength: float, rang: int, tp: bool, elite: bool, ne: bool, booster: int = 0,
+                  weapon: int = 200, is_deploy: bool = False) -> Decimal:
+    dec = 3 if is_deploy else 0
+    base_str = (1 + Decimal(str(round(strength, 3))) / 400)
+    base_rnk = (1 + Decimal(str(rang / 5)))
+    base_wpn = (1 + Decimal(str(weapon / 100)))
+    dmg = 10 * base_str * base_rnk * base_wpn
+
+    dmg = get_final_hit_dmg(dmg, rang, tp=tp, elite=elite, ne=ne, booster=booster)
+    return Decimal(round(dmg, dec))
+
+
+def get_ground_hit_dmg_value(citizen_id: int, natural_enemy: bool = False, true_patriot: bool = False,
+                             booster: int = 0, weapon_power: int = 200) -> Decimal:
+    r = requests.get(f"https://www.erepublik.com/en/main/citizen-profile-json/{citizen_id}").json()
+    rang = r['military']['militaryData']['ground']['rankNumber']
+    strength = r['military']['militaryData']['ground']['strength']
+    elite = r['citizenAttributes']['level'] > 100
+    if natural_enemy:
+        true_patriot = True
+
+    return calculate_hit(strength, rang, true_patriot, elite, natural_enemy, booster, weapon_power)
+
+
+def get_air_hit_dmg_value(citizen_id: int, natural_enemy: bool = False, true_patriot: bool = False, booster: int = 0,
+                          weapon_power: int = 0) -> Decimal:
+    r = requests.get(f"https://www.erepublik.com/en/main/citizen-profile-json/{citizen_id}").json()
+    rang = r['military']['militaryData']['aircraft']['rankNumber']
+    elite = r['citizenAttributes']['level'] > 100
+    return calculate_hit(0, rang, true_patriot, elite, natural_enemy, booster, weapon_power)
+
+
+def get_final_hit_dmg(base_dmg: Union[Decimal, float, str], rang: int,
+                      tp: bool = False, elite: bool = False, ne: bool = False, booster: int = 0) -> Decimal:
+    dmg = Decimal(str(base_dmg))
+
+    if elite:
+        dmg = dmg * 11 / 10
+    if tp and rang >= 70:
+        dmg = dmg * (1 + Decimal((rang - 69) / 10))
+    dmg = dmg * (100 + booster) / 100
+    if ne:
+        dmg = dmg * 11 / 10
+    return Decimal(dmg)
+
+
+# def _clear_up_battle_memory(battle):
+#     del battle.invader._battle, battle.defender._battle
+#     for div_id, division in battle.div.items():
+#         del division._battle
+
+
+def deprecation(message):
+    warnings.warn(message, DeprecationWarning, stacklevel=2)
+
+
+def wait_for_lock(function):
+    def wrapper(instance, *args, **kwargs):
+        if not instance.concurrency_available.wait(600):
+            e = 'Concurrency not freed in 10min!'
+            instance.write_log(e)
+            if instance.debug:
+                instance.report_error(e)
+            return None
+        else:
+            instance.concurrency_available.clear()
+            try:
+                ret = function(instance, *args, **kwargs)
+            except Exception as e:
+                instance.concurrency_available.set()
+                raise e
+            instance.concurrency_available.set()
+            return ret
+
+    return wrapper

examples/battle_launcher.py

@@ -0,0 +1,106 @@
+import threading
+from datetime import timedelta
+
+from erepublik import Citizen, utils
+
+CONFIG = {
+    'email': 'player@email.com',
+    'password': 'Pa$5w0rd!',
+    'interactive': True,
+    'fight': True,
+    'debug': True,
+    'battle_launcher': {
+        # War id: {auto_attack: bool (attack asap when region is available), regions: [region_ids allowed to attack]}
+        121672: {"auto_attack": False, "regions": [661]},
+        125530: {"auto_attack": False, "regions": [259]},
+        125226: {"auto_attack": True, "regions": [549]},
+        124559: {"auto_attack": True, "regions": [176]}
+    }
+}
+
+
+def _battle_launcher(player: Citizen):
+    """Launch battles. Check every 5th minute (0,5,10...45,50,55) if any battle could be started on specified regions
+    and after launching wait for 90 minutes before starting next attack so that all battles aren't launched at the same
+    time. If player is allowed to fight, do 100 hits on the first round in players division.
+
+    :param player: Logged in Citizen instance
+    :type player: Citizen
+    """
+    global CONFIG
+    finished_war_ids = {*[]}
+    war_data = CONFIG.get('battle_launcher', {})
+    war_ids = {int(war_id) for war_id in war_data.keys()}
+    next_attack_time = player.now
+    next_attack_time = next_attack_time.replace(minute=next_attack_time.minute // 5 * 5, second=0)
+    while not player.stop_threads.is_set():
+        try:
+            attacked = False
+            player.update_war_info()
+            running_wars = {b.war_id for b in player.all_battles.values()}
+            for war_id in war_ids - finished_war_ids - running_wars:
+                war = war_data[war_id]
+                war_regions = set(war.get('regions'))
+                auto_attack = war.get('auto_attack')
+
+                status = player.get_war_status(war_id)
+                if status.get('ended', False):
+                    CONFIG['battle_launcher'].pop(war_id, None)
+                    finished_war_ids.add(war_id)
+                    continue
+                elif not status.get('can_attack'):
+                    continue
+
+                if auto_attack or (player.now.hour > 20 or player.now.hour < 2):
+                    for reg in war_regions:
+                        if attacked:
+                            break
+                        if reg in status.get('regions', {}).keys():
+                            player.launch_attack(war_id, reg, status.get('regions', {}).get(reg))
+                            attacked = True
+                            hits = 100
+                            if player.energy.food_fights >= hits and player.config.fight:
+                                for _ in range(120):
+                                    player.update_war_info()
+                                    battle_id = player.get_war_status(war_id).get("battle_id")
+                                    if battle_id is not None and battle_id in player.all_battles:
+                                        battle = player.all_battles.get(battle_id)
+                                        for division in battle.div.values():
+                                            if division.div == player.division:
+                                                div = division
+                                                break
+                                        else:
+                                            player.report_error("Players division not found in the first round!")
+                                            break
+                                        player.fight(battle, div, battle.invader, hits)
+                                        break
+                                    player.sleep(1)
+                        if attacked:
+                            break
+                if attacked:
+                    break
+            war_ids -= finished_war_ids
+            if attacked:
+                next_attack_time = utils.good_timedelta(next_attack_time, timedelta(hours=1, minutes=30))
+            else:
+                next_attack_time = utils.good_timedelta(next_attack_time, timedelta(minutes=5))
+            player.stop_threads.wait(utils.get_sleep_seconds(next_attack_time))
+        except Exception as e:
+            player.report_error(f"Task battle launcher ran into error {e}")
+
+
+# noinspection DuplicatedCode
+def main():
+    player = Citizen(email=CONFIG['email'], password=CONFIG['password'], auto_login=False)
+    player.config.interactive = CONFIG['interactive']
+    player.config.fight = CONFIG['fight']
+    player.set_debug(CONFIG.get('debug', False))
+    player.login()
+    if CONFIG.get('battle_launcher'):
+        name = f"{player.name}-battle_launcher-{threading.active_count() - 1}"
+        state_thread = threading.Thread(target=_battle_launcher, args=(player,), name=name)
+        state_thread.start()
+
+
+if __name__ == "__main__":
+    main()

examples/eat_work_train.py

@@ -0,0 +1,113 @@
+from datetime import timedelta
+
+from erepublik import Citizen, constants, utils
+
+CONFIG = {
+    'email': 'player@email.com',
+    'password': 'Pa$5w0rd!',
+    'interactive': True,
+    'debug': True,
+    'work': True,
+    'ot': True,  # Work OverTime
+    'wam': True,  # WorkAsManager
+    'train': True
+}
+
+
+# noinspection DuplicatedCode
+def main():
+    player = Citizen(email=CONFIG['email'], password=CONFIG['password'], auto_login=False)
+    player.config.interactive = CONFIG['interactive']
+    player.config.work = CONFIG['work']
+    player.config.train = CONFIG['train']
+    player.config.ot = CONFIG['ot']
+    player.config.wam = CONFIG['wam']
+    player.set_debug(CONFIG.get('debug', False))
+    player.login()
+    now = player.now.replace(second=0, microsecond=0)
+    dt_max = constants.max_datetime
+    tasks = {
+        'eat': now,
+    }
+    if player.config.work:
+        tasks.update({'work': now})
+    if player.config.train:
+        tasks.update({'train': now})
+    if player.config.ot:
+        tasks.update({'ot': now})
+    if player.config.wam:
+        tasks.update({'wam': now.replace(hour=14, minute=0)})
+    while True:
+        try:
+            player.update_all()
+            if tasks.get('work', dt_max) <= now:
+                player.write_log("Doing task: work")
+                player.update_citizen_info()
+                player.work()
+                if player.config.ot:
+                    tasks['ot'] = now
+                player.collect_daily_task()
+                next_time = utils.good_timedelta(now.replace(hour=0, minute=0, second=0), timedelta(days=1))
+                tasks.update({'work': next_time})
+
+            if tasks.get('train', dt_max) <= now:
+                player.write_log("Doing task: train")
+                player.update_citizen_info()
+                player.train()
+                player.collect_daily_task()
+                next_time = utils.good_timedelta(now.replace(hour=0, minute=0, second=0), timedelta(days=1))
+                tasks.update({'train': next_time})
+
+            if tasks.get('wam', dt_max) <= now:
+                player.write_log("Doing task: Work as manager")
+                success = player.work_as_manager()
+                player.eat()
+                if success:
+                    next_time = utils.good_timedelta(now.replace(hour=14, minute=0, second=0, microsecond=0),
+                                                     timedelta(days=1))
+                else:
+                    next_time = utils.good_timedelta(now.replace(second=0, microsecond=0), timedelta(minutes=30))
+
+                tasks.update({'wam': next_time})
+
+            if tasks.get('eat', dt_max) <= now:
+                player.write_log("Doing task: eat")
+                player.eat()
+
+                if player.energy.food_fights > player.energy.limit // 10:
+                    next_minutes = 12
+                else:
+                    next_minutes = (player.energy.limit - 5 * player.energy.interval) // player.energy.interval * 6
+
+                next_time = player.energy.reference_time + timedelta(minutes=next_minutes)
+                tasks.update({'eat': next_time})
+
+            if tasks.get('ot', dt_max) <= now:
+                player.write_log("Doing task: work overtime")
+                if now > player.my_companies.next_ot_time:
+                    player.work_ot()
+                    next_time = now + timedelta(minutes=60)
+                else:
+                    next_time = player.my_companies.next_ot_time
+                tasks.update({'ot': next_time})
+
+            closest_next_time = dt_max
+            next_tasks = []
+            for task, next_time in sorted(tasks.items(), key=lambda s: s[1]):
+                next_tasks.append(f"{next_time.strftime('%F %T')}: {task}")
+                if next_time < closest_next_time:
+                    closest_next_time = next_time
+            sleep_seconds = int(utils.get_sleep_seconds(closest_next_time))
+            if sleep_seconds <= 0:
+                player.write_log(f"Loop detected! Offending task: '{next_tasks[0]}'")
+            player.write_log("My next Tasks and there time:\n" + "\n".join(sorted(next_tasks)))
+            player.write_log(f"Sleeping until (eRep): {closest_next_time.strftime('%F %T')}"
+                             f" (sleeping for {sleep_seconds}s)")
+            seconds_to_sleep = sleep_seconds if sleep_seconds > 0 else 0
+            player.sleep(seconds_to_sleep)
+        except Exception as e:
+            player.report_error(f"Task main loop ran into error: {e}")
+
+
+if __name__ == "__main__":
+    main()

requirements_dev.txt

@@ -1,15 +1,19 @@
-pip==19.1.1
+bump2version==1.0.1
-bumpversion==0.5.3
+coverage==5.3.1
-wheel==0.33.4
+edx-sphinx-theme==1.6.0
-watchdog==0.9.0
+flake8==3.8.4
-flake8==3.7.8
+ipython>=7.19.0
-tox==3.13.2
+isort==5.7.0
-coverage==4.5.3
+pip==20.3.3
-Sphinx==2.1.2
+pre-commit==2.9.3
-twine==1.13.0
+pur==5.3.0
-ipython==7.6.1
+PyInstaller==4.1
-PyInstaller==3.5
+PySocks==1.7.1
-pytz==2019.1
+pytest==6.2.1
-requests==2.22.0
+pytz>=2020.5
-pycryptodome==3.8.2
+requests>=2.25.1
-python-slugify==2.0.1
+responses==0.12.1
+setuptools==51.1.1
+Sphinx==3.4.2
+twine==3.3.0
+wheel==0.36.2

setup.cfg

@@ -1,7 +1,10 @@
 [bumpversion]
-current_version = 0.15.1
+current_version = 0.23.4.4
 commit = True
 tag = True
+parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)\.?(?P<dev>\d+)?
+serialize = {major}.{minor}.{patch}.{dev}
+	{major}.{minor}.{patch}
 
 [bumpversion:file:setup.py]
 search = version='{current_version}'
@@ -15,9 +18,22 @@ replace = __version__ = '{new_version}'
 universal = 1
 
 [flake8]
-exclude = docs
+exclude = docs,.git,log,debug,venv
 max-line-length = 120
-ignore = E722 F401
+ignore = D100,D101,D102,D103
 
-[aliases]
+[pycodestyle]
+max-line-length = 120
+exclude = .git,log,debug,venv, build
 
+[mypy]
+python_version = 3.7
+check_untyped_defs = True
+ignore_missing_imports = False
+warn_unused_ignores = True
+warn_redundant_casts = True
+warn_unused_configs = True
+
+[isort]
+multi_line_output = 2
+line_length = 120

setup.py

@@ -3,7 +3,7 @@
 
 """The setup script."""
 
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 with open('README.rst') as readme_file:
     readme = readme_file.read()
@@ -11,11 +11,18 @@ with open('README.rst') as readme_file:
 with open('HISTORY.rst') as history_file:
     history = history_file.read()
 
-requirements = ['pytz==2019.1', 'requests==2.22.0']
+requirements = [
+    'pytz>=2020.0',
+    'requests>=2.24.0,<2.26.0',
+    'PySocks==1.7.1'
+]
 
-setup_requirements = [ ]
+setup_requirements = []
 
-test_requirements = [ ]
+test_requirements = [
+    "pytest==6.1.2",
+    "responses==0.12.1"
+]
 
 setup(
     author="Eriks Karls",
@@ -27,6 +34,7 @@ setup(
         'Natural Language :: English',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
     ],
     description="Python package for automated eRepublik playing",
     entry_points={},
@@ -37,11 +45,11 @@ setup(
     keywords='erepublik',
     name='eRepublik',
     packages=find_packages(include=['erepublik']),
-    python_requires='>=3.7.*, <4',
+    python_requires='>=3.7, <4',
     setup_requires=setup_requirements,
     test_suite='tests',
     tests_require=test_requirements,
-    url='https://github.com/eeriks/erepublik_script',
+    url='https://github.com/eeriks/erepublik/',
-    version='0.15.1',
+    version='0.23.4.4',
     zip_safe=False,
 )

tests/test_erepublik_script.py

@@ -3,32 +3,135 @@
 
 """Tests for `erepublik` package."""
 
+from erepublik import Citizen
 
 import unittest
-from click.testing import CliRunner
-
-from erepublik import Citizen
-from erepublik import cli
 
 
-class TestErepublik_script(unittest.TestCase):
+class TestErepublik(unittest.TestCase):
     """Tests for `erepublik` package."""
 
     def setUp(self):
         """Set up test fixtures, if any."""
+        self.citizen = Citizen("email", "password", False)
+        self.citizen.config.interactive = False
 
-    def tearDown(self):
+    def test_should_do_levelup(self):
-        """Tear down test fixtures, if any."""
+        self.citizen.energy.recovered = 1900
+        self.citizen.energy.recoverable = 2940
+        self.citizen.energy.interval = 30
+        self.citizen.energy.limit = 3000
+        self.citizen.details.xp = 14850
+        self.assertTrue(self.citizen.should_do_levelup)
 
-    def test_000_something(self):
+        self.citizen.energy.recoverable = 1000
-        """Test something."""
+        self.assertFalse(self.citizen.should_do_levelup)
 
-    def test_command_line_interface(self):
+    def test_should_travel_to_fight(self):
-        """Test the CLI."""
+        self.citizen.config.always_travel = True
-        runner = CliRunner()
+        self.assertTrue(self.citizen.should_travel_to_fight())
-        result = runner.invoke(cli.main)
+        self.citizen.config.always_travel = False
-        assert result.exit_code == 0
+        self.assertFalse(self.citizen.should_travel_to_fight())
-        assert 'erepublik.cli.main' in result.output
+
-        help_result = runner.invoke(cli.main, ['--help'])
+        self.citizen.energy.recovered = 1900
-        assert help_result.exit_code == 0
+        self.citizen.energy.recoverable = 2940
-        assert '--help  Show this message and exit.' in help_result.output
+        self.citizen.energy.interval = 30
+        self.citizen.energy.limit = 3000
+        self.citizen.details.xp = 14850
+        self.assertTrue(self.citizen.should_travel_to_fight())
+        self.citizen.details.xp = 15000
+        self.assertFalse(self.citizen.should_travel_to_fight())
+
+        self.citizen.energy.recovered = 3000
+        self.citizen.energy.recoverable = 2910
+        self.assertTrue(self.citizen.should_travel_to_fight())
+        self.citizen.energy.recoverable = 2900
+        self.assertFalse(self.citizen.should_travel_to_fight())
+
+        # self.citizen.next_reachable_energy and self.citizen.config.next_energy
+        self.citizen.config.next_energy = True
+        self.citizen.energy.limit = 5000
+        self.citizen.details.next_pp = [5000, 5250, 5750, 6250, 6750]
+        self.citizen.details.pp = 4900
+        self.citizen.energy.recovered = 4000
+        self.citizen.energy.recoverable = 4510
+        self.assertEqual(self.citizen.next_reachable_energy, 850)
+        self.citizen.energy.recoverable = 4490
+        self.assertTrue(self.citizen.should_travel_to_fight())
+        self.assertEqual(self.citizen.next_reachable_energy, 350)
+        self.citizen.energy.recovered = 100
+        self.citizen.energy.recoverable = 150
+        self.assertFalse(self.citizen.should_travel_to_fight())
+        self.assertEqual(self.citizen.next_reachable_energy, 0)
+
+    def test_should_fight(self):
+        def is_wc_close():
+            return self.citizen.max_time_till_full_ff > self.citizen.time_till_week_change
+        self.citizen.config.fight = False
+        self.assertEqual(self.citizen.should_fight(), (0, "Fighting not allowed!", False))
+
+        self.citizen.config.fight = True
+
+        # Level up
+        self.citizen.energy.limit = 3000
+        self.citizen.details.xp = 24705
+        if not is_wc_close:
+            self.assertEqual(self.citizen.should_fight(), (0, 'Level up', False))
+
+            self.citizen.energy.recovered = 3000
+            self.citizen.energy.recoverable = 2950
+            self.citizen.energy.interval = 30
+            self.assertEqual(self.citizen.should_fight(), (900, 'Level up', True))
+            self.citizen.my_companies.ff_lockdown = 160
+            self.assertEqual(self.citizen.should_fight(), (900, 'Level up', True))
+            self.citizen.my_companies.ff_lockdown = 0
+
+            # Level up reachable
+            self.citizen.details.xp = 24400
+            self.assertEqual(self.citizen.should_fight(), (305, 'Fighting for close Levelup. Doing 305 hits', True))
+            self.citizen.my_companies.ff_lockdown = 160
+            self.assertEqual(self.citizen.should_fight(), (305, 'Fighting for close Levelup. Doing 305 hits', True))
+            self.citizen.my_companies.ff_lockdown = 0
+
+            self.citizen.details.xp = 21000
+            self.assertEqual(self.citizen.should_fight(), (75, 'Obligatory fighting for at least 75pp', True))
+            self.citizen.my_companies.ff_lockdown = 160
+            self.assertEqual(self.citizen.should_fight(), (75, 'Obligatory fighting for at least 75pp', True))
+            self.citizen.my_companies.ff_lockdown = 0
+            self.citizen.details.pp = 80
+
+            # All-in (type = all-in and full ff)
+            self.citizen.config.all_in = True
+            self.assertEqual(self.citizen.should_fight(), (595, 'Fighting all-in. Doing 595 hits', False))
+            self.citizen.my_companies.ff_lockdown = 160
+            self.assertEqual(self.citizen.should_fight(), (
+                435, 'Fight count modified (old count: 595 | FF: 595 | WAM ff_lockdown: 160 | New count: 435)', False
+            ))
+            self.citizen.my_companies.ff_lockdown = 0
+
+            self.citizen.config.air = True
+            self.citizen.energy.recoverable = 1000
+            self.assertEqual(self.citizen.should_fight(), (400, 'Fighting all-in in AIR. Doing 400 hits', False))
+            self.citizen.my_companies.ff_lockdown = 160
+            self.assertEqual(self.citizen.should_fight(), (
+                240, 'Fight count modified (old count: 400 | FF: 400 | WAM ff_lockdown: 160 | New count: 240)', False
+            ))
+            self.citizen.my_companies.ff_lockdown = 0
+            self.citizen.config.all_in = False
+
+            self.citizen.config.next_energy = True
+            self.citizen.energy.limit = 5000
+            self.citizen.details.next_pp = [100, 150, 250, 400, 500]
+            self.assertEqual(self.citizen.should_fight(), (320, 'Fighting for +1 energy. Doing 320 hits', False))
+            self.citizen.my_companies.ff_lockdown = 160
+            self.assertEqual(self.citizen.should_fight(), (
+                160, 'Fight count modified (old count: 320 | FF: 400 | WAM ff_lockdown: 160 | New count: 160)', False
+            ))
+            self.citizen.my_companies.ff_lockdown = 0
+            self.citizen.energy.limit = 3000
+            self.citizen.details.next_pp = [19250, 20000]
+            self.citizen.config.next_energy = False
+
+            # 1h worth of energy
+            self.citizen.energy.recoverable = 2910
+            self.assertEqual(self.citizen.should_fight(), (30, 'Fighting for 1h energy. Doing 30 hits', True))

tox.ini

@@ -1,19 +0,0 @@
-[tox]
-envlist =  py36, py37, flake8
-
-[travis]
-python =
-    3.7: py37
-    3.6: py36
-
-[testenv:flake8]
-basepython = python
-deps = flake8
-commands = flake8 erepublik_script
-
-[testenv]
-setenv =
-    PYTHONPATH = {toxinidir}
-
-commands = python setup.py test
-