@tryghost/webhook-mock-receiver 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2022 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,46 @@
+# Webhook Mock Receiver
+
+Webhook request testing.
+
+It's a bare minimum implementation to be able to check webhook request payload. Few things that need to be done in the future:
+- cleaner module API
+- header snapshot recording/testing
+- better request resolution waiting mechanism (see @TODO list)
+
+## Install
+
+`npm install @tryghost/webhook-mock-receiver --save`
+
+or
+
+`yarn add @tryghost/webhook-mock-receiver`
+
+
+## Usage
+
+
+## Develop
+
+This is a mono repository, managed with [lerna](https://lernajs.io/).
+
+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.
+
+
+## Run
+
+- `yarn dev`
+
+
+## Test
+
+- `yarn lint` run just eslint
+- `yarn test` run lint and tests
+
+
+
+
+# Copyright & License 
+
+Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).

package/index.js

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

package/lib/webhook-mock-receiver.js

@@ -0,0 +1,58 @@
+const util = require('util');
+const {URL} = require('url');
+const nock = require('nock');
+const setTimeoutPromise = util.promisify(setTimeout);
+
+class WebhookMockReceiver {
+    constructor({snapshotManager}) {
+        this.bodyResponse;
+        this.receiver;
+        this.snapshotManager = snapshotManager;
+        this.recordBodyResponse = this.recordBodyResponse.bind(this);
+    }
+
+    recordBodyResponse(body) {
+        this.bodyResponse = {body};
+
+        // let the nock continue with the response
+        return true;
+    }
+
+    /**
+     *
+     * @param {String} url endpoint URL to be mocked
+     * @returns WebhookMockReceiver
+     */
+    mock(url) {
+        const parsedURL = new URL(url);
+
+        this.receiver = nock(parsedURL.origin)
+            .post(parsedURL.pathname, this.recordBodyResponse)
+            .reply(200, {status: 'OK'});
+
+        return this;
+    }
+
+    reset() {
+        nock.cleanAll();
+        this.receiver = undefined;
+        this.bodyResponse = undefined;
+    }
+
+    async matchBodySnapshot(properties = {}) {
+        // @TODO: figure out a better waiting mechanism here, don't allow it to hang forever
+        while (!this.receiver.isDone()) {
+            await setTimeoutPromise(10);
+        }
+
+        let assertion = {
+            properties: properties,
+            field: 'body',
+            type: 'body'
+        };
+
+        this.snapshotManager.assertSnapshot(this.bodyResponse, assertion);
+    }
+}
+
+module.exports = WebhookMockReceiver;

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tryghost/webhook-mock-receiver",
+  "version": "0.1.0",
+  "repository": "https://github.com/TryGhost/framework/tree/main/packages/webhook-mock-receiver",
+  "author": "Ghost Foundation",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing c8 --all --check-coverage --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+    "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",
+    "posttest": "yarn lint"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "c8": "7.11.3",
+    "got": "9.6.0",
+    "mocha": "10.0.0",
+    "sinon": "14.0.0"
+  },
+  "gitHead": "0af921ce800c79f89685307914bd6d704302c043"
+}