feat: add getAppById, getAppsByIds, and getFieldById integration tests

integrationTests/getAppById.spec.ts

@@ -0,0 +1,75 @@
+import { OnspringClient } from '../src/index';
+import { expect } from 'chai';
+import * as dotenv from 'dotenv';
+import path from 'path';
+const envPath = path.resolve(__dirname, '.env');
+dotenv.config({ path: envPath });
+
+describe('getAppById', function () {
+  this.timeout('30s');
+  let baseURL;
+  let apiKey;
+
+  before(function () {
+    baseURL = process.env.API_BASE_URL;
+    apiKey = process.env.SANDBOX_API_KEY;
+  });
+
+  it('should return an app', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+
+    if (process.env.TEST_APP_ID === undefined) {
+      return expect.fail('TEST_APP_ID is not defined');
+    }
+
+    const appId = parseInt(process.env.TEST_APP_ID);
+    const response = await client.getAppById(appId);
+
+    expect(response.statusCode).to.equal(200);
+    expect(response.isSuccessful).to.be.true;
+    expect(response.message).to.equal('');
+    expect(response.data).to.not.be.null;
+
+    if (response.data != null) {
+      expect(response.data.id).to.equal(appId);
+      expect(response.data.name).to.not.be.null;
+      expect(response.data.href).to.not.be.null;
+    }
+  });
+
+  it('should return a 401 error when an invalid api key is used', async function () {
+    const client = new OnspringClient(baseURL, 'invalid');
+    const response = await client.getAppById(1);
+
+    expect(response.statusCode).to.equal(401);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.be.undefined;
+    expect(response.data).to.be.null;
+  });
+
+  it('should return a 403 error when api key does not have access to the requested app', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+
+    if (process.env.TEST_APP_ID_NO_ACCESS === undefined) {
+      return expect.fail('TEST_APP_ID_NO_ACCESS is not defined');
+    }
+
+    const appId = parseInt(process.env.TEST_APP_ID_NO_ACCESS);
+    const response = await client.getAppById(appId);
+
+    expect(response.statusCode).to.equal(403);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.not.be.null;
+    expect(response.data).to.be.null;
+  });
+
+  it('should return a 404 error when an app id cannot be found', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const response = await client.getAppById(0);
+
+    expect(response.statusCode).to.equal(404);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.not.be.null;
+    expect(response.data).to.be.null;
+  });
+});

integrationTests/getApps.spec.ts

