feat(notif): Add Pushbullet notification agent (#950)

server/index.ts

@@ -24,6 +24,7 @@ import SlackAgent from './lib/notifications/agents/slack';
 import PushoverAgent from './lib/notifications/agents/pushover';
 import WebhookAgent from './lib/notifications/agents/webhook';
 import { getClientIp } from '@supercharge/request-ip';
+import PushbulletAgent from './lib/notifications/agents/pushbullet';
 
 const API_SPEC_PATH = path.join(__dirname, '../overseerr-api.yml');
 
@@ -51,9 +52,10 @@ app
     notificationManager.registerAgents([
       new DiscordAgent(),
       new EmailAgent(),
+      new PushbulletAgent(),
+      new PushoverAgent(),
       new SlackAgent(),
       new TelegramAgent(),
-      new PushoverAgent(),
       new WebhookAgent(),
     ]);
 

server/lib/notifications/agents/pushbullet.ts

@@ -0,0 +1,146 @@
+import axios from 'axios';
+import { hasNotificationType, Notification } from '..';
+import logger from '../../../logger';
+import { getSettings, NotificationAgentPushbullet } from '../../settings';
+import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
+
+interface PushbulletPayload {
+  title: string;
+  body: string;
+}
+
+class PushbulletAgent
+  extends BaseAgent<NotificationAgentPushbullet>
+  implements NotificationAgent {
+  protected getSettings(): NotificationAgentPushbullet {
+    if (this.settings) {
+      return this.settings;
+    }
+
+    const settings = getSettings();
+
+    return settings.notifications.agents.pushbullet;
+  }
+
+  public shouldSend(type: Notification): boolean {
+    if (
+      this.getSettings().enabled &&
+      this.getSettings().options.accessToken &&
+      hasNotificationType(type, this.getSettings().types)
+    ) {
+      return true;
+    }
+
+    return false;
+  }
+
+  private constructMessageDetails(
+    type: Notification,
+    payload: NotificationPayload
+  ): {
+    title: string;
+    body: string;
+  } {
+    let messageTitle = '';
+    let message = '';
+
+    const title = payload.subject;
+    const plot = payload.message;
+    const username = payload.notifyUser.displayName;
+
+    switch (type) {
+      case Notification.MEDIA_PENDING:
+        messageTitle = 'New Request';
+        message += `${title}`;
+        if (plot) {
+          message += `\n\n${plot}`;
+        }
+        message += `\n\nRequested By: ${username}`;
+        message += `\nStatus: Pending Approval`;
+        break;
+      case Notification.MEDIA_APPROVED:
+        messageTitle = 'Request Approved';
+        message += `${title}`;
+        if (plot) {
+          message += `\n\n${plot}`;
+        }
+        message += `\n\nRequested By: ${username}`;
+        message += `\nStatus: Processing`;
+        break;
+      case Notification.MEDIA_AVAILABLE:
+        messageTitle = 'Now Available';
+        message += `${title}`;
+        if (plot) {
+          message += `\n\n${plot}`;
+        }
+        message += `\n\nRequested By: ${username}`;
+        message += `\nStatus: Available`;
+        break;
+      case Notification.MEDIA_DECLINED:
+        messageTitle = 'Request Declined';
+        message += `${title}`;
+        if (plot) {
+          message += `\n\n${plot}`;
+        }
+        message += `\n\nRequested By: ${username}`;
+        message += `\nStatus: Declined`;
+        break;
+      case Notification.MEDIA_FAILED:
+        messageTitle = 'Failed Request';
+        message += `${title}`;
+        if (plot) {
+          message += `\n\n${plot}`;
+        }
+        message += `\n\nRequested By: ${username}`;
+        message += `\nStatus: Failed`;
+        break;
+      case Notification.TEST_NOTIFICATION:
+        messageTitle = 'Test Notification';
+        message += `${plot}`;
+        break;
+    }
+
+    return {
+      title: messageTitle,
+      body: message,
+    };
+  }
+
+  public async send(
+    type: Notification,
+    payload: NotificationPayload
+  ): Promise<boolean> {
+    logger.debug('Sending Pushbullet notification', { label: 'Notifications' });
+    try {
+      const endpoint = 'https://api.pushbullet.com/v2/pushes';
+
+      const { accessToken } = this.getSettings().options;
+
+      const { title, body } = this.constructMessageDetails(type, payload);
+
+      await axios.post(
+        endpoint,
+        {
+          type: 'note',
+          title: title,
+          body: body,
+        } as PushbulletPayload,
+        {
+          headers: {
+            'Access-Token': accessToken,
+          },
+        }
+      );
+
+      return true;
+    } catch (e) {
+      logger.error('Error sending Pushbullet notification', {
+        label: 'Notifications',
+        message: e.message,
+      });
+      return false;
+    }
+  }
+}
+
+export default PushbulletAgent;

server/lib/settings.ts

@@ -111,12 +111,17 @@ export interface NotificationAgentTelegram extends NotificationAgentConfig {
   };
 }
 
