Merge pull request #26 from adator85/V2.x.x

V2.0.5

Author: adator85

.gitignore

@@ -9,5 +9,4 @@ docs/*
 setup.py
 test.py
 test_live.py
-CallbackObject.py
 *.zip

how_to_use_it_live.py

@@ -1,16 +1,33 @@
+import asyncio
 import sys
+import time
+import threading
+from types import SimpleNamespace
 from unrealircd_rpc_py.Live import LiveWebsocket
 
 ##########################################
 # How to connect using callback function #
 ##########################################
 
-def callback_function_irc(response):
+def callback_function_irc(response: SimpleNamespace) -> None:
+    # Response model: https://www.unrealircd.org/docs/JSON-RPC:Log#log.subscribe
+    # Possible responses: https://www.unrealircd.org/docs/List_of_all_log_messages
+
+    # High level error
+    if liverpc.get_error.code != 0:
+        print("ERROR:", liverpc.get_error.code, liverpc.get_error.message)
+        return
+
+    # Because of the concurrent approach! there is also local errors
+    if hasattr(response, 'error'):
+        # Check if you are allowed to use log endpoint
+        print(response.error.code, response.error.message)
+        return
 
     if hasattr(response, 'result'):
-        if isinstance(response.result, bool) and response.result:
-            # Check if you are allowed to use log endpoint
-            print(liverpc.get_error)
+        if isinstance(response.result, bool):
+            if response.result:
+                print(f"{response.method} has been activated")
             return
 
     level = response.result.level if hasattr(response.result, 'level') else ''
@@ -21,10 +38,6 @@ def callback_function_irc(response):
 
     build_msg = f"{log_source}: [{level}] {subsystem}.{event_id} - {msg}"
 
-    # Check if there is an error
-    if liverpc.get_error.code != 0:
-        print(f"Your Error message: {liverpc.get_error.message}")
-
     print(build_msg)
 
 # Init your live stream using websocket
@@ -36,12 +49,28 @@ def callback_function_irc(response):
             callback_method_or_function_name='callback_function_irc'
         )
 
-# Check if connection is correct
-if liverpc.get_error.code != 0:
-    print(liverpc.get_error.message, liverpc.get_error.code)
-    sys.exit(1)
+def thread_subscribe() -> None:
+    # This will run until the thread_unsubscribe is called!
+    response = asyncio.run(liverpc.subscribe(["all"]))
+    print(f"FINAL RESPONSE OF SUBSCRIBE: {response}")
 
-liverpc.subscribe(["all"])
+def thread_unsubscribe() -> None:
+    response = asyncio.run(liverpc.unsubscribe())
+    print(f"FINAL RESPONSE OF UNSUBSCRIBE: {response}")
+
+
+th_subscribe = threading.Thread(target=thread_subscribe, daemon=False)
+th_unsubscribe = threading.Thread(target=thread_unsubscribe, daemon=False)
+
+# Subscribe to the stream
+th_subscribe.start()
+
+# Do some stuff
+time.sleep(2)
+
+# If you want to disconnect from the stream
+# run your new unsubscribe thread
+th_unsubscribe.start()
 
 ########################################
 # How to connect using callback method #
@@ -63,13 +92,37 @@ def __init__(self):
             print(self.liverpc.get_error.message, self.liverpc.get_error.code)
             return
 
-        self.liverpc.subscribe(['all'])
+    def thread_subscribe(self) -> None:
+
+        response: dict[str, dict] = asyncio.run(self.liverpc.subscribe())
+        print("[JSONRPC SUBSCRIBE] Subscribe to the stream!")
+        print(response)
 
-    def callback_method_irc(self, response):
+    def thread_unsubscribe(self) -> None:
+
+        response: dict[str, dict] = asyncio.run(self.liverpc.unsubscribe())
+        print("[JSONRPC UNSUBSCRIBE] Unsubscribe from the stream!")
+        print(response)
+
+    def callback_method_irc(self, response: SimpleNamespace) -> None:
+        # Response model: https://www.unrealircd.org/docs/JSON-RPC:Log#log.subscribe
+        # Possible responses: https://www.unrealircd.org/docs/List_of_all_log_messages
+
+        # High level error
+        if self.liverpc.get_error.code != 0:
+            print("ERROR:", self.liverpc.get_error.code, self.liverpc.get_error.message)
+            return
+
+        # Because of the concurrent approach! there is also local errors
+        if hasattr(response, 'error'):
+            # Check if you are allowed to use log endpoint
+            print(response.error.code, response.error.message)
+            return
 
         if hasattr(response, 'result'):
-            if isinstance(response.result, bool) and response.result:
-                print(self.liverpc.get_error)
+            if isinstance(response.result, bool):
+                if response.result:
+                    print(f"{response.method} has been activated")
                 return
 
         level = response.result.level if hasattr(response.result, 'level') else ''
@@ -80,7 +133,18 @@ def callback_method_irc(self, response):
 
         build_msg = f"{log_source}: [{level}] {subsystem}.{event_id} - {msg}"
         print(build_msg)
-        print(self.liverpc.get_error)
 
 
-CallBack()
+live_stream = CallBack()
+th_subscribe = threading.Thread(target=live_stream.thread_subscribe)
+th_unsubscribe = threading.Thread(target=live_stream.thread_unsubscribe)
+
+# Subscribe to the stream
+th_subscribe.start()
+
+# Do some stuff
+time.sleep(2)
+
+# If you want to disconnect from the stream
+# run your unsubscribe thread
+th_unsubscribe.start()

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='unrealircd_rpc_py',
-    version='2.0.2',
+    version='2.0.5',
     packages=find_packages(exclude=["tests","test_*"]),
     install_requires=[
         "requests>=2.25.1",

unrealircd_rpc_py/Definition.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field, asdict, fields
 from json import dumps
-from typing import Any
+from typing import Any, Optional
 from warnings import warn
 from functools import wraps
 
@@ -37,8 +37,22 @@ def get_attributes(self) -> list[str]:
 class RPCError(MainModel):
     """This model will contain the error if any"""
     code: int = 0
-    message: str = None
+    message: Optional[str] = None
 
+@dataclass
+class LiveRPCError(MainModel):
+    """This the Live JSONRPC Model Error"""
+    jsonrpc: str = "2.0"
+    error: RPCError = field(default_factory=RPCError())
+    id: int = 123
+
+@dataclass
+class LiveRPCResult(MainModel):
+    """This the Live JSONRPC Model Result"""
+    jsonrpc: str = "2.0"
+    method: Optional[str] = None
+    result: Optional[Any] = None
+    id: int = 123
 
 @dataclass
 class Tls(MainModel):