mailgun.js 3.7.0 → 4.0.0

package/test/request.test.ts

@@ -8,6 +8,7 @@ import Request from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import APIError from '../lib/error';
 import APIResponse from '../lib/interfaces/ApiResponse';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('Request', function () {
   let headers: { [key: string]: string };
@@ -33,7 +34,7 @@ describe('Request', function () {
         url: 'https://api.mailgun.com',
         headers: { 'X-CSRF-Token': 'protectme' },
         timeout: 10000
-      }, formData);
+      }, formData as InputFormData);
 
       await req.request('get', '/v2/some/resource1', {
         headers: { Test: 'Custom Header', 'X-CSRF-Token': 'protectme' },
@@ -46,7 +47,7 @@ describe('Request', function () {
         .get('/v2/some/resource')
         .reply(200, { id: 1, message: 'hello' });
 
-      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.request('get', '/v2/some/resource')
         .then(function (response: APIResponse) {
           expect(response.status).to.eql(200);
@@ -61,7 +62,7 @@ describe('Request', function () {
         .get('/v2/some/resource')
         .reply(429, 'Too many requests');
 
-      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.request('get', '/v2/some/resource').catch(function (error: APIError) {
         expect(error.status).to.eql(429);
         expect(error.details).to.eql('Too many requests');
@@ -80,7 +81,7 @@ describe('Request', function () {
         .query(search)
         .reply(200, {});
 
-      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       await req.query('get', '/v2/some/resource2', search);
     });
   });
@@ -93,7 +94,7 @@ describe('Request', function () {
         .post('/v2/some/resource')
         .reply(200, {});
 
-      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.command('post', '/v2/some/resource', body);
 
       return res;

package/test/routes.test.ts

@@ -4,6 +4,7 @@ import nock from 'nock';
 import Request from '../lib/request';
 import RoutesClient from '../lib/routes';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 interface Data {
   actions: string[],
@@ -19,7 +20,7 @@ describe('RoutesClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new RoutesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new RoutesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/stats.test.ts

@@ -5,13 +5,14 @@ import Request from '../lib/request';
 import StatsClient from '../lib/stats';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import StatsOptions from '../lib/interfaces/StatsOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('StatsClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new StatsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new StatsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/suppressions.test.ts

@@ -5,6 +5,7 @@ import nock from 'nock';
 import Request from '../lib/request';
 import SuppressionClient from '../lib/suppressions';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 chai.should();
 
@@ -13,7 +14,7 @@ describe('SuppressionsClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new SuppressionClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new SuppressionClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/validate.test.ts

@@ -4,13 +4,17 @@ import nock from 'nock';
 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));
+    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');
   });
 
@@ -27,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

@@ -3,13 +3,14 @@ import nock from 'nock';
 import Request from '../lib/request';
 import WebhookClient from '../lib/webhooks';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('WebhookClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new WebhookClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new WebhookClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 
@@ -24,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
       });
 
@@ -36,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'
         }
@@ -50,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: {
@@ -65,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!'
@@ -80,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: {
@@ -96,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,74 +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';
-
-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));
-    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);
-      });
-    });
-  });
-});