@tryghost/email-mock-receiver 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2023 Ghost Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,30 @@
+# Email Mock Receiver
+
+Mocks email sending method and manages snapshots for outgoing email information such as to addresses, html content of emails, etc.
+
+## Install
+
+`npm install @tryghost/email-mock-receiver --save`
+
+or
+
+`yarn add @tryghost/email-mock-receiver`
+
+## Usage
+
+
+## Develop
+
+This is a monorepo package.
+
+Follow the instructions for the top-level repo.
+1. `git clone` this repo & `cd` into it as usual
+2. Run `yarn` to install top-level dependencies.
+
+
+
+## Test
+
+- `yarn lint` run just eslint
+- `yarn test` run lint and tests
+

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/email-mock-receiver');

package/lib/email-mock-receiver.js

@@ -0,0 +1,77 @@
+const assert = require('assert');
+const {AssertionError} = require('assert');
+
+class EmailMockReceiver {
+    #sendResponse;
+    #snapshotManager;
+    #snapshots = [];
+
+    constructor({snapshotManager, sendResponse = 'Mail is disabled'}) {
+        this.#snapshotManager = snapshotManager;
+        this.#sendResponse = sendResponse;
+    }
+
+    /**
+     * Method mocking email sending logic
+     *
+     * @param {Object} message
+     * @param {string} message.subject - email subject
+     * @param {string} message.html - email content
+     * @param {string} message.to - email recipient address
+     * @param {string} [message.replyTo]
+     * @param {string} [message.from] - sender email address
+     * @param {string} [message.text] - text version of this message
+     */
+    async send(message) {
+        // store snapshot
+        this.#snapshots.push(message);
+
+        return this.#sendResponse;
+    }
+
+    sentEmailCount(count) {
+        assert.equal(this.#snapshots.length, count, 'Email count does not match');
+    }
+
+    matchHTMLSnapshot(snapshotIndex = 0) {
+        const error = new AssertionError({});
+
+        let assertion = {
+            properties: null,
+            field: 'html',
+            hint: `[html ${snapshotIndex + 1}]`,
+            error
+        };
+
+        this.#snapshotManager.assertSnapshot({
+            html: this.#snapshots[snapshotIndex].html
+        }, assertion);
+
+        return this;
+    }
+
+    matchMetadataSnapshot(snapshotIndex = 0, properties = {}) {
+        const error = new AssertionError({});
+        let assertion = {
+            properties: properties,
+            field: 'metadata',
+            hint: `[metadata ${snapshotIndex + 1}]`,
+            error
+        };
+
+        const metadata = Object.assign({}, this.#snapshots[snapshotIndex]);
+        delete metadata.html;
+
+        this.#snapshotManager.assertSnapshot({
+            metadata
+        }, assertion);
+
+        return this;
+    }
+
+    reset() {
+        this.#snapshots = [];
+    }
+}
+
+module.exports = EmailMockReceiver;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@tryghost/email-mock-receiver",
+  "version": "0.1.0",
+  "repository": "https://github.com/TryGhost/framework/tree/main/packages/email-mock-receiver",
+  "author": "Ghost Foundation",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test:unit": "NODE_ENV=testing c8 --all --check-coverage --100  --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+    "test": "yarn test:unit",
+    "lint:code": "eslint *.js lib/ --ext .js --cache",
+    "lint": "yarn lint:code && yarn lint:test",
+    "lint:test": "eslint -c test/.eslintrc.js test/ --ext .js --cache"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "c8": "7.12.0",
+    "mocha": "10.2.0",
+    "sinon": "15.0.1"
+  },
+  "gitHead": "7d645deb73825642289309a43333ee64b9a3a5d1"
+}