Increment version

.gitlab-ci.yml

@@ -20,5 +20,7 @@ deploy_package:
     - curl -X POST --silent --show-error --fail
         "https://gitlab.gog.com/api/v4/projects/${CI_PROJECT_ID}/repository/tags?tag_name=${VERSION}&ref=${CI_COMMIT_REF_NAME}&private_token=${PACKAGE_DEPLOYER_API_TOKEN}"
   when: manual
+  only:
+    - master
   except:
     - tags

galaxy/api/consts.py

@@ -12,6 +12,7 @@ class Platform(Enum):
     Battlenet = "battlenet"
 
 class Feature(Enum):
+    Unknown = "Unknown"
     ImportInstalledGames = "ImportInstalledGames"
     ImportOwnedGames = "ImportOwnedGames"
     LaunchGame = "LaunchGame"
@@ -23,11 +24,19 @@ class Feature(Enum):
     ImportUsers = "ImportUsers"
     VerifyGame = "VerifyGame"
 
+class LicenseType(Enum):
+    Unknown = "Unknown"
+    SinglePurchase = "SinglePurchase"
+    FreeToPlay = "FreeToPlay"
+    OtherUserLicense = "OtherUserLicense"
+
 class LocalGameState(Enum):
+    None_ = "None"
     Installed = "Installed"
     Running = "Running"
 
 class PresenceState(Enum):
+    Unknown = "Unknown"
     Online = "online"
     Offline = "offline"
     Away = "away"

galaxy/api/errors.py

@@ -20,6 +20,10 @@ class BackendError(ApplicationError):
     def __init__(self, data=None):
         super().__init__(4, "Backend error", data)
 
+class UnknownBackendResponse(ApplicationError):
+    def __init__(self, data=None):
+        super().__init__(4, "Backend responded in uknown way", data)
+
 class InvalidCredentials(ApplicationError):
     def __init__(self, data=None):
         super().__init__(100, "Invalid credentials", data)

galaxy/api/jsonrpc.py

@@ -64,10 +64,12 @@ class Server():
 
     async def run(self):
         while self._active:
-            data = await self._reader.readline()
+            try:
-            if not data:
+                data = await self._reader.readline()
-                # on windows rederecting a pipe to stdin result on continues
+                if not data:
-                # not-blocking return of empty line on EOF
+                    self._eof()
+                    continue
+            except:
                 self._eof()
                 continue
             data = data.strip()
@@ -102,6 +104,7 @@ class Server():
         method = self._notifications.get(request.method)
         if not method:
             logging.error("Received uknown notification: %s", request.method)
+            return
 
         callback, internal = method
         if internal:
@@ -141,8 +144,8 @@ class Server():
                     self._send_error(request.id, MethodNotFound())
                 except JsonRpcError as error:
                     self._send_error(request.id, error)
-                except Exception as error: #pylint: disable=broad-except
+                except Exception: #pylint: disable=broad-except
-                    logging.error("Unexpected exception raised in plugin handler: %s", repr(error))
+                    logging.exception("Unexpected exception raised in plugin handler")
 
             asyncio.create_task(handle())
 

galaxy/api/plugin.py

@@ -1,9 +1,12 @@
 import asyncio
 import json
 import logging
+import logging.handlers
 import dataclasses
 from enum import Enum
 from collections import OrderedDict
+import sys
+import os
 
 from galaxy.api.jsonrpc import Server, NotificationClient
 from galaxy.api.consts import Feature
@@ -21,6 +24,7 @@ class JSONEncoder(json.JSONEncoder):
 
 class Plugin():
     def __init__(self, platform, reader, writer, handshake_token):
+        logging.info("Creating plugin for platform %s", platform.value)
         self._platform = platform
 
         self._feature_methods = OrderedDict()
@@ -167,7 +171,10 @@ class Plugin():
         async def pass_control():
             while self._active:
                 logging.debug("Passing control to plugin")
