mailgun.js 5.0.3 → 5.1.0

package/test/mailListMembers.test.ts

@@ -1,198 +0,0 @@
-import nock from 'nock';
-import formData from 'form-data';
-import Request from '../lib/request';
-import RequestOptions from '../lib/interfaces/RequestOptions';
-import MailListMembers from '../lib/mailListMembers';
-import { DeletedMember, MailListMember, NewMultipleMembersResponse } from '../lib/interfaces/mailListMembers';
-import { InputFormData } from '../lib/interfaces/IFormData';
-
-describe('mailListsMembersClient', function () {
-  let client: any;
-  let api: any;
-  let defaultListMember : MailListMember;
-
-  beforeEach(function () {
-    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
-    client = new MailListMembers(reqObject);
-    api = nock('https://api.mailgun.net');
-    defaultListMember = {
-      address: 'testingMailingListMemberAddress@example.com',
-      name: 'test name',
-      subscribed: true,
-      vars: { gender: 'female', age: 0 }
-    } as MailListMember;
-  });
-
-  afterEach(function () {
-    api.done();
-  });
-
-  describe('listMembers', function () {
-    it('fetches all mail list members', function () {
-      const lists = [defaultListMember];
-
-      api.get('/v3/lists/list-name/members/pages').reply(200, {
-        items: lists
-      });
-
-      return client.listMembers('list-name').then(function (membersList: MailListMember[]) {
-        membersList[0].should.eql(defaultListMember);
-      });
-    });
-  });
-
-  describe('getMember', function () {
-    it('gets a specific mailing list member', function () {
-      const mailingListAddress = 'testingMailingListAddress@example.com';
-      const mailingListMemberAddress = 'testingMailingListMemberAddress@example.com';
-      api.get(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, {
-        member: defaultListMember
-      });
-
-      return client.getMember('testingMailingListAddress@example.com', 'testingMailingListMemberAddress@example.com')
-        .then(function (listMember: MailListMember) {
-          listMember.should.eql(defaultListMember);
-        });
-    });
-  });
-
-  describe('createMember', function () {
-    it('adds list member to the mailing list ', function () {
-      const member:any = { ...defaultListMember };
-      member.subscribed = true;
-      const mailingListAddress = 'testingMailingListAddress@example.com';
-      api.post(`/v3/lists/${mailingListAddress}/members`).reply(200, {
-        member
-      });
-
-      return client.createMember(mailingListAddress, member).then(function (newListMember:any) {
-        newListMember.should.eql(member);
-      });
-    });
-
-    it('works with string value in subscribed field', function () {
-      const member:any = { ...defaultListMember };
-      member.subscribed = 'yes';
-      const mailingListAddress = 'testingMailingListAddress@example.com';
-      api.post(`/v3/lists/${mailingListAddress}/members`).reply(200, {
-        member
-      });
-
-      return client.createMember(mailingListAddress, member).then(function (newListMember:any) {
-        newListMember.should.eql(member);
-      });
-    });
-  });
-
-  describe('createMembers', function () {
-    const mailingListAddress = 'testingMailingListAddress@example.com';
-    let response : NewMultipleMembersResponse;
-
-    beforeEach(function () {
-      response = {
-        list: {
-          access_level: 'everyone',
-          address: mailingListAddress,
-          created_at: 'Wed, 26 May 2021 10:40:06 -0000',
-          description: 'test description',
-          members_count: 5,
-          name: 'test name',
-          reply_preference: 'list'
-        },
-        message: 'Mailing list has been updated',
-        'task-id': '00000000000000000000000000000000'
-      };
-    });
-
-    it('adds list of members to the mailing list', function () {
-      const newMembersListPlaceholder = new Array(5).fill(0);
-      const newMembersList = newMembersListPlaceholder.map((_, index) => ({
-        address: `test${index}@example.com`,
-        name: `test name ${index}`,
-        vars: { gender: 'female', age: index },
-        subscribed: true,
-        upsert: 'yes'
-      }));
-
-      api.post(`/v3/lists/${mailingListAddress}/members.json`).reply(200, response);
-
-      return client.createMembers(mailingListAddress, {
-        members: newMembersList,
-        upsert: 'yes'
-      }).then(function (result: NewMultipleMembersResponse) {
-        result.should.eql(response);
-      });
-    });
-
-    it('works with string value in members field', function () {
-      const newMembersListPlaceholder = new Array(5).fill(0);
-      const newMembersList = newMembersListPlaceholder.map((_, index) => ({
-        address: `test${index}@example.com`,
-        name: `test name ${index}`,
-        vars: JSON.stringify({ gender: 'female', age: index }),
-        subscribed: true,
-        upsert: 'yes'
-
-      }));
-      api.post(`/v3/lists/${mailingListAddress}/members.json`).reply(200, response);
-      return client.createMembers(mailingListAddress, {
-        members: newMembersList,
-        upsert: 'yes'
-      }).then(function (result: NewMultipleMembersResponse) {
-        result.should.eql(response);
-      });
-    });
-  });
-
-  describe('updateMember', function () {
-    it('updates list member in the mailing list ', function () {
-      const mailingListAddress = 'testingMailingListAddress@example.com';
-      const mailingListMemberAddress = 'testingMailingListMemberAddress@example.com';
-      api.put(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, { member: defaultListMember });
-
-      return client.updateMember(
-        mailingListAddress,
-        mailingListMemberAddress,
-        defaultListMember
-      ).then(function (res: MailListMember) {
-        res.should.eql(defaultListMember);
-      });
-    });
-
-    it('works with string value in subscribed field', function () {
-      const mailingListAddress = 'testingMailingListAddress@example.com';
-      const mailingListMemberAddress = 'testingMailingListMemberAddress@example.com';
-      const member: any = { ...defaultListMember };
-      member.subscribed = 'yes';
-      api.put(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, { member: defaultListMember });
-
-      return client.updateMember(
-        mailingListAddress,
-        mailingListMemberAddress,
-        member
-      ).then(function (res: MailListMember) {
-        res.should.eql(defaultListMember);
-      });
-    });
-  });
-
-  describe('destroyMember', function () {
-    it('deletes member from the list ', function () {
-      const mailingListAddress = 'testingMailingListAddress@example.com';
-      const mailingListMemberAddress = 'testingMailingListMemberAddress@example.com';
-      const res = {
-        member: defaultListMember,
-        message: 'deleted'
-      } as DeletedMember;
-
-      api.delete(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, res);
-
-      return client.destroyMember(
-        mailingListAddress,
-        mailingListMemberAddress
-      ).then(function (deletedMemberRes: DeletedMember) {
-        deletedMemberRes.should.eql(res);
-      });
-    });
-  });
-});

