SharePoint API: support for userprofiles namespace

vvgrem@gmail.com · vvgrem@gmail.com · commit 0676002838d5 · 2020-09-18T19:19:38.000+03:00
diff --git a/examples/sharepoint/AppPermissionRequests.xml b/examples/sharepoint/AppPermissionRequests.xml
@@ -1,4 +1,5 @@
 <AppPermissionRequests AllowAppOnlyPolicy="true">
      <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" />
      <AppPermissionRequest Scope="http://sharepoint/search" Right="QueryAsUserIgnoreAppPrincipal"/>
+     <AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="FullControl" />
 </AppPermissionRequests>
diff --git a/examples/teams/connect_with_msal.py b/examples/teams/connect_with_msal.py
diff --git a/examples/teams/send_message.py b/examples/teams/send_message.py
@@ -0,0 +1,34 @@
+import msal
+
+from office365.teams.itemBody import ItemBody
+from settings import settings
+from office365.graph_client import GraphClient
+
+
+def acquire_token_by_username_password():
+    """
+    Acquire token via MSAL
+
+    """
+    authority_url = 'https://login.microsoftonline.com/{0}'.format(settings.get('tenant'))
+    app = msal.PublicClientApplication(
+        authority=authority_url,
+        client_id=settings.get('client_credentials').get('client_id')
+    )
+    result = app.acquire_token_by_username_password(username=settings.get('user_credentials').get("username"),
+                                                    password=settings.get('user_credentials').get("password"),
+                                                    scopes=["https://graph.microsoft.com/.default"])
+    return result
+
+
+client = GraphClient(acquire_token_by_username_password)
+teams_result = client.me.joinedTeams.get().execute_query()
+if len(teams_result) > 0:
+    target_team = teams_result[1]
+
+    messages = target_team.primaryChannel.messages.get().execute_query()
+    print(messages)
+
+    #item_body = ItemBody("Hello world!")
+    #message = target_team.primaryChannel.messages.add(item_body).execute_query()
+    #print(message.web_url)
diff --git a/office365/actions/upload_content_query.py b/office365/actions/upload_content_query.py
@@ -1,9 +1,9 @@
-from office365.onedrive.driveItem import DriveItem
 from office365.resource_path_url import ResourcePathUrl
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 
 
 class UploadContentQuery(ServiceOperationQuery):
     def __init__(self, parent_entity, name, content):
+        from office365.onedrive.driveItem import DriveItem
         return_type = DriveItem(parent_entity.context, ResourcePathUrl(name, parent_entity.resource_path))
         super(UploadContentQuery, self).__init__(return_type, "content", None, content, None, return_type)
diff --git a/office365/directory/directoryAudit.py b/office365/directory/directoryAudit.py
@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class DirectoryAudit(Entity):
+    pass
diff --git a/office365/directory/directoryObjectCollection.py b/office365/directory/directoryObjectCollection.py
@@ -13,6 +13,9 @@ def __init__(self, context, resource_path=None):
         super(DirectoryObjectCollection, self).__init__(context, DirectoryObject, resource_path)
 
     def get(self):
+        """
+        :rtype: DirectoryObjectCollection
+        """
         return super(DirectoryObjectCollection, self).get()
 
     def __getitem__(self, key):
diff --git a/office365/directory/user.py b/office365/directory/user.py
@@ -1,12 +1,12 @@
 from office365.directory.directoryObject import DirectoryObject
 from office365.directory.directoryObjectCollection import DirectoryObjectCollection
-from office365.directory.groupCollection import GroupCollection
 from office365.onedrive.drive import Drive
 from office365.outlookservices.contact_collection import ContactCollection
 from office365.outlookservices.event_collection import EventCollection
 from office365.outlookservices.messageCollection import MessageCollection
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.resource_path import ResourcePath
+from office365.teams.teamCollection import TeamCollection
 
 
 class User(DirectoryObject):
@@ -69,7 +69,7 @@ def joinedTeams(self):
         if self.is_property_available('joinedTeams'):
             return self.properties['joinedTeams']
         else:
