SharePoint API: improved support for fields namespace (#137)

Author: vvgrem@gmail.com

examples/directory/import_users.py

@@ -0,0 +1,44 @@
+from faker import Faker
+from office365.graph.directory.userProfile import UserProfile
+from office365.graph.graph_client import GraphClient
+from settings import settings
+from tests import random_seed
+
+
+def acquire_token(auth_ctx):
+    """
+
+    :type auth_ctx: adal.AuthenticationContext
+    """
+    token = auth_ctx.acquire_token_with_username_password(
+        'https://graph.microsoft.com',
+        settings['user_credentials']['username'],
+        settings['user_credentials']['password'],
+        settings['client_credentials']['client_id'])
+    return token
+
+
+def generate_user_profile():
+    fake = Faker()
+
+    user_json = {
+        'givenName': fake.name(),
+        'companyName': fake.company(),
+        'businessPhones': [fake.phone_number()],
+        'officeLocation': fake.street_address(),
+        'city': fake.city(),
+        'country': fake.country(),
+        'principalName': "{0}@{1}".format(fake.user_name(), settings['tenant']),
+        'password': "P@ssw0rd{0}".format(random_seed),
+        'accountEnabled': True
+    }
+    return UserProfile(**user_json)
+
+
+client = GraphClient(settings['tenant'], acquire_token)
+
+for idx in range(0, 5):
+    user_profile = generate_user_profile()
+    user = client.users.add(user_profile)
+    client.execute_query()
+    print("{0} user has been created".format(user.properties['userPrincipalName']))

examples/sharepoint/data_generator.py

@@ -2,12 +2,11 @@
 from faker import Faker
 from office365.runtime.auth.userCredential import UserCredential
 from office365.sharepoint.client_context import ClientContext
-from office365.sharepoint.list_creation_information import ListCreationInformation
-from office365.sharepoint.list_template_type import ListTemplateType
+from office365.sharepoint.lists.list_creation_information import ListCreationInformation
+from office365.sharepoint.lists.list_template_type import ListTemplateType
 
 
 def ensure_list(web, list_properties):
-    ctx = web.context
     lists = web.lists.filter("Title eq '{0}'".format(list_properties.Title))
     ctx.load(lists)
     ctx.execute_query()

examples/sharepoint/download_file_from_url.py

@@ -2,7 +2,7 @@
 import tempfile
 
 from office365.runtime.auth.userCredential import UserCredential
-from office365.sharepoint.file import File
+from office365.sharepoint.files.file import File
 from settings import settings
 
 abs_file_url = "{site_url}sites/team/Shared Documents/sample.docx".format(site_url=settings.get('url'))

generator/metadata/MicrosoftGraph.xml

@@ -1,5 +1,5 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class AuditActivityInitiator(ClientValueObject):
+class AuditActivityInitiator(ClientValue):
     pass

office365/graph/directory/auditActivityInitiator.py

@@ -1,7 +1,7 @@
 from office365.graph.entity import Entity
 from office365.runtime.client_query import DeleteEntityQuery, UpdateEntityQuery
 from office365.runtime.client_result import ClientResult
-from office365.runtime.serviceOperationQuery import ServiceOperationQuery
+from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 
 
 class DirectoryObject(Entity):

office365/graph/directory/directoryObject.py

@@ -3,7 +3,7 @@
 from office365.runtime.client_result import ClientResult
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.resource_path import ResourcePath
-from office365.runtime.serviceOperationQuery import ServiceOperationQuery
+from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 
 
 class DirectoryObjectCollection(ClientObjectCollection):

office365/graph/directory/directoryObjectCollection.py

@@ -6,7 +6,7 @@
 from office365.graph.onedrive.siteCollection import SiteCollection
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.resource_path import ResourcePath
-from office365.runtime.serviceOperationQuery import ServiceOperationQuery
+from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 from office365.graph.teams.team import Team
 
 

office365/graph/directory/group.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class GroupProfile(ClientValueObject):
+class GroupProfile(ClientValue):
     def __init__(self, name):
         """
 

office365/graph/directory/groupProfile.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class Identity(ClientValueObject):
+class Identity(ClientValue):
     """The Identity resource represents an identity of an actor. For example, an actor can be a user, device,
     or application. """
 

office365/graph/directory/identity.py

@@ -1,8 +1,8 @@
 from office365.graph.directory.identity import Identity
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class IdentitySet(ClientValueObject):
+class IdentitySet(ClientValue):
     """The IdentitySet resource is a keyed collection of identity resources. It is used to represent a set of
     identities associated with various events for an item, such as created by or last modified by. """
 

office365/graph/directory/identitySet.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class PasswordProfile(ClientValueObject):
+class PasswordProfile(ClientValue):
     """Contains the password profile associated with a user. The passwordProfile property of the user entity is a
     passwordProfile object. """
     def __init__(self, password):

office365/graph/directory/passwordProfile.py

@@ -6,7 +6,7 @@
 from office365.outlookservices.event_collection import EventCollection
 from office365.outlookservices.messageCollection import MessageCollection
 from office365.runtime.resource_path import ResourcePath
-from office365.runtime.serviceOperationQuery import ServiceOperationQuery
+from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 
 
 class User(DirectoryObject):

office365/graph/directory/user.py

@@ -1,8 +1,8 @@
 from office365.graph.directory.passwordProfile import PasswordProfile
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class UserProfile(ClientValueObject):
+class UserProfile(ClientValue):
     def __init__(self, principal_name, password, display_name=None, account_enabled=False):
         """
         User profile

office365/graph/directory/userProfile.py

@@ -2,7 +2,7 @@
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_object import ClientObject
 from office365.graph.resource_path_url import ResourcePathUrl
-from office365.runtime.serviceOperationQuery import ServiceOperationQuery
+from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 
 
 class DownloadContentQuery(ServiceOperationQuery):

office365/graph/one_drive_actions.py

@@ -10,7 +10,7 @@
 from office365.runtime.resource_path import ResourcePath
 from office365.graph.base_item import BaseItem
 from office365.graph.onedrive.listItem import ListItem
-from office365.runtime.serviceOperationQuery import ServiceOperationQuery
+from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 from office365.graph.onedrive.itemReference import ItemReference
 
 

office365/graph/onedrive/driveItem.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class DriveItemUploadableProperties(ClientValueObject):
+class DriveItemUploadableProperties(ClientValue):
     """The driveItemUploadableProperties resource represents an item being uploaded when creating an upload session."""
 
     def __init__(self):

office365/graph/onedrive/driveItemUploadableProperties.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class DriveRecipient(ClientValueObject):
+class DriveRecipient(ClientValue):
 
     def __init__(self):
         super(DriveRecipient, self).__init__()

office365/graph/onedrive/driveRecipient.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class File(ClientValueObject):
+class File(ClientValue):
 
     def __init__(self):
         super(File, self).__init__()

office365/graph/onedrive/file.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class FileSystemInfo(ClientValueObject):
+class FileSystemInfo(ClientValue):
     """The FileSystemInfo resource contains properties that are reported by the device's local file system for the
     local version of an item. """
 

office365/graph/onedrive/fileSystemInfo.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class Folder(ClientValueObject):
+class Folder(ClientValue):
 
     def __init__(self):
         super(Folder, self).__init__()

office365/graph/onedrive/folder.py

@@ -1,5 +1,5 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class ItemReference(ClientValueObject):
+class ItemReference(ClientValue):
     """The ItemReference resource provides information necessary to address a DriveItem via the API."""

office365/graph/onedrive/itemReference.py

@@ -1,6 +1,6 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class Photo(ClientValueObject):
+class Photo(ClientValue):
     """The photo resource provides photo and camera properties, for example, EXIF metadata, on a driveItem."""
     pass

office365/graph/onedrive/photo.py

@@ -1,5 +1,5 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class Root(ClientValueObject):
+class Root(ClientValue):
     """Root container """

office365/graph/onedrive/root.py

@@ -1,6 +1,6 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class SharePointIds(ClientValueObject):
+class SharePointIds(ClientValue):
     """The SharePointIds resource groups the various identifiers for an item stored in a SharePoint site or OneDrive
     for Business into a single structure. """

office365/graph/onedrive/sharepointIds.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class SiteCollectionType(ClientValueObject):
+class SiteCollectionType(ClientValue):
     """The siteCollection resource provides more information about a site collection. """
 
     def __init__(self):

office365/graph/onedrive/siteCollectionType.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class UploadSession(ClientValueObject):
+class UploadSession(ClientValue):
     """The UploadSession resource provides information about how to upload large files to OneDrive, OneDrive for
     Business, or SharePoint document libraries. """
 

office365/graph/onedrive/uploadSession.py

@@ -1,6 +1,6 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class Video(ClientValueObject):
+class Video(ClientValue):
     """The Video resource groups video-related data items into a single structure."""
     pass

office365/graph/onedrive/video.py

@@ -1,7 +1,7 @@
 from office365.graph.entity import Entity
 from office365.runtime.client_query import UpdateEntityQuery
 from office365.runtime.resource_path import ResourcePath
-from office365.runtime.serviceOperationQuery import ServiceOperationQuery
+from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 from office365.graph.teams.channel import Channel
 from office365.graph.teams.channelCollection import ChannelCollection
 from office365.graph.teams.teamFunSettings import TeamFunSettings

office365/graph/teams/team.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class TeamFunSettings(ClientValueObject):
+class TeamFunSettings(ClientValue):
     """Settings to configure use of Giphy, memes, and stickers in the team."""
 
     def __init__(self):

office365/graph/teams/teamFunSettings.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class TeamGuestSettings(ClientValueObject):
+class TeamGuestSettings(ClientValue):
 
     def __init__(self):
         super().__init__()

office365/graph/teams/teamGuestSettings.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class TeamMemberSettings(ClientValueObject):
+class TeamMemberSettings(ClientValue):
     """Settings to configure whether members can perform certain actions, for example, create channels and add bots,
     in the team. """
 

office365/graph/teams/teamMemberSettings.py

@@ -1,7 +1,7 @@
-from office365.runtime.client_value_object import ClientValueObject
+from office365.runtime.clientValue import ClientValue
 
 
-class TeamMessagingSettings(ClientValueObject):
+class TeamMessagingSettings(ClientValue):
 
     def __init__(self):
         super().__init__()

office365/graph/teams/teamMessagingSettings.py

@@ -1,5 +1,5 @@
 from office365.outlookservices.item import Item
-from office365.runtime.serviceOperationQuery import ServiceOperationQuery
+from office365.runtime.queries.serviceOperationQuery import ServiceOperationQuery
 
 
 class Message(Item):

office365/outlookservices/message.py

@@ -1,13 +1,16 @@
-class ClientValueObject(object):
-    """Base client value object"""
+class ClientValue(object):
+    """Represent complex type.
+    Complex types consist of a list of properties with no key, and can therefore only exist as properties of a
+    containing entity or as a temporary value
+    """
 
     def __init__(self):
-        super(ClientValueObject, self).__init__()
+        super(ClientValue, self).__init__()
 
     def set_property(self, k, v, persist_changes=True):
         if hasattr(self, k):
             prop_type = getattr(self, k)
-            if isinstance(prop_type, ClientValueObject):
+            if isinstance(prop_type, ClientValue):
                 [prop_type.set_property(k, v, persist_changes) for k, v in v.items()]
                 setattr(self, k, prop_type)
             else:

office365/runtime/client_value_object.py renamed to office365/runtime/clientValue.py

@@ -0,0 +1,15 @@
+from office365.runtime.clientValue import ClientValue
+
+
+class ClientValueCollection(ClientValue):
+
+    def __init__(self):
+        super().__init__()
+        self._data = []
+
+    def add(self, value):
+        self._data.append(value)
+
+    def __iter__(self):
+        for item in self._data:
+            yield item