Adding more auth conversion templates

package.json

@@ -16,9 +16,9 @@
     "version": "npm run docs && npm run gen-completions && git add docs/* goodies/* README.md",
     "postversion": "git push && git push --tags && npm publish",
     "prepublish": "npm run build",
-    "build": "rm -rf lib && node_modules/babel-cli/bin/babel.js src -d lib",
-    "watch": "rm -rf lib && node_modules/babel-cli/bin/babel.js --watch src -d lib",
-    "lint": "node_modules/.bin/eslint zapier.js src test",
+    "build": "rm -rf lib && node_modules/babel-cli/bin/babel.js src -d lib --copy-files",
+    "watch": "rm -rf lib && node_modules/babel-cli/bin/babel.js --watch src -d lib --copy-files",
+    "lint": "node_modules/.bin/eslint zapier.js src",
     "lint-snippets": "node_modules/.bin/eslint snippets --rule 'no-unused-vars: 0'",
     "test": "npm run build && node_modules/mocha/bin/mocha -t 15000 --recursive lib/tests && npm run lint && npm run lint-snippets",
     "zapier": "zapier.js",

scaffold/convert/header.template.js

@@ -0,0 +1,75 @@
+<% if (before && !session && !oauth) { %>const maybeIncludeAuth = (request, z, bundle) => {
+<%
+  Object.keys(mapping).forEach((mapperKey) => {
+    fields.forEach((field) => {
+      if (mapping[mapperKey].indexOf(`{{${field}}}`) !== -1) {
+        if (query) { %>
+  request.params['<%= mapperKey %>'] = bundle.authData['<%= field %>'];
+<% } else { %>
+  request.headers['<%= mapperKey %>'] = bundle.authData['<%= field %>'];
+<%      }
+      }
+    });
+  });
+%>
+  return request;
+}
+<% }
+
+if (before && session) { %>const maybeIncludeAuth = (request, z, bundle) => {
+<%
+  if (query) { %>
+  request.params['<%= Object.keys(mapping)[0] %>'] = bundle.authData.sessionKey;;
+<% } else { %>
+  request.headers['<%= Object.keys(mapping)[0] %>'] = bundle.authData.sessionKey;
+<% } %>
+  return request;
+}
+<% }
+
+if (before && oauth) { %>const maybeIncludeAuth = (request, z, bundle) => {
+
+  request.headers.Authorization = `Bearer ${bundle.authData.access_token}`;
+
+  return request;
+}
+<% }
+
+if (after) { %>
+const maybeRefresh = (response, z, bundle) => {
+  if (response.status === 401 || response.status === 403) {
+    throw new z.errors.RefreshAuthError('Session key needs refreshing.');
+  }
+
+  return response;
+}
+
+<% }
+
+if (session) { %>
+const getSessionKey = (z, bundle) => {
+  const scripting = require('../scripting');
+  const legacyScriptingRunner = require('zapier-platform-legacy-scripting-runner')(scripting);
+
+  // Do a get_session_info() from scripting.
+  const getSessionEvent = {
+    name: 'auth.session'
+  };
+  return legacyScriptingRunner.runEvent(getSessionEvent, z, bundle)
+    .then((getSessionResult) => {
+      // IMPORTANT NOTE:
+      //   WB apps in scripting's get_session_info() allowed to return any object and that would be
+      //   added to the authData, but CLI apps require you to specifically define those.
+      //   That means that if you return more than one key from your scripting's get_session_info(),
+      //   you might need to manually tweak this method to return that value at the end of this method,
+      //   and also add more fields to the authentication definition.
+
+      const resultKeys = Object.keys(getSessionResult);
+      const firstKeyValue = (getSessionResult && resultKeys.length > 0) ? getSessionResult[resultKeys[0]] : getSessionResult;
+
+      return {
+        sessionKey: firstKeyValue
+      };
+    });
+}
+<% } %>

scaffold/convert/index.template.js

@@ -2,12 +2,22 @@
 
 <%= REQUIRES %>
 
