Increment version

README.md

@@ -1,24 +1,52 @@
-# Galaxy python plugin API
+# GOG Galaxy - Community Integration - Python API
 
-## Usage
+This document is still work in progress.
 
-Implement plugin:
+## Basic Usage
+
+Basic implementation:
 
 ```python
-import asyncio
-from galaxy.api.plugin import Plugin
+import sys
+from galaxy.api.plugin import Plugin, create_and_run_plugin
+from galaxy.api.consts import Platform
 
 class PluginExample(Plugin):
+    def __init__(self, reader, writer, token):
+        super().__init__(
+            Platform.Generic, # Choose platform from available list
+            "0.1", # Version
+            reader,
+            writer,
+            token
+        )
+
     # implement methods
     async def authenticate(self, stored_credentials=None):
         pass
 
+def main():
+    create_and_run_plugin(PluginExample, sys.argv)
+
 # run plugin event loop
 if __name__ == "__main__":
-    asyncio.run(MockPlugin().run())
+    main()
 ```
 
-Use [pyinstaller](https://www.pyinstaller.org/) to create plugin executbale.
+Plugin should be deployed with manifest:
+```json
+{
+    "name": "Example plugin",
+    "platform": "generic",
+    "guid": "UNIQUE-GUID",
+    "version": "0.1",
+    "description": "Example plugin",
+    "author": "Name",
+    "email": "author@email.com",
+    "url": "https://github.com/user/galaxy-plugin-example",
+    "script": "plugin.py"
+}
+```
 
 ## Development
 
@@ -31,15 +59,9 @@ Run tests:
 ```bash
 pytest
 ```
+## Methods Documentation
+TODO
 
-## Changelog
+## Legal Notice
 
-### 0.21
-* Add `Epic` platform.
-### 0.16
-* Do not log sensitive data.
-* Return `LocalGameState` as int (possible combination of flags).
-### 0.15
-* `shutdown()` is called on socket disconnection.
-### 0.14
-* Added required version parameter to Plugin constructor.
+By integrating or attempting to integrate any applications or content with or into GOG Galaxy® 2.0. you represent that such application or content is your original creation (other than any software made available by GOG) and/or that you have all necessary rights to grant such applicable rights to the relevant community integration to GOG and to GOG Galaxy 2.0 end users for the purpose of use of such community integration and that such community integration comply with any third party license and other requirements including compliance with applicable laws.

jenkins/release.groovy

@@ -4,7 +4,7 @@ stage('Upload to github')
         deleteDir()
         checkout scm
         withPythonEnv('/usr/local/bin/python3.7') {
-            withCredentials([usernamePassword(credentialsId: 'github_friendsofgalaxy', usernameVariable: 'GITHUB_USERNAME', passwordVariable: 'GITHUB_TOKEN')]) {
+            withCredentials([string(credentialsId: 'github_goggalaxy', variable: 'GITHUB_TOKEN')]) {
                 sh 'pip install -r jenkins/requirements.txt'
                 def version = sh(returnStdout: true, script: 'python setup.py --version').trim()
                 sh "python jenkins/release.py $version"

jenkins/release.py

@@ -2,10 +2,10 @@ import os
 import sys
 from galaxy.github.exporter import transfer_repo
 
-GITHUB_USERNAME = "FriendsOfGalaxy"
-GITHUB_EMAIL = "friendsofgalaxy@gmail.com"
+GITHUB_USERNAME = "goggalaxy"
+GITHUB_EMAIL = "galaxy-sdk@gog.com"
 GITHUB_TOKEN = os.environ["GITHUB_TOKEN"]
-GITHUB_REPO_NAME = "galaxy-plugin-api"
+GITHUB_REPO_NAME = "galaxy-integrations-python-api"
 SOURCE_BRANCH = os.environ["GIT_REFSPEC"]
 
 GITLAB_USERNAME = "galaxy-client"
@@ -19,8 +19,8 @@ gh_version = transfer_repo(
     source_repo_spec="git@gitlab.gog.com:{}/{}.git".format(GITLAB_USERNAME, GITLAB_REPO_NAME),
     source_include_elements=["src", "tests", "requirements.txt", ".gitignore", "*.md", "pytest.ini"],
     source_branch=SOURCE_BRANCH,
-    dest_repo_spec="https://{}:{}@github.com/{}/{}.git".format(GITHUB_USERNAME, GITHUB_TOKEN, GITHUB_USERNAME, GITHUB_REPO_NAME),
+    dest_repo_spec="https://{}:{}@github.com/{}/{}.git".format(GITHUB_USERNAME, GITHUB_TOKEN, "gogcom", GITHUB_REPO_NAME),
     dest_branch="master",
     dest_user_email=GITHUB_EMAIL,
-    dest_user_name=GITLAB_USERNAME
+    dest_user_name="GOG Galaxy SDK Team"
 )

setup.py

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

src/galaxy/api/plugin.py

@@ -339,24 +339,28 @@ class Plugin():
         if self._achievements_import_in_progress:
             raise ImportInProgress()
 
-        async def import_games_achievements(game_ids):
-            async def import_game_achievements(game_id):
-                try:
-                    achievements = await self.get_unlocked_achievements(game_id)
-                    self.game_achievements_import_success(game_id, achievements)
-                except Exception as error:
-                    self.game_achievements_import_failure(game_id, error)
-
+        async def import_games_achievements_task(game_ids):
             try:
-                imports = [import_game_achievements(game_id) for game_id in game_ids]
-                await asyncio.gather(*imports)
+                await self.import_games_achievements(game_ids)
             finally:
                 self.achievements_import_finished()
                 self._achievements_import_in_progress = False
 
-        asyncio.create_task(import_games_achievements(game_ids))
+        asyncio.create_task(import_games_achievements_task(game_ids))
         self._achievements_import_in_progress = True
 
+    async def import_games_achievements(self, game_ids):
+        """Call game_achievements_import_success/game_achievements_import_failure for each game_id on the list"""
+        async def import_game_achievements(game_id):
+            try:
+                achievements = await self.get_unlocked_achievements(game_id)
+                self.game_achievements_import_success(game_id, achievements)
+            except Exception as error:
+                self.game_achievements_import_failure(game_id, error)
+
+        imports = [import_game_achievements(game_id) for game_id in game_ids]
+        await asyncio.gather(*imports)
+
     async def get_local_games(self):
         raise NotImplementedError()
 
@@ -397,28 +401,32 @@ class Plugin():
         if self._game_times_import_in_progress:
             raise ImportInProgress()
 
-        async def import_game_times(game_ids):
+        async def import_game_times_task(game_ids):
             try:
-                game_times = await self.get_game_times()
-                game_ids_set = set(game_ids)
-                for game_time in game_times:
-                    if game_time.game_id not in game_ids_set:
-                        continue
-                    self.game_time_import_success(game_time)
-                    game_ids_set.discard(game_time.game_id)
-                for game_id in game_ids_set:
-                    self.game_time_import_failure(game_id, UnknownError())
-
-            except Exception as error:
-                for game_id in game_ids:
-                    self.game_time_import_failure(game_id, error)
+                await self.import_game_times(game_ids)
             finally:
                 self.game_times_import_finished()
                 self._game_times_import_in_progress = False
 
-        asyncio.create_task(import_game_times(game_ids))
+        asyncio.create_task(import_game_times_task(game_ids))
         self._game_times_import_in_progress = True
 
+    async def import_game_times(self, game_ids):
+        """Call game_time_import_success/game_time_import_failure for each game_id on the list"""
+        try:
+            game_times = await self.get_game_times()
+            game_ids_set = set(game_ids)
+            for game_time in game_times:
+                if game_time.game_id not in game_ids_set:
+                    continue
+                self.game_time_import_success(game_time)
+                game_ids_set.discard(game_time.game_id)
+            for game_id in game_ids_set:
+                self.game_time_import_failure(game_id, UnknownError())
+        except Exception as error:
+            for game_id in game_ids:
+                self.game_time_import_failure(game_id, error)
+
 def create_and_run_plugin(plugin_class, argv):
     if len(argv) < 3:
         logging.critical("Not enough parameters, required: token, port")