mailgun.js 5.0.3 → 5.1.0

package/test/routes.test.ts

@@ -1,136 +0,0 @@
-/* eslint-disable camelcase */
-import formData from 'form-data';
-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[],
-  created_at: string,
-  description: string,
-  expression: string,
-  id: string,
-  priority: number
-}
-
-describe('RoutesClient', function () {
-  let client: any;
-  let api: any;
-
-  beforeEach(function () {
-    client = new RoutesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
-    api = nock('https://api.mailgun.net');
-  });
-
-  afterEach(function () {
-    api.done();
-  });
-
-  describe('list', function () {
-    const data = [
-      {
-        actions: ['forward("http://myhost.com/messages/")', 'stop()'],
-        created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
-        description: 'sample',
-        expression: 'match_recipient(".*@example.com")',
-        id: '562da483125730608a7d1719',
-        priority: 0
-      }
-    ];
-
-    it('fetches all routes', function () {
-      api.get('/v3/routes').reply(200, {
-        items: data
-      });
-
-      return client.list().then(function (response: Data[]) {
-        response.should.eql(data);
-      });
-    });
-  });
-
-  describe('get', function () {
-    it('fetches single route by id', function () {
-      const data = {
-        actions: ['forward("http://myhost.com/messages/")', 'stop()'],
-        created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
-        description: 'sample',
-        expression: 'match_recipient(".*@example.com")',
-        id: '562da483125730608a7d1719',
-        priority: 0
-      };
-
-      api.get('/v3/routes/123').reply(200, { route: data });
-
-      return client.get('123').then(function (response: Data) {
-        response.should.eql(data);
-      });
-    });
-  });
-
-  describe('create', function () {
-    it('creates route', function () {
-      const data = {
-        actions: ['forward("http://myhost.com/messages/")', 'stop()'],
-        created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
-        description: 'sample',
-        expression: 'match_recipient(".*@example.com")',
-        id: '562da483125730608a7d1719',
-        priority: 0
-      };
-
-      api.post('/v3/routes').reply(200, { route: data });
-
-      return client.create({
-        priority: 0,
-        description: 'sample',
-        expression: 'match_recipient(".*@example.org")',
-        action: ['forward("http://myhost.com/messages/")', 'stop()']
-      }).then(function (response: Data) {
-        response.should.eql(data);
-      });
-    });
-  });
-
-  describe('update', function () {
-    it('updates route', function () {
-      const data = {
-        actions: ['forward("http://myhost.com/messages/")', 'stop()'],
-        created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
-        description: 'sample',
-        expression: 'match_recipient(".*@example.com")',
-        id: '562da483125730608a7d1719',
-        priority: 0,
-        message: 'Route has been updated',
-      };
-
-      api.put('/v3/routes/123').reply(200, { data });
-
-      return client.update('123', {
-        priority: 0,
-        description: 'sample',
-        expression: 'match_recipient(".*@example.org")',
-        action: ['forward("http://myhost.com/messages/")', 'stop()']
-      }).then(function (response: Data) {
-        response.should.eql({ data });
-      });
-    });
-  });
-
-  describe('destroy', function () {
-    it('deletes route', function () {
-      const data = {
-        id: '562da483125730608a7d1719',
-        message: 'Route has been deleted'
-      };
-
-      api.delete('/v3/routes/123').reply(200, { data });
-
-      return client.destroy('123').then(function (response: Data) {
-        response.should.eql({ data });
-      });
-    });
-  });
-});

package/test/stats.test.ts