-                self.tick()
+                try:
+                    self.tick()
+                except Exception:
+                    logging.exception("Unexpected exception raised in plugin tick")
                 await asyncio.sleep(1)
 
         await asyncio.gather(pass_control(), self._server.run())
@@ -309,22 +316,56 @@ class Plugin():
     async def get_game_times(self):
         raise NotImplementedError()
 
+def _prepare_logging(logger_file):
+    root = logging.getLogger()
+    root.setLevel(logging.DEBUG)
+    if logger_file:
+        # ensure destination folder exists
+        os.makedirs(os.path.dirname(os.path.abspath(logger_file)), exist_ok=True)
+        handler = logging.handlers.RotatingFileHandler(
+            logger_file,
+            mode="a",
+            maxBytes=10000000,
+            backupCount=10,
+            encoding="utf-8"
+        )
+    else:
+        handler = logging.StreamHandler()
+    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+    handler.setFormatter(formatter)
+    root.addHandler(handler)
 
 def create_and_run_plugin(plugin_class, argv):
-    if not issubclass(plugin_class, Plugin):
+    logger_file = argv[3] if len(argv) >= 4 else None
-        raise TypeError("plugin_class must be subclass of Plugin")
+    _prepare_logging(logger_file)
+
     if len(argv) < 3:
-        raise ValueError("Not enough parameters, required: token, port")
+        logging.critical("Not enough parameters, required: token, port")
+        sys.exit(1)
+
     token = argv[1]
+
     try:
         port = int(argv[2])
-    except ValueError as e:
+    except ValueError:
-        raise ValueError("Failed to parse port value, {}".format(e))
+        logging.critical("Failed to parse port value: %s", argv[2])
+        sys.exit(2)
+
     if not (1 <= port <= 65535):
-        raise ValueError("Port value out of range (1, 65535)")
+        logging.critical("Port value out of range (1, 65535)")
+        sys.exit(3)
+
+    if not issubclass(plugin_class, Plugin):
+        logging.critical("plugin_class must be subclass of Plugin")
+        sys.exit(4)
 
     async def coroutine():
         reader, writer = await asyncio.open_connection("127.0.0.1", port)
         plugin = plugin_class(reader, writer, token)
         await plugin.run()
-    asyncio.run(coroutine())
+
+    try:
+        asyncio.run(coroutine())
+    except Exception:
+        logging.exception("Error while running plugin")
+        sys.exit(5)

galaxy/api/types.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
-from typing import List
+from typing import List, Optional
 
-from galaxy.api.consts import LocalGameState, PresenceState
+from galaxy.api.consts import LicenseType, LocalGameState, PresenceState
 
 @dataclass
 class Authentication():
@@ -10,8 +10,8 @@ class Authentication():
 
 @dataclass
 class LicenseInfo():
-    license_type: str
+    license_type: LicenseType
-    owner: str = None
+    owner: Optional[str] = None
 
 @dataclass
 class Dlc():
@@ -28,8 +28,13 @@ class Game():
 
 @dataclass
 class Achievement():
-    achievement_id: str
     unlock_time: int
+    achievement_id: Optional[str] = None
+    achievement_name: Optional[str] = None
+
+    def __post_init__(self):
+        assert self.achievement_id or self.achievement_name, \
+            "One of achievement_id or achievement_name is required"
 
 @dataclass
 class LocalGame():
@@ -39,8 +44,8 @@ class LocalGame():
 @dataclass
 class Presence():
     presence_state: PresenceState
-    game_id: str = None
+    game_id: Optional[str] = None
-    presence_status: str = None
+    presence_status: Optional[str] = None
 
 @dataclass
 class UserInfo():

setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="galaxy.plugin.api",
-    version="0.4",
+    version="0.13",
     description="Galaxy python plugin API",
     author='Galaxy team',
     author_email='galaxy@gog.com',

tests/test_achievements.py

@@ -1,9 +1,18 @@
 import asyncio
 import json
+from pytest import raises
 
 from galaxy.api.types import Achievement
 from galaxy.api.errors import UnknownError
 
