notifications-node-client 8.3.0 → 8.3.1

package/spec/api_client.js

@@ -1,156 +0,0 @@
-var expect = require('chai').expect,
-  MockDate = require('mockdate'),
-  ApiClient = require('../client/api_client.js'),
-  nock = require('nock'),
-  createGovukNotifyToken = require('../client/authentication.js'),
-  version = require('../package.json').version,
-  axios = require('axios'),
-  sinon = require('sinon');
-
-describe('api client', function () {
-
-  beforeEach(function() {
-    MockDate.set(1234567890000);
-  });
-
-  afterEach(function() {
-    MockDate.reset();
-  });
-
-  it('should make a get request with correct headers', function (done) {
-
-    var urlBase = 'https://api.notifications.service.gov.uk',
-      path = '/email',
-      body = {
-        'body': 'body text'
-      },
-      serviceId = 'c745a8d8-b48a-4b0d-96e5-dbea0165ebd1',
-      apiKeyId = '8b3aa916-ec82-434e-b0c5-d5d9b371d6a3';
-
-    [
-      new ApiClient(serviceId, apiKeyId),
-      new ApiClient(urlBase, serviceId, apiKeyId),
-      new ApiClient(urlBase, 'key_name' + '-' + serviceId + '-' + apiKeyId),
-      new ApiClient('key_name' + ':' + serviceId + ':' + apiKeyId),
-    ].forEach(function(client, index, clients) {
-
-      nock(urlBase, {
-        reqheaders: {
-          'Authorization': 'Bearer ' + createGovukNotifyToken('GET', path, apiKeyId, serviceId),
-          'User-Agent': 'NOTIFY-API-NODE-CLIENT/' + version
-        }
-      })
-        .get(path)
-        .reply(200, body);
-
-      client.get(path)
-        .then(function (response) {
-          expect(response.data).to.deep.equal(body);
-          if (index == clients.length - 1) done();
-      });
-
-    });
-
-  });
-
-  it('should make a post request with correct headers', function (done) {
-
-    var urlBase = 'http://localhost',
-      path = '/email',
-      data = {
-        'data': 'qwjjs'
-      },
-      serviceId = 123,
-      apiKeyId = 'SECRET',
-      apiClient = new ApiClient(urlBase, serviceId, apiKeyId);
-
-    nock(urlBase, {
-      reqheaders: {
-        'Authorization': 'Bearer ' + createGovukNotifyToken('POST', path, apiKeyId, serviceId),
-        'User-Agent': 'NOTIFY-API-NODE-CLIENT/' + version
-      }
-    })
-      .post(path, data)
-      .reply(200, {"hooray": "bkbbk"});
-
-    apiClient = new ApiClient(urlBase, serviceId, apiKeyId);
-    apiClient.post(path, data)
-      .then(function (response) {
-        expect(response.status).to.equal(200);
-        done();
-    });
-  });
-
-  it('should direct get requests through the proxy when set', function (done) {
-    var urlBase = 'https://api.notifications.service.gov.uk',
-      proxyConfig = { host: 'addressofmyproxy.test', protocol: 'http'},
-      path = '/email',
-      apiClient = new ApiClient(urlBase, 'apiKey');
-
-    nock("http://" + proxyConfig.host)
-      .get(urlBase + path)
-      .reply(200, 'test');
-
-    apiClient.setProxy(proxyConfig);
-    apiClient.get(path)
-      .then(function (response) {
-        expect(response.status).to.equal(200);
-        expect(response.config.proxy).to.eql(proxyConfig);
-        done();
-    });
-  });
-
-  it('should direct post requests through the proxy when set', function (done) {
-    var urlBase = 'https://api.notifications.service.gov.uk',
-      proxyConfig = { host: 'addressofmyproxy.test', protocol: 'http'},
-      path = '/email',
-      apiClient = new ApiClient(urlBase, 'apiKey');
-
-    nock("http://" + proxyConfig.host)
-      .post(urlBase + path)
-      .reply(200, 'test');
-
-    apiClient.setProxy(proxyConfig);
-    apiClient.post(path)
-      .then(function (response) {
-        expect(response.status).to.equal(200);
-        expect(response.config.proxy).to.eql(proxyConfig);
-        done();
-    });
-  });
-
-  it('should use the custom Axios client when set', function (done) {
-    var urlBase = 'https://api.notifications.service.gov.uk',
-      path = '/email',
-      body = {
-        'body': 'body text'
-      },
-      serviceId = 'c745a8d8-b48a-4b0d-96e5-dbea0165ebd1',
-      apiKeyId = '8b3aa916-ec82-434e-b0c5-d5d9b371d6a3';
-
-    var customClientStub = sinon.stub().resolves({ data: body });
-
-    var apiClient = new ApiClient(serviceId, apiKeyId);
-    apiClient.setClient(customClientStub);
-
-    nock(urlBase, {
-      reqheaders: {
-        'Authorization': 'Bearer ' + createGovukNotifyToken('GET', path, apiKeyId, serviceId),
-        'User-Agent': 'NOTIFY-API-NODE-CLIENT/' + version
-      }
-    })
-      .get(path)
-      .reply(200, body);
-
-    apiClient.get(path)
-      .then(function (response) {
-        expect(response.data).to.deep.equal(body);
-        expect(customClientStub.calledOnce).to.be.true;
-        expect(customClientStub.args[0][0].url).to.equal(urlBase + path);
-        expect(customClientStub.args[0][0].headers['Authorization']).to.equal('Bearer ' + createGovukNotifyToken('GET', path, apiKeyId, serviceId));
-        expect(customClientStub.args[0][0].headers['User-Agent']).to.equal('NOTIFY-API-NODE-CLIENT/' + version);
-        done();
-      })
-      .catch(done);
-  });
-});

