DEVDOCS-552 improve example names

Author: LarryKlugerDS

.idea/misc.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

.idea/modules.xml

@@ -16,20 +16,20 @@ const express = require('express')
     , moment = require('moment')
     , csp = require('helmet-csp')
     , csrf = require('csurf') // https://www.npmjs.com/package/csurf
-    , eg001 = require('./lib/examples/eg001')
-    , eg002 = require('./lib/examples/eg002')
-    , eg003 = require('./lib/examples/eg003')
-    , eg004 = require('./lib/examples/eg004')
-    , eg005 = require('./lib/examples/eg005')
-    , eg006 = require('./lib/examples/eg006')
-    , eg007 = require('./lib/examples/eg007')
-    , eg008 = require('./lib/examples/eg008')
-    , eg009 = require('./lib/examples/eg009')
-    , eg010 = require('./lib/examples/eg010')
-    , eg011 = require('./lib/examples/eg011')
-    , eg012 = require('./lib/examples/eg012')
-    , eg013 = require('./lib/examples/eg013')
-    , eg014 = require('./lib/examples/eg014')
+    , eg001 = require('./lib/examples/eg001EmbeddedSigning')
+    , eg002 = require('./lib/examples/eg002SigningViaEmail')
+    , eg003 = require('./lib/examples/eg003ListEnvelopes')
+    , eg004 = require('./lib/examples/eg004EnvelopeInfo')
+    , eg005 = require('./lib/examples/eg005EnvelopeRecipients')
+    , eg006 = require('./lib/examples/eg006EnvelopeDocs')
+    , eg007 = require('./lib/examples/eg007EnvelopeGetDoc')
+    , eg008 = require('./lib/examples/eg008CreateTemplate')
+    , eg009 = require('./lib/examples/eg009UseTemplate')
+    , eg010 = require('./lib/examples/eg010SendBinaryDocs')
+    , eg011 = require('./lib/examples/eg011EmbeddedSending')
+    , eg012 = require('./lib/examples/eg012EmbeddedConsole')
+    , eg013 = require('./lib/examples/eg013AddDocToTemplate')
+    , eg014 = require('./lib/examples/eg014CollectPayment')
     ;
 
 const PORT = process.env.PORT || 5000

.idea/vcs.xml

@@ -11,7 +11,7 @@ const path = require('path')
     , dsConfig = require('../../ds_configuration.js').config
     ;
 
-const eg001 = exports
+const eg001EmbeddedSigning = exports
     , eg = 'eg001' // This example reference.
     , mustAuthenticate = '/ds/mustAuthenticate'
     , minimumBufferMin = 3
@@ -25,13 +25,13 @@ const eg001 = exports
 /**
  * Form page for this application
  */
