Compare commits

...

8 Commits
0.9 ... 0.13

Author SHA1 Message Date
Pawel Kierski
6885cdc439 Increment version 2019-03-06 14:13:45 +01:00
Pawel Kierski
88e25a93be Ensure log folder exists 2019-03-06 11:15:33 +01:00
Pawel Kierski
67e7a4c0b2 Don't create log file if not specified 2019-03-05 12:19:48 +01:00
Paweł Kierski
788d2550e6 SDK-2552 optional achievement id or name 2019-03-05 12:18:33 +01:00
Rafal Makagon
059a1ea343 update logging facility in plugin API 2019-03-05 09:36:44 +01:00
Pawel Kierski
300ade5d43 Fix handling unknown notification 2019-03-04 11:52:08 +01:00
Paweł Kierski
43556a0470 SDK-2586 Return "None" instead of "Unknown" state for local game for Origin 2019-03-01 14:10:48 +01:00
Romuald Bierbasz
e244d3bb44 SDK-2577: Add UnknownBackendResponse 2019-02-28 15:20:03 +01:00
7 changed files with 53 additions and 11 deletions

View File

@@ -31,7 +31,7 @@ class LicenseType(Enum):
OtherUserLicense = "OtherUserLicense" OtherUserLicense = "OtherUserLicense"
class LocalGameState(Enum): class LocalGameState(Enum):
Unknown = "Unknown" None_ = "None"
Installed = "Installed" Installed = "Installed"
Running = "Running" Running = "Running"

View File

@@ -20,6 +20,10 @@ class BackendError(ApplicationError):
def __init__(self, data=None): def __init__(self, data=None):
super().__init__(4, "Backend error", data) 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): class InvalidCredentials(ApplicationError):
def __init__(self, data=None): def __init__(self, data=None):
super().__init__(100, "Invalid credentials", data) super().__init__(100, "Invalid credentials", data)

View File

@@ -104,6 +104,7 @@ class Server():
method = self._notifications.get(request.method) method = self._notifications.get(request.method)
if not method: if not method:
logging.error("Received uknown notification: %s", request.method) logging.error("Received uknown notification: %s", request.method)
return
callback, internal = method callback, internal = method
if internal: if internal:

View File

@@ -6,6 +6,7 @@ import dataclasses
from enum import Enum from enum import Enum
from collections import OrderedDict from collections import OrderedDict
import sys import sys
import os
from galaxy.api.jsonrpc import Server, NotificationClient from galaxy.api.jsonrpc import Server, NotificationClient
from galaxy.api.consts import Feature from galaxy.api.consts import Feature
@@ -315,12 +316,28 @@ class Plugin():
async def get_game_times(self): async def get_game_times(self):
raise NotImplementedError() raise NotImplementedError()
def create_and_run_plugin(plugin_class, argv): def _prepare_logging(logger_file):
root = logging.getLogger() root = logging.getLogger()
root.setLevel(logging.DEBUG) root.setLevel(logging.DEBUG)
if len(argv) >= 4: if logger_file:
handler = logging.handlers.RotatingFileHandler(argv[3], "a", 10000000, 10) # ensure destination folder exists
root.addHandler(handler) 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):
logger_file = argv[3] if len(argv) >= 4 else None
_prepare_logging(logger_file)
if len(argv) < 3: if len(argv) < 3:
logging.critical("Not enough parameters, required: token, port") logging.critical("Not enough parameters, required: token, port")

View File

@@ -28,8 +28,13 @@ class Game():
@dataclass @dataclass
class Achievement(): class Achievement():
achievement_id: str
unlock_time: int 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 @dataclass
class LocalGame(): class LocalGame():

View File

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

View File

@@ -1,9 +1,18 @@
import asyncio import asyncio
import json import json
from pytest import raises
from galaxy.api.types import Achievement from galaxy.api.types import Achievement
from galaxy.api.errors import UnknownError 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): def test_success(plugin, readline, write):
request = { request = {
"jsonrpc": "2.0", "jsonrpc": "2.0",
@@ -15,8 +24,9 @@ def test_success(plugin, readline, write):
} }
readline.side_effect = [json.dumps(request), ""] readline.side_effect = [json.dumps(request), ""]
plugin.get_unlocked_achievements.return_value = [ 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()) asyncio.run(plugin.run())
plugin.get_unlocked_achievements.assert_called_with(game_id="14") plugin.get_unlocked_achievements.assert_called_with(game_id="14")
@@ -32,8 +42,13 @@ def test_success(plugin, readline, write):
"unlock_time": 1548421241 "unlock_time": 1548421241
}, },
{ {
"achievement_id": "lvl20", "achievement_name": "Got level 20",
"unlock_time": 1548422395 "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): def test_unlock_achievement(plugin, write):
achievement = Achievement("lvl20", 1548422395) achievement = Achievement(achievement_id="lvl20", unlock_time=1548422395)
async def couritine(): async def couritine():
plugin.unlock_achievement("14", achievement) plugin.unlock_achievement("14", achievement)