Refactored Pushbullet backend to remove the dependency from websocket-client and rely only on websockets

platypush/backend/pushbullet/__init__.py

@@ -1,9 +1,11 @@
+import asyncio
 import json
 import requests
 import time
-import websocket
+import websockets
 
 from platypush.config import Config
+from platypush.context import get_or_create_event_loop
 from platypush.message import Message
 from platypush.message.event.pushbullet import PushbulletEvent
 
@@ -26,7 +28,7 @@ class PushbulletBackend(Backend):
     Requires:
 
         * **requests** (``pip install requests``)
-        * **websocket-client** (``pip install websocket-client``)
+        * **websockets** (``pip install websockets``)
     """
 
     def __init__(self, token, device='Platypush', **kwargs):
@@ -43,6 +45,7 @@ class PushbulletBackend(Backend):
         self.token = token
         self.device_name = device
         self.pb_device_id = self.get_device_id()
+        self.ws = None
 
         self._last_received_msg = {
             'request'  : { 'body': None, 'time': None },
@@ -94,57 +97,78 @@ class PushbulletBackend(Backend):
 
         return is_duplicate
 
-    def on_push(self):
+    def on_push(self, ws, data):
-        def _f(ws, data):
+        try:
+            # Parse the push
             try:
-                # Parse the push
+                data = json.loads(data) if isinstance(data, str) else data
-                try:
-                    data = json.loads(data) if isinstance(data, str) else push
-                except Exception as e:
-                    self.logger.exception(e)
-                    return
-
-                # If it's a push, get it
-                if data['type'] == 'tickle' and data['subtype'] == 'push':
-                    push = self._get_latest_push()
-                elif data['type'] == 'push':
-                    push = data['push']
-                else: return  # Not a push notification
-
-                # Post an event, useful to react on mobile notifications if
-                # you enabled notification mirroring on your PushBullet app
-                event = PushbulletEvent(**push)
-                self.on_message(event)
-
-                if 'body' not in push: return
-                self.logger.debug('Received push: {}'.format(push))
-
-                body = push['body']
-                try: body = json.loads(body)
-                except ValueError as e: return  # Some other non-JSON push
-
-                if not self._should_skip_last_received_msg(body):
-                    self.on_message(body)
             except Exception as e:
                 self.logger.exception(e)
                 return
 
-        return _f
+            # If it's a push, get it
+            if data['type'] == 'tickle' and data['subtype'] == 'push':
+                push = self._get_latest_push()
+            elif data['type'] == 'push':
+                push = data['push']
+            else: return  # Not a push notification
 
-    def on_error(self):
+            # Post an event, useful to react on mobile notifications if
-        def _f(ws, e):
+            # you enabled notification mirroring on your PushBullet app
+            event = PushbulletEvent(**push)
+            self.on_message(event)
+
+            if 'body' not in push: return
+            self.logger.debug('Received push: {}'.format(push))
+
+            body = push['body']
+            try: body = json.loads(body)
+            except ValueError as e: return  # Some other non-JSON push
+
+            if not self._should_skip_last_received_msg(body):
+                self.on_message(body)
+        except Exception as e:
             self.logger.exception(e)
-            self.logger.info('Restarting PushBullet backend')
+            return
-            ws.close()
-            self._init_socket()
 
-        return _f
+    def on_error(self, ws, e):
+        self.logger.exception(e)
+        self.logger.info('Restarting PushBullet backend')
+        ws.close()
+        self._init_socket()
 
     def _init_socket(self):
-        self.ws = websocket.WebSocketApp(
+        async def pushbullet_client():
-            'wss://stream.pushbullet.com/websocket/' + self.token,
+            async with websockets.connect('wss://stream.pushbullet.com/websocket/'
-            on_message = self.on_push(),
+                                          + self.token) as self.ws:
-            on_error = self.on_error())
+                while True:
+                    try:
+                        push = await self.ws.recv()
+                    except Exception as e:
+                        self.on_error(ws, e)
+                        break
+
+                    self.on_push(self.ws, push)
+
+        self.close()
+        loop = get_or_create_event_loop()
+
+        loop.run_until_complete(pushbullet_client())
+        loop.run_forever()
+
+    def create_device(self, name):
+        return requests.post(
+            u'https://api.pushbullet.com/v2/devices',
+            headers = { 'Access-Token': self.token },
+            json = {
+                'nickname': name,
+                'model': 'Platypush virtual device',
+                'manufactorer': 'platypush',
+                'app_version': 8623,
+                'icon': 'system',
+            }
+        ).json()
+
 
     def get_device_id(self):
         response = requests.get(
@@ -155,11 +179,21 @@ class PushbulletBackend(Backend):
         devices = [dev for dev in response['devices'] if 'nickname' in dev
                    and dev['nickname'] == self.device_name]
 
-        if not devices:
+        if devices:
-            raise RuntimeError('No such Pushbullet device: {}'
+            return devices[0]['iden']
-                               .format(self.device_name))
 
-        return devices[0]['iden']
+        try:
+            response = self.create_device(self.device_name)
+            if 'iden' not in response:
+                raise RuntimeError()
+
+            self.logger.info('Created Pushbullet device {}'.format(
+                self.device_name))
+
+            return response['iden']
+        except Exception as e:
+            self.logger.error('Unable to create Pushbillet device {}'.
+                                format(self.device_name))
 
     def send_message(self, msg):
         requests.post(
@@ -172,17 +206,19 @@ class PushbulletBackend(Backend):
             }
         ).json()
 
+    def close(self):
+        if self.ws:
+            self.ws.close()
+
     def on_stop(self):
-        self.ws.close()
+        return self.close()
 
     def run(self):
         super().run()
 
-        self._init_socket()
         self.logger.info('Initialized Pushbullet backend - device_id: {}'
                      .format(self.device_name))
-
+        self._init_socket()
-        self.ws.run_forever()
 
 # vim:sw=4:ts=4:et:
 

requirements.txt

@@ -11,9 +11,6 @@ pyyaml
 # Apache Kafka backend support
 kafka-python
 
-# PushBullet backend support
-websocket-client
-
 # HTTP backend support
 flask
 websockets

setup.py

@@ -61,11 +61,12 @@ setup(
     install_requires = [
         'pyyaml',
         'redis',
+        'requests',
     ],
     extras_require = {
         'Support for Apache Kafka backend': ['kafka-python'],
-        'Support for Pushbullet backend': ['requests', 'websocket-client'],
+        'Support for Pushbullet backend': ['requests', 'websockets'],
-        'Support for HTTP backend': ['flask','websockets'],
+        'Support for HTTP backend': ['flask','websockets', 'python-dateutil'],
         'Support for HTTP poll backend': ['frozendict'],
         'Support for database plugin': ['sqlalchemy'],
         'Support for RSS feeds': ['feedparser'],
@@ -93,7 +94,7 @@ setup(
         'Support for Chromecast plugin': ['pychromecast'],
         'Support for sound devices': ['sounddevice', 'soundfile', 'numpy'],
         # 'Support for Leap Motion backend': ['git+ssh://git@github.com:BlackLight/leap-sdk-python3.git'],
-        # 'Support for Flic buttons': ['git+ssh://git@github.com/50ButtonsEach/fliclib-linux-hci']
+        # 'Support for Flic buttons': ['git+https://@github.com/50ButtonsEach/fliclib-linux-hci.git']
     },
 )