-eg001.getController = (req, res) => {
+eg001EmbeddedSigning.getController = (req, res) => {
     // Check that the authentication token is ok with a long buffer time.
     // If needed, now is the best time to ask the user to authenticate
     // since they have not yet entered any information into the form.
     let tokenOK = req.dsAuthCodeGrant.checkToken();
     if (tokenOK) {
-        res.render('pages/examples/eg001', {
+        res.render('pages/examples/eg001EmbeddedSigning', {
             csrfToken: req.csrfToken(), 
             title: "Embedded Signing Ceremony",
             source: dsConfig.githubExampleUrl + path.basename(__filename),
@@ -50,7 +50,7 @@ eg001.getController = (req, res) => {
  * @param {object} req Request obj 
  * @param {object} res Response obj
  */
-eg001.createController = async (req, res) => {
+eg001EmbeddedSigning.createController = async (req, res) => {
     // Step 1. Check the token
     // At this point we should have a good token. But we
     // double-check here to enable a better UX to the user.
@@ -90,7 +90,7 @@ eg001.createController = async (req, res) => {
       ;
 
     try {
-        results = await eg001.worker (args)
+        results = await eg001EmbeddedSigning.worker (args)
     }
     catch (error) {
         let errorBody = error && error.response && error.response.body
@@ -123,7 +123,7 @@ eg001.createController = async (req, res) => {
  *      <tt>signerEmail</tt>, <tt>signerName</tt>, <tt>signerClientId</tt>
  */
 // ***DS.worker.start ***DS.snippet.1.start
-eg001.worker = async (args) => { 
+eg001EmbeddedSigning.worker = async (args) => {
     let envelopesApi = new docusign.EnvelopesApi(args.dsAPIclient)
       , createEnvelopeP = args.makePromise(envelopesApi, 'createEnvelope')
       , results = null

.idea/workspace.xml

@@ -11,7 +11,7 @@ const path = require('path')
     , dsConfig = require('../../ds_configuration.js').config
     ;
 
-const eg002 = exports
+const eg002SigningViaEmail = exports
     , eg = 'eg002' // This example reference.
     , mustAuthenticate = '/ds/mustAuthenticate'
     , minimumBufferMin = 3
@@ -25,13 +25,13 @@ const eg002 = exports
 /**
  * Form page for this application
  */
-eg002.getController = (req, res) => {
+eg002SigningViaEmail.getController = (req, res) => {
     // Check that the authentication token is ok with a long buffer time.
     // If needed, now is the best time to ask the user to authenticate
     // since they have not yet entered any information into the form.
     let tokenOK = req.dsAuthCodeGrant.checkToken();
     if (tokenOK) {
-        res.render('pages/examples/eg002', {
+        res.render('pages/examples/eg002SigningViaEmail', {
             csrfToken: req.csrfToken(), 
             title: "Signing request by email",
             source: dsConfig.githubExampleUrl + path.basename(__filename),
@@ -50,7 +50,7 @@ eg002.getController = (req, res) => {
  * @param {object} req Request obj 
  * @param {object} res Response obj
  */
-eg002.createController = async (req, res) => {
+eg002SigningViaEmail.createController = async (req, res) => {
     // Step 1. Check the token
     // At this point we should have a good token. But we
     // double-check here to enable a better UX to the user.
@@ -91,7 +91,7 @@ eg002.createController = async (req, res) => {
       ;
 
     try {
-        results = await eg002.worker (args)
+        results = await eg002SigningViaEmail.worker (args)
     }
     catch (error) {
         let errorBody = error && error.response && error.response.body
@@ -125,7 +125,7 @@ eg002.createController = async (req, res) => {
  *      <tt>signerEmail</tt>, <tt>signerName</tt>, <tt>ccEmail</tt>, <tt>ccName</tt>
  */
 // ***DS.worker.start ***DS.snippet.1.start
-eg002.worker = async (args) => { 
+eg002SigningViaEmail.worker = async (args) => {
     let envelopesApi = new docusign.EnvelopesApi(args.dsAPIclient)
       , createEnvelopeP = args.makePromise(envelopesApi, 'createEnvelope')
       , results = null

eg-03-node-auth-code-grant.iml

@@ -10,7 +10,7 @@ const docusign = require('docusign-esign')
     , path = require('path')
     ;
 
-const eg003 = exports
+const eg003ListEnvelopes = exports
     , eg = 'eg003' // This example reference.
     , mustAuthenticate = '/ds/mustAuthenticate'
     , minimumBufferMin = 3
@@ -19,13 +19,13 @@ const eg003 = exports
 /**
  * Form page for this application
  */
-eg003.getController = (req, res) => {
+eg003ListEnvelopes.getController = (req, res) => {
     // Check that the authentication token is ok with a long buffer time.
     // If needed, now is the best time to ask the user to authenticate
     // since they have not yet entered any information into the form.
     let tokenOK = req.dsAuthCodeGrant.checkToken();
     if (tokenOK) {
-        res.render('pages/examples/eg003', {
+        res.render('pages/examples/eg003ListEnvelopes', {
             csrfToken: req.csrfToken(), 
             title: "List envelopes",
             source: dsConfig.githubExampleUrl + path.basename(__filename),
@@ -44,7 +44,7 @@ eg003.getController = (req, res) => {
  * @param {object} req Request obj 
  * @param {object} res Response obj
  */
-eg003.createController = async (req, res) => {
+eg003ListEnvelopes.createController = async (req, res) => {
     // Step 1. Check the token
     // At this point we should have a good token. But we
     // double-check here to enable a better UX to the user.
@@ -72,7 +72,7 @@ eg003.createController = async (req, res) => {
       ;
 
     try {
-        results = await eg003.worker (args)
+        results = await eg003ListEnvelopes.worker (args)
     }
     catch (error) {
         let errorBody = error && error.response && error.response.body
@@ -102,7 +102,7 @@ eg003.createController = async (req, res) => {
  *   <tt>accountId</tt>: Current account Id <br/>
  */
 // ***DS.worker.start ***DS.snippet.1.start
-eg003.worker = async (args) => { 
+eg003ListEnvelopes.worker = async (args) => {
     let envelopesApi = new docusign.EnvelopesApi(args.dsAPIclient)
       , listStatusChangesP = args.makePromise(envelopesApi, 'listStatusChanges')
       , results = null

index.js

@@ -9,7 +9,7 @@ const path = require('path')
     , dsConfig = require('../../ds_configuration.js').config
     ;
 
-const eg004 = exports
+const eg004EnvelopeInfo = exports
     , eg = 'eg004' // This example reference.
     , mustAuthenticate = '/ds/mustAuthenticate'
     , minimumBufferMin = 3
@@ -18,13 +18,13 @@ const eg004 = exports
 /**
  * Form page for this application
  */
-eg004.getController = (req, res) => {
+eg004EnvelopeInfo.getController = (req, res) => {
     // Check that the authentication token is ok with a long buffer time.
     // If needed, now is the best time to ask the user to authenticate
     // since they have not yet entered any information into the form.
     let tokenOK = req.dsAuthCodeGrant.checkToken();
     if (tokenOK) {
-        res.render('pages/examples/eg004', {
+        res.render('pages/examples/eg004EnvelopeInfo', {
             csrfToken: req.csrfToken(), 
             title: "Get envelope information",
             envelopeOk: req.session.envelopeId,
@@ -44,7 +44,7 @@ eg004.getController = (req, res) => {
  * @param {object} req Request obj 
  * @param {object} res Response obj
  */
-eg004.createController = async (req, res) => {
+eg004EnvelopeInfo.createController = async (req, res) => {
     // Step 1. Check the token
     // At this point we should have a good token. But we
     // double-check here to enable a better UX to the user.
@@ -60,7 +60,7 @@ eg004.createController = async (req, res) => {
         res.redirect(mustAuthenticate);
     }
     if (! req.session.envelopeId) {
-        res.render('pages/examples/eg004', {
+        res.render('pages/examples/eg004EnvelopeInfo', {
             csrfToken: req.csrfToken(), 
             title: "Get envelope information",
             envelopeOk: req.session.envelopeId,
@@ -83,7 +83,7 @@ eg004.createController = async (req, res) => {
       ;
 
     try {
-        results = await eg004.worker (args)
+        results = await eg004EnvelopeInfo.worker (args)
     }
     catch (error) {
         let errorBody = error && error.response && error.response.body
@@ -114,7 +114,7 @@ eg004.createController = async (req, res) => {
  *   <tt>envelopeId</tt>: envelope Id <br/>
  */
 // ***DS.worker.start ***DS.snippet.1.start
-eg004.worker = async (args) => { 
+eg004EnvelopeInfo.worker = async (args) => {
     let envelopesApi = new docusign.EnvelopesApi(args.dsAPIclient)
       , getEnvelopeP = args.makePromise(envelopesApi, 'getEnvelope')
       , results = null