package/spec/authentication.js

@@ -1,32 +0,0 @@
-var expect = require('chai').expect,
-    MockDate = require('mockdate'),
-    jwt = require('jsonwebtoken'),
-    createGovukNotifyToken = require('../client/authentication.js');
-
-
-describe('Authentication', function() {
-
-  beforeEach(function() {
-    MockDate.set(1234567890000);
-  });
-
-  afterEach(function() {
-    MockDate.reset();
-  });
-
-  describe('tokens', function() {
-
-    it('can be generated and decoded', function() {
-
-      var token = createGovukNotifyToken("POST", "/v2/notifications/sms", "SECRET", 123),
-          decoded = jwt.verify(token, 'SECRET');
-
-      expect(token).to.equal('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOjEyMywiaWF0IjoxMjM0NTY3ODkwfQ.18aBKSLffjbX_TLmosB_qYgW9EkWIQpBgWy7GpiKg6o');
-      expect(decoded.iss).to.equal(123);
-      expect(decoded.iat).to.equal(1234567890);
-
-    });
-
-  });
-
-});

package/spec/integration/schemas/v1/GET_notifications_return.json

@@ -1,37 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "description": "GET notification return schema - for sms notifications",
-  "type" : "object",
-  "properties": {
-    "notifications": {
-      "type": "array",
-      "items": {
-        "oneOf": [
-          {"$ref": "sms_notification.json"},
-          {"$ref": "email_notification.json"}
-        ]
-      }
-    },
-    "links": {
-      "type": "object",
-      "properties" : {
-        "prev" : {
-          "type" : "string"
-        },
-        "next" : {
-          "type" : "string"
-        },
-        "last": {
-          "type" : "string"
-        }
-      },
-      "additionalProperties": false
-    },
-    "page_size": {"type": "number"},
-    "total": {"type": "number"}
-  },
-  "additionalProperties": false,
-  "required": [
-    "notifications", "links", "page_size", "total"
-  ]
-}

package/spec/integration/schemas/v1/POST_notification_return_email.json

@@ -1,27 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "description": "POST notification return schema - for email notifications",
-  "type" : "object",
-  "properties": {
-    "data": {
-      "type": "object",
-      "properties": {
-        "notification": {
-          "type": "object",
-          "properties": {
-            "id": {"$ref": "definitions.json#/uuid"}
-          },
-          "additionalProperties": false,
-          "required": ["id"]
-        },
-        "body": {"type": "string"},
-        "template_version": {"type": "number"},
-        "subject": {"type": "string"}
-      },
-      "additionalProperties": false,
-      "required": ["notification", "body", "template_version", "subject"]
-    }
-  },
-  "additionalProperties": false,
-  "required": ["data"]
-}