+export interface NotificationAgentPushbullet extends NotificationAgentConfig {
+  options: {
+    accessToken: string;
+  };
+}
+
 export interface NotificationAgentPushover extends NotificationAgentConfig {
   options: {
     accessToken: string;
     userToken: string;
     priority: number;
-    sound: string;
   };
 }
 
@@ -129,11 +134,12 @@ export interface NotificationAgentWebhook extends NotificationAgentConfig {
 }
 
 interface NotificationAgents {
-  email: NotificationAgentEmail;
   discord: NotificationAgentDiscord;
+  email: NotificationAgentEmail;
+  pushbullet: NotificationAgentPushbullet;
+  pushover: NotificationAgentPushover;
   slack: NotificationAgentSlack;
   telegram: NotificationAgentTelegram;
-  pushover: NotificationAgentPushover;
   webhook: NotificationAgentWebhook;
 }
 
@@ -224,6 +230,13 @@ class Settings {
               sendSilently: false,
             },
           },
+          pushbullet: {
+            enabled: false,
+            types: 0,
+            options: {
+              accessToken: '',
+            },
+          },
           pushover: {
             enabled: false,
             types: 0,
@@ -231,7 +244,6 @@ class Settings {
               accessToken: '',
               userToken: '',
               priority: 0,
-              sound: '',
             },
           },
           webhook: {

server/routes/settings/notifications.ts

@@ -7,6 +7,7 @@ import SlackAgent from '../../lib/notifications/agents/slack';
 import TelegramAgent from '../../lib/notifications/agents/telegram';
 import PushoverAgent from '../../lib/notifications/agents/pushover';
 import WebhookAgent from '../../lib/notifications/agents/webhook';
+import PushbulletAgent from '../../lib/notifications/agents/pushbullet';
 
 const notificationRoutes = Router();
 
@@ -135,6 +136,40 @@ notificationRoutes.post('/telegram/test', (req, res, next) => {
   return res.status(204).send();
 });
 
+notificationRoutes.get('/pushbullet', (_req, res) => {
+  const settings = getSettings();
+
+  res.status(200).json(settings.notifications.agents.pushbullet);
+});
+
+notificationRoutes.post('/pushbullet', (req, res) => {
+  const settings = getSettings();
+
+  settings.notifications.agents.pushbullet = req.body;
+  settings.save();
+
+  res.status(200).json(settings.notifications.agents.pushbullet);
+});
+
+notificationRoutes.post('/pushbullet/test', (req, res, next) => {
+  if (!req.user) {
+    return next({
+      status: 500,
+      message: 'User information missing from request',
+    });
+  }
+
+  const pushbulletAgent = new PushbulletAgent(req.body);
+  pushbulletAgent.send(Notification.TEST_NOTIFICATION, {
+    notifyUser: req.user,
+    subject: 'Test Notification',
+    message:
+      'This is a test notification! Check check, 1, 2, 3. Are we coming in clear?',
+  });
+
+  return res.status(204).send();
+});
+
 notificationRoutes.get('/pushover', (_req, res) => {
   const settings = getSettings();