Merge branch 'master' of https://github.com/docusign/code-examples-node-private

Author: paigesrossi

README.md

@@ -2,9 +2,7 @@
 
 ### GitHub repo: [code-examples-node](./README.md)
 
-This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the `examplesApi` setting in the appsettings.json file. Set only one API type to `true` and set the remaining to `false`.
-
-If none of the API types are set to `true`, the DocuSign eSignature REST API code examples will be shown. If multiple API types are set to `true`, only the first will be shown.
+This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. By default, the launcher will display the eSignature examples. To switch between API code examples, select "Choose API" in the top menu.
 
 
 ## Introduction

config/appsettings.example.json

@@ -24,13 +24,6 @@
   "documentation": null,
   "multiSourceChooser": false,
   "quickstart" : "{QUICKSTART_VALUE}",
-  "examplesApi": {
-    "isESignatureApi": true,
-    "isRoomsApi": false,
-    "isClickApi": false,
-    "isMonitorApi": false,
-    "isAdminApi": false
-  },
   "roomsApiUrl": "https://demo.rooms.docusign.com",
   "clickAPIUrl": "https://demo.docusign.net/clickapi",
   "adminAPIUrl": "https://api-d.docusign.net/management",

config/examplesApi.json

@@ -0,0 +1 @@
+{"examplesApi":{"isESignatureApi":true,"isRoomsApi":false,"isClickApi":false,"isMonitorApi":false,"isAdminApi":false}}

index.js

@@ -18,6 +18,7 @@ const flash = require('express-flash');
 const helmet = require('helmet'); // https://expressjs.com/en/advanced/best-practice-security.html
 const moment = require('moment');
 const csrf = require('csurf'); // https://www.npmjs.com/package/csurf
+const examplesApi = require('./config/examplesApi.json');
 
 const eg001 = require('./lib/eSignature/controllers/eg001EmbeddedSigning');
 
@@ -75,6 +76,7 @@ let app = express()
     res.locals.user = req.user;
     res.locals.session = req.session;
     res.locals.dsConfig = { ...dsConfig, docOptions: docOptions, docNames: docNames };
+    res.locals.examplesApi = examplesApi
     res.locals.hostUrl = hostUrl; // Used by DSAuthCodeGrant#logout
     next()
   })) // Send user info to views
@@ -93,6 +95,8 @@ let app = express()
   })
   // Routes
   .get('/', commonControllers.indexController)
+  .get('/ds/choose_api', commonControllers.chooseApi)
+  .get('/ds/switch_api', commonControllers.switchApi)
   .get('/ds/login', commonControllers.login)
   .get('/ds/callback', [dsLoginCB1, dsLoginCB2]) // OAuth callbacks. See below
   .get('/ds/logout', commonControllers.logout)
@@ -101,7 +105,7 @@ let app = express()
   .get('/ds-return', commonControllers.returnController)
   .use(csrfProtection) // CSRF protection for the following routes
 ;
