Feature/version checker (#50)

* Add version check functionality

Author: kyuridenamida

atcoder-tools

@@ -1,16 +1,33 @@
 #!/usr/bin/env python3
 import sys
 
+from atcodertools.release_management.version_check import get_latest_version
 from atcodertools.tools.envgen import main as envgen_main
 from atcodertools.tools.tester import main as tester_main
 from atcodertools.tools.submit import main as submit_main
+from atcodertools.release_management.version import __version__
+from colorama import Fore, Style
 
 
 def exit_program(success: bool):
     sys.exit(0 if success else -1)
 
 
+def notify_if_latest_version_found():
+    latest = get_latest_version()
+    if latest != __version__:
+        print(Fore.YELLOW, end='')
+        print("The latest version {0} is available! (The current version: {1})".format(
+            latest, __version__))
+        print("To upgrade, run the following command:")
+        print("")
+        print("pip3 install atcoder-tools --upgrade")
+        print(Style.RESET_ALL)
+
+
 if __name__ == '__main__':
+    notify_if_latest_version_found()
+
     if len(sys.argv) < 2 or sys.argv[1] not in ("gen", "test", "submit"):
         print("Usage:")
         print("{} gen -- to generate workspace".format(sys.argv[0]))

atcodertools/__init__.py

@@ -0,0 +1 @@
+from atcodertools.release_management.version import __version__  # noqa

atcodertools/client/atcoder.py

@@ -8,6 +8,7 @@
 import requests
 from bs4 import BeautifulSoup
 
+from atcodertools.fileutils.artifacts_cache import get_cache_file_path
 from atcodertools.models.contest import Contest
 from atcodertools.models.problem import Problem
 from atcodertools.models.problem_content import ProblemContent, InputFormatDetectionError, SampleDetectionError
@@ -18,8 +19,7 @@ class LoginError(Exception):
     pass
 
 
-default_cookie_path = os.path.join(
-    os.path.expanduser('~/.local/share'), 'atcoder-tools', 'cookie.txt')
+default_cookie_path = get_cache_file_path('cookie.txt')
 
 
 def save_cookie(session: requests.Session, cookie_path: Optional[str] = None):

atcodertools/fileutils/artifacts_cache.py

@@ -0,0 +1,9 @@
+import os
+
+
+def _get_cache_dir_path():
+    return os.path.join(os.path.expanduser('~/.local/share'), 'atcoder-tools')
+
+
+def get_cache_file_path(filename: str):
+    return os.path.join(_get_cache_dir_path(), filename)

atcodertools/release_management/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.4"

atcodertools/release_management/version.py

@@ -0,0 +1,58 @@
+import json
+import os
+import time
+
+import requests
+
+from atcodertools.fileutils.artifacts_cache import get_cache_file_path
+
+
+class VersionCheckError(Exception):
+    pass
+
+
+cache_file_path = get_cache_file_path('version_cache.txt')
+
+HOUR_IN_SEC = 60 * 60
+
+
+def _fetch_latest_version():
+    dic = json.loads(requests.get(
+        "https://pypi.org/pypi/atcoder-tools/json").text)
+    return dic["info"]["version"]
+
+
+def _get_latest_version_cache():
+    if not os.path.exists(cache_file_path):
+        return None
+    with open(cache_file_path, 'r') as f:
+        version, timestamp_ms = f.read().split()
+        timestamp_sec = float(timestamp_ms)
+
+        if time.time() - timestamp_sec > HOUR_IN_SEC:
+            return None
+
+        return version
+
+
+def store_version_cache(version):
+    os.makedirs(os.path.dirname(cache_file_path), exist_ok=True)
+    with open(cache_file_path, 'w') as f:
+        f.write("{} {}".format(version, time.time()))
+
+
+def get_latest_version(user_cache=True):
+    try:
+        if user_cache:
+            cached_version = _get_latest_version_cache()
+            if cached_version:
+                return cached_version
+
+        version = _fetch_latest_version()
+
+        if user_cache:
+            store_version_cache(version)
+
+        return version
+    except Exception:
+        raise VersionCheckError

atcodertools/release_management/version_check.py

@@ -1,2 +1,3 @@
 beautifulsoup4
 requests
+colorama

requirements.txt

@@ -4,6 +4,7 @@
 from __future__ import unicode_literals
 
 from setuptools import setup, find_packages
+from atcodertools.release_management.version import __version__
 
 try:
     with open('README.md') as f:
@@ -18,7 +19,7 @@ def _requires_from_file(filename):
 
 setup(
     name="atcoder-tools",
-    version="1.0.4",
+    version=__version__,
     description="Convenient modules & tools for AtCoder users, written in Python 3.5",
     url='https://github.com/kyuridenamida/atcoder-tools',
     author='kyuridenamida',

setup.py

@@ -0,0 +1,17 @@
+import os
+import unittest
+
+from atcodertools.release_management.version_check import get_latest_version
+
+RESOURCE_DIR = os.path.abspath(os.path.join(
+    os.path.dirname(os.path.abspath(__file__)),
+    "./resources/test_tester/"))
+
+
+class TestTester(unittest.TestCase):
+    def test_get_latest_version_with_no_error(self):
+        get_latest_version(user_cache=False)
+
+
+if __name__ == '__main__':
+    unittest.main()