Merge pull request #2 from py-package/feature/clients

Feature/clients

Author: yubarajshrestha

README.md

@@ -17,6 +17,10 @@
 
 It's an extra broadcast driver support for SocketIO in masonite 4, it extends default masonite broadcast driver to support SocketIO.
 
+**Masonite Broadcast Server and Client Library**
+- [x] [Broadcast Server](https://github.com/py-package/masonite-broadcast-server)
+- [x] [broadcast Client](https://github.com/py-package/masonite-broadcast-client)
+
 **Setup**
 
 Install package using pip:
@@ -76,3 +80,14 @@ class YourController(Controller):
         }
         broadcast.channel(["channel-name"], "event-name", broadcast_data)
 ```
+
+**Helpers**
+
+List all connected clients:
+    
+```python
+from socketio_driver.facades import Communicator
+
+communicator.clients() # get list of connected clients
+communicator.client(id='client-id') # get client by id, id is basically a socket.io session id
+```

setup.py

@@ -5,9 +5,10 @@
 
 setup(
     name="masonite-socketio-driver",
-    version='2.0.5',
+    version='2.0.6',
     packages=[
         "socketio_driver",
+        "socketio_driver.models",
         "socketio_driver.config",
         "socketio_driver.drivers",
         "socketio_driver.providers"
@@ -29,7 +30,7 @@
         #   3 - Alpha
         #   4 - Beta
         #   5 - Production/Stable
-        "Development Status :: 3 - Alpha",
+        "Development Status :: 5 - Production/Stable",
         # Indicate who your project is intended for
         "Intended Audience :: Developers",
         "Environment :: Web Environment",

src/socketio_driver/__init__.py

@@ -1 +1,2 @@
+# flake8: noqa: E501
 from .providers.socket_provider import SocketProvider

src/socketio_driver/communicator.py

@@ -1,14 +1,24 @@
+from masonite.configuration import config
+import json
 import redis
 import msgpack
+from .models.socket_client import SocketClient
 
 
 class Communicator:
 
     EVENT = 2
     BINARY_EVENT = 5
 
-    def __init__(self, opts):
-        self._opts = opts
+    def __init__(self, application):
+        self.config = config("broadcast").get("broadcasts").get("socketio")
+        self.application = application
+
+        self._opts = {
+            "host": self.config.get("host"),
+            "port": self.config.get("port"),
+        }
+
         self._rooms = []
         self._flags = {}
 
@@ -103,5 +113,13 @@ def _createClient(self):
     def pubsub(self):
         return self._client.pubsub()
 
+    def clients(self):
+        client_keys = self._client.keys(pattern="mbroadcast_users:*")
+        return [self.user(key) for key in client_keys]
+
+    def client(self, id):
+        client_json_string = self._client.get(id)
+        return SocketClient(**json.loads(client_json_string))
+
     def authenticate(self):
         return True

src/socketio_driver/drivers/__init__.py

@@ -1 +1,2 @@
+# flake8: noqa: E501
 from .socket_driver import SocketDriver

src/socketio_driver/drivers/socket_driver.py

@@ -1,6 +1,3 @@
-from ..communicator import Communicator
-
-
 class SocketDriver:
     def __init__(self, application) -> None:
         self.application = application
@@ -15,12 +12,7 @@ def get_connection(self):
         if self.connection:
             return self.connection
 
-        self.connection = Communicator(
-            {
-                "host": self.options.get("host"),
-                "port": self.options.get("port"),
-            }
-        )
+        self.connection = self.application.make("communicator")
 
         return self.connection
 

src/socketio_driver/facades/__init__.py

@@ -0,0 +1,2 @@
+# flake8: noqa: E501
+from .communicator import Communicator

src/socketio_driver/facades/communicator.py

@@ -0,0 +1,5 @@
+from masonite.facades import Facade
+
+
+class Communicator(metaclass=Facade):
+    key = "communicator"

src/socketio_driver/facades/communicator.pyi

@@ -0,0 +1,10 @@
+from typing import Optional
+from ..models.socket_client import SocketClient
+
+class Communicator:
+    def clients() -> list[SocketClient]:
+        """Returns a list of all clients."""
+        ...
+    def client(id: str) -> SocketClient | None:
+        """Returns a client by id."""
+        ...

src/socketio_driver/models/socket_client.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class SocketClient:
+    id: str
+    name: str
+    address: str