feat(notif): add LunaSea agent (#1495)

* feat(notif): add LunaSea agent

* feat(notif): change LunaSea 'Authorization Header' input field to 'Profile Name'

server/index.ts

@@ -16,6 +16,7 @@ import { startJobs } from './job/schedule';
 import notificationManager from './lib/notifications';
 import DiscordAgent from './lib/notifications/agents/discord';
 import EmailAgent from './lib/notifications/agents/email';
+import LunaSeaAgent from './lib/notifications/agents/lunasea';
 import PushbulletAgent from './lib/notifications/agents/pushbullet';
 import PushoverAgent from './lib/notifications/agents/pushover';
 import SlackAgent from './lib/notifications/agents/slack';
@@ -53,6 +54,7 @@ app
     notificationManager.registerAgents([
       new DiscordAgent(),
       new EmailAgent(),
+      new LunaSeaAgent(),
       new PushbulletAgent(),
       new PushoverAgent(),
       new SlackAgent(),

server/lib/notifications/agents/lunasea.ts

@@ -0,0 +1,104 @@
+import axios from 'axios';
+import { hasNotificationType, Notification } from '..';
+import { MediaStatus } from '../../../constants/media';
+import logger from '../../../logger';
+import { getSettings, NotificationAgentLunaSea } from '../../settings';
+import { BaseAgent, NotificationAgent, NotificationPayload } from './agent';
+
+class LunaSeaAgent
+  extends BaseAgent<NotificationAgentLunaSea>
+  implements NotificationAgent {
+  protected getSettings(): NotificationAgentLunaSea {
+    if (this.settings) {
+      return this.settings;
+    }
+
+    const settings = getSettings();
+
+    return settings.notifications.agents.lunasea;
+  }
+
+  private buildPayload(type: Notification, payload: NotificationPayload) {
+    return {
+      notification_type: Notification[type],
+      subject: payload.subject,
+      message: payload.message,
+      image: payload.image ?? null,
+      email: payload.notifyUser?.email,
+      username: payload.notifyUser?.username,
+      avatar: payload.notifyUser?.avatar,
+      media: payload.media
+        ? {
+            media_type: payload.media.mediaType,
+            tmdbId: payload.media.tmdbId,
+            imdbId: payload.media.imdbId,
+            tvdbId: payload.media.tvdbId,
+            status: MediaStatus[payload.media.status],
+            status4k: MediaStatus[payload.media.status4k],
+          }
+        : null,
+      extra: payload.extra ?? [],
+      request: payload.request
+        ? {
+            request_id: payload.request.id,
+            requestedBy_email: payload.request.requestedBy.email,
+            requestedBy_username: payload.request.requestedBy.displayName,
+            requestedBy_avatar: payload.request.requestedBy.avatar,
+          }
+        : null,
+    };
+  }
+
+  public shouldSend(type: Notification): boolean {
+    if (
+      this.getSettings().enabled &&
+      this.getSettings().options.webhookUrl &&
+      hasNotificationType(type, this.getSettings().types)
+    ) {
+      return true;
+    }
+
+    return false;
+  }
+
+  public async send(
+    type: Notification,
+    payload: NotificationPayload
+  ): Promise<boolean> {
+    logger.debug('Sending LunaSea notification', {
+      label: 'Notifications',
+      type: Notification[type],
+      subject: payload.subject,
+    });
+
+    try {
+      const { webhookUrl, profileName } = this.getSettings().options;
+
+      if (!webhookUrl) {
+        return false;
+      }
+
+      await axios.post(webhookUrl, this.buildPayload(type, payload), {
+        headers: {
+          Authorization: `Basic ${Buffer.from(`${profileName}:`).toString(
+            'base64'
+          )}`,
+        },
+      });
+
+      return true;
+    } catch (e) {
+      logger.error('Error sending LunaSea notification', {
+        label: 'Notifications',
+        type: Notification[type],
+        subject: payload.subject,
+        errorMessage: e.message,
+        response: e.response.data,
+      });
+
+      return false;
+    }
+  }
+}
+
+export default LunaSeaAgent;

server/lib/settings.ts

@@ -140,6 +140,13 @@ export interface NotificationAgentEmail extends NotificationAgentConfig {
   };
 }
 
+export interface NotificationAgentLunaSea extends NotificationAgentConfig {
+  options: {
+    webhookUrl: string;
+    profileName: string;
+  };
+}
+
 export interface NotificationAgentTelegram extends NotificationAgentConfig {
   options: {
     botUsername?: string;
@@ -185,6 +192,7 @@ export enum NotificationAgentKey {
 interface NotificationAgents {
   discord: NotificationAgentDiscord;
   email: NotificationAgentEmail;
+  lunasea: NotificationAgentLunaSea;
   pushbullet: NotificationAgentPushbullet;
   pushover: NotificationAgentPushover;
   slack: NotificationAgentSlack;
@@ -274,6 +282,14 @@ class Settings {
               webhookUrl: '',
             },
           },
+          lunasea: {
+            enabled: false,
+            types: 0,
+            options: {
+              webhookUrl: '',
+              profileName: '',
+            },
+          },
           slack: {
             enabled: false,
             types: 0,

server/routes/settings/notifications.ts

@@ -2,6 +2,7 @@ import { Router } from 'express';
 import { Notification } from '../../lib/notifications';
 import DiscordAgent from '../../lib/notifications/agents/discord';
 import EmailAgent from '../../lib/notifications/agents/email';
+import LunaSeaAgent from '../../lib/notifications/agents/lunasea';
 import PushbulletAgent from '../../lib/notifications/agents/pushbullet';
 import PushoverAgent from '../../lib/notifications/agents/pushover';
 import SlackAgent from '../../lib/notifications/agents/slack';
@@ -332,4 +333,38 @@ notificationRoutes.post('/webhook/test', (req, res, next) => {
   }
 });
 
+notificationRoutes.get('/lunasea', (_req, res) => {
+  const settings = getSettings();
+
+  res.status(200).json(settings.notifications.agents.lunasea);
+});
+
+notificationRoutes.post('/lunasea', (req, res) => {
+  const settings = getSettings();
+
+  settings.notifications.agents.lunasea = req.body;
+  settings.save();
+
+  res.status(200).json(settings.notifications.agents.lunasea);
+});
+
+notificationRoutes.post('/lunasea/test', (req, res, next) => {
+  if (!req.user) {
+    return next({
+      status: 500,
+      message: 'User information missing from request',
+    });
+  }
+
+  const lunaseaAgent = new LunaSeaAgent(req.body);
+  lunaseaAgent.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();
+});
+
 export default notificationRoutes;