package/test/messageAttachment.test.ts

@@ -1,50 +0,0 @@
-import fs from 'fs';
-import nock from 'nock';
-import { expect } from 'chai';
-import formData from 'form-data';
-
-import Request from '../lib/request';
-import MessagesClient from '../lib/messages';
-import RequestOptions from '../lib/interfaces/RequestOptions';
-import { InputFormData } from '../lib/interfaces/IFormData';
-
-const mailgunLogo = fs.createReadStream(`${__dirname}/img/mailgun.png`);
-
-describe('MessagesClient', function () {
-  let client: any;
-  let api: any;
-
-  beforeEach(function () {
-    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
-    api = nock('https://api.mailgun.net');
-  });
-
-  afterEach(function () {
-    nock.cleanAll();
-    nock.restore();
-    if (!nock.isActive()) nock.activate();
-    api.done();
-  });
-
-  describe('create with attachments', function () {
-    it('sends a custom attachment', async function () {
-      api.post('/v3/sandbox.mailgun.org/messages').reply(200, {
-        message: 'Queued. Thank you.',
-        id: '<20111114174239.25659.5817@samples.mailgun.org>'
-      });
-
-      const res = await client.create('sandbox.mailgun.org', {
-        to: 'foo@example.com',
-        from: 'bar@example.com',
-        subject: 'howdy!',
-        text: 'Testing some Mailgun awesomeness!',
-        attachment: [{
-          filename: 'test-image',
-          data: mailgunLogo
-        }]
-      });
-
-      expect(res.message).to.eql('Queued. Thank you.');
-    });
-  });
-});

package/test/messages.test.ts

