SharePoint API: workflowservices namespace introduced, examples section refactoring

Author: vgrem

examples/__init__.py

@@ -1,30 +1,34 @@
+import os
+
 import msal
 
 from tests import settings
 
-
-test_user_principal_name = settings.get('users', 'test_user1')
-test_user_principal_name_alt = settings.get('users', 'test_user2')
-
-tenant_prefix = settings.get('default', 'tenant_prefix')
-tenant_name = settings.get('default', 'tenant')
+#shortcuts
+sample_client_id = settings.get('client_credentials', 'client_id')
+sample_user_principal_name = settings.get('users', 'test_user1')
+sample_user_principal_name_alt = settings.get('users', 'test_user2')
+sample_tenant_prefix = settings.get('default', 'tenant_prefix')
+sample_tenant_name = settings.get('default', 'tenant')
+sample_thumbprint = settings.get('certificate_credentials', 'thumbprint')
+sample_cert_path = '{0}/selfsigncert.pem'.format(os.path.dirname(__file__))
 
 
 def acquire_token_by_client_credentials():
-    authority_url = 'https://login.microsoftonline.com/{0}'.format(settings.get('default', 'tenant'))
+    authority_url = 'https://login.microsoftonline.com/{0}'.format(sample_tenant_name)
     app = msal.ConfidentialClientApplication(
         authority=authority_url,
-        client_id=settings.get('client_credentials', 'client_id'),
+        client_id=sample_client_id,
         client_credential=settings.get('client_credentials', 'client_secret')
     )
     return app.acquire_token_for_client(scopes=["https://graph.microsoft.com/.default"])
 
 
 def acquire_token_by_username_password():