+def test_initialization_no_unlock_time():
+    with raises(Exception):
+        Achievement(achievement_id="lvl30", achievement_name="Got level 30")
+
+def test_initialization_no_id_nor_name():
+    with raises(AssertionError):
+        Achievement(unlock_time=1234567890)
+
 def test_success(plugin, readline, write):
     request = {
         "jsonrpc": "2.0",
@@ -15,8 +24,9 @@ def test_success(plugin, readline, write):
     }
     readline.side_effect = [json.dumps(request), ""]
     plugin.get_unlocked_achievements.return_value = [
-        Achievement("lvl10", 1548421241),
+        Achievement(achievement_id="lvl10", unlock_time=1548421241),
-        Achievement("lvl20", 1548422395)
+        Achievement(achievement_name="Got level 20", unlock_time=1548422395),
+        Achievement(achievement_id="lvl30", achievement_name="Got level 30", unlock_time=1548495633)
     ]
     asyncio.run(plugin.run())
     plugin.get_unlocked_achievements.assert_called_with(game_id="14")
@@ -32,8 +42,13 @@ def test_success(plugin, readline, write):
                     "unlock_time": 1548421241
                 },
                 {
-                    "achievement_id": "lvl20",
+                    "achievement_name": "Got level 20",
                     "unlock_time": 1548422395
+                },
+                {
+                    "achievement_id": "lvl30",
+                    "achievement_name": "Got level 30",
+                    "unlock_time": 1548495633
                 }
             ]
         }
@@ -65,7 +80,7 @@ def test_failure(plugin, readline, write):
     }
 
 def test_unlock_achievement(plugin, write):
-    achievement = Achievement("lvl20", 1548422395)
+    achievement = Achievement(achievement_id="lvl20", unlock_time=1548422395)
 
     async def couritine():
         plugin.unlock_achievement("14", achievement)

tests/test_owned_games.py

@@ -2,6 +2,7 @@ import asyncio
 import json
 
 from galaxy.api.types import Game, Dlc, LicenseInfo
+from galaxy.api.consts import LicenseType
 from galaxy.api.errors import UnknownError
 
 def test_success(plugin, readline, write):
@@ -13,15 +14,15 @@ def test_success(plugin, readline, write):
 
     readline.side_effect = [json.dumps(request), ""]
     plugin.get_owned_games.return_value = [
-        Game("3", "Doom", None, LicenseInfo("SinglePurchase", None)),
+        Game("3", "Doom", None, LicenseInfo(LicenseType.SinglePurchase, None)),
         Game(
             "5",
             "Witcher 3",
             [
-                Dlc("7", "Hearts of Stone", LicenseInfo("SinglePurchase", None)),
+                Dlc("7", "Hearts of Stone", LicenseInfo(LicenseType.SinglePurchase, None)),
-                Dlc("8", "Temerian Armor Set", LicenseInfo("FreeToPlay", None)),
+                Dlc("8", "Temerian Armor Set", LicenseInfo(LicenseType.FreeToPlay, None)),
             ],
-            LicenseInfo("SinglePurchase", None))
+            LicenseInfo(LicenseType.SinglePurchase, None))
     ]
     asyncio.run(plugin.run())
     plugin.get_owned_games.assert_called_with()
@@ -89,7 +90,7 @@ def test_failure(plugin, readline, write):
     }
 
 def test_add_game(plugin, write):
-    game = Game("3", "Doom", None, LicenseInfo("SinglePurchase", None))
+    game = Game("3", "Doom", None, LicenseInfo(LicenseType.SinglePurchase, None))
 
     async def couritine():
         plugin.add_game(game)
@@ -127,7 +128,7 @@ def test_remove_game(plugin, write):
     }
 
 def test_update_game(plugin, write):
-    game = Game("3", "Doom", None, LicenseInfo("SinglePurchase", None))
+    game = Game("3", "Doom", None, LicenseInfo(LicenseType.SinglePurchase, None))
 
     async def couritine():
         plugin.update_game(game)