add integration tests

Author: shannamurry

.eslintrc

@@ -6,6 +6,9 @@
   "globals": {
     "API_KEY": false,
     "expect": false,
+    "HAS_LIVE_KEY": false,
+    "INTEGRATION_TIMEOUT": false,
+    "LiveLob": false,
     "Lob": false,
     "mocks": false
   }

.github/workflows/run_tests.yml

@@ -1,6 +1,6 @@
 name: Run Tests
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   node_tests:
@@ -20,6 +20,11 @@ jobs:
         run: npm install --legacy-peer-deps
       - name: Run tests
         run: npm run test
+      - name: Run integration tests
+        env:
+          TEST_API_KEY: ${{ secrets.TEST_API_KEY }}
+          LIVE_API_KEY: ${{ secrets.LIVE_API_KEY }}
+        run: npm run test:integration
       - name: Coverage
         run: npm run test-lcov
       - name: Coveralls

.mocharc.json

@@ -1,5 +1,6 @@
 {
   "recursive": true,
   "timeout": 30000,
-  "require": ["./test/setup.js"]
+  "require": ["./test/setup.js"],
+  "ignore": ["test/integration/**"]
 }

lib/resources/resourceBase.js

@@ -39,6 +39,7 @@ class ResourceBase {
     }
 
     let isMultiPartForm = false;
+    let requiresJson = false;
 
     for (const key in form) {
       if (form[key] === undefined) {
@@ -61,6 +62,11 @@ class ResourceBase {
         isMultiPartForm = true;
         break;
       }
+
+      // Check if array contains objects (requires JSON encoding)
+      if (Array.isArray(val) && val.length > 0 && typeof val[0] === 'object') {
+        requiresJson = true;
+      }
     }
 
     if (qs) {
@@ -85,6 +91,10 @@ class ResourceBase {
 
         config.data = formData;
         config.headers = Object.assign({}, config.headers, formData.getHeaders());
+      } else if (requiresJson) {
+        // Use JSON for requests with nested objects (e.g., bulk verifications)
+        config.data = form;
+        config.headers['Content-Type'] = 'application/json';
       } else {
         const params = new URLSearchParams();
         for (const key in form) {

package.json

@@ -46,6 +46,7 @@
   },
   "scripts": {
     "test": "cross-env NODE_ENV=test nyc mocha test",
+    "test:integration": "mocha --config test/integration/.mocharc.json",
     "test-no-cover": "cross-env NODE_ENV=test mocha test",
     "coverage": "nyc report --reporter=text",
     "enforce": "nyc check-coverage --statements 100 --lines 100 --functions 100 --branches 100",

test/integration/.mocharc.json

@@ -0,0 +1,6 @@
+{
+  "recursive": true,
+  "timeout": 30000,
+  "require": ["./test/integration/setup.js"],
+  "spec": "test/integration/**/*.test.js"
+}

test/integration/addresses.test.js

@@ -0,0 +1,105 @@
+'use strict';
+
+describe('Integration: Addresses', function () {
+
+  this.timeout(INTEGRATION_TIMEOUT);
+
+  let createdAddressId;
+
+  const TEST_ADDRESS = {
+    name: 'Integration Test',
+    address_line1: '185 Berry St',
+    address_line2: 'Ste 6100',
+    address_city: 'San Francisco',
+    address_state: 'CA',
+    address_zip: '94107',
+    address_country: 'US'
+  };
+
+  describe('create', () => {
+
+    it('creates an address with valid data', (done) => {
+      Lob.addresses.create(TEST_ADDRESS, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res).to.have.property('id');
+        expect(res.id).to.match(/^adr_/);
+        expect(res.name).to.eql('INTEGRATION TEST');
+        expect(res.address_city).to.eql('SAN FRANCISCO');
+        expect(res.object).to.eql('address');
+        createdAddressId = res.id;
+        done();
+      });
+    });
+
+    it('rejects an address with invalid data', (done) => {
+      Lob.addresses.create({
+        name: 'Bad Address',
+        address_line1: '123 Fake Street',
+        address_city: 'Nonexistent City',
+        address_state: 'XX',
+        address_zip: '00000',
+        address_country: 'US'
+      }, (err) => {
+        expect(err).to.exist;
+        expect(err.message).to.exist;
+        done();
+      });
+    });
+
+  });
+
+  describe('retrieve', () => {
+
+    it('retrieves a created address', function (done) {
+      if (!createdAddressId) {
+        return this.skip();
+      }
+      Lob.addresses.retrieve(createdAddressId, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res.id).to.eql(createdAddressId);
+        expect(res.object).to.eql('address');
+        done();
+      });
+    });
+
+    it('returns error for non-existent address', (done) => {
+      Lob.addresses.retrieve('adr_nonexistent123456', (err) => {
+        expect(err).to.exist;
+        expect(err.status_code).to.eql(404);
+        done();
+      });
+    });
+
+  });
+
+  describe('list', () => {
+
+    it('returns a list of addresses', (done) => {
+      Lob.addresses.list({ limit: 5 }, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res.object).to.eql('list');
+        expect(res.data).to.be.instanceof(Array);
+        expect(res.data.length).to.be.at.most(5);
+        done();
+      });
+    });
+
+  });
+
+  describe('delete', () => {
+
+    it('deletes a created address', function (done) {
+      if (!createdAddressId) {
+        return this.skip();
+      }
+      Lob.addresses.delete(createdAddressId, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res.id).to.eql(createdAddressId);
+        expect(res.deleted).to.eql(true);
+        done();
+      });
+    });
+
+  });
+
+});