@@ -1,90 +0,0 @@
-import formData from 'form-data';
-
-import nock from 'nock';
-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 as InputFormData));
-    api = nock('https://api.mailgun.net');
-  });
-
-  afterEach(function () {
-    api.done();
-  });
-
-  describe('getDomain', function () {
-    const query = { event: 'delivered' };
-
-    it('fetches stats for a given domain', function () {
-      api.get('/v3/domain.com/stats/total')
-        .query(query)
-        .reply(200, {
-          end: 'Mon, 23 Mar 2015 00:00:00 UTC',
-          resolution: 'day',
-          start: 'Mon, 16 Mar 2015 00:00:00 UTC',
-          stats: [
-            {
-              time: 'Mon, 16 Mar 2015 00:00:00 UTC',
-              delivered: {
-                smtp: 2,
-                http: 1,
-                total: 3
-              }
-            }
-          ]
-        });
-
-      return client.getDomain('domain.com', query).then(function (stats: StatsOptions) {
-        (stats.start as Date).toUTCString().should.eql('Mon, 16 Mar 2015 00:00:00 GMT');
-        (stats.end as Date).toUTCString().should.eql('Mon, 23 Mar 2015 00:00:00 GMT');
-
-        (stats.stats[0].time as Date).toUTCString().should.eql('Mon, 16 Mar 2015 00:00:00 GMT');
-        stats.stats[0].delivered.http.should.eql(1);
-        stats.stats[0].delivered.smtp.should.eql(2);
-        stats.stats[0].delivered.total.should.eql(3);
-      });
-    });
-  });
-
-  describe('getAccount', function () {
-    const query = { event: 'delivered' };
-
-    it('fetches stats for a given account', function () {
-      api.get('/v3/stats/total')
-        .query(query)
-        .reply(200, {
-          end: 'Mon, 23 Mar 2015 00:00:00 UTC',
-          resolution: 'day',
-          start: 'Mon, 16 Mar 2015 00:00:00 UTC',
-          stats: [
-            {
-              time: 'Mon, 16 Mar 2015 00:00:00 UTC',
-              delivered: {
-                smtp: 2,
-                http: 1,
-                total: 3
-              }
-            }
-          ]
-        });
-
-      return client.getAccount({ event: ['delivered'] }).then(function (stats: StatsOptions) {
-        (stats.start as Date).toUTCString().should.eql('Mon, 16 Mar 2015 00:00:00 GMT');
-        (stats.end as Date).toUTCString().should.eql('Mon, 23 Mar 2015 00:00:00 GMT');
-
-        (stats.stats[0].time as Date).toUTCString().should.eql('Mon, 16 Mar 2015 00:00:00 GMT');
-        stats.stats[0].delivered.http.should.eql(1);
-        stats.stats[0].delivered.smtp.should.eql(2);
-        stats.stats[0].delivered.total.should.eql(3);
-      });
-    });
-  });
-});

package/test/suppressions.test.ts

