SharePoint API: PeopleManager, SocialFollowingManager

Author: vvgrem@gmail.com

README.md

@@ -113,15 +113,13 @@ the following clients are available:
 #### Authentication
 
 [The Microsoft Authentication Library (MSAL) for Python](https://pypi.org/project/msal/) which comes as a dependency 
-is used as a default library to obtain token to call Microsoft Graph API. But in terms of Microsoft Graph API 
-authentication, another Microsoft Authentication Client compliant libraries such [adal](https://github.com/AzureAD/azure-activedirectory-library-for-python) 
-as are supported as well.   
+is used as a default library to obtain tokens to call Microsoft Graph API. 
+
+Using [Microsoft Authentication Library (MSAL) for Python](https://pypi.org/project/msal/)
 
 > Note: access token is getting acquired  via [Client Credential flow](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow)
 > in the provided examples
 
-Using [Microsoft Authentication Library (MSAL) for Python](https://pypi.org/project/msal/)
-
 ```python
 import msal
 from office365.graph_client import GraphClient
@@ -144,6 +142,9 @@ client = GraphClient(acquire_token)
 
 ```
 
+But in terms of Microsoft Graph API authentication, another Microsoft Authentication Client compliant libraries 
+such as [adal](https://github.com/AzureAD/azure-activedirectory-library-for-python) 
+are supported as well.   
 
 Using [ADAL Python](https://adal-python.readthedocs.io/en/latest/#)
 

examples/teams/provision_team.py

@@ -38,7 +38,3 @@ def print_failure(retry_number):
 result = client.teams.create(group_name)
 client.execute_query_retry(max_retry=5, failure_callback=print_failure)
 print("Team has been provisioned")
-
-channels = result.value.channels
-client.load(channels)
-client.execute_query()

office365/sharepoint/folders/folder_collection.py

@@ -9,6 +9,12 @@ class FolderCollection(ClientObjectCollection):
     def __init__(self, context, resource_path=None):
         super(FolderCollection, self).__init__(context, Folder, resource_path)
 
+    def get(self):
+        """
+        :rtype: FolderCollection
+        """
+        return super(FolderCollection, self).get()
+
     def add(self, server_relative_url):
         """Adds the folder that is located at the specified URL to the collection.
 

office365/sharepoint/social/socialFollowingManager.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class SocialFollowingManager(BaseEntity):
+    """Provides methods for managing a user's list of followed actors (users, documents, sites, and tags)."""

office365/sharepoint/userprofiles/peopleManager.py

@@ -1,6 +1,33 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
+from office365.runtime.resource_path import ResourcePath
 from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.userprofiles.personalSiteCreationPriority import PersonalSiteCreationPriority
 
 
 class PeopleManager(BaseEntity):
     """Provides methods for operations related to people."""
-    pass
+
+    def __init__(self, context):
+        super().__init__(context, ResourcePath("SP.UserProfiles.PeopleManager"))
+
+    def get_user_profile_properties(self, accountName):
+        """
+        :type accountName: str
+        :return: dict
+        """
+        result = ClientResult(None)
+        payload = {"accountName": accountName}
+        qry = ServiceOperationQuery(self, "GetUserProfileProperties", payload, None, None, result)
+        self.context.add_query(qry)
+        return result
+
+    def get_default_document_library(self, accountName, createSiteIfNotExists=False,
+                                     siteCreationPriority=PersonalSiteCreationPriority.Low):
+        result = ClientResult(str)
+        params = {"accountName": accountName,
+                  "createSiteIfNotExists": createSiteIfNotExists,
+                  "siteCreationPriority": siteCreationPriority}
+        qry = ServiceOperationQuery(self, "GetDefaultDocumentLibrary", params, None, None, result)
+        self.context.add_query(qry)
+        return result

office365/sharepoint/userprofiles/personalSiteCreationPriority.py

@@ -0,0 +1,4 @@
+class PersonalSiteCreationPriority:
+    Low = 0
+    Medium = 1
+    High = 2

requirements.txt

@@ -1,8 +1,6 @@
 requests~=2.24.0
 requests_ntlm [NTLMAuthentication]
-setuptools~=50.3.0
+setuptools~=50.3.2
 
-adal~=1.2.4
 msal~=1.5.0
-Faker~=4.1.2
 astunparse~=1.6.3

tests/sharepoint/test_folder.py

@@ -29,54 +29,41 @@ def setUpClass(cls):
 
     @classmethod
     def tearDownClass(cls):
-        cls.target_list.delete_object()
-        cls.client.execute_query()
+        cls.target_list.delete_object().execute_query()
 
     def test1_enum_folders_and_files(self):
-        parent_folder = self.__class__.target_list.rootFolder
-        self.client.load(parent_folder)
-        self.client.execute_query()
+        parent_folder = self.__class__.target_list.rootFolder.get().execute_query()
         self.assertIsNotNone(parent_folder.serverRelativeUrl)
 
         folder_url = parent_folder.serverRelativeUrl
-        folder_object = self.client.web.get_folder_by_server_relative_url(folder_url)
-        self.client.load(folder_object)
-        self.client.execute_query()
+        folder_object = self.client.web.get_folder_by_server_relative_url(folder_url).get().execute_query()
         self.assertTrue(folder_object.properties["ServerRelativeUrl"], folder_url)
-        folders = folder_object.folders
-        self.client.load(folders)
-        self.client.execute_query()
+        folders = folder_object.folders.get().execute_query()
         for child_folder in folders:
             self.assertIsNotNone(child_folder.resource_path)
-            self.assertIsNotNone(child_folder.resource_path)
-            files = child_folder.files
-            self.client.load(files)
-            self.client.execute_query()
+            files = child_folder.files.get().execute_query()
             for file_in_folder in files:
                 self.assertIsNotNone(file_in_folder.resource_path)
 
     def test2_create_folder(self):
-        folder_new = self.__class__.target_list.rootFolder.folders.add(self.__class__.target_folder_name)
-        self.client.execute_query()
+        folder_new = self.__class__.target_list.rootFolder.folders.add(self.__class__.target_folder_name).execute_query()
         self.assertTrue(folder_new.properties["Exists"])
         self.__class__.target_folder = folder_new
 
     def test3_get_folder_by_id(self):
         folder_id = self.__class__.target_folder.properties['UniqueId']
-        folder = self.client.web.get_folder_by_id(folder_id)
-        self.client.execute_query()
+        folder = self.client.web.get_folder_by_id(folder_id).execute_query()
         self.assertIsNotNone(folder.resource_path)
 
     def test4_update_folder(self):
         folder_to_update = self.__class__.target_list.rootFolder.folders.get_by_url(self.__class__.target_folder_name)
         self.__class__.target_folder_name = "_Archive_" + str(randint(0, 1000))
-        folder_to_update.rename(self.__class__.target_folder_name)
-        self.client.execute_query()
+        folder_to_update.rename(self.__class__.target_folder_name).execute_query()
 
-        result = self.__class__.target_list.rootFolder.folders.filter(
-            "Name eq '{0}'".format(self.__class__.target_folder_name))
-        self.client.load(result)
-        self.client.execute_query()
+        result = self.__class__.target_list.rootFolder.folders\
+            .filter("Name eq '{0}'".format(self.__class__.target_folder_name))\
+            .get()\
+            .execute_query()
         self.assertEqual(len(result), 1)
 
     def test5_copy_folder(self):
@@ -132,8 +119,8 @@ def test_11_delete_folder(self):
         folder_to_delete = self.__class__.target_list.rootFolder.folders.get_by_url(self.__class__.target_folder_name)
         folder_to_delete.delete_object().execute_query()
 
-        result = self.__class__.target_list.rootFolder.folders.filter(
-            "Name eq '{0}'".format(self.__class__.target_folder_name))
-        self.client.load(result)
-        self.client.execute_query()
+        result = self.__class__.target_list.rootFolder.folders\
+            .filter("Name eq '{0}'".format(self.__class__.target_folder_name))\
+            .get()\
+            .execute_query()
         self.assertEqual(len(result), 0)

tests/sharepoint/test_user_profile.py

@@ -2,7 +2,7 @@
 
 from office365.runtime.auth.user_credential import UserCredential
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.userprofiles.userProfilePropertiesForUser import UserProfilePropertiesForUser
+from office365.sharepoint.userprofiles.peopleManager import PeopleManager
 from settings import settings
 
 
@@ -31,9 +31,16 @@ def test3_create_personal_site(self):
         up = user_profile.create_personal_site_enque(True).execute_query()
         self.assertIsNotNone(up.properties['PublicUrl'])
 
-    # def test4_get_user_props(self):
-    #    account_name = settings['user_credentials']['username']
-    #    props = UserProfilePropertiesForUser(self.my_client, account_name, ['PublicUrl'])
-    #    self.my_client.load(props)
-    #    self.my_client.execute_query()
-    #    self.assertIsNotNone(props)
+    def test4_get_user_props(self):
+        me = self.my_client.web.currentUser.get().execute_query()
+        people_manager = PeopleManager(self.my_client)
+        result = people_manager.get_user_profile_properties(me.login_name)
+        self.my_client.execute_query()
+        self.assertIsNotNone(result.value)
+
+    def test5_get_default_document_library(self):
+        me = self.my_client.web.currentUser.get().execute_query()
+        people_manager = PeopleManager(self.my_client)
+        result = people_manager.get_default_document_library(me.login_name)
+        self.my_client.execute_query()
+        self.assertIsNotNone(result.value)