add Addresses resource

lib/resources/Addresses.js

@@ -0,0 +1,47 @@
+'use strict';
+
+var TelnyxResource = require('../TelnyxResource');
+var utils = require('../utils');
+var telnyxMethod = TelnyxResource.method;
+
+function transformResponseData(response, telnyx) {
+  return utils.addResourceToResponseData(
+    response,
+    telnyx,
+    'addresses',
+    {
+      del: telnyxMethod({
+        method: 'DELETE',
+        path: '/{addressId}',
+        urlParams: ['addressId'],
+        paramsValues: [response.data.id],
+        paramsNames: ['id'],
+      }),
+    }
+  );
+}
+
+module.exports = TelnyxResource.extend({
+  path: 'addresses',
+
+  list: telnyxMethod({
+    method: 'GET',
+    methodType: 'list',
+
+    transformResponseData: transformResponseData,
+  }),
+
+  create: telnyxMethod({
+    method: 'POST',
+
+    transformResponseData: transformResponseData,
+  }),
+
+  retrieve: telnyxMethod({
+    method: 'GET',
+    path: '/{id}',
+    urlParams: ['id'],
+
+    transformResponseData: transformResponseData,
+  }),
+});

lib/telnyx.js

@@ -67,6 +67,7 @@ var resources = {
   SimCardGroups: require('./resources/SimCardGroups'),
   NumberLookup: require('./resources/NumberLookup'),
   Balance: require('./resources/Balance'),
+  Addresses: require('./resources/Addresses'),
 };
 
 Telnyx.TelnyxResource = require('./TelnyxResource');

test/resources/Addresses.spec.js

@@ -0,0 +1,123 @@
+'use strict';
+
+var utils = require('../../testUtils');
+var telnyx = utils.getTelnyxMock();
+var expect = require('chai').expect;
+
+var TEST_AUTH_KEY = utils.getUserTelnyxKey();
+
+var addressData = {
+  address_book: true,
+  administrative_area: 'IL',
+  borough: 'Guadalajara',
+  neighborhood: 'Ciudad de los deportes',
+  business_name: 'Kon',
+  country_code: 'us',
+  extended_address: 'Suite 123',
+  first_name: 'Alfred',
+  last_name: 'Foster',
+  locality: 'Chicago',
+  postal_code: '2904',
+};
+
+describe('Addresses Resource', function () {
+  describe('retrieve', function () {
+    function responseFn(response) {
+      expect(response.data).to.have.property('id');
+      expect(response.data).to.have.property('street_address');
+      expect(response.data).to.have.property('postal_code');
+      expect(response.data).to.have.property('first_name');
+      expect(response.data).to.have.property('last_name');
+      expect(response.data).to.have.property('locality');
+      expect(response.data).to.include({record_type: 'address'});
+    }
+
+    it('Sends the correct request', function () {
+      return telnyx.addresses.retrieve('123').then(responseFn);
+    });
+
+    it('Sends the correct request [with specified auth]', function () {
+      return telnyx.addresses.retrieve('123', TEST_AUTH_KEY).then(responseFn);
+    });
+  });
+
+  describe('create', function () {
+    function responseFn(response) {
+      expect(response.data).to.have.property('id');
+      expect(response.data).to.have.property('street_address');
+      expect(response.data).to.have.property('postal_code');
+      expect(response.data).to.have.property('first_name');
+      expect(response.data).to.have.property('last_name');
+      expect(response.data).to.have.property('locality');
+      expect(response.data).to.have.property('address_book');
+      expect(response.data).to.include({record_type: 'address'});
+    }
+
+    it('Sends the correct request', function () {
+      return telnyx.addresses.create(addressData).then(responseFn);
+    });
+
+    it('Sends the correct request [with specified auth]', function () {
+      return telnyx.addresses
+        .create(addressData, TEST_AUTH_KEY)
+        .then(responseFn);
+    });
+
+    it('Sends the correct request [with specified auth in options]', function () {
+      return telnyx.addresses
+        .create(addressData, {api_key: TEST_AUTH_KEY})
+        .then(responseFn);
+    });
+  });
+
+  describe('list', function () {
+    function responseFn(response) {
+      expect(response.data[0]).to.have.property('id');
+      expect(response.data[0]).to.have.property('street_address');
+      expect(response.data[0]).to.have.property('postal_code');
+      expect(response.data[0]).to.have.property('first_name');
+      expect(response.data[0]).to.have.property('last_name');
+      expect(response.data[0]).to.have.property('locality');
+      expect(response.data[0]).to.include({record_type: 'address'});
+    }
+
+    it('Sends the correct request', function () {
+      return telnyx.addresses.list().then(responseFn);
+    });
+
+    it('Sends the correct request [with specified auth]', function () {
+      return telnyx.addresses.list(TEST_AUTH_KEY).then(responseFn);
+    });
+  });
+
+  describe('Nested', function () {
+    function responseFn(response) {
+      if (response.data) {
+        expect(response.data).to.have.property('id');
+        expect(response.data).to.have.property('street_address');
+        expect(response.data).to.have.property('postal_code');
+        expect(response.data).to.have.property('first_name');
+        expect(response.data).to.have.property('last_name');
+        expect(response.data).to.have.property('locality');
+        expect(response.data).to.include({record_type: 'address'});
+      }
+    }
+
+    describe('del', function () {
+      it('Sends the correct request', function () {
+        return telnyx.addresses
+          .create(addressData)
+          .then(function (response) {
+            const mp = response.data;
+            return mp.del().then(responseFn);
+          });
+      });
+      it('Sends the correct request [with specified auth]', function () {
+        return telnyx.addresses.retrieve('123').then(function (response) {
+          const mp = response.data;
+          return mp.del(TEST_AUTH_KEY).then(responseFn);
+        });
+      });
+    });
+  });
+});