@@ -1,303 +0,0 @@
-import chai, { expect } from 'chai';
-import formData from 'form-data';
-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';
-import { WhiteListData } from '../lib/interfaces/Supressions';
-
-chai.should();
-
-describe('SuppressionsClient', function () {
-  let client: any;
-  let api: any;
-
-  beforeEach(function () {
-    client = new SuppressionClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
-    api = nock('https://api.mailgun.net');
-  });
-
-  afterEach(function () {
-    api.done();
-  });
-
-  describe('list', function () {
-    let response: any;
-
-    beforeEach(function () {
-      response = {
-        items: [],
-        paging: {
-          first: 'https://api.mailgun.net/v3/mailgun.com/bounces?page=first',
-          last: 'https://api.mailgun.net/v3/mailgun.com/bounces?page=last',
-          next: 'https://api.mailgun.net/v3/mailgun.com/bounces?page=next&address=next@mailgun.com',
-          previous: 'https://api.mailgun.net/v3/mailgun.com/bounces?page=previous&address=previous@mailgun.com'
-        }
-      };
-    });
-
-    it('fetches bounces', function () {
-      response.items = [{
-        address: 'unknown@unknown.com',
-        code: 550,
-        error: 'No such mailbox',
-        created_at: 'Fri, 21 Oct 2011 11:02:55 GMT'
-      }, {
-        address: 'full@disk.com',
-        code: 552,
-        error: 'Mailbox full',
-        created_at: 'Fri, 21 Oct 2011 12:02:55 GMT'
-      }];
-
-      api.get('/v3/domain.com/bounces').reply(200, response);
-
-      return client.list('domain.com', 'bounces')
-        .then(function (bounces: { items: any }) {
-          let b;
-          b = bounces.items[0];
-          b.address.should.eql('unknown@unknown.com');
-          b.code.should.eql(550);
-          b.error.should.eql('No such mailbox');
-          (b.created_at as Date).toUTCString().should.eql('Fri, 21 Oct 2011 11:02:55 GMT');
-
-          b = bounces.items[1];
-          b.address.should.eql('full@disk.com');
-          b.code.should.eql(552);
-          b.error.should.eql('Mailbox full');
-          (b.created_at as Date).toUTCString().should.eql('Fri, 21 Oct 2011 12:02:55 GMT');
-        });
-    });
-
-    it('fetches unsubscribes', function () {
-      response.items = [{
-        address: 'brad@example.com',
-        tags: ['*'],
-        created_at: 'Fri, 21 Oct 2011 11:02:55 GMT'
-      }, {
-        address: 'roman@example.com',
-        tags: ['*'],
-        created_at: 'Fri, 21 Oct 2011 12:02:55 GMT'
-      }];
-
-      api.get('/v3/domain.com/unsubscribes').reply(200, response);
-
-      return client.list('domain.com', 'unsubscribes')
-        .then(function (unsubscribes: { items: any }) {
-          let u;
-
-          u = unsubscribes.items[0];
-          u.address.should.eql('brad@example.com');
-          u.tags.should.eql(['*']);
-          u.created_at.toUTCString().should.eql('Fri, 21 Oct 2011 11:02:55 GMT');
-
-          u = unsubscribes.items[1];
-          u.address.should.eql('roman@example.com');
-          u.tags.should.eql(['*']);
-          u.created_at.toUTCString().should.eql('Fri, 21 Oct 2011 12:02:55 GMT');
-        });
-    });
-
-    it('fetches complaints', function () {
-      response.items = [{
-        address: 'brad@example.com',
-        created_at: 'Fri, 21 Oct 2011 11:02:55 GMT'
-      }, {
-        address: 'roman@example.com',
-        created_at: 'Fri, 21 Oct 2011 12:02:55 GMT'
-      }];
-
-      api.get('/v3/domain.com/complaints').reply(200, response);
-
-      return client.list('domain.com', 'complaints')
-        .then(function (complaints: { items: any }) {
-          let c;
-
-          c = complaints.items[0];
-          c.address.should.eql('brad@example.com');
-          c.created_at.toUTCString().should.eql('Fri, 21 Oct 2011 11:02:55 GMT');
-
-          c = complaints.items[1];
-          c.address.should.eql('roman@example.com');
-          c.created_at.toUTCString().should.eql('Fri, 21 Oct 2011 12:02:55 GMT');
-        });
-    });
-
-    it('fetches WhiteLists', function () {
-      response.items = [{
-        type: 'whitelists',
-        value: 'brad@example.com',
-        reason: 'first reason',
-        createdAt: '2021-11-30T10:38:56.000Z'
-      }, {
-        type: 'whitelists',
-        value: 'roman@example.com',
-        reason: 'second reason',
-        createdAt: '2021-11-30T10:38:56.000Z'
-      }];
-
-      api.get('/v3/domain.com/whitelists').reply(200, response);
-
-      return client.list('domain.com', 'whitelists')
-        .then(function (complaints: { items: WhiteListData[] }) {
-          let c;
-          c = complaints.items[0];
-          c.type.should.eql('whitelists');
-          c.value.should.eql('brad@example.com');
-          c.reason.should.eql('first reason');
-          c.createdAt.should.eql(new Date('2021-11-30T10:38:56.000Z'));
-
-          c = complaints.items[1];
-          c.type.should.eql('whitelists');
-          c.value.should.eql('roman@example.com');
-          c.reason.should.eql('second reason');
-          c.createdAt.should.eql(new Date('2021-11-30T10:38:56.000Z'));
-        });
-    });
-
-    it('parses page links', function () {
-      api.get('/v3/domain.com/bounces').reply(200, response);
-
-      return client.list('domain.com', 'bounces')
-        .then(function (bounces: { pages: any }) {
-          let page;
-
-          page = bounces.pages.first;
-          page.url.should.eql('https://api.mailgun.net/v3/mailgun.com/bounces?page=first');
-          expect(page.page).to.eql('first');
-          expect(page.address).to.be.eql(undefined);
-
-          page = bounces.pages.last;
-          page.url.should.eql('https://api.mailgun.net/v3/mailgun.com/bounces?page=last');
-          expect(page.page).to.be.eql('last');
-          expect(page.address).to.be.eql(undefined);
-
-          page = bounces.pages.next;
-          page.url.should.eql('https://api.mailgun.net/v3/mailgun.com/bounces?page=next&address=next@mailgun.com');
-          expect(page.page).to.be.eql('next');
-          page.address.should.eql('next@mailgun.com');
-
-          page = bounces.pages.previous;
-          page.url.should.eql('https://api.mailgun.net/v3/mailgun.com/bounces?page=previous&address=previous@mailgun.com');
-          expect(page.page).to.be.eql('previous');
-          page.address.should.eql('previous@mailgun.com');
-        });
-    });
-  });
-
-  describe('get', function () {
-    it('fetches bounce for address', function () {
-      api.get('/v3/domain.com/bounces/address%3F%40unknown.com').reply(200, {
-        address: 'address?@unknown.com',
-        code: 550,
-        error: 'No such mailbox',
-        created_at: 'Fri, 21 Oct 2011 11:02:55 GMT'
-      });
-
-      return client.get('domain.com', 'bounces', 'address?@unknown.com')
-        .then(function (bounce: any) {
-          bounce.address.should.eql('address?@unknown.com');
-          bounce.code.should.eql(550);
-          bounce.error.should.eql('No such mailbox');
-          bounce.created_at.toUTCString().should.eql('Fri, 21 Oct 2011 11:02:55 GMT');
-        });
-    });
-
-    it('fetches unsubscribe for address', function () {
-      api.get('/v3/domain.com/unsubscribes/roman%3F%40example.com').reply(200, {
-        address: 'address?@unknown.com',
-        tags: ['*'],
-        created_at: 'Fri, 21 Oct 2011 12:02:55 GMT'
-      });
-
-      return client.get('domain.com', 'unsubscribes', 'roman?@example.com')
-        .then(function (unsubscribe: any) {
-          unsubscribe.address.should.eql('address?@unknown.com');
-          unsubscribe.tags.should.eql(['*']);
-          unsubscribe.created_at.toUTCString().should.eql('Fri, 21 Oct 2011 12:02:55 GMT');
-        });
-    });
-  });
-  describe('create', function () {
-    describe('create bounce', function () {
-      it('creates suppression', function () {
-        api.post('/v3/domain.com/bounces').reply(200, {
-          message: '1 addresses have been added to the bounces table'
-        });
-
-        return client.create('domain.com', 'bounces', {
-          address: 'myaddress',
-          code: 550
-        }).then(function (data: { message: string }) {
-          data.message.should.eql('1 addresses have been added to the bounces table');
-        });
-      });
-    });
-
-    describe('create multiple bounces', function () {
-      it('creates bounces', async function () {
-        const message = '2 addresses have been added to the bounces table';
-        api.post('/v3/domain.com/bounces').reply(200, {
-          message
-        });
-        return client.create('domain.com', 'bounces',
-          [{ address: 'myaddress' }, { address: 'myaddress1' }])
-          .then(function (data: { message: string }) {
-            data.message.should.eql(message);
-          });
-      });
-    });
-    describe('create whitelists', function () {
-      it('creates whitelist', async function () {
-        const message = '1 addresses have been added to the whitelists table';
-        api.post('/v3/domain.com/whitelists').reply(200, {
-          message
-        });
-        return client.create('domain.com', 'whitelists',
-          { address: 'myaddress' })
-          .then(function (data: { message: string }) {
-            data.message.should.eql(message);
-          });
-      });
-    });
-
-    describe('create multiple whitelists', function () {
-      it('throws in case multiple whitelists provided', async function () {
-        try {
-          await client.create('domain.com', 'whitelists',
-            [{ address: 'myaddress' }, { address: 'myaddress1' }]);
-        } catch (error: any) {
-          error.message.should.eql('Data property should be an object');
-          error.details.should.eql("Whitelist's creation process does not support multiple creations. Data property should be an object");
-          error.status.should.eql(400);
-        }
-      });
-    });
-
-    it('throws in case type is unknown', async function () {
-      try {
-        await client.create('domain.com', 'wrong type',
-          { address: 'myaddress' });
-      } catch (error: any) {
-        error.message.should.eql('Unknown type value');
-        error.details.should.eql('Type may be only one of [bounces, complaints, unsubscribes, whitelists]');
-        error.status.should.eql(400);
-      }
-    });
-  });
-
-  describe('destroy', function () {
-    it('deletes suppression', function () {
-      api.delete('/v3/domain.com/bounces/my%3F%40address.com').reply(200, {
-        message: 'Bounced address has been removed',
-        address: 'my?@address.com'
-      });
-
-      return client.destroy('domain.com', 'bounces', 'my?@address.com')
-        .then(function (data: { address: string }) {
-          data.address.should.eql('my?@address.com');
-        });
-    });
-  });
-});

