SharePoint API: PeopleManager changes, introduced TaxonomyService

vvgrem@gmail.com · vvgrem@gmail.com · commit 0009381ca7b4 · 2020-11-11T18:45:28.000+02:00
diff --git a/generator/metadata/SharePoint.xml b/generator/metadata/SharePoint.xml
diff --git a/generator/metadata/SharePoint2_1.xml b/generator/metadata/SharePoint2_1.xml
diff --git a/office365/sharepoint/taxonomy/taxonomyService.py b/office365/sharepoint/taxonomy/taxonomyService.py
@@ -0,0 +1,15 @@
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.taxonomy.termStore import TermStore
+
+
+class TaxonomyService(BaseEntity):
+    """Wraps all of the associated TermStore objects for an Site object."""
+
+    def __init__(self, context):
+        super().__init__(context, ResourcePath("v2.1"))
+
+    @property
+    def term_store(self):
+        return self.properties.get("termStore",
+                                   TermStore(self.context, ResourcePath("termStore", self.resource_path)))
diff --git a/office365/sharepoint/taxonomy/termGroup.py b/office365/sharepoint/taxonomy/termGroup.py
@@ -0,0 +1,6 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class TermGroup(BaseEntity):
+    """Represents the top-level container in a TermStore object."""
+    pass
diff --git a/office365/sharepoint/taxonomy/termGroupCollection.py b/office365/sharepoint/taxonomy/termGroupCollection.py
@@ -0,0 +1,8 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.sharepoint.taxonomy.termGroup import TermGroup
+
+
+class TermGroupCollection(ClientObjectCollection):
+
+    def __init__(self, context, resource_path=None):
+        super(TermGroupCollection, self).__init__(context, TermGroup, resource_path)
diff --git a/office365/sharepoint/taxonomy/termSetInfo.py b/office365/sharepoint/taxonomy/termSetInfo.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TermSetInfo(ClientValue):
+    pass
diff --git a/office365/sharepoint/taxonomy/termStore.py b/office365/sharepoint/taxonomy/termStore.py
@@ -0,0 +1,40 @@
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.taxonomy.termGroupCollection import TermGroupCollection
+
+
+class TermStore(BaseEntity):
+    """Represents a hierarchical or flat set of Term objects known as a 'TermSet'."""
+
+    @property
+    def id(self):
+        """
+        :rtype: str
+        """
+        return self.properties.get("id", None)
+
+    @property
+    def name(self):
+        """
+        :rtype: str
+        """
+        return self.properties.get("name", None)
+
+    @property
+    def defaultLanguageTag(self):
+        """
+        :rtype: str
+        """
+        return self.properties.get("defaultLanguageTag", None)
+
+    @property
+    def languageTags(self):
+        """
+        :rtype: list[str]
+         """
+        return self.properties.get("languageTags", [])
+
+    @property
+    def termGroups(self):
+        return self.properties.get("termGroups",
+                                   TermGroupCollection(self.context, ResourcePath("termGroups", self.resource_path)))
diff --git a/office365/sharepoint/userprofiles/followResult.py b/office365/sharepoint/userprofiles/followResult.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class FollowResult(ClientValue):
+    pass
diff --git a/office365/sharepoint/userprofiles/followedContent.py b/office365/sharepoint/userprofiles/followedContent.py
@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class FollowedContent(BaseEntity):
+    pass
diff --git a/office365/sharepoint/userprofiles/followedItem.py b/office365/sharepoint/userprofiles/followedItem.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class FollowedItem(ClientValue):
+    pass
diff --git a/office365/sharepoint/userprofiles/peopleManager.py b/office365/sharepoint/userprofiles/peopleManager.py
@@ -13,8 +13,58 @@ class PeopleManager(BaseEntity):
     def __init__(self, context):
         super().__init__(context, ResourcePath("SP.UserProfiles.PeopleManager"))
 
