📍 OMRSJS-12: Infer swagger.json URL.

Author: psbrandt

.gitignore

@@ -4,3 +4,4 @@ coverage-node
 coverage-browser
 sauce_connect.log
 npm-debug.log
+lib

src/constants.js

@@ -0,0 +1,6 @@
+/* eslint-disable no-unused-vars */
+export const OMRSJS_CLASS_NAME = 'OpenMRS';
+export const OMRSJS_VERSION = '0.0.1';
+
+export const OMRSJS_DEFAULT_PROTOCOL = 'http';
+export const OMRSJS_OPENAPI_SPEC_PATH_SUFFIX = 'module/webservices/rest/swagger.json';

src/openmrs.js

@@ -1,16 +1,25 @@
 import Swagger from 'swagger-client';
+import * as constants from './constants';
 
 export default class OpenMRS {
 
   constructor(config) {
     /** Allow configuration to to be initialized on new instance creation */
-    this.config = config || {};
+    if (typeof config === 'object') {
+      this.config = config;
+    } else if (typeof config === 'string') {
+      this.config = {
+        url: config,
+      };
+    } else {
+      this.config = {};
+    }
 
     /** Used as the library name. */
-    this._name = 'OpenMRS';
+    this._name = constants.OMRSJS_CLASS_NAME;
 
     /** Used as the semantic version number. */
-    this._version = '0.0.1';
+    this._version = constants.OMRSJS_VERSION;
 
     this._api = undefined;
   }
@@ -35,9 +44,28 @@ export default class OpenMRS {
     }
   }
 
+  getOpenAPISpecURL(url) {
+    let specUrl = url;
+
+    // make sure a protocol is specified
+    if (url.substring(0, 3) !== constants.OMRSJS_DEFAULT_PROTOCOL) {
+      specUrl = `${constants.OMRSJS_DEFAULT_PROTOCOL}://${specUrl}`;
+    }
+
+    // make sure the url string points to the OpenAPI spec
+    if (url.endsWith(constants.OMRSJS_OPENAPI_SPEC_PATH_SUFFIX)) {
+      /** noop */
+    } else {
+      specUrl = url.endsWith('/') ? `${specUrl}${constants.OMRSJS_OPENAPI_SPEC_PATH_SUFFIX}` :
+        `${specUrl}/${constants.OMRSJS_OPENAPI_SPEC_PATH_SUFFIX}`;
+    }
+
+    return specUrl;
+  }
+
   login(user = this.config.user, pass = this.config.pass, url = this.config.url) {
     return new Swagger({
-      url,
+      url: this.getOpenAPISpecURL(url),
       usePromise: true,
       authorizations: {
         easyapi_basic: new Swagger.PasswordAuthorization(user, pass),

test/openmrs.spec.js

@@ -12,7 +12,7 @@ let lib;
 chai.expect();
 chai.use(chaiAsPromised);
 
-describe('After contructing a new instance of OpenMRS', () => {
+describe('After contructing a new instance of OpenMRS with no constructor parameters', () => {
   before(() => {
     lib = new OpenMRS();
   });
@@ -96,3 +96,149 @@ describe('After contructing a new instance of OpenMRS', () => {
     });
   });
 });
+
+describe('Contructing a new instance of OpenMRS with the full URL constructor parameter', () => {
+  before(() => {
+    lib = new OpenMRS('http://localhost:8080/openmrs/module/webservices/rest/swagger.json');
+  });
+
+  describe('and logging in', () => {
+    beforeEach(() => {
+      fauxJax.install();
+    });
+
+    afterEach(() => {
+      fauxJax.restore();
+    });
+
+    it('should succeed with just the user and password', () => {
+      fauxJax.on('request', (req) => {
+        req.respond(200, {
+          'Content-Type': 'application/json',
+        }, JSON.stringify(swaggerSpec));
+      });
+
+      const deferred = lib.login('admin', 'Admin123');
+
+      return expect(deferred).to.eventually.be.fulfilled;
+    });
+  });
+});
+
+describe('Contructing a new instance of OpenMRS with the base URL and protocol', () => {
+  before(() => {
+    lib = new OpenMRS('http://localhost:8080/openmrs/module/webservices/rest/swagger.json');
+  });
+
+  describe('and logging in', () => {
+    beforeEach(() => {
+      fauxJax.install();
+    });
+
+    afterEach(() => {
+      fauxJax.restore();
+    });
+
+    it('should succeed with just the user and password', () => {
+      fauxJax.on('request', (req) => {
+        req.respond(200, {
+          'Content-Type': 'application/json',
+        }, JSON.stringify(swaggerSpec));
+      });
+
+      const deferred = lib.login('admin', 'Admin123');
+
+      return expect(deferred).to.eventually.be.fulfilled;
+    });
+  });
+});
+
+describe('Contructing a new instance of OpenMRS with the full URL without protocol', () => {
+  before(() => {
+    lib = new OpenMRS('localhost:8080/openmrs/module/webservices/rest/swagger.json');
+  });
+
+  describe('and logging in', () => {
+    beforeEach(() => {
+      fauxJax.install();
+    });
+
+    afterEach(() => {
+      fauxJax.restore();
+    });
+
+    it('should succeed with just the user and password', () => {
+      fauxJax.on('request', (req) => {
+        req.respond(200, {
+          'Content-Type': 'application/json',
+        }, JSON.stringify(swaggerSpec));
+      });
+
+      const deferred = lib.login('admin', 'Admin123');
+
+      return expect(deferred).to.eventually.be.fulfilled;
+    });
+  });
+});
+
+describe('Contructing a new instance of OpenMRS with the base URL without protocol', () => {
+  before(() => {
+    lib = new OpenMRS('localhost:8080/openmrs');
+  });
+
+  describe('and logging in', () => {
+    beforeEach(() => {
+      fauxJax.install();
+    });
+
+    afterEach(() => {
+      fauxJax.restore();
+    });
+
+    it('should succeed with just the user and password', () => {
+      fauxJax.on('request', (req) => {
+        req.respond(200, {
+          'Content-Type': 'application/json',
+        }, JSON.stringify(swaggerSpec));
+      });
+
+      const deferred = lib.login('admin', 'Admin123');
+
+      return expect(deferred).to.eventually.be.fulfilled;
+    });
+  });
+});
+
+describe('Contructing a new instance of OpenMRS with the config object', () => {
+  before(() => {
+    const config = {
+      user: 'admin',
+      pass: 'Admin123',
+      url: 'localhost:8080/openmrs',
+    };
+
+    lib = new OpenMRS(config);
+  });
+
+  describe('and logging in', () => {
+    beforeEach(() => {
+      fauxJax.install();
+    });
+
+    afterEach(() => {
+      fauxJax.restore();
+    });
+
+    it('should succeed with no parameters', () => {
+      fauxJax.on('request', (req) => {
+        req.respond(200, {
+          'Content-Type': 'application/json',
+        }, JSON.stringify(swaggerSpec));
+      });
+
+      const deferred = lib.login();
+
+      return expect(deferred).to.eventually.be.fulfilled;
+    });
+  });
+});