-if (dsConfig.examplesApi.isRoomsApi) {
+if (examplesApi.examplesApi.isRoomsApi) {
   app.get('/eg001rooms', eg001rooms.getController)
     .post('/eg001rooms', eg001rooms.createController)
     .get('/eg002rooms', eg002rooms.getController)
@@ -120,7 +124,7 @@ if (dsConfig.examplesApi.isRoomsApi) {
     .post('/eg008rooms', eg008rooms.createController)
     .get('/eg009rooms', eg009rooms.getController)
     .post('/eg009rooms', eg009rooms.createController)
-} else if (dsConfig.examplesApi.isClickApi) {
+} else if (examplesApi.examplesApi.isClickApi) {
   app.get('/eg001', eg001click.getController)
     .post('/eg001', eg001click.createController)
     .get('/eg002', eg002click.getController)
@@ -131,10 +135,10 @@ if (dsConfig.examplesApi.isRoomsApi) {
     .post('/eg004', eg004click.createController)
     .get('/eg005', eg005click.getController)
     .post('/eg005', eg005click.createController)
-} else if (dsConfig.examplesApi.isMonitorApi) {
+} else if (examplesApi.examplesApi.isMonitorApi) {
   app.get('/eg001', eg001monitor.getController)
     .post('/eg001', eg001monitor.createController)
-} else if (dsConfig.examplesApi.isAdminApi) {
+} else if (examplesApi.examplesApi.isAdminApi) {
     app.get('/eg001', eg001admin.getController)
     .post('/eg001', eg001admin.createController)
     .get('/eg002', eg002admin.getController)
@@ -260,13 +264,13 @@ const ADMIN_SCOPES = [
   "domain_read", "identity_provider_read", "signature"
 ];
 let scope;
-if (dsConfig.examplesApi.isRoomsApi) {
+if (examplesApi.examplesApi.isRoomsApi) {
   scope = ROOM_SCOPES;
-} else if (dsConfig.examplesApi.isClickApi) {
+} else if (examplesApi.examplesApi.isClickApi) {
   scope = CLICK_SCOPES;
-} else if (dsConfig.examplesApi.isMonitorApi) {
+} else if (examplesApi.examplesApi.isMonitorApi) {
   scope = MONITOR_SCOPES;
-} else if (dsConfig.examplesApi.isAdminApi) {
+} else if (examplesApi.examplesApi.isAdminApi) {
   scope = ADMIN_SCOPES;
 } else {
   scope = SCOPES;

lib/DSAuthCodeGrant.js

@@ -21,6 +21,7 @@ const moment = require('moment')
       // minutes later or it will be replaced
 
     ;
+
 /**
  * Manages OAuth Authentication Code Grant with DocuSign.
  * @constructor

lib/DSJwtAuth.js

@@ -9,6 +9,7 @@
  * @author DocuSign
  */
 
+const examplesApi = require('../config/examplesApi.json');
 
 'use strict';
 let DsJwtAuth = function _DsJwtAuth(req) {
@@ -20,11 +21,11 @@ let DsJwtAuth = function _DsJwtAuth(req) {
     this.basePath = req.user && req.user.basePath;
     this._tokenExpiration = req.user && req.user.tokenExpirationTimestamp;
     this.scopes = "signature"
-    if (dsConfig.examplesApi.isRoomsApi) {
+    if (examplesApi.examplesApi.isRoomsApi) {
         this.scopes += " dtr.rooms.read dtr.rooms.write dtr.documents.read dtr.documents.write dtr.profile.read dtr.profile.write dtr.company.read dtr.company.write room_forms";
-    } else if(dsConfig.examplesApi.isClickApi) {
+    } else if(examplesApi.examplesApi.isClickApi) {
         this.scopes += " click.manage click.send"
-    } else if(dsConfig.examplesApi.isAdminApi) {
+    } else if(examplesApi.examplesApi.isAdminApi) {
       this.scopes += " organization_read group_read permission_read user_read user_write account_read domain_read identity_provider_read";
     }
 

lib/common/DSJwtAuth.js

@@ -9,6 +9,7 @@
  * @author DocuSign
  */
 
+const examplesApi = require('.../config/examplesApi.json');
 
  'use strict';
  let DsJwtAuth = function _DsJwtAuth(req) {
@@ -20,9 +21,9 @@
      this.basePath = req.user && req.user.basePath;
      this._tokenExpiration = req.user && req.user.tokenExpirationTimestamp;
      this.scopes = "signature"
-     if (dsConfig.examplesApi.isRoomsApi) {
+     if (examplesApi.examplesApi.isRoomsApi) {
          this.scopes += " dtr.rooms.read dtr.rooms.write dtr.documents.read dtr.documents.write dtr.profile.read dtr.profile.write dtr.company.read dtr.company.write room_forms";
-     } else if(dsConfig.examplesApi.isClickApi) {
+     } else if(examplesApi.examplesApi.isClickApi) {
          this.scopes += " click.manage click.send"
      }
 

lib/commonControllers.js

@@ -6,6 +6,7 @@
 
 const fs = require('fs')
     , dsConfig = require('../config/appsettings.json')
+    , examplesApi = require('../config/examplesApi.json')
     , documentationTopic = 'auth-code-grant-node'
     ;
 
@@ -19,7 +20,7 @@ commonControllers.indexController = (req, res) => {
         console.debug ('quickstart mode on');
         return res.redirect('/eg001');
     }
-    else if (dsConfig.examplesApi['isMonitorApi']){
+    else if (examplesApi.examplesApi['isMonitorApi']){
         res.render('pages/index_monitor_examples', {
             title: "Home",
             documentation: dsConfig.documentation + documentationTopic,
@@ -38,7 +39,7 @@ commonControllers.indexController = (req, res) => {
 commonControllers.mustAuthenticateController = (req, res) => {
     if (dsConfig.quickstart == 'true')
       res.redirect('login');
-    else if (dsConfig.examplesApi.isMonitorApi) {
+    else if (examplesApi.examplesApi.isMonitorApi) {
           // Monitor API supports JWT only
           req.dsAuth = req.dsAuthJwt;
           req.dsAuth.login(req, res, '');
@@ -47,6 +48,73 @@ commonControllers.mustAuthenticateController = (req, res) => {
       res.render('pages/ds_must_authenticate', {title: "Authenticate with DocuSign"});
 }
 
+commonControllers.chooseApi = (req, res) => {
+    res.render('pages/choose_api', {title: "Choose API"});
+}
+
+commonControllers.switchApi = (req, res) => {
+    const { chosenApi } = req.query;
+    const fs = require('fs');
+
+    let apiChoice = {
+            examplesApi: {
+                isESignatureApi: false,
+                isRoomsApi: false,
+                isClickApi: false,
+                isMonitorApi: false,
+                isAdminApi: false
+            }
+    }
+
+    if (chosenApi == "eSignature") {
+        apiChoice.examplesApi.isESignatureApi = true;
+        let data = JSON.stringify(apiChoice);
+        fs.writeFile ("config/examplesApi.json", data, function(err) {
+            if (err) throw err;
+            console.log('complete');
+            }
+        );
+      }
+    else if (chosenApi == "rooms") {
+        apiChoice.examplesApi.isRoomsApi = true;
+        let data = JSON.stringify(apiChoice);
+        fs.writeFile ("config/examplesApi.json", data, function(err) {
+            if (err) throw err;
+            console.log('complete');
+            }
+        ); 
+      }
+    else if (chosenApi == "click") {
+        apiChoice.examplesApi.isClickApi = true;
+        let data = JSON.stringify(apiChoice);
+        fs.writeFile ("config/examplesApi.json", data, function(err) {
+            if (err) throw err;
+            console.log('complete');
+            }
+        );
+      }
+    else if (chosenApi == "monitor") {
+        apiChoice.examplesApi.isMonitorApi = true;
+        let data = JSON.stringify(apiChoice);
+        fs.writeFile ("config/examplesApi.json", data, function(err) {
+            if (err) throw err;
+            console.log('complete');
+            }
+        );
+      }
+    else if (chosenApi == "admin") {
+        apiChoice.examplesApi.isAdminApi = true;
+        let data = JSON.stringify(apiChoice);
+        fs.writeFile ("config/examplesApi.json", data, function(err) {
+            if (err) throw err;
+            console.log('complete');
+            }
+        );
+      }
+
+    res.render('pages/restart', {title: "Restart the app"});
+}
+
 commonControllers.login = (req, res, next) => {
     const { auth } = req.query;
     if (auth === 'grand-auth') {

views/pages/choose_api.ejs

@@ -0,0 +1,22 @@
+<% include ../partials/genericHead %>
+<div style="margin:1% 5%;">
+  <h1 class="display-4">Please Choose an API</h1>
+  <p class="lead">
+  <form class="eg" action="/ds/switch_api" method="get" data-busy="form">
+    <div class="form-group">
+      <label>Please choose your API</label>
+      <select id="chosenApi" name="chosenApi" class="form-control">
+        <option value="eSignature" selected>eSignature</option>
+        <option value="rooms">Rooms</option>
+        <option value="click">Click</option>
+        <option value="monitor">Monitor</option>
+        <option value="admin">Admin</option>
+      </select><br>
+      <button class="btn btn-docu btn-lg">Choose your desired API</button>
+    </div>
+  </form>
+  </p>
+  <hr class="my-4">
+
+</div>
+<% include ../partials/genericFoot %>

views/pages/index.ejs

@@ -16,7 +16,7 @@
       <p class="Xlead">Run and explore DocuSign code examples with Authorization Code Grant or JWT Grant authentication</p>
     <% } else { %>
       <h1 class="display-4">Node Launcher</h1>
-      <% if (dsConfig.examplesApi.isAdminApi) { %>
+      <% if (examplesApi.examplesApi.isAdminApi) { %>
         <p class="Xlead">
           Run and explore DocuSign Admin API code examples with Authorization Code Grant or JWT Grant authentication
         </p>