package/test/validate.test.ts

@@ -1,43 +0,0 @@
-import formData from 'form-data';
-
-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: ValidateClient;
-  let api: nock.Scope;
-
-  beforeEach(function () {
-    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');
-  });
-
-  afterEach(function () {
-    api.done();
-  });
-
-  describe('get', function () {
-    it('validates a single email address', function () {
-      const data: any = {
-        address: 'Alice <alice@example.com>',
-        did_you_mean: null,
-        is_valid: false,
-        parts: { display_name: null, domain: null, local_part: null }
-      };
-
-      api.get('/v4/address/validate')
-        .query({ address: 'foo@example.com' })
-        .reply(200, data);
-
-      return client.get('foo@example.com').then(function (response: any) {
-        response.should.eql(data);
-      });
-    });
-  });
-});

package/test/webhooks.test.ts

@@ -1,112 +0,0 @@
-import formData from 'form-data';
-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 as InputFormData));
-    api = nock('https://api.mailgun.net');
-  });
-
-  afterEach(function () {
-    api.done();
-  });
-
-  describe('list', function () {
-    const hooks = {
-      open: { url: 'trackopen.com' },
-      click: { url: 'trackclick.com' }
-    };
-
-    it('fetches all webhooks', function () {
-      api.get('/v3/domains/domain.com/webhooks').reply(200, {
-        webhooks: hooks
-      });
-
-      return client.list('domain.com').then(function (webhooks: any) {
-        webhooks.should.eql(hooks);
-      });
-    });
-  });
-
-  describe('get', function () {
-    it('fetches single webhook', function () {
-      api.get('/v3/domains/domain.com/webhooks/click').reply(200, {
-        webhook: {
-          url: 'trackclick.com'
-        }
-      });
-
-      return client.get('domain.com', 'click').then(function (webhook: any) {
-        webhook.should.eql({ id: 'click', url: 'trackclick.com' });
-      });
-    });
-  });
-
-  describe('create', function () {
-    it('creates webhook', function () {
-      api.post('/v3/domains/domain.com/webhooks')
-        .reply(200, {
-          message: 'Webhook has been created',
-          webhook: {
-            url: 'trackclick.com'
-          }
-        });
-
-      return client.create('domain.com', 'click', 'trackclick.com')
-        .then(function (webhook: any) {
-          webhook.should.eql({ id: 'click', url: 'trackclick.com' });
-        });
-    });
-
-    it('tests webhook', function () {
-      api.put('/v3/domains/domain.com/webhooks/click/test')
-        .reply(200, {
-          code: '500',
-          message: 'Hi!'
-        });
-
-      return client.create('domain.com', 'click', 'trackclick.com', true)
-        .then(function (test: any) {
-          test.should.eql({ code: '500', message: 'Hi!' });
-        });
-    });
-  });
-
-  describe('update', function () {
-    it('updates webhook', function () {
-      api.put('/v3/domains/domain.com/webhooks/click')
-        .reply(200, {
-          message: 'Webhook has been updated',
-          webhook: {
-            url: 'trackclick.com'
-          }
-        });
-
-      return client.update('domain.com', 'click', 'trackclick.com').then(function (webhook: any) {
-        webhook.should.eql({ id: 'click', url: 'trackclick.com' });
-      });
-    });
-  });
-
-  describe('destroy', function () {
-    it('deletes webhook', function () {
-      api.delete('/v3/domains/domain.com/webhooks/click').reply(200, {
-        message: 'Webhook has been deleted',
-        webhook: {
-          url: 'trackclick.com'
-        }
-      });
-
-      return client.destroy('domain.com', 'click', { url: 'trackclick.com' }).then(function (webhook: any) {
-        webhook.should.eql({ id: 'click', url: 'trackclick.com' });
-      });
-    });
-  });
-});