Merge pull request #23 from adator85/v2.x.x

Moving to version 2

Author: adator85

README.MD

@@ -49,31 +49,29 @@ If you are using Python3, this package can help you to parse all json responses
             path_to_socket_file='/path/to/unrealircd/data/rpc.socket'
         )
 ```
-### Live Connection (Local Only)
+### Live Connection using UnixSocket (Local Only)
 ```python
-    from unrealircd_rpc_py.Live import Live
+    from unrealircd_rpc_py.Live import LiveUnixSocket
     # Live Connection (Local only) using unix socket
-    LiveRpc = Live(
-        req_method='unixsocket',
-        path_to_socket_file='/path/to/unrealircd/data/rpc.socket',
+    LiveRpc = LiveUnixSocket(
         callback_object_instance=Callback_class_instance,
-        callback_method_name='your_method_name'
+        callback_method_name='your_method_name',
+        path_to_socket_file='/path/to/unrealircd/data/rpc.socket'
     )
 ```
-### Live connection (Local or Remote)
+### Live connection using Websocket (Local or Remote)
 ```python
-    from unrealircd_rpc_py.Live import Live
-    # Live Connection (Local Or Remote)
-    liveRpc = Live(
-        req_method='websocket',
+    from unrealircd_rpc_py.Live import LiveWebsocket
+    # Live Connection (Local Or Remote) using websocket
+    liveRpc = LiveWebsocket(
+        callback_object_instance=InitCallbackClass,
+        callback_method_name='your_method_name',
         url='https://your.irc.domaine.org:8600/api',
         username='apiname',
-        password='apiPASSWORD',
-        callback_object_instance=InitCallbackClass,
-        callback_method_name='your_method_name'
+        password='apiPASSWORD'
     )
 ```
-## How to work with (remotly)
+## How to work with remotly
 This package allows easy interfacing with UnrealIRCd through regular Python3 code, such as:
 ```python
     from unrealircd_rpc_py.Loader import Loader
@@ -169,18 +167,18 @@ This package allows easy interfacing with UnrealIRCd through regular Python3 cod
 # Live Connection via unixsocket or websocket
 ## How to work with (using Live unixsocket)
 ```python
-    from unrealircd_rpc_py.Live import Live
+    from unrealircd_rpc_py.Live import LiveUnixSocket
 
     # This is un callback class that will recieve the response
     from TestObject import TestObject
 
     InitCallbackClass = TestObject()
 
     # The Callback method must always have 1 parameter as string
-    liveRpc = Live(req_method='unixsocket',
-        path_to_socket_file='/path/to/unrealircd/data/rpc.socket',
+    liveRpc = LiveUnixSocket(
         callback_object_instance=InitCallbackClass,
-        callback_method_name='your_method_name'
+        callback_method_name='your_method_name',
+        path_to_socket_file='/path/to/unrealircd/data/rpc.socket'
     )
 
     # This method will run forever and will send to your callback method the response
@@ -194,20 +192,20 @@ This package allows easy interfacing with UnrealIRCd through regular Python3 cod
 ```
 ## How to work with (using Live websocket)
 ```python
-    from unrealircd_rpc_py.Live import Live
+    from unrealircd_rpc_py.Live import LiveWebsocket
 
     # This is un callback class that will recieve the response
     from TestObject import TestObject
 
     InitCallbackClass = TestObject()
 
     # The Callback method must always have 1 parameter as string
-    liveRpc = Live(req_method='websocket',
+    liveRpc = LiveWebsocket(
+        callback_object_instance=InitCallbackClass,
+        callback_method_name='your_method_name',
         url='https://your.irc.domaine.org:8600/api',
         username='apiname',
-        password='apiPASSWORD',
-        callback_object_instance=InitCallbackClass,
-        callback_method_name='your_method_name'
+        password='apiPASSWORD'
     )
 
     # This method will run forever and will send to your callback method the response

how_to_use_it.py

@@ -10,6 +10,10 @@
             password='your-rpc-password'
         )
 
+    # Check if connection is correct
+    if rpc.get_error.code != 0:
+        print(f"You error message: {rpc.get_error.message}")
+
     # Use User object
     Users = rpc.User.list_()
 

how_to_use_it_live.py

@@ -0,0 +1,86 @@
+import sys
+from unrealircd_rpc_py.Live import LiveWebsocket
+
+##########################################
+# How to connect using callback function #
+##########################################
+
+def callback_function_irc(response):
+
+    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)
+            return
+
+    level = response.result.level if hasattr(response.result, 'level') else ''
+    subsystem = response.result.subsystem if hasattr(response.result, 'subsystem') else ''
+    event_id = response.result.event_id if hasattr(response.result, 'event_id') else ''
+    log_source = response.result.log_source if hasattr(response.result, 'log_source') else ''
+    msg = response.result.msg if hasattr(response.result, 'msg') else ''
+
+    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
+liverpc = LiveWebsocket(
+            url="https://your.rpc.link:PORT/api",
+            username='Your-rpc-username',
+            password='your-rpc-password',
+            callback_object_instance=sys.modules[__name__],
+            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)
+
+liverpc.subscribe(["all"])
+
+########################################
+# How to connect using callback method #
+########################################
+
+class CallBack:
+
+    def __init__(self):
+
+        self.liverpc: LiveWebsocket = LiveWebsocket(
+            url="https://your.rpc.link:PORT/api",
+            username='Your-rpc-username',
+            password='your-rpc-password',
+            callback_object_instance=self,
+            callback_method_or_function_name='callback_method_irc'
+        )
+
+        if self.liverpc.get_error.code != 0:
+            print(self.liverpc.get_error.message, self.liverpc.get_error.code)
+            return
+
+        self.liverpc.subscribe(['all'])
+
+    def callback_method_irc(self, response):
+
+        if hasattr(response, 'result'):
+            if isinstance(response.result, bool) and response.result:
+                print(self.liverpc.get_error)
+                return
+
+        level = response.result.level if hasattr(response.result, 'level') else ''
+        subsystem = response.result.subsystem if hasattr(response.result, 'subsystem') else ''
+        event_id = response.result.event_id if hasattr(response.result, 'event_id') else ''
+        log_source = response.result.log_source if hasattr(response.result, 'log_source') else ''
+        msg = response.result.msg if hasattr(response.result, 'msg') else ''
+
+        build_msg = f"{log_source}: [{level}] {subsystem}.{event_id} - {msg}"
+        print(build_msg)
+        print(self.liverpc.get_error)
+
+
+CallBack()

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='unrealircd_rpc_py',
-    version='1.1.0',
+    version='2.0.0',
     packages=find_packages(),
     install_requires=[
         "requests>=2.25.1",

unrealircd_rpc_py/EngineError.py

@@ -30,3 +30,17 @@ def set_error(self, code:int, message:str):
         """
         self.Error.code = code
         self.Error.message = message
+
+class InvalidUrlFormat(Exception):
+
+    def __init__(self, detail: str, returncode: int = -1):
+        self.returncode: int = returncode
+        detail = detail.strip()
+        super().__init__(detail)
+
+class UnixSocketFileNotFoundError(Exception):
+
+    def __init__(self, detail: str, returncode: int = -1):
+        self.returncode: int = returncode
+        detail = detail.strip()
+        super().__init__(detail)