Merge pull request docusign#16 from docusign/private

Moved examples under eSignature, added private.key to .gitignore, add…

Author: Robert Knight

.gitignore

@@ -113,3 +113,6 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 .vscode/settings.json
+
+# Security key files
+private.key

README.md

@@ -6,108 +6,108 @@ This repo is a Python 3 application that demonstrates:
 
 
 1. **Embedded Signing Ceremony.**
-   [Source.](./app/examples/eg001_embedded_signing/controller.py)
+   [Source.](./app/eg001_embedded_signing/controller.py)
    This example sends an envelope, and then uses an embedded signing ceremony for the first signer.
    With embedded signing, the DocuSign signing ceremony is initiated from your website.
 1. **Send an envelope with a remote (email) signer and cc recipient.**
-   [Source.](./app/examples/eg002_signing_via_email/controller.py)
+   [Source.](./app/eSignature/examples/eg002_signing_via_email/controller.py)
    The envelope includes a pdf, Word, and HTML document.
    Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the documents.
 1. **List envelopes in the user's account.**
-   [Source.](./app/examples/eg003_list_envelopes/controller.py)
+   [Source.](./app/eSignature/examples/eg003_list_envelopes/controller.py)
    The envelopes' current status is included.
 1. **Get an envelope's basic information.**
-   [Source.](./app/examples/eg004_envelope_info/controller.py)
+   [Source.](./app/eSignature/examples/eg004_envelope_info/controller.py)
    The example lists the basic information about an envelope, including its overall status.
 1. **List an envelope's recipients**
-   [Source.](./app/examples/eg005_envelope_recipients/controller.py)
+   [Source.](./app/eSignature/examples/eg005_envelope_recipients/controller.py)
    Includes current recipient status.
 1. **List an envelope's documents.**
-   [Source.](./app/examples/eg006_envelope_docs/controller.py)
+   [Source.](./app/eSignature/examples/eg006_envelope_docs/controller.py)
 1. **Download an envelope's documents.**
-   [Source.](./app/examples/eg007_envelope_get_doc/controller.py)
+   [Source.](./app/eSignature/examples/eg007_envelope_get_doc/controller.py)
    The example can download individual
    documents, the documents concatenated together, or a zip file of the documents.
 1. **Programmatically create a template.**
-   [Source.](./app/examples/eg008_create_template/controller.py)
+   [Source.](./app/eSignature/examples/eg008_create_template/controller.py)
 1. **Send an envelope using a template.**
-   [Source.](./app/examples/eg009_use_template/controller.py)
+   [Source.](./app/eSignature/examples/eg009_use_template/controller.py)
 1. **Send an envelope and upload its documents with multipart binary transfer.**
-   [Source.](./app/examples/eg010_send_binary_docs/controller.py)
+   [Source.](./app/eSignature/examples/eg010_send_binary_docs/controller.py)
    Binary transfer is 33% more efficient than using Base64 encoding.
 1. **Embedded sending.**
-   [Source.](./app/examples/eg011_embedded_sending/controller.py)
+   [Source.](./app/eSignature/examples/eg011_embedded_sending/controller.py)
    Embeds the DocuSign web tool (NDSE) in your web app to finalize or update
    the envelope and documents before they are sent.
 1. **Embedded DocuSign web tool (NDSE).**
-   [Source.](./app/examples/eg012_embedded_console/controller.py)
+   [Source.](./app/eSignature/examples/eg012_embedded_console/controller.py)
 1. **Embedded Signing Ceremony from a template with an added document.**