-            return GroupCollection(self.context, ResourcePath("joinedTeams", self.resource_path))
+            return TeamCollection(self.context, ResourcePath("joinedTeams", self.resource_path))
 
     @property
     def memberOf(self):
diff --git a/office365/onedrive/baseItemVersion.py b/office365/onedrive/baseItemVersion.py
@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class BaseItemVersion(Entity):
+    pass
diff --git a/office365/onedrive/driveItem.py b/office365/onedrive/driveItem.py
@@ -109,8 +109,9 @@ def resumable_upload(self, source_path, chunk_size=1000000):
         :param str source_path: Local file path
         :param int chunk_size: chunk size
         """
-        uploader = ResumableFileUpload(self, source_path, chunk_size)
-        return uploader.drive_item
+        upload_query = ResumableFileUpload(self, source_path, chunk_size)
+        self.context.add_query(upload_query)
+        return upload_query.return_type
 
     def create_upload_session(self, item):
         """Creates a temporary storage location where the bytes of the file will be saved until the complete file is
diff --git a/office365/onedrive/driveItemVersion.py b/office365/onedrive/driveItemVersion.py
@@ -1,5 +1,5 @@
-from office365.entity import Entity
+from office365.onedrive.baseItemVersion import BaseItemVersion
 
 
-class DriveItemVersion(Entity):
+class DriveItemVersion(BaseItemVersion):
     pass
diff --git a/office365/onedrive/file_upload.py b/office365/onedrive/file_upload.py
@@ -3,6 +3,7 @@
 from office365.onedrive.driveItemUploadableProperties import DriveItemUploadableProperties
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
+from office365.actions.upload_content_query import UploadContentQuery
 
 
 def read_in_chunks(file_object, chunk_size=1024):
@@ -15,7 +16,7 @@ def read_in_chunks(file_object, chunk_size=1024):
         yield data
 
 
-class ResumableFileUpload(object):
+class ResumableFileUpload(UploadContentQuery):
     """Create an upload session to allow your app to upload files up to the maximum file size. An upload session
     allows your app to upload ranges of the file in sequential API requests, which allows the transfer to be resumed
     if a connection is dropped while the upload is in progress. """