+<%= HEADER %>
+
 const App = {
   version: require('./package.json').version,
   platformVersion: require('zapier-platform-core').version,
 
   authentication: <%= AUTHENTICATION %>,
 
+  beforeRequest: [
+    <%= BEFORE_REQUESTS %>
+  ],
+
+  afterResponse: [
+    <%= AFTER_RESPONSES %>
+  ],
+
   resources: {
   },
 

scaffold/convert/oauth2-refresh.template.js

@@ -0,0 +1,47 @@
+{
+  // TODO: just an example stub - you'll need to complete
+  type: 'oauth2',
+  test: AuthTest.operation.perform,
+  oauth2Config: {
+    authorizeUrl: {
+      method: 'GET',
+      url: '<%= AUTHORIZE_URL %>',
+      params: {
+        client_id: '{{process.env.CLIENT_ID}}',
+        state: '{{bundle.inputData.state}}',
+        redirect_uri: '{{bundle.inputData.redirect_uri}}',
+        response_type: 'code'
+      }
+    },
+    getAccessToken: {
+      method: 'POST',
+      url: '<%= ACCESS_TOKEN_URL %>',
+      body: {
+        code: '{{bundle.inputData.code}}',
+        client_id: '{{process.env.CLIENT_ID}}',
+        client_secret: '{{process.env.CLIENT_SECRET}}',
+        redirect_uri: '{{bundle.inputData.redirect_uri}}',
+        grant_type: 'authorization_code'
+      },
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded'
+      }
+    },
+    refreshAccessToken: {
+      method: 'POST',
+      url: '<%= REFRESH_TOKEN_URL %>',
+      body: {
+        refresh_token: '{{bundle.authData.refresh_token}}',
+        client_id: '{{process.env.CLIENT_ID}}',
+        client_secret: '{{process.env.CLIENT_SECRET}}',
+        grant_type: 'refresh_token'
+      },
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded'
+      }
+    },
+    scope: '<%= SCOPE %>',
+    autoRefresh: true
+  },
+  connectionLabel: '<%= CONNECTION_LABEL %>'
+}

scaffold/convert/oauth2.template.js

@@ -1,9 +1,7 @@
 {
   // TODO: just an example stub - you'll need to complete
   type: 'oauth2',
-  test: {
-    url: 'http://www.EXAMPLE.com/auth'
-  },
+  test: AuthTest.operation.perform,
   oauth2Config: {
     authorizeUrl: {
       method: 'GET',
@@ -28,6 +26,8 @@
       headers: {
         'Content-Type': 'application/x-www-form-urlencoded'
       }
-    }
-  }
+    },
+    scope: '<%= SCOPE %>'
+  },
+  connectionLabel: '<%= CONNECTION_LABEL %>'
 }

scaffold/convert/package.template.json

@@ -7,17 +7,16 @@
     "test": "node node_modules/mocha/bin/mocha --recursive"
   },
   "engines": {
-    "node": ">=4.3.0",
-    "npm": ">=2.0.0"
+    "node": ">=6.10.0",
+    "npm": ">=3.0.0"
   },
   "dependencies": {
-    "lodash": "4.15.0",
-    "zapier-platform-core": "<%= ZAPIER_CORE_VERSION %>"
+    "lodash": "4.17.4",
+    <%= DEPENDENCIES %>
   },
   "devDependencies": {
-    "babel": "6.5.2",
-    "babel-eslint": "6.1.2",
-    "mocha": "2.5.3",
-    "should": "9.0.2"
-  }
+    "mocha": "4.0.1",
+    "should": "13.1.2"
+  },
+  "private": true
 }

scaffold/convert/scripting.template.js

@@ -0,0 +1,29 @@
+'use strict';
+
+// START: HEADER -- AUTOMATICALLY ADDED FOR COMPATIBILITY - v<%= VERSION %>
+const _ = require('lodash');
+_.templateSettings.interpolate = /{{([\s\S]+?)}}/g;
+const crypto = require('crypto');
+const async = require('async');
+const moment = require('moment-timezone');
+const DOMParser = require('zapier-platform-legacy-scripting-runner/dom-parser');
+const XMLSerializer = require('zapier-platform-legacy-scripting-runner/xml-serializer');
+const atob = require('zapier-platform-legacy-scripting-runner/atob');
+const btoa = require('zapier-platform-legacy-scripting-runner/btoa');
+const z = require('zapier-platform-legacy-scripting-runner/z');
+const $ = require('zapier-platform-legacy-scripting-runner/$');
+const {
+  ErrorException,
+  HaltedException,
+  StopRequestException,
+  ExpiredAuthException,
+  RefreshTokenException,
+  InvalidSessionException,
+} = require('zapier-platform-legacy-scripting-runner/exceptions');
+// END: HEADER -- AUTOMATICALLY ADDED FOR COMPATIBILITY - v<%= VERSION %>
+
+<%= CODE %>
+
+// START: FOOTER -- AUTOMATICALLY ADDED FOR COMPATIBILITY - v<%= VERSION %>
+module.exports = Zap;
+// END: FOOTER -- AUTOMATICALLY ADDED FOR COMPATIBILITY - v<%= VERSION %>

scaffold/convert/session.template.js

@@ -0,0 +1,12 @@
+{
+  // TODO: just an example stub - you'll need to complete
+  type: 'session',
+  test: AuthTest.operation.perform,
+  fields: [
+    <%= FIELDS %>
+  ],
+  sessionConfig: {
+    perform: getSessionKey
+  },
+  connectionLabel: '<%= CONNECTION_LABEL %>'
+}

src/tests/utils.js

@@ -9,6 +9,7 @@ describe('utils', () => {
     global._babelPolyfill.should.eql(true);
   });
 
+  // For some reason, Travis dies on this one
   it.skip('should print a nice little table', () => {
     const table = utils.makeTable(
       [{id: 123, title: 'hello'}, {id: 456, title: 'world'}],