package/spec/integration/schemas/v1/POST_notification_return_sms.json

@@ -1,26 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "description": "POST notification return schema - for sms notifications",
-  "type" : "object",
-  "properties": {
-    "data": {
-      "type": "object",
-      "properties": {
-        "notification": {
-          "type": "object",
-          "properties": {
-            "id": {"$ref": "definitions.json#/uuid"}
-          },
-          "additionalProperties": false,
-          "required": ["id"]
-        },
-        "body": {"type": "string"},
-        "template_version": {"type": "number"}
-      },
-      "additionalProperties": false,
-      "required": ["notification", "body", "template_version"]
-    }
-  },
-  "additionalProperties": false,
-  "required": ["data"]
-}

package/spec/integration/schemas/v1/definitions.json

@@ -1,12 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "description": "Common definitions - usage example: {'$ref': 'definitions.json#/uuid'} (swap quotes for double quotes)",
-  "uuid": {
-    "type": "string",
-    "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
-  },
-  "datetime": {
-    "type": "string",
-    "format": "date-time"
-  }
-}

package/spec/integration/schemas/v1/email_notification.json

@@ -1,106 +0,0 @@
-{
-  "description": "Single email notification schema - as returned by GET /notification and GET /notification/{}",
-  "type": "object",
-  "properties": {
-    "id": {"$ref": "definitions.json#/uuid"},
-    "to": {"type": "string", "format": "email"},
-    "job_row_number": {"oneOf":[
-      {"type": "number"},
-      {"type": "null"}
-    ]},
-    "template_version": {"type": "number"},
-    "billable_units": {"type": "number"},
-    "notification_type": {
-      "type": "string",
-      "enum": ["email"]
-    },
-    "created_at": {"$ref": "definitions.json#/datetime"},
-    "sent_at": {"oneOf":[
-      {"$ref": "definitions.json#/datetime"},
-      {"type": "null"}
-    ]},
-    "sent_by": {"oneOf":[
-      {"type": "string"},
-      {"type": "null"}
-    ]},
-    "updated_at": {"oneOf":[
-      {"$ref": "definitions.json#/datetime"},
-      {"type": "null"}
-    ]},
-    "status": {
-      "type": "string",
-      "enum": [
-        "created",
-        "sending",
-        "delivered",
-        "pending",
-        "failed",
-        "technical-failure",
-        "temporary-failure",
-        "permanent-failure"
-      ]
-    },
-    "reference": {"oneOf":[
-      {"type": "string"},
-      {"type": "null"}
-    ]},
-    "template": {
-      "type": "object",
-      "properties": {
-        "id": {"$ref": "definitions.json#/uuid"},
-        "name": {"type": "string"},
-        "template_type": {
-          "type": "string",
-          "enum": ["email"]
-        },
-        "version": {"type": "number"}
-      },
-      "additionalProperties": false,
-      "required": ["id", "name", "template_type", "version"]
-    },
-    "service": {"$ref": "definitions.json#/uuid"},
-    "job": {
-      "oneOf": [
-        {
-          "type": "object",
-          "properties": {
-            "id": {"$ref": "definitions.json#/uuid"},
-            "original_file_name": {"type": "string"}
-          },
-          "additionalProperties": false,
-          "required": ["id", "original_file_name"]
-        },
-        {"type": "null"}
-      ]
-    },
-    "api_key": {"oneOf":[
-      {"$ref": "definitions.json#/uuid"},
-      {"type": "null"}
-    ]},
-    "body": {"type": "string"},
-    "content_char_count": {"type": "null"},
-    "subject": {"type": "string"}
-  },
-  "additionalProperties": false,
-  "required": [
-    "id",
-    "to",
-    "job_row_number",
-    "template_version",
-    "billable_units",
-    "notification_type",
-    "created_at",
-    "sent_at",
-    "sent_by",
-    "updated_at",
-    "status",
-    "reference",
-    "template",
-    "service",
-    "job",
-    "api_key",
-    "body",
-    "content_char_count",
-    "subject"
-  ]
-}