+    def ami_following(self, account_name):
+        """
+        Checks whether the current user is following the specified user.
+
+        :param str account_name:
+        :return:
+        """
+        result = ClientResult(None)
+        params = {"accountName": account_name}
+        qry = ServiceOperationQuery(self, "AmIFollowing", params, None, None, result)
+        self.context.add_query(qry)
+        return result
+
+    def get_followers_for(self, account_name):
+        """
+        Gets the people who are following the specified user.
+
+        :param str account_name:
+        :return:
+        """
+        result = ClientResult(PersonPropertiesCollection(self.context))
+        params = {"accountName": account_name}
+        qry = ServiceOperationQuery(self, "GetFollowersFor", params, None, None, result)
+        self.context.add_query(qry)
+        return result
+
+    def follow(self, account_name):
+        """
+        Add the specified user to the current user's list of followed users.
+
+        :param str account_name:
+        """
+        params = {"accountName": account_name}
+        qry = ServiceOperationQuery(self, "Follow", params, None, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def stop_following(self, account_name):
+        """
+        Remove the specified user from the current user's list of followed users.
+
+        :param str account_name:
+        """
+        params = {"accountName": account_name}
+        qry = ServiceOperationQuery(self, "StopFollowing", params, None, None, None)
+        self.context.add_query(qry)
+        return self
+
     def get_user_profile_properties(self, accountName):
         """
+        Gets the specified user profile properties for the specified user.
+
         :type accountName: str
         :return: dict
         """
@@ -26,6 +76,8 @@ def get_user_profile_properties(self, accountName):
 
     def get_properties_for(self, accountName):
         """
+        Gets user properties for the specified user.
+
         :type accountName: str
         :return: PersonProperties
         """
@@ -37,6 +89,13 @@ def get_properties_for(self, accountName):
 
     def get_default_document_library(self, accountName, createSiteIfNotExists=False,
                                      siteCreationPriority=PersonalSiteCreationPriority.Low):
+        """
+
+        :param str accountName:
+        :param bool createSiteIfNotExists:
+        :param int siteCreationPriority:
+        :return:
+        """
         result = ClientResult(str)
         params = {"accountName": accountName,
                   "createSiteIfNotExists": createSiteIfNotExists,
diff --git a/office365/sharepoint/userprofiles/userProfile.py b/office365/sharepoint/userprofiles/userProfile.py
@@ -1,8 +1,25 @@
-from office365.runtime.client_object import ClientObject
 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.followedContent import FollowedContent
 
 
-class UserProfile(ClientObject):
+class UserProfile(BaseEntity):
+
+    @property
+    def public_url(self):
+        """
+        :rtype: str or None
+        """
+        return self.properties.get("PublicUrl", None)
+
+    @property
+    def followed_content(self):
+        """
+        Gets a FollowedContent object for the user.
+        """
+        return self.properties.get("FollowedContent",
+                                   FollowedContent(self.context, ResourcePath("FollowedContent", self.resource_path)))
 
     def create_personal_site_enque(self, isInteractive):
         """
diff --git a/tests/sharepoint/test_taxonomy.py b/tests/sharepoint/test_taxonomy.py
@@ -1,4 +1,6 @@
 from office365.sharepoint.taxonomy.taxonomyField import TaxonomyField
+from office365.sharepoint.taxonomy.taxonomyService import TaxonomyService
+from office365.sharepoint.taxonomy.termStore import TermStore
 
 from tests.sharepoint.sharepoint_case import SPTestCase
 
@@ -16,7 +18,13 @@ def setUpClass(cls):
     def tearDownClass(cls):
         pass
 
-    def test1_create_list_tax_field(self):
+    def test1_get_term_store(self):
+        tax_session = TaxonomyService(self.client)
+        term_store = tax_session.term_store.get().execute_query()
+        self.assertIsInstance(term_store, TermStore)
+        self.assertIsNotNone(term_store.name)
+
+    def test2_create_list_tax_field(self):
         ssp_id = "f02be691-d551-462f-aaae-e1c89168cd0b"
         term_set_id = "b49f64b3-4722-4336-9a5c-56c326b344d4"
         text_field_id = "cd790052-00e3-4317-a090-365cd85795b6"
@@ -30,7 +38,7 @@ def test1_create_list_tax_field(self):
         self.assertIsNotNone(tax_field.resource_path)
         self.__class__.target_field = tax_field
 
-    def test2_get_tax_field(self):
+    def test3_get_tax_field(self):
         existing_field = self.__class__.target_field.get().execute_query()
         self.assertTrue(existing_field.properties.get('TypeAsString'), 'TaxonomyFieldType')
         self.assertIsInstance(existing_field, TaxonomyField)
@@ -44,7 +52,7 @@ def test2_get_tax_field(self):
         self.client.execute_batch()
         self.assertIsNotNone(text_field.internal_name)
 
-    def test3_delete_tax_field(self):
+    def test4_delete_tax_field(self):
         self.__class__.target_field.delete_object().execute_query()
 
         # text_field_id = self.__class__.target_field.properties.get('TextField')
diff --git a/tests/sharepoint/test_user_profile.py b/tests/sharepoint/test_user_profile.py
@@ -1,5 +1,7 @@
 from unittest import TestCase
 
+from office365.sharepoint.userprofiles.personPropertiesCollection import PersonPropertiesCollection
+
 from settings import settings
 
 from office365.runtime.auth.user_credential import UserCredential
@@ -10,6 +12,7 @@
 
 class TestUserProfile(TestCase):
     profile_loader = None  # type: ProfileLoader
+    target_account_name = "mdoe@mediadev8.onmicrosoft.com"
 
     @classmethod
     def setUpClass(cls):
@@ -56,3 +59,22 @@ def test7_get_people_followed_by(self):
         people_manager = PeopleManager(self.my_client)
         result = people_manager.get_people_followed_by(me.login_name).execute_query()
         self.assertIsNotNone(result)
+
+    def test7_start_stop_following(self):
+        people_manager = PeopleManager(self.my_client)
+        target_user = self.my_client.web.ensure_user(self.__class__.target_account_name).execute_query()
+
+        result = people_manager.ami_following(target_user.login_name)
+        people_manager.execute_query()
+
+        if result.value:
+            people_manager.stop_following(target_user.login_name).execute_query()
+        else:
+            people_manager.follow(target_user.login_name)
+
+    def test8_get_followers(self):
+        people_manager = PeopleManager(self.my_client)
+        target_user = self.my_client.web.ensure_user(self.__class__.target_account_name).execute_query()
+        result = people_manager.get_followers_for(target_user.login_name)
+        people_manager.execute_query()
+        self.assertIsInstance(result.value, PersonPropertiesCollection)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +from office365.runtime.client_value import ClientValue
++
++
 +class TermSetInfo(ClientValue):
 +    pass