Added source code links to all rooms API examples

connorl-docusign · connorl-docusign · commit 9fb08cf2b664 · 2021-12-08T14:06:50.000-08:00
diff --git a/app/rooms/examples/eg001_create_room_with_data/views.py b/app/rooms/examples/eg001_create_room_with_data/views.py
@@ -53,5 +53,6 @@ def get_view():
     return render_template(
         "eg001_create_room_with_data.html",
         title="Creating a room with data",
-        source_file=path.basename(path.dirname(__file__)) + "/controller.py",
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
     )
diff --git a/app/rooms/examples/eg002_create_room_with_template/views.py b/app/rooms/examples/eg002_create_room_with_template/views.py
@@ -66,6 +66,7 @@ def get_view():
     return render_template(
         "eg002_create_room_with_template.html",
         title="Creating a room with a template",
-        source_file=path.basename(path.dirname(__file__)) + "/controller.py",
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
         templates=templates
     )
diff --git a/app/rooms/examples/eg003_export_data_from_room/views.py b/app/rooms/examples/eg003_export_data_from_room/views.py
@@ -62,6 +62,7 @@ def get_view():
     return render_template(
         "eg003_export_data_from_room.html",
         title="Exporting data from a room",
-        source_file=path.basename(path.dirname(__file__)) + "/controller.py",
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
         rooms=rooms,
     )
diff --git a/app/rooms/examples/eg004_add_forms_to_room/views.py b/app/rooms/examples/eg004_add_forms_to_room/views.py
@@ -65,7 +65,8 @@ def get_view():
     return render_template(
         "eg004_add_forms_to_room.html",
         title="Adding forms to a room",
-        source_file=path.basename(path.dirname(__file__)) + "/controller.py",
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
         rooms=rooms,
         forms=forms
     )
