re-numbering examples

paigesrossi · paigesrossi · commit 4641390fc43a · 2021-08-20T15:16:37.000-07:00
diff --git a/app/__init__.py b/app/__init__.py
@@ -65,8 +65,8 @@
 
 elif EXAMPLES_API_TYPE["Admin"]:
     app.register_blueprint(admin_examples.eg001)
-    app.register_blueprint(admin_examples.eg002)
     app.register_blueprint(admin_examples.eg003)
+    app.register_blueprint(admin_examples.eg004)
     
 else:
     app.register_blueprint(examples.eg001)
diff --git a/app/admin/examples/__init__.py b/app/admin/examples/__init__.py
@@ -1,3 +1,3 @@
 from .eg001_create_a_new_user import eg001
-from .eg002_bulk_export_user_data import eg002
-from .eg003_add_users_via_bulk_import import eg003
+from .eg003_bulk_export_user_data import eg003
+from .eg004_add_users_via_bulk_import import eg004
diff --git a/app/admin/examples/eg002_bulk_export_user_data/__init__.py b/app/admin/examples/eg002_bulk_export_user_data/__init__.py
diff --git a/app/admin/examples/eg003_bulk_export_user_data/__init__.py b/app/admin/examples/eg003_bulk_export_user_data/__init__.py
diff --git a/app/admin/examples/eg003_bulk_export_user_data/controller.py b/app/admin/examples/eg003_bulk_export_user_data/controller.py
@@ -6,7 +6,7 @@
 from app.ds_config import DS_CONFIG
 
 
-class Eg002Controller:
+class Eg003Controller:
 
     @staticmethod
     def _get_export_api():
diff --git a/app/admin/examples/eg003_bulk_export_user_data/views.py b/app/admin/examples/eg003_bulk_export_user_data/views.py
@@ -9,13 +9,13 @@
 from app.error_handlers import process_error
 from app.docusign import authenticate
 from app.ds_config import DS_CONFIG
-from .controller import Eg002Controller
+from .controller import Eg003Controller
 
 
-eg = "eg002"  # Reference (and URL) for this example
-eg002 = Blueprint(eg, __name__)
+eg = "eg003"  # Reference (and URL) for this example
+eg003 = Blueprint(eg, __name__)
 
-@eg002.route("/eg002", methods=["POST"])
+@eg003.route("/eg003", methods=["POST"])
 @authenticate(eg=eg)
 def get_user_list_data():
     """
@@ -25,7 +25,7 @@ def get_user_list_data():
 
     # 1. Call the worker method
     try:
-        results = Eg002Controller.worker()
+        results = Eg003Controller.worker()
         current_app.logger.info(f"User list export ID: {results.id}")
     except ApiException as err:
         return process_error(err)
@@ -40,7 +40,7 @@ def get_user_list_data():
         json=json.dumps(json.dumps(results.to_dict(), default=str))
     )
 
-@eg002.route("/eg002", methods=["GET"])
+@eg003.route("/eg003", methods=["GET"])
 @authenticate(eg=eg)
 def get_view():
     """