package/spec/integration/schemas/v1/sms_notification.json

@@ -1,104 +0,0 @@
-{
-  "description": "Single sms notification schema - as returned by GET /notification and GET /notification/{}",
-  "type": "object",
-  "properties": {
-    "id": {"$ref": "definitions.json#/uuid"},
-    "to": {"type": "string"},
-    "job_row_number": {"oneOf":[
-      {"type": "number"},
-      {"type": "null"}
-    ]},
-    "template_version": {"type": "number"},
-    "billable_units": {"type": "number"},
-    "notification_type": {
-      "type": "string",
-      "enum": ["sms"]
-    },
-    "created_at": {"$ref": "definitions.json#/datetime"},
-    "sent_at": {"oneOf":[
-      {"$ref": "definitions.json#/datetime"},
-      {"type": "null"}
-    ]},
-    "sent_by": {"oneOf":[
-      {"type": "string"},
-      {"type": "null"}
-    ]},
-    "updated_at": {"oneOf":[
-      {"$ref": "definitions.json#/datetime"},
-      {"type": "null"}
-    ]},
-    "status": {
-      "type": "string",
-      "enum": [
-        "created",
-        "sending",
-        "delivered",
-        "pending",
-        "failed",
-        "technical-failure",
-        "temporary-failure",
-        "permanent-failure"
-      ]
-    },
-    "reference": {"oneOf":[
-      {"type": "string"},
-      {"type": "null"}
-    ]},
-    "template": {
-      "type": "object",
-      "properties": {
-        "id": {"$ref": "definitions.json#/uuid"},
-        "name": {"type": "string"},
-        "template_type": {
-          "type": "string",
-          "enum": ["sms"]
-        },
-        "version": {"type": "number"}
-      },
-      "additionalProperties": false,
-      "required": ["id", "name", "template_type", "version"]
-    },
-    "service": {"$ref": "definitions.json#/uuid"},
-    "job": {
-      "oneOf": [
-        {
-          "type": "object",
-          "properties": {
-            "id": {"$ref": "definitions.json#/uuid"},
-            "original_file_name": {"type": "string"}
-          },
-          "additionalProperties": false,
-          "required": ["id", "original_file_name"]
-        },
-        {"type": "null"}
-      ]
-    },
-    "api_key": {"oneOf":[
-      {"$ref": "definitions.json#/uuid"},
-      {"type": "null"}
-    ]},
-    "body": {"type": "string"},
-    "content_char_count": {"type": "number"}
-  },
-  "additionalProperties": false,
-  "required": [
-    "id",
-    "to",
-    "job_row_number",
-    "template_version",
-    "billable_units",
-    "notification_type",
-    "created_at",
-    "sent_at",
-    "sent_by",
-    "updated_at",
-    "status",
-    "reference",
-    "template",
-    "service",
-    "job",
-    "api_key",
-    "body",
-    "content_char_count"
-  ]
-}

package/spec/integration/schemas/v2/GET_notification_response.json

@@ -1,50 +0,0 @@
-{
-    "$schema": "http://json-schema.org/schema#",
-    "description": "GET notification response schema",
-    "type": "object",
-    "title": "response v2/notification",
-    "properties": {
-        "id": {"$ref": "definitions.json#/uuid"},
-        "reference": {"type": ["string", "null"]},
-        "email_address": {"type": ["string", "null"]},
-        "phone_number": {"type": ["string", "null"]},
-        "line_1": {"type": ["string", "null"]},
-        "line_2": {"type": ["string", "null"]},
-        "line_3": {"type": ["string", "null"]},
-        "line_4": {"type": ["string", "null"]},
-        "line_5": {"type": ["string", "null"]},
-        "line_6": {"type": ["string", "null"]},
-        "postcode": {"type": ["string", "null"]},
-        "postage": {"type": ["string", "null"]},
-        "type": {"enum": ["sms", "letter", "email"]},
-        "status": {"type": "string"},
-        "template": {"$ref": "definitions.json#/template"},
-        "body": {"type": "string"},
-        "subject": {"type": ["string", "null"]},
-        "created_at": {"type": "string"},
-        "created_by_name": {"type": ["string", "null"]},
-        "sent_at": {"type": ["string", "null"]},
-        "completed_at": {"type": ["string", "null"]},
-        "scheduled_for": {"oneOf":[
-          {"$ref": "definitions.json#/datetime"},
-          {"type": "null"}
-        ]},
-        "cost_in_pounds": {"type": ["number", "null"]},
-        "is_cost_data_ready": {"type": "boolean"},
-        "cost_details": {
-            "type": "object",
-            "properties": {
-                "billable_sms_fragments": {"type": ["integer", "null"]},
-                "international_rate_multiplier": {"type": ["number", "null"]},
-                "sms_rate": {"type": ["number", "null"]},
-                "billable_sheets_of_paper": {"type": ["integer", "null"]},
-                "postage": {"type": ["string", "null"]}
-            }
-        }
-    },
-    "required": [
-        "id", "reference", "email_address", "phone_number",
-        "line_1", "line_2", "line_3", "line_4", "line_5", "line_6", "postcode",
-        "type", "status", "template", "created_at", "created_by_name", "sent_at", "completed_at"
-    ]
-}

