mailgun.js 3.7.3 → 4.0.0

package/test/events.test.ts

@@ -5,10 +5,11 @@ import EventClient from '../lib/events';
 import MgRequest from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import { InputFormData } from '../lib/interfaces/IFormData';
+import { EventsList, EventsResponse } from '../lib/interfaces/Events';
 
 describe('EventsClient', function () {
-  let client: any;
-  let api: any;
+  let client: EventClient;
+  let api: nock.Scope;
 
   beforeEach(function () {
     client = new EventClient(new MgRequest({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
@@ -26,14 +27,12 @@ describe('EventsClient', function () {
       response = {
         items: [
           {
-            type: 'accepted',
+            event: 'accepted',
             timestamp: 'Wed, 19 Nov 2014 18:32:57 GMT',
-            gist: 'got it',
             content: { more: 'data' }
           }, {
-            type: 'opened',
+            event: 'opened',
             timestamp: 'Tue, 18 Nov 2014 12:32:57 GMT',
-            gist: 'sent',
             content: { more: 'data' }
           }
         ],
@@ -47,49 +46,41 @@ describe('EventsClient', function () {
     });
 
     it('fetches all events', function () {
-      api.get('/v2/domain.com/events').reply(200, response);
+      api.get('/v3/domain.com/events').reply(200, response);
 
-      return client.get('domain.com').then(function (data: any) {
+      return client.get('domain.com').then(function (data: EventsList) {
         let e;
 
         e = data.items[0];
-        e.type.should.eql('accepted');
-        e.gist.should.eql('got it');
+        e.event.should.eql('accepted');
         e.timestamp.should.eql('Wed, 19 Nov 2014 18:32:57 GMT');
-        e.content.should.eql({ more: 'data' });
 
         e = data.items[1];
-        e.type.should.eql('opened');
-        e.gist.should.eql('sent');
+        e.event.should.eql('opened');
         e.timestamp.should.eql('Tue, 18 Nov 2014 12:32:57 GMT');
-        e.content.should.eql({ more: 'data' });
       });
     });
 
     it('fetches single page', function () {
-      api.get('/v2/domain.com/events/pageId').reply(200, response);
+      api.get('/v3/domain.com/events/pageId').reply(200, response);
 
-      return client.get('domain.com', { page: 'pageId' }).then(function (data: any) {
+      return client.get('domain.com', { page: 'pageId' }).then(function (data: EventsList) {
         let e;
 
         e = data.items[0];
-        e.type.should.eql('accepted');
-        e.gist.should.eql('got it');
+        e.event.should.eql('accepted');
         e.timestamp.should.eql('Wed, 19 Nov 2014 18:32:57 GMT');
-        e.content.should.eql({ more: 'data' });
 
         e = data.items[1];
-        e.type.should.eql('opened');
-        e.gist.should.eql('sent');
+        e.event.should.eql('opened');
         e.timestamp.should.eql('Tue, 18 Nov 2014 12:32:57 GMT');
-        e.content.should.eql({ more: 'data' });
       });
     });
 
     it('parses page links', function () {
-      api.get('/v2/domain.com/events').reply(200, response);
+      api.get('/v3/domain.com/events').reply(200, response);
 
-      return client.get('domain.com').then(function (data: any) {
+      return client.get('domain.com').then(function (data: EventsList) {
         let page;
 
         page = data.pages.first;

package/test/multipleValidation.test.ts

@@ -0,0 +1,159 @@
+import formData from 'form-data';
+import fs from 'fs';
+import path from 'path';
+
+import nock from 'nock';
+import Request from '../lib/request';
+import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
+import MultipleValidationClient from '../lib/multipleValidation';
+import {
+  CanceledMultipleValidationJob,
+  CreatedMultipleValidationJob,
+  MultipleValidationJob,
+  MultipleValidationJobsListResult
+} from '../lib/interfaces/MultipleValidation';
+
+const filepath = path.resolve(__dirname, './data/emailsValidation1.csv');
+
+describe('ValidateClient', function () {
+  const fsPromises = fs.promises;
+  let client: MultipleValidationClient;
+  let api: nock.Scope;
+
+  beforeEach(function () {
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
+    client = new MultipleValidationClient(reqObject);
+    api = nock('https://api.mailgun.net');
+  });
+
+  afterEach(function () {
+    api.done();
+  });
+
+  describe('List', function () {
+    it('should provide list of all bulk validation jobs', function () {
+      const data = {
+        jobs: [
+          {
+            created_at: 1636716764,
+            download_url: {
+              csv: 'csv-url',
+              json: 'json-url'
+            },
+            id: 'testValidationList',
+            quantity: 40,
+            records_processed: 40,
+            status: 'uploaded',
+            summary: {
+              result: {
+                catch_all: 0,
+                deliverable: 2,
+                do_not_send: 0,
+                undeliverable: 16,
+                unknown: 22
+              },
+              risk: {
+                high: 16,
+                low: 2,
+                medium: 0,
+                unknown: 22
+              }
+            }
+          }
+        ],
+        paging: {
+          first: 'https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=first&pivot=',
+          last: 'https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=last&pivot=',
+          next: 'https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=next&pivot=',
+          prev: 'https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=prev&pivot='
+        },
+        total: 1
+      };
+
+      api.get('/v4/address/validate/bulk')
+        .reply(200, data);
+
+      return client.list().then(function (response: MultipleValidationJobsListResult) {
+        response.should.eql(data);
+      });
+    });
+  });
+
+  describe('get', function () {
+    it('should returns status of a bulk validation job.', function () {
+      const listId = 'testValidationList';
+      const data = {
+        created_at: 1636716764,
+        download_url: {
+          csv: 'csv-url',
+          json: 'json-url'
+        },
+        id: listId,
+        quantity: 40,
+        records_processed: 40,
+        status: 'uploaded',
+        summary: {
+          result: {
+            catch_all: 0,
+            deliverable: 2,
+            do_not_send: 0,
+            undeliverable: 16,
+            unknown: 22
+          },
+          risk: {
+            high: 16,
+            low: 2,
+            medium: 0,
+            unknown: 22
+          }
+        }
+      };
+
+      api.get(`/v4/address/validate/bulk/${listId}`)
+        .reply(200, data);
+
+      return client.get(listId).then(function (response: MultipleValidationJob) {
+        response.should.eql(data);
+      });
+    });
+  });
+
+  describe('create', function () {
+    it('Creates a bulk validation job.', async function () {
+      const listId = 'testValidationList';
+      const data = {
+        id: 'testValidationList',
+        message: 'The validation job was submitted.'
+      };
+      const file = {
+        filename: 'test.jpg',
+        data: await fsPromises.readFile(filepath)
+      };
+      api.post(`/v4/address/validate/bulk/${listId}`)
+        .reply(200, data);
+
+      return client.create(listId, { file })
+        .then(function (response: CreatedMultipleValidationJob) {
+          response.should.eql(data);
+        });
+    });
+  });
+
+  describe('destroy', function () {
+    it('should cancel current running bulk validation job.', async function () {
+      const listId = 'testValidationList';
+      const data = {
+        body: { message: 'Validation job canceled.' },
+        status: 200
+      };
+      api.delete(`/v4/address/validate/bulk/${listId}`)
+        .reply(200, { message: 'Validation job canceled.' });
+
+      return client.destroy(listId)
+        .then(function (response: CanceledMultipleValidationJob) {
+          response.should.eql(data);
+        });
+    });
+  });
+});

package/test/validate.test.ts

@@ -5,13 +5,16 @@ import Request from '../lib/request';
 import ValidateClient from '../lib/validate';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import { InputFormData } from '../lib/interfaces/IFormData';
+import MultipleValidationClient from '../lib/multipleValidation';
 
 describe('ValidateClient', function () {
-  let client: any;
-  let api: any;
+  let client: ValidateClient;
+  let api: nock.Scope;
 
   beforeEach(function () {
-    client = new ValidateClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
+    const multipleValidationClient = new MultipleValidationClient(reqObject);
+    client = new ValidateClient(reqObject, multipleValidationClient);
     api = nock('https://api.mailgun.net');
   });
 
@@ -28,7 +31,7 @@ describe('ValidateClient', function () {
         parts: { display_name: null, domain: null, local_part: null }
       };
 
-      api.get('/v3/address/validate')
+      api.get('/v4/address/validate')
         .query({ address: 'foo@example.com' })
         .reply(200, data);
 

package/test/webhooks.test.ts

@@ -25,7 +25,7 @@ describe('WebhookClient', function () {
     };
 
     it('fetches all webhooks', function () {
-      api.get('/v2/domains/domain.com/webhooks').reply(200, {
+      api.get('/v3/domains/domain.com/webhooks').reply(200, {
         webhooks: hooks
       });
 
@@ -37,7 +37,7 @@ describe('WebhookClient', function () {
 
   describe('get', function () {
     it('fetches single webhook', function () {
-      api.get('/v2/domains/domain.com/webhooks/click').reply(200, {
+      api.get('/v3/domains/domain.com/webhooks/click').reply(200, {
         webhook: {
           url: 'trackclick.com'
         }
@@ -51,7 +51,7 @@ describe('WebhookClient', function () {
 
   describe('create', function () {
     it('creates webhook', function () {
-      api.post('/v2/domains/domain.com/webhooks')
+      api.post('/v3/domains/domain.com/webhooks')
         .reply(200, {
           message: 'Webhook has been created',
           webhook: {
@@ -66,7 +66,7 @@ describe('WebhookClient', function () {
     });
 
     it('tests webhook', function () {
-      api.put('/v2/domains/domain.com/webhooks/click/test')
+      api.put('/v3/domains/domain.com/webhooks/click/test')
         .reply(200, {
           code: '500',
           message: 'Hi!'
@@ -81,7 +81,7 @@ describe('WebhookClient', function () {
 
   describe('update', function () {
     it('updates webhook', function () {
-      api.put('/v2/domains/domain.com/webhooks/click')
+      api.put('/v3/domains/domain.com/webhooks/click')
         .reply(200, {
           message: 'Webhook has been updated',
           webhook: {
@@ -97,7 +97,7 @@ describe('WebhookClient', function () {
 
   describe('destroy', function () {
     it('deletes webhook', function () {
-      api.delete('/v2/domains/domain.com/webhooks/click').reply(200, {
+      api.delete('/v3/domains/domain.com/webhooks/click').reply(200, {
         message: 'Webhook has been deleted',
         webhook: {
           url: 'trackclick.com'

package/webpack/webpack.dev.config.js

@@ -5,6 +5,11 @@ const nodeConf = merge(commonConfig, {
   target: 'node',
   output: {
     filename: 'mailgun.node.js'
+  },
+  watchOptions: {
+    aggregateTimeout: 300,
+    poll: 5000,
+    ignored: ['../**/dist/*', '**/node_modules']
   }
 });
 
@@ -12,6 +17,11 @@ const webConf = merge(commonConfig, {
   target: 'web',
   output: {
     filename: 'mailgun.web.js'
+  },
+  watchOptions: {
+    aggregateTimeout: 300,
+    poll: 5000,
+    ignored: ['../**/dist/*', '**/node_modules']
   }
 });
 

package/lib/parse.ts

@@ -1,27 +0,0 @@
-/* eslint-disable camelcase */
-import Request from './request';
-
-export default class ParseClient {
-  request: Request;
-
-  constructor(request: Request) {
-    this.request = request;
-  }
-
-  get(addresses: string[] | string, enableDnsEspChecks: boolean) {
-    const query = {} as { addresses: string, syntax_only: boolean };
-
-    if (Array.isArray(addresses)) {
-      query.addresses = addresses.join(',');
-    } else {
-      query.addresses = addresses;
-    }
-
-    if (enableDnsEspChecks) {
-      query.syntax_only = false;
-    }
-
-    return this.request.get('/v3/address/parse', query)
-      .then((response) => response.body);
-  }
-}

package/test/parse.test.ts

@@ -1,75 +0,0 @@
-import formData from 'form-data';
-
-import { URLSearchParams } from 'url';
-import nock from 'nock';
-import Request from '../lib/request';
-import ParseClient from '../lib/parse';
-
-import RequestOptions from '../lib/interfaces/RequestOptions';
-import { InputFormData } from '../lib/interfaces/IFormData';
-
-interface Data {
-  parsed: string[],
-  unparseable: string[]
-}
-
-describe('ParseClient', function () {
-  let client: any;
-  let api: any;
-
-  beforeEach(function () {
-    client = new ParseClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
-    api = nock('https://api.mailgun.net');
-  });
-
-  afterEach(function () {
-    api.done();
-  });
-
-  describe('get', function () {
-    it('parses a single email addresses', function () {
-      const data: Data = {
-        parsed: ['foo@example.com'],
-        unparseable: []
-      };
-
-      const query = new URLSearchParams({ addresses: data.parsed });
-
-      api.get('/v3/address/parse').query(query).reply(200, data);
-
-      return client.get('foo@example.com').then(function (response: Data) {
-        response.should.eql(data);
-      });
-    });
-
-    it('parses an array email addresses', function () {
-      const data: Data = {
-        parsed: ['foo@example.com'],
-        unparseable: ['example.com']
-      };
-
-      api.get('/v3/address/parse')
-        .query({ addresses: 'foo@example.com,example.com' })
-        .reply(200, data);
-
-      return client.get(['foo@example.com', 'example.com']).then(function (response: Data) {
-        response.should.eql(data);
-      });
-    });
-
-    it('parses email addresses with dns and esp checks', function () {
-      const data: Data = {
-        parsed: [],
-        unparseable: ['foo@example.com']
-      };
-
-      api.get('/v3/address/parse')
-        .query({ addresses: 'foo@example.com', syntax_only: false })
-        .reply(200, data);
-
-      return client.get('foo@example.com', true).then(function (response: Data) {
-        response.should.eql(data);
-      });
-    });
-  });
-});