-    authority_url = 'https://login.microsoftonline.com/{0}'.format(settings.get('default', 'tenant'))
+    authority_url = 'https://login.microsoftonline.com/{0}'.format(sample_tenant_name)
     app = msal.PublicClientApplication(
         authority=authority_url,
-        client_id=settings.get('client_credentials', 'client_id')
+        client_id=sample_client_id
     )
     return app.acquire_token_by_username_password(username=settings.get('user_credentials', "username"),
                                                   password=settings.get('user_credentials', "password"),

examples/onedrive/connect_with_client_cert.py

@@ -0,0 +1,24 @@
+from examples import sample_tenant_name, sample_client_id, sample_thumbprint, sample_cert_path
+from office365.graph_client import GraphClient
+
+
+def acquire_token_with_client_certificate():
+    with open(sample_cert_path, 'r') as f:
+        private_key = open(sample_cert_path).read()
+
+    authority_url = 'https://login.microsoftonline.com/{0}'.format(sample_tenant_name)
+    credentials = {"thumbprint": sample_thumbprint, "private_key": private_key}
+    import msal
+    app = msal.ConfidentialClientApplication(
+        sample_client_id,
+        authority=authority_url,
+        client_credential=credentials,
+    )
+    result = app.acquire_token_for_client(scopes=["https://graph.microsoft.com/.default"])
+    return result
+
+
+client = GraphClient(acquire_token_with_client_certificate)
+drives = client.drives.get().top(10).execute_query()
+for drive in drives:
+    print(drive.web_url)

examples/onedrive/export_files.py

@@ -5,14 +5,14 @@
 import os
 import tempfile
 
-from examples import acquire_token_by_client_credentials, test_user_principal_name
+from examples import acquire_token_by_client_credentials, sample_user_principal_name
 from office365.graph_client import GraphClient
 from office365.onedrive.drives.drive import Drive
 
 client = GraphClient(acquire_token_by_client_credentials)
 
 
-drive = client.users[test_user_principal_name].drive  # type: Drive
+drive = client.users[sample_user_principal_name].drive  # type: Drive
 with tempfile.TemporaryDirectory() as local_path:
     drive_items = drive.root.children.get().execute_query()
     file_items = [item for item in drive_items if item.file is not None]    # files only

examples/onedrive/get_file_by_abs_url.py

@@ -1,7 +1,7 @@
-from examples import acquire_token_by_username_password, tenant_prefix
+from examples import acquire_token_by_username_password, sample_tenant_prefix
 from office365.graph_client import GraphClient
 
-file_abs_url = "https://{0}.sharepoint.com/sites/team/Shared Documents/big_buck_bunny.mp4".format(tenant_prefix)
+file_abs_url = "https://{0}.sharepoint.com/sites/team/Shared Documents/big_buck_bunny.mp4".format(sample_tenant_prefix)
 
 client = GraphClient(acquire_token_by_username_password)
 file_item = client.shares.by_url(file_abs_url).drive_item.get().execute_query()

examples/onedrive/upload_file.py

@@ -1,12 +1,12 @@
 import os
 
-from examples import acquire_token_by_client_credentials, test_user_principal_name_alt
+from examples import acquire_token_by_client_credentials, sample_user_principal_name_alt
 from office365.graph_client import GraphClient
 
 
 client = GraphClient(acquire_token_by_client_credentials)
 
-remote_drive = client.users[test_user_principal_name_alt].drive.root.get_by_path("archive")
+remote_drive = client.users[sample_user_principal_name_alt].drive.root.get_by_path("archive")
 
 local_path = "../../tests/data/SharePoint User Guide.docx"
 # local_path = "../data/countries.json"

examples/outlook/download_messages.py

@@ -1,13 +1,13 @@
 import os
 import tempfile
 
-from examples import acquire_token_by_client_credentials, test_user_principal_name
+from examples import acquire_token_by_client_credentials, sample_user_principal_name
 from office365.graph_client import GraphClient
 from office365.outlook.mail.messages.message import Message
 
 client = GraphClient(acquire_token_by_client_credentials)
 # requires Mail.ReadWrite permission
-user = client.users[test_user_principal_name]
+user = client.users[sample_user_principal_name]
 messages = user.messages.select(["id"]).top(2).get().execute_query()
 with tempfile.TemporaryDirectory() as local_path:
     for message in messages:  # type: Message

examples/outlook/download_messages_with_attachments.py

@@ -1,7 +1,7 @@
 import os
 import tempfile
 
-from examples import acquire_token_by_client_credentials, test_user_principal_name
+from examples import acquire_token_by_client_credentials, sample_user_principal_name
 from office365.graph_client import GraphClient
 from office365.outlook.mail.attachments.attachment import Attachment
 from office365.outlook.mail.messages.message import Message
@@ -10,7 +10,7 @@
 # Permissions: requires Mail.ReadWrite
 
 client = GraphClient(acquire_token_by_client_credentials)
-user = client.users[test_user_principal_name]
+user = client.users[sample_user_principal_name]
 messages = user.messages.filter("hasAttachments eq true").expand(["attachments"]).top(1).get().execute_query()
 with tempfile.TemporaryDirectory() as local_path:
     for message in messages:  # type: Message

examples/outlook/get_messages_basic_props.py

@@ -1,12 +1,12 @@
-from examples import acquire_token_by_client_credentials, test_user_principal_name
+from examples import acquire_token_by_client_credentials, sample_user_principal_name
 from office365.graph_client import GraphClient
 from office365.outlook.mail.messages.message import Message
 
 # Demonstrates how to read messages (only basic properties!) in user mailbox
 
 client = GraphClient(acquire_token_by_client_credentials)
 # requires Mail.ReadBasic.All permission
-user = client.users[test_user_principal_name]
+user = client.users[sample_user_principal_name]
 messages = user.messages.select(["id", "subject"]).top(10).get().execute_query()
 for message in messages:  # type: Message
     print(message.id)

examples/outlook/get_messages_with_body.py

@@ -1,10 +1,10 @@
-from examples import acquire_token_by_client_credentials, test_user_principal_name
+from examples import acquire_token_by_client_credentials, sample_user_principal_name
 from office365.graph_client import GraphClient
 from office365.outlook.mail.messages.message import Message
 
 client = GraphClient(acquire_token_by_client_credentials)
 # requires Mail.Read permission
-user = client.users[test_user_principal_name]
+user = client.users[sample_user_principal_name]
 messages = user.messages.select(["subject", "body"]).top(10).get().execute_query()
 for message in messages:  # type: Message
     print(message.body.content)

examples/sharepoint/applauncher/__init__.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class AppLauncher(BaseEntity):
+    pass

examples/sharepoint/applauncher/app_launcher.py

@@ -7,7 +7,7 @@
 """
 import sys
 
-from examples import acquire_token_by_client_credentials, test_user_principal_name_alt
+from examples import acquire_token_by_client_credentials, sample_user_principal_name_alt
 from office365.graph_client import GraphClient
 from office365.onedrive.permissions.permission import Permission
 from office365.sharepoint.client_context import ClientContext
@@ -45,7 +45,7 @@ def assign_site_access(site_url, roles=None, clear_existing=False):
 
 def verify_site_access():
     ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-    site = ctx.web.site_users.get_by_email(test_user_principal_name_alt).get_personal_site().execute_query()
+    site = ctx.web.site_users.get_by_email(sample_user_principal_name_alt).get_personal_site().execute_query()
     print(site.url)
 
 

examples/sharepoint/sites/grant_app_access.py

@@ -15,9 +15,9 @@ def export_to_file(path, content):
 
 parser = ArgumentParser()
 parser.add_argument("-e", "--endpoint", dest="endpoint",
-                    help="Import metadata endpoint", default="microsoftgraph")
+                    help="Import metadata endpoint", default="sharepoint")
 parser.add_argument("-p", "--path",
-                    dest="path", default="./metadata/MicrosoftGraph.xml",
+                    dest="path", default="./metadata/SharePoint.xml",
                     help="Import metadata endpoint")
 
 args = parser.parse_args()