@@ -1,89 +0,0 @@
-import formData from 'form-data'; // importing this way to not have type error in line 13
-
-import fs from 'fs';
-import nock from 'nock';
-import { expect } from 'chai';
-
-import Request from '../lib/request';
-import MessagesClient from '../lib/messages';
-import RequestOptions from '../lib/interfaces/RequestOptions';
-import { InputFormData } from '../lib/interfaces/IFormData';
-
-const mailgunLogo = fs.createReadStream(`${__dirname}/img/mailgun.png`);
-
-describe('MessagesClient', function () {
-  let client: any;
-  let api: any;
-
-  beforeEach(function () {
-    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
-    api = nock('https://api.mailgun.net');
-  });
-
-  afterEach(function () {
-    api.done();
-  });
-
-  describe('create', function () {
-    it('sends an email', function () {
-      api.post('/v3/sandbox.mailgun.org/messages').reply(200, {
-        message: 'Queued. Thank you.',
-        id: '<20111114174239.25659.5817@samples.mailgun.org>'
-      });
-
-      return client.create('sandbox.mailgun.org', {
-        to: 'foo@example.com',
-        from: 'bar@example.com',
-        subject: 'howdy!',
-        text: 'ello world!'
-      }).then(function (data: { message: string }) {
-        expect(data.message).to.eql('Queued. Thank you.');
-      });
-    });
-
-    it('returns error messages', function () {
-      api.post('/v3/sandbox.mailgun.org/messages').reply(400, 'Missing parameter \'to\'.');
-
-      return client.create('sandbox.mailgun.org', {
-        from: 'bar@example.com',
-        subject: 'howdy!',
-        text: 'ello world!'
-      }).catch(function (data: { details: string }) {
-        expect(data.details).to.eql('Missing parameter \'to\'.');
-      });
-    });
-
-    it('sends a mime email', function () {
-      api.post('/v3/sandbox.mailgun.org/messages.mime').reply(200, {
-        message: 'Queued. Thank you.',
-        id: '<20111114174239.25659.5817@samples.mailgun.org>'
-      });
-
-      return client.create('sandbox.mailgun.org', {
-        to: 'foo@example.com',
-        from: 'bar@example.com',
-        subject: 'howdy!',
-        message: 'ello world!'
-      }).then(function (data: { message: string }) {
-        expect(data.message).to.eql('Queued. Thank you.');
-      });
-    });
-
-    it('sends an attachment', function () {
-      api.post('/v3/sandbox.mailgun.org/messages').reply(200, {
-        message: 'Queued. Thank you.',
-        id: '<20111114174239.25659.5817@samples.mailgun.org>'
-      });
-
-      return client.create('sandbox.mailgun.org', {
-        to: 'foo@example.com',
-        from: 'bar@example.com',
-        subject: 'howdy!',
-        text: 'Testing some Mailgun awesomeness!',
-        attachment: [mailgunLogo]
-      }).then(function (data: { message: string }) {
-        expect(data.message).to.eql('Queued. Thank you.');
-      });
-    });
-  });
-});

package/test/multipleValidation.test.ts

@@ -1,159 +0,0 @@
-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/request.test.ts

@@ -1,103 +0,0 @@
-// jscs:disable requireDotNotation
-import formData from 'form-data';
-
-import base64 from 'base-64';
-import nock from 'nock';
-import { expect } from 'chai';
-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 };
-
-  beforeEach(function () {
-    headers = {};
-    headers.Authorization = `Basic ${base64.encode('api:key')}`;
-  });
-
-  describe('request', function () {
-    it('makes API request', async function () {
-      headers.Test = 'Custom Header';
-      headers['X-CSRF-Token'] = 'protectme';
-
-      nock('https://api.mailgun.com', { reqheaders: headers })
-        .get('/v2/some/resource1')
-        .query({ some: 'parameter' })
-        .reply(200, {});
-
-      const req = new Request({
-        username: 'api',
-        key: 'key',
-        url: 'https://api.mailgun.com',
-        headers: { 'X-CSRF-Token': 'protectme' },
-        timeout: 10000
-      }, formData as InputFormData);
-
-      await req.request('get', '/v2/some/resource1', {
-        headers: { Test: 'Custom Header', 'X-CSRF-Token': 'protectme' },
-        query: { some: 'parameter' }
-      });
-    });
-
-    it('parses API response', function () {
-      nock('https://api.mailgun.com', { reqheaders: headers })
-        .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 as InputFormData);
-      const res = req.request('get', '/v2/some/resource')
-        .then(function (response: APIResponse) {
-          expect(response.status).to.eql(200);
-          expect(response.body).to.eql({ id: 1, message: 'hello' });
-        });
-
-      return res;
-    });
-
-    it('handles API error', function () {
-      nock('https://api.mailgun.com', { reqheaders: headers })
-        .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 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');
-      });
-
-      return res;
-    });
-  });
-
-  describe('query', function () {
-    const search = { query: 'data' };
-
-    it('sends data as query parameter', async function () {
-      nock('https://api.mailgun.com')
-        .get('/v2/some/resource2')
-        .query(search)
-        .reply(200, {});
-
-      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
-      await req.query('get', '/v2/some/resource2', search);
-    });
-  });
-
-  describe('command', function () {
-    const body = { query: 'data' };
-
-    it('sends data as form-encoded request body', function () {
-      nock('https://api.mailgun.com')
-        .post('/v2/some/resource')
-        .reply(200, {});
-
-      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;
-    });
-  });
-});