@@ -27,18 +28,17 @@ def __init__(self, target_folder, source_path, chunk_size=1024, chunk_uploaded=N
         :type source_path: str
         :type chunk_size: int
         """
+        super().__init__(target_folder, os.path.basename(source_path), "")
         self._chunk_size = chunk_size
         self._source_path = source_path
         self._file_name = os.path.basename(self._source_path)
         self._chunk_uploaded = chunk_uploaded
-        # 1. create an empty file
-        self._target_item = target_folder.upload(self._file_name, "")
-        self._target_item.context.after_execute(self._execute_upload_session, True)
+        self._return_type.context.after_execute(self._execute_upload_session, True)
 
     def _execute_upload_session(self, resp):
         item = DriveItemUploadableProperties()
         item.name = self._file_name
-        self._session_result = self._target_item.create_upload_session(item)
+        self._session_result = self._return_type.create_upload_session(item)
         self.context.execute_query()
 
         fh = open(self._source_path, 'rb')
@@ -55,11 +55,3 @@ def _execute_upload_session(self, resp):
             f_pos += len(piece)
             if callable(self._chunk_uploaded):
                 self._chunk_uploaded(f_pos)
-
-    @property
-    def context(self):
-        return self._target_item.context
-
-    @property
-    def drive_item(self):
-        return self._target_item
diff --git a/office365/runtime/client_object.py b/office365/runtime/client_object.py
@@ -86,7 +86,10 @@ def set_property(self, name, value, persist_changes=True):
         if hasattr(self, safe_name) and value is not None:
             prop_type = getattr(self, safe_name)
             if isinstance(prop_type, ClientObject) or isinstance(prop_type, ClientValue):
-                [prop_type.set_property(k, v, persist_changes) for k, v in value.items()]
+                if isinstance(value, list):
+                    [prop_type.set_property(i, v, persist_changes) for i, v in enumerate(value)]
+                else:
+                    [prop_type.set_property(k, v, persist_changes) for k, v in value.items()]
                 self._properties[name] = prop_type
             else:
                 self._properties[name] = value
diff --git a/office365/runtime/odata/odata_model.py b/office365/runtime/odata/odata_model.py
@@ -4,15 +4,15 @@
 class ODataModel(object):
     """OData model"""
     _types = {}
-    _namespaces = ['principal', 'onedrive', 'outlookservices', 'teams']
+    _namespaces = ['directory', 'onedrive', 'outlookservices', 'teams']
 
     @property
     def types(self):
         return self._types
 
     def resolve_type(self, schema):
         type_alias = schema['name']
-        types = [locate("office365.graph.{0}.{1}".format(ns, type_alias)) for ns in self._namespaces]
+        types = [locate("office365.{0}.{1}".format(ns, type_alias)) for ns in self._namespaces]
         found_modules = [t for t in types if t is not None]
         if any(found_modules):
             schema['state'] = 'attached'
diff --git a/office365/sharepoint/userprofiles/profileLoader.py b/office365/sharepoint/userprofiles/profileLoader.py
@@ -0,0 +1,31 @@
+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.userprofiles.userProfile import UserProfile
+
+
+class ProfileLoader(ClientObject):
+
+    def __init__(self, context):
+        super().__init__(context, ResourcePath("SP.UserProfiles.ProfileLoader.GetProfileLoader"))
+
+    @staticmethod
+    def get_profile_loader(context):
+        """
+        :type: office365.sharepoint.client_context.ClientContext context
+        """
+        result = ProfileLoader(context)
+        qry = ServiceOperationQuery(result, "GetProfileLoader", None, None, None, result)
+        qry.static = True
+        context.add_query(qry)
+        return result
+
+    def get_user_profile(self):
+        result = UserProfile(self.context)
+        qry = ServiceOperationQuery(self, "GetUserProfile", None, None, None, result)
+        self.context.add_query(qry)
+        return result
+
+    @property
+    def entity_type_name(self):
+        return "SP.UserProfiles.ProfileLoader"
diff --git a/office365/sharepoint/userprofiles/userProfile.py b/office365/sharepoint/userprofiles/userProfile.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_object import ClientObject
+
+
+class UserProfile(ClientObject):
+    pass
diff --git a/office365/sharepoint/userprofiles/userProfilePropertiesForUser.py b/office365/sharepoint/userprofiles/userProfilePropertiesForUser.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_object import ClientObject
+
+
+class UserProfilePropertiesForUser(ClientObject):
+    pass
diff --git a/office365/teams/channel.py b/office365/teams/channel.py
@@ -1,6 +1,7 @@
 from urllib.parse import quote
 
 from office365.entity import Entity
+from office365.onedrive.driveItem import DriveItem
 from office365.runtime.queries.delete_entity_query import DeleteEntityQuery
 from office365.runtime.resource_path import ResourcePath
 from office365.teams.chatMessageCollection import ChatMessageCollection
@@ -17,6 +18,12 @@ def delete_object(self):
         self.remove_from_parent_collection()
         return self
 
+    @property
+    def filesFolder(self):
+        """Get the metadata for the location where the files of a channel are stored."""
+        return self.properties.get('filesFolder',
+                                   DriveItem(self.context, ResourcePath("filesFolder", self.resource_path)))
+
     @property
     def tabs(self):
         """A collection of all the tabs in the channel. A navigation property."""
diff --git a/office365/teams/chatMessage.py b/office365/teams/chatMessage.py
@@ -1,9 +1,16 @@
 from office365.entity import Entity
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.resource_path import ResourcePath
+from office365.teams.chatMessageAttachment import ChatMessageAttachment
 
 
 class ChatMessage(Entity):
 
+    @property
+    def attachments(self):
+        """The collection of replies."""
+        return self.properties.get("attachments", ClientValueCollection(ChatMessageAttachment()))
+
     @property
     def replies(self):
         """The collection of replies."""
diff --git a/office365/teams/chatMessageAttachment.py b/office365/teams/chatMessageAttachment.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ChatMessageAttachment(ClientValue):
+    pass
diff --git a/office365/teams/chatMessageCollection.py b/office365/teams/chatMessageCollection.py
@@ -8,6 +8,12 @@ class ChatMessageCollection(ClientObjectCollection):
     def __init__(self, context, resource_path=None):
         super(ChatMessageCollection, self).__init__(context, ChatMessage, resource_path)
 
+    def get(self):
+        """
+        :rtype: ChatMessageCollection
+        """
+        return super(ChatMessageCollection, self).get()
+
     def add(self, item_body):
         """Create a new chatMessage in the specified channel.
 
diff --git a/office365/teams/teamCollection.py b/office365/teams/teamCollection.py
@@ -16,6 +16,12 @@ def __getitem__(self, key):
             return self._data[key]
         return Team(self.context, ResourcePath(key, self.resource_path))
 
+    def get(self):
+        """
+        :rtype: TeamCollection
+        """
+        return super(TeamCollection, self).get()
+
     def get_all(self):
         """List all teams in Microsoft Teams for an organization"""
         groups = self.context.groups.select(["id", "resourceProvisioningOptions"])
diff --git a/office365/teams/teamsAppDefinition.py b/office365/teams/teamsAppDefinition.py
@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class TeamsAppDefinition(Entity):
+    pass
diff --git a/tests/onedrive/test_driveItem.py b/tests/onedrive/test_driveItem.py
@@ -100,5 +100,5 @@ def test_12_copy_file(self):
     #    self.assertIsNotNone(result.value)
 
     def test_14_delete_file(self):
-        items = self.target_drive.root.children.top(1).get().execute_query()
-        items[0].delete_object().execute_query()
+        items = self.target_drive.root.children.top(2).get().execute_query()
+        items[1].delete_object().execute_query()
diff --git a/tests/sharepoint/test_user_profile.py b/tests/sharepoint/test_user_profile.py
@@ -0,0 +1,14 @@
+from office365.sharepoint.userprofiles.profileLoader import ProfileLoader
+from tests.sharepoint.sharepoint_case import SPTestCase
+
+
+class TestUserProfile(SPTestCase):
+    profile_loader = None  # type: ProfileLoader
+
+    def test1_get_profile_loader(self):
+        profile_loader = ProfileLoader.get_profile_loader(self.client).execute_query()
+        self.__class__.profile_loader = profile_loader
+
+    def test2_get_profile_loader(self):
+        user_profile = self.__class__.profile_loader.get_user_profile().execute_query()
+        self.assertIsNotNone(user_profile.properties["AccountName"])
diff --git a/tests/teams/test_channel.py b/tests/teams/test_channel.py
@@ -51,18 +51,22 @@ def test5_get_primary_channel(self):
         primary_channel = self.__class__.target_team.primaryChannel.get().execute_query()
         self.assertIsNotNone(primary_channel.resource_path)
 
-    def test6_send_message(self):
+    #def test6_get_channel_files_location(self):
+    #    drive_item = self.__class__.target_channel.filesFolder.get().execute_query()
+    #    self.assertIsNotNone(drive_item.resource_path)
+
+    def test7_send_message(self):
         item_body = ItemBody("Hello world!")
         message = self.__class__.target_channel.messages.add(item_body).execute_query()
         self.assertIsNotNone(message.id)
         self.__class__.target_message = message
 
-    def test7_reply_to_message(self):
+    def test8_reply_to_message(self):
         item_body = ItemBody("Hello world back!")
         reply = self.__class__.target_message.replies.add(item_body).execute_query()
         self.assertIsNotNone(reply.id)
 
-    def test8_delete_channel(self):
+    def test9_delete_channel(self):
         channels_before = self.__class__.target_team.channels.get().execute_query()
         self.__class__.target_channel.delete_object().execute_query()
         channels_after = self.__class__.target_team.channels.get().execute_query()

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +from office365.entity import Entity
++
++
 +class DirectoryAudit(Entity):
 +    pass