Refactor to Modular Program

.gitignore

@@ -1,3 +1 @@
-# Ignore log files
-/log/
-/test/
+/tests/config/config.json

README.md

@@ -16,19 +16,24 @@ Get game events and sync to database.
     "database": "example",
     "user": "user",
     "password": "password"
+  },
+  "planetside2": {
+    "api": "wss://push.planetside2.com/streaming?environment=ps2&service-id=s: ...",
+    "subscription": "{\"service\":\"event\", ... , \"logicalAndCharactersWithWorlds\":true}"
   }
 }
 ```
 
 2. You will need following third-party dependencies to run the application.
 
 ```requirements.txt
-pymysql >= 1.0.2
-websockets >= 10.1
+setuptools==57.0.0
+mysql-connector-python==8.0.28
+websockets==10.1
 ```
 
 3. Use the command below to start.
 
 ```shell
-python -m update_database.py
+python -m ps2cpcdata
 ```

ps2cpcdata/__init__.py

@@ -0,0 +1,8 @@
+"""The program initializes the configuration file and executes the main program."""
+import json
+import logging
+
+logger = logging.getLogger(__name__)
+
+with open("ps2cpcdata/config/config.json", "r") as config:
+    __config__ = json.load(config)

ps2cpcdata/__main__.py

@@ -0,0 +1,56 @@
+"""This module implements the core developer interface for ps2cpcdata."""
+import asyncio
+import json
+import logging
+import sys
+
+import websockets
+
+from ps2cpcdata import __config__
+from ps2cpcdata import database
+
+logging.basicConfig(stream=sys.stderr, level="NOTSET")
+logger = logging.getLogger(__name__)
+
+
+class PS2CPCData(object):
+    def __init__(self):
+        self.planetside = __config__["planetside2"]
+        self.api = self.planetside["api"]
+        self.subscription = self.planetside["subscription"]
+        self.database = database.Mysql()
+
+    async def connect(self):
+        async with websockets.connect(self.api, ping_timeout=None) as ws:
+            await ws.send(self.subscription)
+            while True:
+                message = await ws.recv()
+                data = json.loads(message)
+                await self.update_database(data)
+
+    async def update_database(self, data):
+        try:
+            payload = data["payload"]
+        except KeyError:
+            return
+
+        if "Death" in payload.values():
+            await self.database.death(payload)
+
+        elif "MetagameEvent" in payload.values():
+            await self.database.alert(payload)
+
+
+ps2cpc_data = PS2CPCData()
+
+while True:
+    try:
+        asyncio.run(ps2cpc_data.connect())
+
+    except KeyboardInterrupt:
+        logger.info("The program was closed by the user.")
+        break
+
+    except websockets.WebSocketException:
+        logger.warning("Connection failed, try to reconnect.")
+        continue

ps2cpcdata/config/config.json

@@ -0,0 +1,13 @@
+{
+  "database": {
+    "host": "localhost",
+    "port": 3306,
+    "database": "example",
+    "user": "user",
+    "password": "password"
+  },
+  "planetside2": {
+    "api": "wss://push.planetside2.com/streaming?environment=ps2&service-id=s:yinxue",
+    "subscription": "{\"service\":\"event\",\"action\":\"subscribe\",\"characters\":[\"all\"],\"eventNames\":[\"Death\", \"MetagameEvent\"],\"worlds\":[\"1\", \"10\", \"13\", \"17\", \"40\"], \"logicalAndCharactersWithWorlds\":true}"
+  }
+}

ps2cpcdata/database.py

@@ -0,0 +1,64 @@
+"""This module contains all database operation."""
+import logging
+
+import mysql.connector
+
+from ps2cpcdata import __config__
+
+logger = logging.getLogger(__name__)
+
+
+class Mysql(object):
+    """Mysql database operation."""
+
+    def __init__(self):
+        self.database = __config__["database"]
+        self.conn = mysql.connector.connect(**self.database)
+
+    async def _update(self, insert_event, event):
+        cursor = None
+        try:
+            cursor = self.conn.cursor()
+            cursor.execute(insert_event, event)
+        except mysql.connector.errors.Error as err:
+            logger.exception(err)
+        else:
+            self.conn.commit()
+        finally:
+            cursor.close()
+
+    async def death(self, payload):
+        """Update death event.
+
+        Args:
+            payload: Death event.
+
+        Returns: None.
+
+        """
+        insert_death = "INSERT INTO ps2_death (attacker_character_id, attacker_fire_mode_id, attacker_loadout_id, " \
+                       "attacker_vehicle_id, attacker_weapon_id, character_id, character_loadout_id, is_headshot, " \
+                       "world_id, zone_id) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s)"
+        death = (payload["attacker_character_id"], payload["attacker_fire_mode_id"], payload["attacker_loadout_id"],
+                 payload["attacker_vehicle_id"], payload["attacker_weapon_id"], payload["character_id"],
+                 payload["character_loadout_id"], payload["is_headshot"], payload["world_id"], payload["zone_id"])
+        await self._update(insert_death, death)
+
+    async def alert(self, payload):
+        """Update death event.
+
+        Args:
+            payload: Alert event.
+
+        Returns: None.
+
+        """
+        insert_alert = "INSERT INTO ps2_jingbao (faction_vs, faction_tr, faction_nc, world_id, zone_id, " \
+                       "metagame_event_id, metagame_event_state) VALUES (%s, %s, %s, %s, %s, %s, %s)"
+        alert = ((payload["faction_vs"], payload["faction_tr"], payload["faction_nc"], payload["world_id"],
+                  payload["zone_id"], payload["metagame_event_id"], payload["metagame_event_state"]))
+        await self._update(insert_alert, alert)
+
+
+if __name__ == '__main__':
+    pass

ps2cpcdata/version.py

@@ -0,0 +1,5 @@
+"""Just a version information."""
+__version__ = "2.0.0"
+
+if __name__ == '__main__':
+    print(__version__)

requirements.txt

@@ -0,0 +1,3 @@
+setuptools==57.0.0
+mysql-connector-python==8.0.28
+websockets==10.1

setup.py

@@ -0,0 +1,17 @@
+from setuptools import setup
+
+from ps2cpcdata.version import __version__
+
+setup(
+    name="ps2cpcdata",
+    version=__version__,
+    description="A tool for updating data in real time for the database.",
+    author="ecss11",
+    maintainer="ecss11",
+    url="https://github.com/PlanetSide2-CPC/PS2-DatabaseSync",
+    packages=["ps2cpcdata"],
+    install_requires=[
+        "mysql-connector-python==8.0.28",
+        "websockets==10.1"
+    ]
+)