Webhook signature jwt (#87)

* Add implementation of the webhook signature JWT. * Update the linter. * Fix all lint errors and some lint warnings. * Add GH Actions.
messagebird · Oct 5, 2021 · 8b2295b · 8b2295b
1 parent 5119af8
commit 8b2295b
Show file tree

Hide file tree

Showing 40 changed files with 3,432 additions and 371 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -1,20 +1,17 @@
 {
-  "ecmaFeatures": {
-    "modules": true
-  },
-
+  "extends": "eslint:recommended",
   "env": {
-    "node": true
+    "node": true,
+    "es6": true 
   },
-
   "rules": {
     "array-bracket-spacing": [2, "never"],
     "brace-style": [2, "1tbs", { "allowSingleLine": true }],
     "camelcase": 0,
     "comma-spacing": [2, { "before": false, "after": true }],
     "comma-style": [2, "last"],
     "comma-dangle": [2, "never"],
-    "complexity": [1, 8],
+    "complexity": [1, 10],
     "computed-property-spacing": [2, "never"],
     "consistent-return": 1,
     "curly": [2, "all"],
@@ -96,7 +93,7 @@
     "no-undef": 2,
     "no-undef-init": 2,
     "no-undefined": 2,
-    "no-underscore-dangle": 2,
+    "no-underscore-dangle": [2, {"allow": ["_links", "_extend"]}],
     "no-unexpected-multiline": 2,
     "no-unneeded-ternary": 2,
     "no-unreachable": 2,
@@ -121,15 +118,14 @@
       "before": false,
       "after": true
     }],
-    "space-after-keywords": [2, "always"],
+    "keyword-spacing": 2,
     "space-before-blocks": [2, "always"],
     "space-before-function-paren": [2, {
       "anonymous": "always",
       "named": "never"
     }],
     "space-in-parens": [2, "never"],
     "space-infix-ops": 2,
-    "space-return-throw-case": 2,
     "space-unary-ops": [2, {
       "words": true,
       "nonwords": false

diff --git a/.github/test.yml b/.github/test.yml
@@ -0,0 +1,36 @@
+name: test
+on:
+  push:
+    branches:
+      - '*'
+      - '!master'
+  workflow_dispatch: {}
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: NodeJS ${{ matrix.node }} lint
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup nodejs
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'
+      - run: npm install
+      - run: npm run dtslint
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ '10','11', '12', '13', '14', '15', '16', '17', '18']
+    name: NodeJS ${{ matrix.node }} test
+    env:
+      MB_ACCESSKEY: test_iQpAp0KCs5GCsMpDhIx2leuNB
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup nodejs
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - run: npm install
+      - run: npm run test
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Let's go ahead and initialize the library first. Don't forget to replace `<YOUR_
 CommonJS require syntax:
 
 ```javascript
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 ```
 
 Typescript with ES6 import (or .mjs with Node >= v13):

diff --git a/examples/balance.js b/examples/balance.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.balance.read(function (err, response) {
   if (err) {

diff --git a/examples/calls.js b/examples/calls.js
@@ -1,18 +1,18 @@
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 // create a call
 var params = {
-  source: "<SOURCE_PHONE_NUMBER>",
-  destination: "<DESTINATION_PHONE_NUMBER>",
+  source: '<SOURCE_PHONE_NUMBER>',
+  destination: '<DESTINATION_PHONE_NUMBER>',
   callFlow: {
-    title: "Say message",
+    title: 'Say message',
     steps: [
       {
-        action: "say",
+        action: 'say',
         options: {
-          payload: "This is a journey into sound. Good bye!",
-          voice: "male",
-          language: "en-US"
+          payload: 'This is a journey into sound. Good bye!',
+          voice: 'male',
+          language: 'en-US'
         }
       }
     ]
@@ -21,31 +21,31 @@ var params = {
 
 messagebird.calls.create(params, function (err, response) {
   if (err) {
-      return console.log(err);
+    return console.log(err);
   }
   console.log(response);
 });
 
 // list calls
 messagebird.calls.list(function (err, response) {
   if (err) {
-      return console.log(err);
+    return console.log(err);
   }
   console.log(response);
 });
 
 // read a call
-messagebird.calls.read('<CALL_ID>' ,function (err, response) {
+messagebird.calls.read('<CALL_ID>', function (err, response) {
   if (err) {
-      return console.log(err);
+    return console.log(err);
   }
   console.log(response);
 });
 
 // delete a call
-messagebird.calls.delete('<CALL_ID>' ,function (err, response) {
+messagebird.calls.delete('<CALL_ID>', function (err, response) {
   if (err) {
-      return console.log(err);
+    return console.log(err);
   }
   console.log(response);
 });
diff --git a/examples/conversations.js b/examples/conversations.js
@@ -1,10 +1,10 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 // start a conversation
 messagebird.conversations.start({
   'to': '31612345678',
-  'channelId': '619747f69cf940a98fb443140ce9aed2' ,
+  'channelId': '619747f69cf940a98fb443140ce9aed2',
   'type': 'text',
   'content': { 'text': 'Hello!' }
 }, function (err, response) {
@@ -102,7 +102,7 @@ messagebird.conversations.webhooks.read('451e6b72799e4415b2aab425f582f65e', func
 
 // update webhook
 messagebird.conversations.webhooks.update('451e6b72799e4415b2aab425f582f65e', {
-  'status': 'disabled',
+  'status': 'disabled'
 }, function (err, response) {
   if (err) {
     return console.log(err);

diff --git a/examples/hlr_create.js → examples/hlr-create.js b/examples/hlr_create.js → examples/hlr-create.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.hlr.create('31612345678', 'YourBrand', function (err, response) {
   if (err) {

diff --git a/examples/hlr_read.js → examples/hlr-read.js b/examples/hlr_read.js → examples/hlr-read.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.hlr.read('<HLR_ID>', function (err, response) {
   if (err) {

diff --git a/examples/lookup_hlr_create.js → examples/lookup-hlr-create.js b/examples/lookup_hlr_create.js → examples/lookup-hlr-create.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.lookup.hlr.create('31612345678', function (err, response) {
   if (err) {

diff --git a/examples/lookup_hlr_read.js → examples/lookup-hlr-read.js b/examples/lookup_hlr_read.js → examples/lookup-hlr-read.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.lookup.hlr.read('31612345678', function (err, response) {
   if (err) {

diff --git a/examples/lookup_read.js → examples/lookup-read.js b/examples/lookup_read.js → examples/lookup-read.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.lookup.read('31612345678', function (err, response) {
   if (err) {

diff --git a/examples/messages_create.js → examples/messages-create.js b/examples/messages_create.js → examples/messages-create.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 var params = {
   'originator': 'YourBrand',

diff --git a/examples/messages-list.js b/examples/messages-list.js
@@ -0,0 +1,16 @@
+
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+
+messagebird.messages.list(function (err, response) {
+  if (err) {
+    return console.log(err);
+  }
+  console.log(response);
+});
+
+messagebird.messages.list({ status: 'scheduled' }, function (err, response) {
+  if (err) {
+    return console.log(err);
+  }
+  console.log(response);
+});
diff --git a/examples/messages_read.js → examples/messages-read.js b/examples/messages_read.js → examples/messages-read.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.messages.read('<MESSAGE_ID>', function (err, response) {
   if (err) {

diff --git a/examples/messages_list.js b/examples/messages_list.js
diff --git a/examples/node_middleware.js b/examples/node_middleware.js
diff --git a/examples/recordings.js b/examples/recordings.js
@@ -1,4 +1,4 @@
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 // list recordings
 messagebird.recordings.list('<CALL_ID>', '<LEG_ID>', '<LIMIT>', '<OFFSET>', function (err, response) {

diff --git a/examples/transcription.js b/examples/transcription.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.transcriptions.create('<CALL_ID>', '<LEG_ID>', '<RECORDING_ID>', '<LANGUAGE>', function (err, data) {
   if (err) {

diff --git a/examples/verify_create_email.js → examples/verify-create-email.js b/examples/verify_create_email.js → examples/verify-create-email.js
@@ -1,37 +1,42 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
-var from = "<FROM_EMAIL>";//email from which users will receive the verification token
-var to = "<TO_EMAIL>";//email to which the verification code will be sent to
-var additionalParams = {
+// email from which users will receive the verification token
+const from = '<FROM_EMAIL>';
+
+// email to which the verification code will be sent to
+const to = '<TO_EMAIL>';
+const additionalParams = {
   subject: 'Your verification code',
   template: 'Your security token: %token',
   timeout: 300
-}
+};
 
-//Creating a token with email
+// Creating a token with email
 messagebird.verify.createWithEmail(from, to, additionalParams, function (err, response) {
   if (err) {
     return console.log(err);
   }
   console.log(response);
 });
 
-//Validating a token
-var verifyId = '<VERIFY_ID>';
-var token = '<TOKEN>';
+// Validating a token
+const verifyId = '<VERIFY_ID>';
+const token = '<TOKEN>';
+
 messagebird.verify.verify(verifyId, token, function (err, response) {
   if (err) {
     return console.log(err);
   }
   console.log(response);
 });
 
-//Retrieving a email message
-var emailMessageId = '<MESSAGE_ID>';
+// Retrieving a email message
+const emailMessageId = '<MESSAGE_ID>';
+
 messagebird.verify.getVerifyEmailMessage(emailMessageId, function (err, response) {
   if (err) {
     return console.log(err);
   }
   console.log(response);
-});
+});
diff --git a/examples/verify_create.js → examples/verify-create.js b/examples/verify_create.js → examples/verify-create.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.verify.create('31612345678', function (err, response) {
   if (err) {

diff --git a/examples/verify_delete.js → examples/verify-delete.js b/examples/verify_delete.js → examples/verify-delete.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.verify.delete('<VERIFY_ID>', function (err, response) {
   if (err) {

diff --git a/examples/verify_read.js → examples/verify-read.js b/examples/verify_read.js → examples/verify-read.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.verify.read('<VERIFY_ID>', function (err, response) {
   if (err) {

diff --git a/examples/verify_verify.js → examples/verify-verify.js b/examples/verify_verify.js → examples/verify-verify.js
@@ -1,5 +1,5 @@
 
-var messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
+const messagebird = require('messagebird')('<YOUR_ACCESS_KEY>');
 
 messagebird.verify.verify('<VERIFY_ID>', '<TOKEN>', function (err, response) {
   if (err) {