-   [Source.](./app/examples/eg013_add_doc_to_template/controller.py)
+   [Source.](./app/eSignature/examples/eg013_add_doc_to_template/controller.py)
    This example sends an envelope based on a template.
    In addition to the template's document(s), the example adds an
    additional document to the envelope by using the
    [Composite Templates](https://developers.docusign.com/esign-rest-api/guides/features/templates#composite-templates)
    feature.
 1. **Payments example: an order form, with online payment by credit card.**
-   [Source.](./app/examples/eg014_collect_payment/controller.py)
+   [Source.](./app/eSignature/examples/eg014_collect_payment/controller.py)
 1. **Get the envelope tab data.**
    Retrieve the tab (field) values for all of the envelope's recipients.
-   [Source.](./app/examples/eg015_envelope_tab_data/controller.py)
+   [Source.](./app/eSignature/examples/eg015_envelope_tab_data/controller.py)
 1. **Set envelope tab values.**
    The example creates an envelope and sets the initial values for its tabs (fields). Some of the tabs
    are set to be read-only, others can be updated by the recipient. The example also stores
    metadata with the envelope.
-   [Source.](./app/examples/eg016_set_tab_values/controller.py)
+   [Source.](./app/eSignature/examples/eg016_set_tab_values/controller.py)
 1. **Set template tab values.**
    The example creates an envelope using a template and sets the initial values for its tabs (fields).
    The example also stores metadata with the envelope.
-   [Source.](./app/examples/eg017_set_template_tab_values/controller.py)
+   [Source.](./app/eSignature/examples/eg017_set_template_tab_values/controller.py)
 1. **Get the envelope custom field data (metadata).**
    The example retrieves the custom metadata (custom data fields) stored with the envelope.
-   [Source.](./app/examples/eg018_envelope_custom_field_data/controller.py)
+   [Source.](./app/eSignature/examples/eg018_envelope_custom_field_data/controller.py)
 1. **Requiring an Access Code for a Recipient**
-   [Source.](./app/examples/eg019_access_code_authentication/controller.py)
+   [Source.](./app/eSignature/examples/eg019_access_code_authentication/controller.py)
    This example sends an envelope that requires an access-code for the purpose of multi-factor authentication.   
 1. **Requiring SMS authentication for a recipient**
-   [Source.](./app/examples/eg020_sms_authentication/controller.py)
+   [Source.](./app/eSignature/examples/eg020_sms_authentication/controller.py)
    This example sends an envelope that requires entering in a six digit code from an text message for the purpose of multi-factor authentication.   
 1. **Requiring Phone authentication for a recipient**
-   [Source.](./app/examples/eg021_phone_authentication/controller.py)
+   [Source.](./app/eSignature/examples/eg021_phone_authentication/controller.py)
    This example sends an envelope that requires entering in a voice-based response code for the purpose of multi-factor authentication. 
 1. **Requiring Knowledge-Based Authentication (KBA) for a Recipient**
-   [Source.](./app/examples/eg022_kba_authentication/controller.py)
+   [Source.](./app/eSignature/examples/eg022_kba_authentication/controller.py)
    This example sends an envelope that requires passing a Public records check to validate identity for the purpose of multi-factor authentication.    
 1. **Requiring ID Verification (IDV) for a recipient**
-   [Source.](./app/examples/eg023_idv_authentication/controller.py)
+   [Source.](./app/eSignature/examples/eg023_idv_authentication/controller.py)
    This example sends an envelope that requires submitting a photo of a government issued id for the purpose of multi-factor authentication.
 1. **Creating a permission profile**
-   [Source.](./app/examples/eg024_permissions_creating/controller.py)
+   [Source.](./app/eSignature/examples/eg024_permissions_creating/controller.py)
    This code example demonstrates how to create a permission profile using the [Create Permission Profile](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountPermissionProfiles/create) method.
 1. **Setting a permission profile**
-   [Source.](./app/examples/eg025_permissions_set_user_group/controller.py)
+   [Source.](./app/eSignature/examples/eg025_permissions_set_user_group/controller.py)
    This code example demonstrates how to set a user group’s permission profile using the [Update Group](https://developers.docusign.com/esign-rest-api/reference/UserGroups/Groups/update) method. 
    You must have already created the permissions profile and the group of users.
 1. **Updating individual permission settings**
-   [Source.](./app/examples/eg026_permissions_change_single_setting/controller.py)
+   [Source.](./app/eSignature/examples/eg026_permissions_change_single_setting/controller.py)
    This code example demonstrates how to edit individual permission settings on a permissions profile using the [Update Permission Profile](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountPermissionProfiles/update) method.
 1. **Deleting a permission profile**
-   [Source.](./app/examples/eg027_permissions_delete/controller.py)
+   [Source.](./app/eSignature/examples/eg027_permissions_delete/controller.py)
    This code example demonstrates how to delete a permission profile using the [Delete Permission Profile](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountPermissionProfiles/create) method.
 1. **Creating a brand**
-   [Source.](./app/examples/eg028_brand_creating/controller.py)
+   [Source.](./app/eSignature/examples/eg028_brand_creating/controller.py)
    This example creates brand profile for an account using the [Create Brand](https://developers.docusign.com/esign-rest-api/reference/Accounts/AccountBrands/create) method.
 1. **Applying a brand to an envelope**
-   [Source.](./app/examples/eg029_brands_apply_to_envelope/controller.py)
+   [Source.](./app/eSignature/examples/eg029_brands_apply_to_envelope/controller.py)
    This code example demonstrates how to apply a brand you've created to an envelope using the [Create Envelope](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create) method. 
    First, creates the envelope and then applies the brand to it.
    Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the documents.
 1. **Applying a brand to a template**
-   [Source.](./app/examples/eg030_brands_apply_to_template/controller.py)
+   [Source.](./app/eSignature/examples/eg030_brands_apply_to_template/controller.py)
    This code example demonstrates how to apply a brand you've created to a template using using the [Create Envelope](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create) method. 
    You must have already created the template and the brand.
    Anchor text ([AutoPlace](https://support.docusign.com/en/guides/AutoPlace-New-DocuSign-Experience)) is used to position the signing fields in the documents.
 1. **Bulk sending envelopes to multiple recipients**
-   [Source.](./app/examples/eg031_bulk_send/controller.py)
+   [Source.](./app/eSignature/examples/eg031_bulk_send/controller.py)
    This code example demonstrates how to send envelopes in bulk to multiple recipients using these methods:
    [Create Bulk Send List](https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendList), 
    [Create Bulk Send Request](https://developers.docusign.com/esign-rest-api/reference/BulkEnvelopes/BulkSend/createBulkSendRequest).

app/__init__.py

@@ -3,7 +3,8 @@
 from flask import Flask
 from flask_wtf.csrf import CSRFProtect
 
-from . import examples
+from .ds_config import DS_CONFIG
+from .eSignature import examples
 from .docusign.views import ds
 from .views import core
 
@@ -14,6 +15,12 @@
 # See https://flask-wtf.readthedocs.io/en/stable/csrf.html
 csrf = CSRFProtect(app)
 
+# Set whether this is a quickstart in config
+app.config["quickstart"] = DS_CONFIG["quickstart"]
+
+# Set whether user has logged in
+app.config["isLoggedIn"] = False
+
 # Register home page
 app.register_blueprint(core)
 # Register OAuth

app/docusign/views.py

@@ -1,6 +1,6 @@
 from datetime import datetime, timedelta
 
-from flask import redirect, request, url_for, flash, render_template, Blueprint, session
+from flask import redirect, request, url_for, flash, render_template, Blueprint, session, current_app as app
 
 from .ds_client import DSClient
 from .utils import ds_logout_internal
@@ -14,13 +14,17 @@
 def ds_login():
     if not session.get("auth_type"):
         session["auth_type"] = request.form.get("auth_type")
+    app.config["isLoggedIn"] = True
+    app.config["quickstart"] = DS_CONFIG["quickstart"]
     return DSClient.login(session["auth_type"])
 
 
 @ds.route("/logout")
 def ds_logout():
     ds_logout_internal()
     flash("You have logged out from DocuSign.")
+    app.config["isLoggedIn"] = False
+    app.config["quickstart"] = False
     return redirect(url_for("core.index"))
 
 
@@ -52,12 +56,12 @@ def ds_callback():
         if target_account_id:
             account = next((a for a in accounts if a["account_id"] == target_account_id), None)
             if not account:
-                # Panic! The user does not have the targeted account. They should not log in!
+                # The user does not have the targeted account. They should not log in!
                 raise Exception("No access to target account")
         else:  # get the default account
             account = next((a for a in accounts if a["is_default"]), None)
             if not account:
-                # Panic! Every user should always have a default account
+                # Every user should always have a default account
                 raise Exception("No default account")
 
         # Save the account information

app/ds_config_sample.py

@@ -24,7 +24,8 @@
     "gateway_name": "stripe",
     "gateway_display_name": "Stripe",
     "github_example_url": "https://github.com/docusign/code-examples-python/tree/master/app/",
-    "documentation": ""  # Use an empty string to indicate no documentation path.
+    "documentation": "",  # Use an empty string to indicate no documentation path.
+    "quickstart": "{QUICKSTART_VALUE}"
 }
 
 DS_JWT = {

app/examples/__init__.py renamed to app/eSignature/examples/__init__.py

@@ -1,4 +1,4 @@
-from .eg001_embedded_signing import eg001
+from ...eg001_embedded_signing import eg001
 from .eg002_signing_via_email import eg002
 from .eg003_list_envelopes import eg003
 from .eg004_envelope_info import eg004

app/examples/eg002_signing_via_email/__init__.py renamed to app/eSignature/examples/eg002_signing_via_email/__init__.py

@@ -4,9 +4,9 @@
 from docusign_esign import EnvelopesApi, EnvelopeDefinition, Document, Signer, CarbonCopy, SignHere, Tabs, Recipients
 from flask import session, request
 
-from ...consts import demo_docs_path, pattern
-from ...docusign import create_api_client
-from ...ds_config import DS_CONFIG
+from ....consts import demo_docs_path, pattern
+from ....docusign import create_api_client
+from ....ds_config import DS_CONFIG
 
 
 class Eg002Controller:

app/examples/eg002_signing_via_email/controller.py renamed to app/eSignature/examples/eg002_signing_via_email/controller.py

@@ -6,9 +6,9 @@
 from flask import render_template, session, Blueprint
 
 from .controller import Eg002Controller
-from ...docusign import authenticate
-from ...ds_config import DS_CONFIG
-from ...error_handlers import process_error
+from ....docusign import authenticate
+from ....ds_config import DS_CONFIG
+from ....error_handlers import process_error
 
 eg = "eg002"  # reference (and url) for this example
 eg002 = Blueprint("eg002", __name__)