@@ -49,7 +49,7 @@ def get_view():
 
     # Render the response
     return render_template(
-        "eg002_bulk_export_user_data.html",
+        "eg003_bulk_export_user_data.html",
         title="Bulk export user data",
         source_file=path.basename(path.dirname(__file__)) + "/controller.py",
         source_url=(
@@ -59,7 +59,7 @@ def get_view():
         documentation=DS_CONFIG["documentation"] + eg,
     )
 
-@eg002.route("/eg002check", methods=["GET"])
+@eg003.route("/eg003check", methods=["GET"])
 @authenticate(eg=eg)
 def check_if_csv_ready():
     """
@@ -69,17 +69,17 @@ def check_if_csv_ready():
 
     # 1. Checking if a CSV file exists
     try:
-        csv_file = Eg002Controller.get_csv_user_list()
+        csv_file = Eg003Controller.get_csv_user_list()
     except ApiException as err:
         return process_error(err)
 
     # 2. Render the response
     return render_template(
-        "eg002_file_state.html",
+        "eg003_file_state.html",
         get_csv=bool(csv_file)
     )
 
-@eg002.route("/eg002csv", methods=["GET"])
+@eg003.route("/eg003csv", methods=["GET"])
 @authenticate(eg=eg)
 def get_csv():
     """
@@ -89,7 +89,7 @@ def get_csv():
 
     # 1. Getting an existing CSV file
     try:
-        csv_file = Eg002Controller.get_csv_user_list()
+        csv_file = Eg003Controller.get_csv_user_list()
     except ApiException as err:
         return process_error(err)
 
diff --git a/app/admin/examples/eg004_add_users_via_bulk_import/__init__.py b/app/admin/examples/eg004_add_users_via_bulk_import/__init__.py
@@ -0,0 +1 @@
+from .views import eg004
diff --git a/app/admin/examples/eg004_add_users_via_bulk_import/controller.py b/app/admin/examples/eg004_add_users_via_bulk_import/controller.py
@@ -6,7 +6,7 @@
 from app.ds_config import DS_CONFIG
 
 
-class Eg003Controller:
+class Eg004Controller:
 
     @staticmethod
     def worker(request):
diff --git a/app/admin/examples/eg004_add_users_via_bulk_import/csv/uploaded_file.csv b/app/admin/examples/eg004_add_users_via_bulk_import/csv/uploaded_file.csv
diff --git a/app/admin/examples/eg004_add_users_via_bulk_import/views.py b/app/admin/examples/eg004_add_users_via_bulk_import/views.py
@@ -1,4 +1,4 @@
-"""Example 003: Add users via bulk import"""
+"""Example 004: Add users via bulk import"""
 
 import json
 from os import path
@@ -9,14 +9,14 @@
 from app.error_handlers import process_error
 from app.docusign import authenticate
 from app.ds_config import DS_CONFIG
-from .controller import Eg003Controller
+from .controller import Eg004Controller
 
 
-eg = "eg003"  # Reference(and URL) for this example
-eg003 = Blueprint(eg, __name__)
+eg = "eg004"  # Reference(and URL) for this example
+eg004 = Blueprint(eg, __name__)
 
 
-@eg003.route("/eg003", methods=["POST"])
+@eg004.route("/eg004", methods=["POST"])
 @authenticate(eg=eg)
 def add_users_via_bulk_import():
     """
@@ -26,7 +26,7 @@ def add_users_via_bulk_import():
 
     # 1. Call the worker method
     try:
-        results = Eg003Controller.worker(request)
+        results = Eg004Controller.worker(request)
         current_app.logger.info(f"Bulk import request ID: {results.id}")
     except ApiException as err:
         return process_error(err)
@@ -40,7 +40,7 @@ def add_users_via_bulk_import():
         json=json.dumps(json.dumps(results.to_dict(), default=str))
     )
 
-@eg003.route("/eg003", methods=["GET"])
+@eg004.route("/eg004", methods=["GET"])
 @authenticate(eg=eg)
 def get_view():
     """
@@ -49,7 +49,7 @@ def get_view():
 
     # Render the response
     return render_template(
-        "eg003_add_users_via_bulk_import.html",
+        "eg004_add_users_via_bulk_import.html",
         title="Add users via bulk import",
         source_file=path.basename(path.dirname(__file__)) + "/controller.py",
         source_url=(
@@ -59,7 +59,7 @@ def get_view():
         documentation=DS_CONFIG["documentation"] + eg,
     )
 
-@eg003.route("/eg003examplecsv", methods=["GET"])
+@eg004.route("/eg004examplecsv", methods=["GET"])
 @authenticate(eg=eg)
 def get_csv():
     """
@@ -68,7 +68,7 @@ def get_csv():
     """
 
     # 1. Creates an example of a CSV file
-    csv_file = Eg003Controller.get_example_csv()
+    csv_file = Eg004Controller.get_example_csv()
 
     # 2. Returns an example of a CSV file to the user
     return Response(
diff --git a/app/admin/templates/eg003_bulk_export_user_data.html b/app/admin/templates/eg003_bulk_export_user_data.html
@@ -1,6 +1,6 @@
 <!-- extend base layout --> {% extends "base.html" %}  {% block content %}
 
-<h4>2. Bulk-export user data</h4>
+<h4>3. Bulk-export user data</h4>
 <p>Demonstrates how to bulk-export user accounts within an organization into a CSV (comma separated value) file</p>
 
 {% if show_doc %}
diff --git a/app/admin/templates/eg003_file_state.html b/app/admin/templates/eg003_file_state.html
@@ -3,7 +3,7 @@
 {% if get_csv %}
     <h4>File is ready</h4>
     <p>You can download the file from the link below</p>
-    <p><a href="eg002csv">Get CSV file</a></p>
+    <p><a href="eg003csv">Get CSV file</a></p>
     <p><a href="/">Continue</a></p>
 {% else %}
     <h4>File is not ready</h4>
diff --git a/app/admin/templates/eg004_add_users_via_bulk_import.html b/app/admin/templates/eg004_add_users_via_bulk_import.html
@@ -1,6 +1,6 @@
 <!-- extend base layout --> {% extends "base.html" %}  {% block content %}
 
-<h4>3. Add users via bulk import</h4>
+<h4>4. Add users via bulk import</h4>
 <p>Demonstrates how to bulk-import users and add user data from an example CSV (comma-separated value) file into a DocuSign Admin organization</p>
 
 {% if show_doc %}
@@ -15,7 +15,7 @@ <h4>3. Add users via bulk import</h4>
 </p>
 <br>
 <p>
-    You can <a href="eg003examplecsv">download an example of the required csv file</a>
+    You can <a href="eg004examplecsv">download an example of the required csv file</a>
     and change it as you see fit
 </p>
 <form class="eg" action="" method="post" data-busy="form" enctype="multipart/form-data">
diff --git a/app/admin/templates/home_admin.html b/app/admin/templates/home_admin.html
@@ -34,15 +34,15 @@ <h4 id="example001">1. <a href="eg001">Create a new user</a></h4>
            </p>
 
         <h2>Bulk-export user data</h2>
-           <h4 id="example002">2. <a href="eg002">bulk-export user data</a></h4>
+           <h4 id="example003">3. <a href="eg003">bulk-export user data</a></h4>
            <p>Demonstrates how to bulk-export user accounts within an organization into a CSV (comma separated value) file.</p>
 
            <p>API method used: 
              <a target='_blank' href="https://developers.docusign.com/docs/admin-api/reference/bulkoperations/userexport/createuserlistexport/">UserExport:createUserListExport</a>.
           </p>
 
         <h2>Add users via bulk import</h2>
-          <h4 id="example003">3. <a href="eg003">Add users via bulk import</a></h4>
+          <h4 id="example004">4. <a href="eg004">Add users via bulk import</a></h4>
           <p>Demonstrates how to bulk-import users and add user data from an example CSV (comma-separated value) file into a DocuSign Admin organization</p>
 
           <p>API method used: 
diff --git a/app/admin/templates/must_authenticate.html b/app/admin/templates/must_authenticate.html
@@ -0,0 +1,24 @@
+<!-- extend base layout -->
+{% extends "base.html" %}
+
+{% block content %}
+    <div style="margin:1% 5%;">
+      <h1 class="display-4">Please authenticate with DocuSign</h1>
+
+    <form method="post" data-busy="form" action={{ url_for("ds.ds_login") }}>
+        <div class="form-group col-md-5">
+            <label for="auth_type">Please choose your OAuth2.0 grant type</label>
+            <select class="form-control" id="auth_type" name="auth_type">
+                <option value="code_grant">Authorization Code Grant</option>
+                <option value="jwt">JSON Web Token</option>
+            </select>
+            <p class="lead" style="padding-top: .5rem;">
+                <input type="hidden" name="csrf_token" value="{{ csrf_token() }}"/>
+                <button type="submit" class="btn btn-docu">Authenticate with DocuSign</button>
+            </p>
+        </div>
+    </form>
+      <hr class="my-4">
+      <p>You need to authenticate with DocuSign to continue your request.</p>
+    </div>
+{% endblock %}
diff --git a/app/docusign/ds_client.py b/app/docusign/ds_client.py
@@ -26,7 +26,8 @@
 ]
 
 ADMIN_SCOPES = [
-    "signature", "user_write", "user_read"
+    "signature", "organization_read", "group_read", "permission_read", "user_read", "user_write", 
+    "account_read", "domain_read", "identity_provider", "read impersonation" 
 ]
 
 
diff --git a/app/docusign/views.py b/app/docusign/views.py
@@ -81,7 +81,7 @@ def ds_must_authenticate():
         session["auth_type"] = "code_grant"
         return redirect(url_for("ds.ds_login"))
 
-    elif EXAMPLES_API_TYPE["Monitor"] or EXAMPLES_API_TYPE["Admin"]:
+    elif EXAMPLES_API_TYPE["Monitor"]:
         session["auth_type"] = "jwt"
         return redirect(url_for("ds.ds_login"))
 