package/spec/integration/schemas/v2/GET_notifications_response.json

@@ -1,29 +0,0 @@
-{
-    "$schema": "http://json-schema.org/schema#",
-    "description": "GET list of notifications response schema",
-    "type": "object",
-    "properties": {
-        "notifications": {
-            "type": "array",
-            "items": {
-                "type": "object",
-                "$ref": "notification.json"
-            }
-        },
-        "links": {
-            "type": "object",
-            "properties": {
-                "current": {
-                    "type": "string"
-                },
-                "next": {
-                    "type": "string"
-                }
-            },
-            "additionalProperties": false,
-            "required": ["current"]
-        }
-    },
-    "additionalProperties": false,
-    "required": ["notifications", "links"]
-}

package/spec/integration/schemas/v2/GET_received_text_response.json

@@ -1,23 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "GET inbound sms schema response",
-    "type": "object",
-    "title": "GET response v2/inbound_sms",
-    "properties": {
-        "user_number": {"type": "string"},
-        "created_at": {
-            "format": "date-time",
-            "type": "string",
-            "description": "Date+time created at"
-        },
-        "service_id": {"$ref": "definitions.json#/uuid"},
-        "id": {"$ref": "definitions.json#/uuid"},
-        "notify_number": {"type": "string"},
-        "content": {"type": "string"}
-    },
-    "required": [
-        "id", "user_number", "created_at", "service_id",
-        "notify_number", "content"
-    ],
-    "additionalProperties": false
-}

package/spec/integration/schemas/v2/GET_received_texts_response.json

@@ -1,29 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "GET list of inbound sms response schema",
-    "type": "object",
-    "properties": {
-        "received_text_messages": {
-            "type": "array",
-            "items": {
-                "type": "object",
-                "$ref": "receivedText.json"
-            }
-        },
-        "links": {
-            "type": "object",
-            "properties": {
-                "current": {
-                    "type": "string"
-                },
-                "next": {
-                    "type": "string"
-                }
-            },
-            "additionalProperties": false,
-            "required": ["current"]
-        }
-    },
-    "required": ["received_text_messages", "links"],
-    "additionalProperties": false
-}

package/spec/integration/schemas/v2/GET_template_by_id.json

@@ -1,30 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "description": "GET template by id schema response",
-    "type": "object",
-    "title": "reponse v2/template",
-    "properties": {
-        "id": {"$ref": "definitions.json#/uuid"},
-        "name": {"type": "string"},
-        "type": {"enum": ["sms", "email", "letter"] },
-        "created_at": {
-            "format": "date-time",
-            "type": "string",
-            "description": "Date+time created"
-        },
-        "updated_at": {
-            "format": "date-time",
-            "type": ["string", "null"],
-            "description": "Date+time updated"
-        },
-        "created_by": {"type": "string"},
-        "version": {"type": "integer"},
-        "body": {"type": "string"},
-        "subject": {"type": ["string", "null"]},
-        "letter_contact_block": {"type": ["string", "null"]}
-    },
-    "required": [
-        "id", "name", "type", "created_at", "updated_at", "version", "created_by",
-        "body", "letter_contact_block"
-    ]
-}