Merge pull request #136 from docusign/feature/validate-webhook-message-code-example

Add webhook validation code example

Author: meihDS

app/__init__.py

@@ -11,6 +11,7 @@
 from .click import views as click_views
 from .monitor import views as monitor_views
 from .admin import views as admin_views
+from .connect import views as connect_views
 from .views import core
 
 session_path = "/tmp/python_recipe_sessions"
@@ -110,6 +111,8 @@
 app.register_blueprint(esignature_views.eg043)
 app.register_blueprint(esignature_views.eg044)
 
+app.register_blueprint(connect_views.cneg001)
+
 if "DYNO" in os.environ:  # On Heroku?
     import logging
 

app/connect/__init__.py

@@ -0,0 +1 @@
+from .views import cneg001

app/connect/examples/eg001_validate_webhook_message.py

@@ -0,0 +1,29 @@
+from flask import request
+import hmac
+import hashlib
+import base64
+
+class Eg001ValidateWebhookMessageController:
+    @staticmethod
+    def get_args():
+        """Get required session and request arguments"""
+        return {
+            "secret": request.form.get("secret"),
+            "payload": request.form.get("payload"),
+        }
+
+    @staticmethod
+    def worker(args):
+        """
+        1. Create an API client with headers
+        2. Get your monitor data via SDK
+        """        
+        #ds-snippet-start:Connect1Step2
+        key = bytes(args['secret'], 'utf-8')
+        payload = bytes(args['payload'], 'utf-8')
+
+        hmac_hash = hmac.new(key, payload, hashlib.sha256)
+        result = base64.b64encode(hmac_hash.digest()).decode('utf-8')
+        #ds-snippet-end:Connect1Step2
+
+        return result

app/connect/views/__init__.py

@@ -0,0 +1 @@
+from .eg001_validate_webhook_message import cneg001

app/connect/views/eg001_validate_webhook_message.py

@@ -0,0 +1,55 @@
+"""Example 001: Validate webhook message using HMAC. """
+
+from docusign_monitor.client.api_exception import ApiException
+from flask import Blueprint, render_template, session
+
+from app.docusign import authenticate, ensure_manifest, get_example_by_number
+from app.error_handlers import process_error
+from ..examples.eg001_validate_webhook_message import Eg001ValidateWebhookMessageController
+from ...ds_config import DS_CONFIG
+from ...consts import API_TYPE
+
+example_number = 1
+api = API_TYPE["CONNECT"]
+eg = f"cneg00{example_number}"  # Reference (and URL) for this example
+cneg001 = Blueprint(eg, __name__)
+
+@cneg001.route(f"/{eg}", methods=["POST"])
+@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"])
+def get_monitoring_data():
+    """
+    1. Get required arguments
+    2. Call the worker method
+    3. Render the response
+    """
+    example = get_example_by_number(session["manifest"], example_number, api)
+    
+    # 1. Get required arguments
+    args = Eg001ValidateWebhookMessageController.get_args()
+    try:
+        # 2. Call the worker method to compute hash
+        results = Eg001ValidateWebhookMessageController.worker(args)
+    except ApiException as err:
+        return process_error(err)
+
+    return render_template(
+        "example_done.html",
+        title=example["ExampleName"],
+        message=example["ResultsPageText"].format(results)
+    )
+
+@cneg001.route(f"/{eg}", methods=["GET"])
+@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"])
+def get_view():
+    """ Responds with the form for the example"""
+    example = get_example_by_number(session["manifest"], example_number, api)
+
+    return render_template(
+        "connect/eg001_validate_webhook_message.html",
+        title=example["ExampleName"],
+        example=example,
+        source_file= "eg001_validate_webhook_message.py",
+        source_url=DS_CONFIG["monitor_github_url"] + "eg001_validate_webhook_message.py",
+        documentation=DS_CONFIG["documentation"] + eg,
+    )
+

app/consts.py

@@ -108,5 +108,6 @@
     "MONITOR": "Monitor",
     "CLICK": "Click",
     "ROOMS": "Rooms",
-    "ADMIN": "Admin"
+    "ADMIN": "Admin",
+    "CONNECT": "Connect"
 }