diff --git a/app/rooms/examples/eg005_get_rooms_with_filters/views.py b/app/rooms/examples/eg005_get_rooms_with_filters/views.py
@@ -69,7 +69,8 @@ def get_view():
     return render_template(
         "eg005_get_rooms_with_filters.html",
         title="Getting rooms with filters",
-        source_file=path.basename(path.dirname(__file__)) + "/controller.py",
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
         rooms=rooms,
         start=start_date.strftime("%Y-%m-%d"),
         end=end_date.strftime("%Y-%m-%d")
diff --git a/app/rooms/examples/eg006_create_external_form_fill_session/views.py b/app/rooms/examples/eg006_create_external_form_fill_session/views.py
@@ -64,7 +64,8 @@ def get_view():
     return render_template(
         "eg006_create_external_form_fill_session.html",
         title="Create an external form fill session",
-        source_file=path.basename(path.dirname(__file__)) + "/controller.py",
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
         rooms=rooms,
     )
 
diff --git a/app/rooms/examples/eg007_create_form_group/views.py b/app/rooms/examples/eg007_create_form_group/views.py
@@ -53,5 +53,6 @@ def get_view():
     return render_template(
         "eg007_create_form_group.html",
         title="Creating a form group",
-        source_file=path.basename(path.dirname(__file__)) + "/controller.py"
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
     )
diff --git a/app/rooms/examples/eg008_grant_office_access_to_form_group/views.py b/app/rooms/examples/eg008_grant_office_access_to_form_group/views.py
@@ -1,6 +1,8 @@
 from docusign_rooms.client.api_exception import ApiException
 from flask import Blueprint, render_template, current_app
 
+from os import path
+
 from app.docusign import authenticate
 from app.error_handlers import process_error
 from .controller import Eg008Controller
@@ -63,5 +65,7 @@ def get_view():
     return render_template(
         "eg008_grant_office_access_to_form_group.html",
         offices=offices,
-        form_groups=form_groups
+        form_groups=form_groups,
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
     )
diff --git a/app/rooms/examples/eg009_assign_form_to_form_group/views.py b/app/rooms/examples/eg009_assign_form_to_form_group/views.py
@@ -1,4 +1,5 @@
 import json
+from os import path
 
 from docusign_rooms.client.api_exception import ApiException
 from flask import Blueprint, render_template, current_app
@@ -73,5 +74,7 @@ def get_view():
     return render_template(
         "eg009_assign_form_to_form_group.html",
         forms=forms,
-        form_groups=form_groups
+        form_groups=form_groups,
+        source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",
+        source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",
     )
diff --git a/app/rooms/templates/eg001_create_room_with_data.html b/app/rooms/templates/eg001_create_room_with_data.html
@@ -12,6 +12,9 @@ <h4>1. Creating a room with data</h4>
    <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Rooms/Rooms/CreateRoom">Rooms::CreateRoom</a> and
    <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Roles/Roles/GetRoles">Roles::GetRoles</a>
 </p>
+<p>
+  View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
+</p>
 
 <form class="eg" action="" method="post" data-busy="form">
     <div class="form-group">
diff --git a/app/rooms/templates/eg002_create_room_with_template.html b/app/rooms/templates/eg002_create_room_with_template.html
@@ -16,6 +16,9 @@ <h4>2. Creating a room with a template</h4>
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/RoomTemplates/RoomTemplates/GetRoomTemplates">RoomTemplates::GetRoomTemplates</a> and
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Roles/Roles/GetRoles">Roles::GetRoles</a>
 </p>
+<p>
+    View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
+</p>
 
 <form class="eg" action="" method="post" data-busy="form">
     {% if templates %}
diff --git a/app/rooms/templates/eg003_export_data_from_room.html b/app/rooms/templates/eg003_export_data_from_room.html
@@ -13,6 +13,9 @@ <h4>3. Exporting data from a room</h4>
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Rooms/Rooms/GetRooms">Rooms::GetRooms</a> and
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Rooms/Rooms/GetRoomFieldData">Rooms::GetRoomFieldData</a>
 </p>
+<p>
+  View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
+</p>
 
 <form class="eg" action="" method="post" data-busy="form">
     {% if rooms %}
diff --git a/app/rooms/templates/eg004_add_forms_to_room.html b/app/rooms/templates/eg004_add_forms_to_room.html
@@ -14,6 +14,9 @@ <h4>4. Adding forms to a room</h4>
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Forms/FormLibraries/GetFormLibraryForms">Forms::GetFormLibraryForms</a> and
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Rooms/Rooms/AddFormToRoom">Rooms::AddFormToRoom</a>
 </p>
+<p>
+    View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
+</p>
 
 <form class="eg" action="" method="post" data-busy="form">
     {% if rooms %}
diff --git a/app/rooms/templates/eg005_get_rooms_with_filters.html b/app/rooms/templates/eg005_get_rooms_with_filters.html
@@ -12,6 +12,9 @@ <h4>5. Getting rooms with filters</h4>
 <p>API method used:
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Rooms/Rooms/GetRooms">Rooms::GetRooms</a>
 </p>
+<p>
+  View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
+</p>
 
 <form class="eg" action="" method="post" data-busy="form">
     {% if rooms %}
diff --git a/app/rooms/templates/eg006_create_external_form_fill_session.html b/app/rooms/templates/eg006_create_external_form_fill_session.html
@@ -16,6 +16,9 @@ <h4>6. Creating an external form fill session</h4>
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Rooms/Rooms/GetRooms">Rooms::GetRooms</a>,
     <a target ='_blank' href="https://developers.docusign.com/docs/rooms-api/reference/Rooms/Rooms/GetDocuments/">Rooms::GetDocuments</a> and
     <a target ='_blank' href="https://developers.docusign.com/rooms-api/reference/Forms/ExternalFormFillSessions/CreateExternalFormFillSession">Forms::CreateExternalFormFillSession</a>
+</p>
+<p>
+    View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
 </p>
     {% if rooms %}
         <form class="eg" action="/forms" method="post" data-busy="form">
diff --git a/app/rooms/templates/eg007_create_form_group.html b/app/rooms/templates/eg007_create_form_group.html
@@ -11,6 +11,9 @@ <h4>7. Creating a form group</h4>
 <p>API methods used:
    <a target ='_blank' href="https://developers.docusign.com/docs/rooms-api/how-to/create-form-group/">Rooms::CreateFormGroup</a>
 </p>
+<p>
+  View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
+</p>
 
 <form class="eg" action="" method="post" data-busy="form">
     <div class="form-group">
diff --git a/app/rooms/templates/eg008_grant_office_access_to_form_group.html b/app/rooms/templates/eg008_grant_office_access_to_form_group.html
@@ -14,6 +14,9 @@ <h4>8. Grant office access to a form group</h4>
     <a target ='_blank' href="https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/getformgroups/">FormGroups::GetFormGroups</a> and
     <a target ='_blank' href="https://developers.docusign.com/docs/rooms-api/reference/offices/offices/getoffices/">Offices::GetOffices</a>
 </p>
+<p>
+    View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
+</p>
 
 <form class="eg" action="" method="post" data-busy="form">
     {% if form_groups %}
diff --git a/app/rooms/templates/eg009_assign_form_to_form_group.html b/app/rooms/templates/eg009_assign_form_to_form_group.html
@@ -13,6 +13,9 @@ <h4>9. Assign a form to a form group</h4>
     <a target ='_blank' href="https://developers.docusign.com/docs/rooms-api/reference/forms/formgroups/getformgroups/">FormGroups::GetFormGroups</a> and
     <a target ='_blank' href="https://developers.docusign.com/docs/rooms-api/reference/forms/formlibraries/getformlibraries/">FormLibraries:GetFormLibraries</a>
 </p>
+<p>
+    View source file <a target="_blank" href="{{ source_url | safe }}">{{ source_file }}</a> on GitHub.
+</p>
 
 <form class="eg" action="" method="post" data-busy="form">
     {% if form_groups %}

Original file line number	Diff line number	Diff line change
`@@ -53,5 +53,6 @@ def get_view():`
`53`	`53`	`return render_template(`
`54`	`54`	`"eg001_create_room_with_data.html",`
`55`	`55`	`title="Creating a room with data",`
`56`		`- source_file=path.basename(path.dirname(__file__)) + "/controller.py",`
	`56`	`+ source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",`
	`57`	`+ source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",`
`57`	`58`	`)`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,7 @@ def get_view():`
`66`	`66`	`return render_template(`
`67`	`67`	`"eg002_create_room_with_template.html",`
`68`	`68`	`title="Creating a room with a template",`
`69`		`- source_file=path.basename(path.dirname(__file__)) + "/controller.py",`
	`69`	`+ source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",`
	`70`	`+ source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",`
`70`	`71`	`templates=templates`
`71`	`72`	`)`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ def get_view():`
`62`	`62`	`return render_template(`
`63`	`63`	`"eg003_export_data_from_room.html",`
`64`	`64`	`title="Exporting data from a room",`
`65`		`- source_file=path.basename(path.dirname(__file__)) + "/controller.py",`
	`65`	`+ source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",`
	`66`	`+ source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",`
`66`	`67`	`rooms=rooms,`
`67`	`68`	`)`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,8 @@ def get_view():`
`64`	`64`	`return render_template(`
`65`	`65`	`"eg006_create_external_form_fill_session.html",`
`66`	`66`	`title="Create an external form fill session",`
`67`		`- source_file=path.basename(path.dirname(__file__)) + "/controller.py",`
	`67`	`+ source_file=path.relpath(path.dirname(__file__), start='app') + "/controller.py",`
	`68`	`+ source_url="https://github.com/docusign/code-examples-python/tree/master/app/" + path.relpath(path.dirname(__file__), start='app') + "/controller.py",`
`68`	`69`	`rooms=rooms,`
`69`	`70`	`)`
`70`	`71`