test/integration/bulkIntlVerifications.test.js

@@ -0,0 +1,37 @@
+'use strict';
+
+describe('Integration: Bulk Intl Verifications (Live Key Required)', function () {
+
+  this.timeout(INTEGRATION_TIMEOUT);
+
+  before(function () {
+    if (!HAS_LIVE_KEY) {
+      this.skip();
+    }
+  });
+
+  describe('verify', () => {
+
+    it('verifies an international address', (done) => {
+      LiveLob.bulkIntlVerifications.verify({
+        addresses: [
+          {
+            primary_line: '370 Water St',
+            city: 'Summerside',
+            state: 'Prince Edward Island',
+            postal_code: 'C1N 1C4',
+            country: 'CA'
+          }
+        ]
+      }, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res).to.have.property('addresses');
+        expect(res.addresses).to.be.instanceof(Array);
+        expect(res.addresses.length).to.eql(1);
+        done();
+      });
+    });
+
+  });
+
+});

test/integration/bulkUSVerifications.test.js

@@ -0,0 +1,42 @@
+'use strict';
+
+describe('Integration: Bulk US Verifications (Live Key Required)', function () {
+
+  this.timeout(INTEGRATION_TIMEOUT);
+
+  before(function () {
+    if (!HAS_LIVE_KEY) {
+      this.skip();
+    }
+  });
+
+  describe('verify', () => {
+
+    it('verifies multiple addresses', (done) => {
+      LiveLob.bulkUSVerifications.verify({
+        addresses: [
+          {
+            primary_line: '185 Berry St Ste 6100',
+            city: 'San Francisco',
+            state: 'CA',
+            zip_code: '94107'
+          },
+          {
+            primary_line: '210 King St',
+            city: 'San Francisco',
+            state: 'CA',
+            zip_code: '94107'
+          }
+        ]
+      }, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res).to.have.property('addresses');
+        expect(res.addresses).to.be.instanceof(Array);
+        expect(res.addresses.length).to.eql(2);
+        done();
+      });
+    });
+
+  });
+
+});

test/integration/campaigns.test.js

@@ -0,0 +1,77 @@
+'use strict';
+
+describe('Integration: Campaigns (Live Key Required)', function () {
+
+  this.timeout(INTEGRATION_TIMEOUT);
+
+  let createdCampaignId;
+
+  before(function () {
+    if (!HAS_LIVE_KEY) {
+      this.skip();
+    }
+  });
+
+  describe('create', () => {
+
+    it('creates a campaign', (done) => {
+      LiveLob.campaigns.create({
+        name: 'Integration Test Campaign',
+        schedule_type: 'immediate'
+      }, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res).to.have.property('id');
+        expect(res.id).to.match(/^cmp_/);
+        expect(res.name).to.eql('Integration Test Campaign');
+        createdCampaignId = res.id;
+        done();
+      });
+    });
+
+  });
+
+  describe('retrieve', () => {
+
+    it('retrieves a created campaign', function (done) {
+      if (!createdCampaignId) {
+        return this.skip();
+      }
+      LiveLob.campaigns.retrieve(createdCampaignId, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res.id).to.eql(createdCampaignId);
+        done();
+      });
+    });
+
+  });
+
+  describe('list', () => {
+
+    it('returns a list of campaigns', (done) => {
+      LiveLob.campaigns.list({ limit: 5 }, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res.object).to.eql('list');
+        expect(res.data).to.be.instanceof(Array);
+        done();
+      });
+    });
+
+  });
+
+  describe('delete', () => {
+
+    it('deletes a created campaign', function (done) {
+      if (!createdCampaignId) {
+        return this.skip();
+      }
+      LiveLob.campaigns.delete(createdCampaignId, (err, res) => {
+        expect(err).to.not.exist;
+        expect(res.id).to.eql(createdCampaignId);
+        expect(res.deleted).to.eql(true);
+        done();
+      });
+    });
+
+  });
+
+});