eg 7 works

LarryKlugerDS · LarryKlugerDS · commit 4b6d75ab79cb · 2018-11-11T11:36:41.000+02:00
diff --git a/app/eg007_envelope_get_doc.py b/app/eg007_envelope_get_doc.py
@@ -1,177 +1,159 @@
-/**
- * @file
- * Example 007: Get a document from an envelope
- * @author DocuSign
- */
-
-const path = require('path')
-    , docusign = require('docusign-esign')
-    , dsConfig = require('../../ds_configuration.js').config
-    , validator = require('validator')
-    , stream = require('stream')
-    , {promisify} = require('util') // http://2ality.com/2017/05/util-promisify.html
-    ;
-
-const eg007EnvelopeGetDoc = exports
-    , eg = 'eg007' // This example reference.
-    , mustAuthenticate = '/ds/mustAuthenticate'
-    , minimumBufferMin = 3
-    ;
-
-/**
- * Form page for this application
- */
-eg007EnvelopeGetDoc.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) {
-        let envelopeDocuments = req.session.envelopeDocuments,
-            documentOptions;
-        if (envelopeDocuments) {
-            // Prepare the select items
-            documentOptions = envelopeDocuments.documents.map ( item => 
-                ({text: item.name, documentId: item.documentId}));
-        }
-        res.render('pages/examples/eg007EnvelopeGetDoc', {
-            csrfToken: req.csrfToken(), 
-            title: "Download a document",
-            envelopeOk: req.session.envelopeId,
-            documentsOk: envelopeDocuments,
-            documentOptions: documentOptions,
-            sourceFile: path.basename(__filename),
-            sourceUrl: dsConfig.githubExampleUrl + path.basename(__filename),
-            documentation: dsConfig.documentation + eg,
-            showDoc: dsConfig.documentation
-        });
-    } else {
-        // Save the current operation so it will be resumed after authentication
-        req.dsAuthCodeGrant.setEg(req, eg);
-        res.redirect(mustAuthenticate);
-    }
-}  
-
-/**
- * Get the envelope
- * @param {object} req Request obj 
- * @param {object} res Response obj
- */
-eg007EnvelopeGetDoc.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.
-    let tokenOK = req.dsAuthCodeGrant.checkToken(minimumBufferMin);
-    if (! tokenOK) {
-        req.flash('info', 'Sorry, you need to re-authenticate.');
-        // We could store the parameters of the requested operation 
-        // so it could be restarted automatically.
-        // But since it should be rare to have a token issue here,
-        // we'll make the user re-enter the form data after 
-        // authentication.
-        req.dsAuthCodeGrant.setEg(req, eg);
-        res.redirect(mustAuthenticate);
-    }
-    let envelopeDocuments = req.session.envelopeDocuments;
-    if (! req.session.envelopeId || ! envelopeDocuments ) {
-        res.render('pages/examples/eg007EnvelopeGetDoc', {
-            csrfToken: req.csrfToken(), 
-            title: "Download a document",
-            envelopeOk: req.session.envelopeId,
-            documentsOk: envelopeDocuments,
-            sourceFile: path.basename(__filename),
-            sourceUrl: dsConfig.githubExampleUrl + path.basename(__filename),
-            documentation: dsConfig.documentation + eg,
-            showDoc: dsConfig.documentation
-        });
-    }
-
-    // Step 2. Call the worker method
-    let accountId = req.dsAuthCodeGrant.getAccountId()
-      , dsAPIclient = req.dsAuthCodeGrant.getDSApi()
-        // Additional data validation might also be appropriate
-      , documentId = validator.escape(req.body.docSelect)
-      , args = {
-          dsAPIclient: dsAPIclient,
-          accountId: accountId,
-          documentId: documentId,
-          envelopeDocuments: envelopeDocuments
+"""007: Get an envelope's document"""
+
+from flask import render_template, url_for, redirect, session, flash, request, send_file
+from os import path
+import json
+import re
+import io
+from app import app, ds_config, views
+from docusign_esign import *
+from docusign_esign.rest import ApiException
+
+eg = "eg007"  # reference (and url) for this example
+
+def controller():
+    """Controller router using the HTTP method"""
+    if request.method == 'GET':
+        return get_controller()
+    elif request.method == 'POST':
+        return create_controller()
+    else:
+        return render_template('404.html'), 404
+
+
+def create_controller():
+    """
+    1. Check the token
+    2. Call the worker method
+    3. Show results
+    """
+    minimum_buffer_min = 3
+    token_ok = views.ds_token_ok(minimum_buffer_min)
+    if token_ok and 'envelope_id' in session and 'envelope_documents' in session:
+        # 2. Call the worker method
+        # More data validation would be a good idea here
+        # Strip anything other than characters listed
+        pattern = re.compile('([^\w \-\@\.\,])+')
+        document_id = pattern.sub('', request.form.get('document_id'))
+
+        args = {
+            'account_id': session['ds_account_id'],
+            'envelope_id': session['envelope_id'],
+            'base_path': session['ds_base_path'],
+            'ds_access_token': session['ds_access_token'],
+            'document_id': document_id,
+            'envelope_documents': session['envelope_documents']
         }
-      , results = null
-      ;
-
-    try {
-        results = await eg007EnvelopeGetDoc.worker (args)
-    }
-    catch (error) {
-        let errorBody = error && error.response && error.response.body
-            // we can pull the DocuSign error code and message from the response body
-        , errorCode = errorBody && errorBody.errorCode
-        , errorMessage = errorBody && errorBody.message
-        ;
-        // In production, may want to provide customized error messages and 
-        // remediation advice to the user.
-        res.render('pages/error', {err: error, errorCode: errorCode, errorMessage: errorMessage});
-    }
-    if (results) {
-        // ***DS.snippet.2.start
-        res.writeHead(200, {
-            'Content-Type': results.mimetype,
-            'Content-disposition': 'inline;filename=' + results.docName,
-            'Content-Length': results.fileBytes.length
-        });
-        res.end(results.fileBytes, 'binary');
-        // ***DS.snippet.2.end
-    }
-}
-
-/**
- * This function does the work of listing the envelope's recipients
- * @param {object} args An object with the following elements: <br/>
- *   <tt>dsAPIclient</tt>: The DocuSign API Client object, already set with an access token and base url <br/>
- *   <tt>accountId</tt>: Current account Id <br/>
- *   <tt>documentId</tt>: the document to be fetched <br/>
- *   <tt>envelopeDocuments</tt>: object with data about the envelope's documents
- */
-// ***DS.worker.start ***DS.snippet.1.start
-eg007EnvelopeGetDoc.worker = async (args) => {
-    let envelopesApi = new docusign.EnvelopesApi(args.dsAPIclient)
-      , getEnvelopeDocumentP = promisify(envelopesApi.getDocument).bind(envelopesApi)
-      , results = null
-      ;
-
-    // Step 1. EnvelopeDocuments::get.
-    // Exceptions will be caught by the calling function
-    results = await getEnvelopeDocumentP(
-        args.accountId, args.envelopeDocuments.envelopeId, args.documentId, null);
-
-    let docItem = args.envelopeDocuments.documents.find(item => item.documentId === args.documentId)
-      , docName = docItem.name
-      , hasPDFsuffix = docName.substr(docName.length - 4).toUpperCase() === '.PDF'
-      , pdfFile = hasPDFsuffix
-      ;
-    // Add .pdf if it's a content or summary doc and doesn't already end in .pdf
-    if ((docItem.type === "content" || docItem.type === "summary") && !hasPDFsuffix){
-        docName += ".pdf";
-        pdfFile = true;
-    }
-    // Add .zip as appropriate
-    if (docItem.type === "zip") {
-        docName += ".zip"
-    }
-
-    // Return the file information
-    // See https://stackoverflow.com/a/30625085/64904
-    let mimetype;
-    if (pdfFile) { 
+
+        try:
+            results = worker(args)
+        except ApiException as err:
+            error_body_json = err and hasattr(err, 'body') and err.body
+            # we can pull the DocuSign error code and message from the response body
+            error_body = json.loads(error_body_json)
+            error_code = error_body and 'errorCode' in error_body and error_body['errorCode']
+            error_message = error_body and 'message' in error_body and error_body['message']
+            # In production, may want to provide customized error messages and
+            # remediation advice to the user.
+            return render_template('error.html',
+                                   err=err,
+                                   error_code=error_code,
+                                   error_message=error_message
+                                   )
+
+        return send_file(
+            results["data"],
+            mimetype=results["mimetype"],
+            as_attachment=True,
+            attachment_filename=results["doc_name"]
+        )
+
+    elif not token_ok:
+        flash('Sorry, you need to re-authenticate.')
+        # We could store the parameters of the requested operation
+        # so it could be restarted automatically.
+        # But since it should be rare to have a token issue here,
+        # we'll make the user re-enter the form data after
+        # authentication.
+        session['eg'] = url_for(eg)
+        return redirect(url_for('ds_must_authenticate'))
+    elif not 'envelope_id' in session or not 'envelope_documents' in session:
+        return render_template("eg007_envelope_get_doc.html",
+                               title="Download an Envelope's Document",
+                               envelope_ok=False,
+                               documents_ok=False,
+                               source_file=path.basename(__file__),
+                               source_url=ds_config.DS_CONFIG['github_example_url'] + path.basename(__file__),
+                               documentation=ds_config.DS_CONFIG['documentation'] + eg,
+                               show_doc=ds_config.DS_CONFIG['documentation'],
+                               )
+
+
+def worker(args):
+    """
+    1. Call the envelope get method
+    """
+
+    # Exceptions will be caught by the calling function
+    api_client = ApiClient()
+    api_client.host = args['base_path']
+    api_client.set_default_header("Authorization", "Bearer " + args['ds_access_token'])
+    envelope_api = EnvelopesApi(api_client)
+    document_id = args['document_id']
+
+    # The SDK always stores the received file as a temp file
+    temp_file = envelope_api.get_document(args['account_id'], document_id, args['envelope_id'])
+    doc_item = next(item for item in args['envelope_documents']['documents'] if item['document_id'] == document_id)
+    doc_name = doc_item['name']
+    has_pdf_suffix = doc_name[-4:].upper() == '.PDF'
+    pdf_file = has_pdf_suffix
+    # Add .pdf if it's a content or summary doc and doesn't already end in .pdf
+    if (doc_item["type"] == "content" or doc_item["type"] == "summary") and not has_pdf_suffix:
+        doc_name += ".pdf"
+        pdf_file = True
+    # Add .zip as appropriate
+    if doc_item["type"] == "zip":
+        doc_name += ".zip"
+
+    # Return the file information
+    if pdf_file:
         mimetype = 'application/pdf'
-    } else if (docItem.type === 'zip') {
+    elif doc_item["type"] == 'zip':
         mimetype = 'application/zip'
-    } else {
+    else:
         mimetype = 'application/octet-stream'
-    }
 
-    return ({mimetype: mimetype, docName: docName, fileBytes: results});
-}
-// ***DS.worker.end ***DS.snippet.1.end
+    return {'mimetype': mimetype, 'doc_name': doc_name, 'data': temp_file}
+
+
+# ***DS.worker.end ***DS.snippet.1.end
+
+
+def get_controller():
+    """responds with the form for the example"""
+
+    if views.ds_token_ok():
+        documents_ok = 'envelope_documents' in session
+        document_options = []
+        if documents_ok:
+            # Prepare the select items
+            envelope_documents = session["envelope_documents"]
+            document_options = map( lambda item :
+                {'text': item['name'], 'document_id': item['document_id']}
+                , envelope_documents['documents'])
+
+        return render_template("eg007_envelope_get_doc.html",
+                               title="Download an Envelope's Document",
+                               envelope_ok='envelope_id' in session,
+                               documents_ok=documents_ok,
+                               source_file=path.basename(__file__),
+                               source_url=ds_config.DS_CONFIG['github_example_url'] + path.basename(__file__),
+                               documentation=ds_config.DS_CONFIG['documentation'] + eg,
+                               show_doc=ds_config.DS_CONFIG['documentation'],
+                               document_options=document_options
+        )
+    else:
+        # Save the current operation so it will be resumed after authentication
+        session['eg'] = url_for(eg)
+        return redirect(url_for('ds_must_authenticate'))
 
