feat: Completed API

Author: dploeger

lib/api/check.ts renamed to lib/api/Check.ts

@@ -1,5 +1,5 @@
 import got from 'got'
-import { Check } from './check'
+import { Check } from './Check'
 import { Logger } from 'loglevel'
 import { ConfigurationError } from '../error/ConfigurationError'
 import * as SMTPTransport from 'nodemailer/lib/smtp-transport'
@@ -48,6 +48,11 @@ export class Configuration {
    */
   public domain: string
 
+  /**
+   * From address for notifications
+   */
+  public notificationFrom: string
+
   /**
    * Transport options for nodemailer for the notifications
    */
@@ -139,6 +144,7 @@ export class Configuration {
 
       this.domain = configuration.domain || null
       this.space = configuration.space || null
+      this.notificationFrom = configuration.notificationfrom || null
 
       // Load checks
 

lib/api/configuration.ts renamed to lib/api/Configuration.ts

@@ -3,7 +3,7 @@ import moment = require('moment')
 import { Logger } from 'loglevel'
 import log = require('loglevel')
 import { ConfluenceError } from '../error/ConfluenceError'
-import { DocumentInfo } from './documentInfo'
+import { DocumentInfo } from './DocumentInfo'
 import { Moment } from 'moment'
 
 /**

lib/api/confluence.ts renamed to lib/api/Confluence.ts

@@ -0,0 +1,29 @@
+import { Configuration } from './Configuration'
+import { Confluence } from './Confluence'
+import { createTransport } from 'nodemailer'
+import * as Mail from 'nodemailer/lib/mailer'
+import { DocumentInfo } from './DocumentInfo'
+import * as Handlebars from 'handlebars'
+
+export class Notification {
+  private _configuration: Configuration
+  private _confluence: Confluence
+  private _transport: Mail
+
+  constructor(configuration: Configuration, confluence: Confluence, transport: Mail = null) {
+    this._configuration = configuration
+    this._confluence = confluence
+    this._transport = transport || createTransport(this._configuration.transportOptions)
+  }
+
+  public async notify(documentInfo: DocumentInfo): Promise<void> {
+    const subjectTemplate = Handlebars.compile(this._configuration.notificationSubjectTemplate)
+    const bodyTemplate = Handlebars.compile(this._configuration.notificationBodyTemplate)
+    await this._transport.sendMail({
+      from: this._configuration.notificationFrom,
+      to: `${documentInfo.author}@${this._configuration.domain}`,
+      subject: subjectTemplate(documentInfo),
+      html: bodyTemplate(documentInfo),
+    })
+  }
+}

lib/api/documentInfo.ts renamed to lib/api/DocumentInfo.ts

@@ -1,8 +1,8 @@
-import { Configuration } from './configuration'
-import { Confluence } from './confluence'
+import { Configuration } from './Configuration'
+import { Confluence } from './Confluence'
 import { Logger } from 'loglevel'
 import log = require('loglevel')
-import { Notification } from './notification'
+import { Notification } from './Notification'
 
 /**
  * The main out of date checker

lib/api/Notification.ts

@@ -27,7 +27,8 @@
     "loglevel": "^1.6.8",
     "got": "^11.3.0",
     "nodemailer": "^6.4.10",
-    "cheerio": "^1.0.0-rc.3"
+    "cheerio": "^1.0.0-rc.3",
+    "handlebars": "^4.7.6"
   },
   "devDependencies": {
     "@types/bluebird": "^3.5.32",
@@ -57,6 +58,8 @@
     "ts-node": "^8.10.2",
     "moment": "^2.27.0",
     "@types/nodemailer": "^6.4.0",
-    "@types/cheerio": "^0.22.18"
+    "@types/cheerio": "^0.22.18",
+    "sinon": "^9.0.2",
+    "@types/sinon": "^9.0.4"
   }
 }

lib/api/outdateCheck.ts renamed to lib/api/OutdateCheck.ts

@@ -1,5 +1,5 @@
 import 'mocha'
-import { Configuration } from '../lib/api/configuration'
+import { Configuration } from '../lib/api/Configuration'
 import { MockServer } from './MockServer'
 import chai = require('chai')
 import chaiAsPromised = require('chai-as-promised')
@@ -24,5 +24,7 @@ describe('The Configuration API', (): void => {
 
     chai.expect(configuration.transportOptions.host).to.eq('localhost')
     chai.expect(configuration.transportOptions.port).to.eq('25')
+
+    chai.expect(configuration.notificationFrom).to.eq('Notification <[email protected]>')
   })
 })