APIKey identication resolved #1

Labs64 · Aug 12, 2019 · 5e3c751 · 5e3c751
1 parent e5b0590
commit 5e3c751
Show file tree

Hide file tree

Showing 19 changed files with 141 additions and 47 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
 ## 0.9.0
 
 * (New) Early Access version of NetLicensing / Zapier integration
+
+## 0.9.1
+
+* API Key authentication added
diff --git a/authentication/Custom.js b/authentication/Custom.js
@@ -0,0 +1,53 @@
+const constants = require('../config/Constants');
+
+const test = (z) => {
+    // Normally you want to make a request to an endpoint that is either specifically designed to test auth, or one that
+    // every user will have access to, such as an account or profile endpoint like /me.
+    // In this example, we'll hit httpbin, which validates the Authorization Header against the arguments passed in the
+    // URL path
+
+    // This method can return any truthy value to indicate the credentials are valid.
+    // Raise an error to show
+    return z.request({
+        url: `${constants.BASE_HOST + constants.BASE_PATH}/utility/licensingModels`,
+        method: 'GET',
+        headers: {
+            Accept: 'application/json',
+        },
+        params: {},
+    }).then((response) => {
+        if (response.status === 401) {
+            throw new Error(constants.authentication.LOGIN_FAILED_TEXT);
+        } else if (response.status >= 500) {
+            throw new Error(constants.authentication.SERVICE_UNAVAILABLE_TEXT);
+        }
+        return response;
+    });
+};
+
+module.exports = {
+    type: 'custom',
+    // The test method allows Zapier to verify that the credentials a user provides are valid. We'll execute this
+    // method whenver a user connects their account for the first time.
+    test,
+    // assuming "username" is a key returned from the test
+    // connectionLabel: '{{username}}',
+    fields: [
+        {
+            key: 'username',
+            type: 'string',
+            required: false,
+        },
+        {
+            key: 'password',
+            type: 'password',
+            required: false,
+        },
+        {
+            key: 'apiKey',
+            type: 'string',
+            required: false,
+            helpText: 'You could authenticate by Username and Password or API Key',
+        },
+    ],
+};
diff --git a/creates/CreateLicensee.js b/creates/CreateLicensee.js
@@ -1,14 +1,11 @@
-const { LicenseeService, Licensee, Context, Constants } = require('netlicensing-client/dist/netlicensing-client.node');
+const { LicenseeService, Licensee } = require('netlicensing-client/dist/netlicensing-client.node');
 const constants = require('../config/Constants');