diff --git a/app/templates/eg007_envelope_get_doc.html b/app/templates/eg007_envelope_get_doc.html
@@ -24,15 +24,15 @@ <h4>7. Download a document from an envelope</h4>
     View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
 </p>
 
-<% if (! envelope_ok) { %>
+{% if not envelope_ok %}
   <p>Problem: please first create an envelope using <a href="eg002">example 2.</a> <br/>
     You will then need to use example 6 to create the list of documents.<br/>
     Thank you.</p>
     
  <form class="eg" action="eg002" method="get">
      <button type="submit" class="btn btn-primary">Continue</button>
  </form>
-<% } else if (!documentsOk) { %>
+{%  elif not documents_ok %}
   <p>Problem: please first create a list of the envelope's documents using 
     <a href="eg006">example 6.</a> <br/>
     Thank you.</p>
@@ -47,11 +47,11 @@ <h4>7. Download a document from an envelope</h4>
   <form class="eg" action="" method="post" data-busy="form-download">
     <div class="form-group">
         <label for="docSelect">Document selection</label>
-        <select class="custom-select" id="docSelect" 
-          name="docSelect" aria-describedby="emailHelp">
-        <% for (let opt of documentOptions) { %>
-          <option value="<%= opt.documentId %>"><%= opt.text %></option>
-        {% endif %}
+        <select class="custom-select" id="document_id"
+          name="document_id" aria-describedby="emailHelp">
+        {% for opt in document_options %}
+          <option value="{{ opt.document_id | safe }}">{{ opt.text }}</option>
+        {% endfor %}
         </select>
     </div>  
     <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
diff --git a/app/views.py b/app/views.py
@@ -7,7 +7,7 @@
 import uuid
 from app import app, ds_config, eg001_embedded_signing, eg002_signing_via_email,  \
             eg003_list_envelopes, eg004_envelope_info, eg005_envelope_recipients, \
-            eg006_envelope_docs
+            eg006_envelope_docs, eg007_envelope_get_doc
 
 
 @app.route('/')
@@ -55,6 +55,11 @@ def eg006():
     return eg006_envelope_docs.controller()
 
 
+@app.route('/eg007', methods=['GET', 'POST'])
+def eg007():
+    return eg007_envelope_get_doc.controller()
+
+
 @app.route('/ds_return')
 def ds_return():
     event = request.args.get('event')