@@ -6,7 +6,7 @@ const envPath = path.resolve(__dirname, '.env');
 dotenv.config({ path: envPath });
 
 describe('getApps', function () {
-  this.timeout('5s');
+  this.timeout('30s');
   let baseURL;
   let apiKey;
 
@@ -15,7 +15,7 @@ describe('getApps', function () {
     apiKey = process.env.SANDBOX_API_KEY;
   });
 
-  it('should return a list of apps', async function () {
+  it('should return a paged list of apps', async function () {
     const client = new OnspringClient(baseURL, apiKey);
     const response = await client.getApps();
 
@@ -42,7 +42,7 @@ describe('getApps', function () {
     }
   });
 
-  it('should return a list of apps with with correct page size and number when passed paging request', async function () {
+  it('should return a paged list of apps with with correct page size and number when passed paging request', async function () {
     const client = new OnspringClient(baseURL, apiKey);
     const response = await client.getApps(new PagingRequest(1, 1));
 

integrationTests/getAppsByIds.spec.ts

@@ -0,0 +1,74 @@
+import { OnspringClient } from '../src/index';
+import { expect } from 'chai';
+import * as dotenv from 'dotenv';
+import path from 'path';
+const envPath = path.resolve(__dirname, '.env');
+dotenv.config({ path: envPath });
+
+describe('getAppsByIds', function () {
+  this.timeout('30s');
+  let baseURL;
+  let apiKey;
+
+  before(function () {
+    baseURL = process.env.API_BASE_URL;
+    apiKey = process.env.SANDBOX_API_KEY;
+  });
+
+  it('should return a collection of apps', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const appIds = process.env.TEST_APP_IDS;
+
+    if (appIds === undefined) {
+      return expect.fail('TEST_APP_IDS is not defined');
+    }
+
+    const appIdsAsNumbers = appIds.split(',').map((id) => parseInt(id));
+    const response = await client.getAppsByIds(appIdsAsNumbers);
+
+    expect(response.statusCode).to.equal(200);
+    expect(response.isSuccessful).to.be.true;
+    expect(response.message).to.equal('');
+    expect(response.data).to.not.be.null;
+
+    if (response.data != null) {
+      expect(response.data.items).to.not.be.null;
+      expect(response.data.items)
+        .to.be.an('array')
+        .that.has.lengthOf(appIdsAsNumbers.length);
+
+      response.data.items.forEach((item) => {
+        expect(item.id).to.not.be.null;
+        expect(item.name).to.not.be.null;
+        expect(item.href).to.not.be.null;
+      });
+    }
+  });
+
+  it('should return a 401 error when an invalid api key is used', async function () {
+    const client = new OnspringClient(baseURL, 'invalid');
+    const response = await client.getAppsByIds([1]);
+
+    expect(response.statusCode).to.equal(401);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.be.undefined;
+    expect(response.data).to.be.null;
+  });
+
+  it('should return a 403 error when api key does not have access to any of the requested app', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const appIds = process.env.TEST_APP_IDS_NO_ACCESS;
+
+    if (appIds === undefined) {
+      return expect.fail('TEST_APP_IDS_NO_ACCESS is not defined');
+    }
+
+    const appIdsAsNumbers = appIds.split(',').map((id) => parseInt(id));
+    const response = await client.getAppsByIds(appIdsAsNumbers);
+
+    expect(response.statusCode).to.equal(403);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.not.be.null;
+    expect(response.data).to.be.null;
+  });
+});

integrationTests/getFieldById.spec.ts

@@ -0,0 +1,79 @@
+import { OnspringClient } from '../src/index';
+import { expect } from 'chai';
+import * as dotenv from 'dotenv';
+import path from 'path';
+const envPath = path.resolve(__dirname, '.env');
+dotenv.config({ path: envPath });
+
+describe('getAppById', function () {
+  this.timeout('30s');
+  let baseURL;
+  let apiKey;
+
+  before(function () {
+    baseURL = process.env.API_BASE_URL;
+    apiKey = process.env.SANDBOX_API_KEY;
+  });
+
+  it('should return a field', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+
+    if (process.env.TEST_FIELD_ID === undefined) {
+      return expect.fail('TEST_FIELD_ID is not defined');
+    }
+
+    const fieldId = parseInt(process.env.TEST_FIELD_ID);
+    const response = await client.getFieldById(fieldId);
+
+    expect(response.statusCode).to.equal(200);
+    expect(response.isSuccessful).to.be.true;
+    expect(response.message).to.equal('');
+    expect(response.data).to.not.be.null;
+
+    if (response.data != null) {
+      expect(response.data.id).to.equal(fieldId);
+      expect(response.data.name).to.not.be.null;
+      expect(response.data.appId).to.not.be.null;
+      expect(response.data.type).to.not.be.null;
+      expect(response.data.status).to.not.be.null;
+      expect(response.data.isRequired).to.not.be.null;
+      expect(response.data.isUnique).to.not.be.null;
+    }
+  });
+
+  it('should return a 401 error when an invalid api key is used', async function () {
+    const client = new OnspringClient(baseURL, 'invalid');
+    const response = await client.getFieldById(1);
+
+    expect(response.statusCode).to.equal(401);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.be.undefined;
+    expect(response.data).to.be.null;
+  });
+
+  it('should return a 403 error when api key does not have access to the requested field', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+
+    if (process.env.TEST_FIELD_ID_NO_ACCESS === undefined) {
+      return expect.fail('TEST_FIELD_ID_NO_ACCESS is not defined');
+    }
+
+    const fieldId = parseInt(process.env.TEST_FIELD_ID_NO_ACCESS);
+    const response = await client.getFieldById(fieldId);
+
+    expect(response.statusCode).to.equal(403);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.not.be.null;
+    expect(response.data).to.be.null;
+  });
+
+  it('should return a 404 error when the requested field does not exist', async function () {
+    const client = new OnspringClient(baseURL, apiKey);
+    const response = await client.getFieldById(0);
+
+    expect(response.statusCode).to.equal(404);
+    expect(response.isSuccessful).to.be.false;
+    expect(response.message).to.not.be.null;
+    expect(response.data).to.be.null;
+  });
+});