+const getContext = require('../utils/getContext');
 
 const createLicensee = async (z, bundle) => {
-    const context = new Context();
-    context.setUsername(bundle.authData.username);
-    context.setPassword(bundle.authData.password);
-    context.setSecurityMode(Constants.BASIC_AUTHENTICATION);
+    const context = getContext(bundle);
 
     let licensee = new Licensee();
-
     if (bundle.inputData.name !== undefined) {
         licensee.setName(bundle.inputData.name);
     }

diff --git a/creates/CreateProduct.js b/creates/CreateProduct.js
@@ -1,11 +1,9 @@
-const { ProductService, Product, Context, Constants } = require('netlicensing-client/dist/netlicensing-client.node');
+const { ProductService, Product } = require('netlicensing-client/dist/netlicensing-client.node');
 const constants = require('../config/Constants');
+const getContext = require('../utils/getContext');
 
 const createProduct = async (z, bundle) => {
-    const context = new Context();
-    context.setUsername(bundle.authData.username);
-    context.setPassword(bundle.authData.password);
-    context.setSecurityMode(Constants.BASIC_AUTHENTICATION);
+    const context = getContext(bundle);
 
     let product = new Product()
         .setName(bundle.inputData.name);

diff --git a/index.js b/index.js
@@ -1,8 +1,12 @@
+const { Token, TokenService, Constants, Context } = require('netlicensing-client/dist/netlicensing-client.node');
+
 const { version: platformVersion } = require('zapier-platform-core');
 const { version } = require('./package.json');
 
-// auth (basic)
-const authentication = require('./authentication/BasicAuth');
+// auth
+// const authentication = require('./authentication/BasicAuth');
+const authentication = require('./authentication/Custom');
+
 // triggers
 const newProduct = require('./triggers/NewProduct');
 const newLicensee = require('./triggers/NewLicensee');
@@ -16,6 +20,18 @@ const createLicensee = require('./creates/CreateLicensee');
 const searchOrCreateProduct = require('./search_or_creates/SearchOrCreateProduct');
 const searchOrCreateLicensee = require('./search_or_creates/SearchOrCreateLicensee');
 
+const addAuthToHeader = (request, z, bundle) => {
+    if (bundle.authData.username.trim() && bundle.authData.password.trim()) {
+        request.headers.Authorization = `Basic ${Buffer.from(`${bundle.authData.username}:${bundle.authData.password}`)
+            .toString('base64')}`;
+    } else if (bundle.authData.apiKey.trim()) {
+        request.headers.Authorization = `Basic ${Buffer.from(`apiKey:${bundle.authData.apiKey}`)
+            .toString('base64')}`;
+    }
+
+    return request;
+};
+
 // We can roll up all our behaviors in an App.
 const App = {
     // This is just shorthand to reference the installed dependencies you have. Zapier will
@@ -28,7 +44,7 @@ const App = {
     authentication,
 
     // beforeRequest & afterResponse are optional hooks into the provided HTTP client
-    beforeRequest: [],
+    beforeRequest: [addAuthToHeader],
 
     afterResponse: [],
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "netlicensing",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "NetLicensing / Zapier integration",
   "repository": "github:Labs64/NetLicensing-Zapier",
   "homepage": "https://netlicensing.io",

diff --git a/searches/FindLicensee.js b/searches/FindLicensee.js
@@ -1,14 +1,10 @@
-const { LicenseeService, Context, Constants } = require('netlicensing-client/dist/netlicensing-client.node');
+const { LicenseeService } = require('netlicensing-client/dist/netlicensing-client.node');
 const constants = require('../config/Constants');
+const getContext = require('../utils/getContext');
 
 const getLicensee = async (z, bundle) => {
-    const context = new Context();
-    context.setUsername(bundle.authData.username);
-    context.setPassword(bundle.authData.password);
-    context.setSecurityMode(Constants.BASIC_AUTHENTICATION);
-
+    const context = getContext(bundle);
     const licensee = await LicenseeService.get(context, bundle.inputData.number);
-
     return [licensee.getProperties()];
 };
 

diff --git a/searches/FindProduct.js b/searches/FindProduct.js
@@ -1,14 +1,10 @@
-const { ProductService, Context, Constants } = require('netlicensing-client/dist/netlicensing-client.node');
+const { ProductService } = require('netlicensing-client/dist/netlicensing-client.node');
 const constants = require('../config/Constants');
+const getContext = require('../utils/getContext');
 
 const getProduct = async (z, bundle) => {
-    const context = new Context();
-    context.setUsername(bundle.authData.username);
-    context.setPassword(bundle.authData.password);
-    context.setSecurityMode(Constants.BASIC_AUTHENTICATION);
-
+    const context = getContext(bundle);
     const product = await ProductService.get(context, bundle.inputData.number);
-
     return [product.getProperties()];
 };
 

diff --git a/test/mock/authentication/MockApiKeyAuth.js b/test/mock/authentication/MockApiKeyAuth.js
@@ -0,0 +1,37 @@
+const nock = require('nock');
+
+const zapier = require('zapier-platform-core');
+
+const constants = require('../../../config/Constants');
+
+// Use this to make test calls into your app:
+const App = require('../../../index');
+
+const appTester = zapier.createAppTester(App);
+
+describe('Authentication', () => {
+    const apiMock = nock(constants.BASE_HOST);
+    const authData = {
+        username: '',
+        password: '',
+        apiKey: 'testApiKey',
+    };
+
+    afterEach(() => {
+        nock.cleanAll();
+    });
+
+    it('Success auth', (done) => {
+        const bundle = Object.assign({}, { authData });
+
+        apiMock.get(`${constants.BASE_PATH}/utility/licensingModels`)
+            .reply(200);
+
+        appTester(App.authentication.test, bundle)
+            .then((response) => {
+                response.status.should.eql(200);
+                done();
+            })
+            .catch(done);
+    });
+});
diff --git a/test/mock/authentication/MockBasicAuth.js b/test/mock/authentication/MockBasicAuth.js
@@ -1,5 +1,4 @@
 const nock = require('nock');
-const should = require('should');
 
 const zapier = require('zapier-platform-core');
 
@@ -13,7 +12,7 @@ const appTester = zapier.createAppTester(App);
 describe('Authentication', () => {
     const apiMock = nock(constants.BASE_HOST);
     const authData = {
-        email: constants.NLIC_USERNAME,
+        username: constants.NLIC_USERNAME,
         password: constants.NLIC_PASSWORD,
     };
 

diff --git a/test/mock/triggers/MockNewLecensee.js b/test/mock/triggers/MockNewLecensee.js
@@ -2,8 +2,6 @@ const zapier = require('zapier-platform-core/index');
 
 const nock = require('nock');
 
-const should = require('should');
-
 const constants = require('../../../config/Constants');
 
 const App = require('../../../index');

diff --git a/test/mock/triggers/MockNewProduct.js b/test/mock/triggers/MockNewProduct.js
@@ -2,8 +2,6 @@ const zapier = require('zapier-platform-core/index');
 
 const nock = require('nock');
 
-const should = require('should');
-
 const constants = require('../../../config/Constants');
 
 const App = require('../../../index');

diff --git a/test/production/creates/CreateLicensee.js b/test/production/creates/CreateLicensee.js
@@ -1,5 +1,3 @@
-const should = require('should/should');
-
 const zapier = require('zapier-platform-core/index');
 
 const constants = require('../../../config/Constants');

diff --git a/test/production/creates/CreateProduct.js b/test/production/creates/CreateProduct.js
@@ -1,5 +1,3 @@
-const should = require('should/should');
-
 const zapier = require('zapier-platform-core/index');
 
 const constants = require('../../../config/Constants');

diff --git a/test/production/searches/FindLicensee.js b/test/production/searches/FindLicensee.js
@@ -1,5 +1,3 @@
-const should = require('should/should');
-
 const zapier = require('zapier-platform-core/index');
 
 const App = require('../../../index');

diff --git a/test/production/searches/FindProduct.js b/test/production/searches/FindProduct.js
@@ -1,5 +1,3 @@
-const should = require('should/should');
-
 const zapier = require('zapier-platform-core/index');
 
 const App = require('../../../index');

diff --git a/test/production/triggers/NewLecensee.js b/test/production/triggers/NewLecensee.js
@@ -1,5 +1,3 @@
-const should = require('should/should');
-
 const zapier = require('zapier-platform-core/index');
 
 const App = require('../../../index');

diff --git a/test/production/triggers/NewProduct.js b/test/production/triggers/NewProduct.js
@@ -1,5 +1,3 @@
-const should = require('should/should');
-
 const zapier = require('zapier-platform-core/index');
 
 const App = require('../../../index');

diff --git a/utils/getContext.js b/utils/getContext.js
@@ -0,0 +1,14 @@
+const { Context, Constants } = require('netlicensing-client/dist/netlicensing-client.node');
+
+module.exports = (bundle) => {
+    const context = new Context();
+    if (bundle.authData.username.trim() && bundle.authData.password.trim()) {
+        context.setUsername(bundle.authData.username);
+        context.setPassword(bundle.authData.password);
+        context.setSecurityMode(Constants.BASIC_AUTHENTICATION);
+    } else {
+        context.setApiKey(bundle.authData.apiKey);
+        context.setSecurityMode(Constants.APIKEY_IDENTIFICATION);
+    }
+    return context;
+};