OneDrive: sitepages namespace enhancements, support for Prefer header

Author: vgrem

examples/directory/applications/has_delegated_perms.py

@@ -17,11 +17,14 @@
 )
 
 resource = client.service_principals.get_by_name("Microsoft Graph")
-scope = "FileStorageContainer.Selected"
+scope = "BackupRestore-Control.Read.All"
 user = client.users.get_by_principal_name(test_admin_principal_name)
 client_app = client.applications.get_by_app_id(test_client_id)
 result = resource.get_delegated_permissions(test_client_id).execute_query()
-if len([cur_scope for cur_scope in result.value if cur_scope == scope]) == 0:
+found_scope = next(
+    (cur_scope for cur_scope in result.value if cur_scope == scope), None
+)
+if found_scope is None:
     print("Delegated permission '{0}' is not granted".format(scope))
 else:
     print(result.value)

examples/onedrive/files/get_by_abs_url.py

@@ -18,6 +18,4 @@
 )
 
 file_item = client.shares.by_url(file_abs_url).drive_item.get().execute_query()
-
-result = file_item.get_content().execute_query()
-print(result.value)
+print(file_item.id)

office365/onedrive/contenttypes/collection.py

@@ -6,6 +6,8 @@
 
 
 class ContentTypeCollection(EntityCollection[ContentType]):
+    """Content type collection"""
+
     def __init__(self, context, resource_path):
         super(ContentTypeCollection, self).__init__(context, ContentType, resource_path)
 

office365/onedrive/driveitems/publication_facet.py

@@ -1,8 +1,12 @@
+from office365.directory.permissions.identity_set import IdentitySet
 from office365.runtime.client_value import ClientValue
 
 
 class PublicationFacet(ClientValue):
-    def __init__(self, level=None, version_id=None):
+    """The publicationFacet resource provides details on the published status of a driveItemVersion or driveItem
+    resource."""
+
+    def __init__(self, checked_out_by=IdentitySet(), level=None, version_id=None):
         """
         The publicationFacet resource provides details on the published status of a driveItemVersion
         or driveItem resource.
@@ -11,5 +15,6 @@ def __init__(self, level=None, version_id=None):
         :param str version_id: The unique identifier for the version that is visible to the current caller. Read-only.
         """
         super(PublicationFacet, self).__init__()
+        self.checkedOutBy = checked_out_by
         self.level = level
         self.versionId = version_id

office365/onedrive/listitems/collection.py

@@ -0,0 +1,34 @@
+from office365.entity_collection import EntityCollection
+from office365.onedrive.listitems.list_item import ListItem
+from office365.runtime.http.request_options import RequestOptions
+
+
+class ListItemCollection(EntityCollection[ListItem]):
+    """List Item's collection"""
+
+    def __init__(self, context, resource_path):
+        super(ListItemCollection, self).__init__(context, ListItem, resource_path)
+        self._honor_nonindexed = False
+
+    def honor_nonindexed(self, value):
+        # type: (bool) -> "ListItemCollection"
+        """Sets if true HonorNonIndexedQueriesWarningMayFailRandomly header
+        to allow non-indexed properties to be queried."""
+        self._honor_nonindexed = value
+        return self
+
+    def get(self):
+        """Retrieve a list item"""
+
+        def _construct_request(request):
+            # type: (RequestOptions) -> None
+            if self._honor_nonindexed:
+                request.headers["Prefer"] = (
+                    "HonorNonIndexedQueriesWarningMayFailRandomly"
+                )
+
+        return super(ListItemCollection, self).get().before_execute(_construct_request)
+
+    def get_by_name(self, name):
+        """Retrieve a list item by name"""
+        return self.single("fields/FileLeafRef eq '{0}'".format(name))

office365/onedrive/lists/list.py

@@ -4,7 +4,7 @@
 from office365.onedrive.base_item import BaseItem
 from office365.onedrive.columns.definition_collection import ColumnDefinitionCollection
 from office365.onedrive.contenttypes.collection import ContentTypeCollection
-from office365.onedrive.listitems.list_item import ListItem
+from office365.onedrive.listitems.collection import ListItemCollection
 from office365.onedrive.lists.info import ListInfo
 from office365.onedrive.operations.rich_long_running import RichLongRunningOperation
 from office365.onedrive.sharepoint_ids import SharePointIds
@@ -68,13 +68,11 @@ def content_types(self):
 
     @property
     def items(self):
-        # type: () -> EntityCollection[ListItem]
+        # type: () -> ListItemCollection
         """All items contained in the list."""
         return self.properties.get(
             "items",
-            EntityCollection(
-                self.context, ListItem, ResourcePath("items", self.resource_path)
-            ),
+            ListItemCollection(self.context, ResourcePath("items", self.resource_path)),
         )
 
     @property

office365/onedrive/sitepages/base.py

@@ -30,3 +30,11 @@ def title(self):
         # type: () -> Optional[str]
         """Title of the sitePage."""
         return self.properties.get("title", None)
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "publishingState": self.publishing_state,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(BaseSitePage, self).get_property(name, default_value)

office365/onedrive/sitepages/collection.py

@@ -19,13 +19,19 @@ def _construct_request(request):
         return super(SitePageCollection, self).get().before_execute(_construct_request)
 
     def get_by_name(self, name):
+        """Get a sitePage by name."""
         return self.single("name eq '{0}'".format(name))
 
-    def add(self, title):
+    def get_by_title(self, title):
+        """Get a sitePage by title."""
+        return self.single("title eq '{0}'".format(title))
+
+    def add(self, title, page_layout="article"):
         """
         Create a new sitePage in the site pages list in a site.
 
         :param str title:
+        :param str page_layout:
         """
 
         def _construct_request(request):
@@ -37,7 +43,7 @@ def _construct_request(request):
             .add(
                 title=title,
                 name="{0}.aspx".format(title),
-                pageLayout="article",
+                pageLayout=page_layout,
                 titleArea=TitleArea(),
             )
             .before_execute(_construct_request)

office365/onedrive/sitepages/site_page.py

@@ -15,7 +15,11 @@ class SitePage(BaseSitePage):
     webParts."""
 
     def get_web_parts_by_position(
-        self, web_part_index, horizontal_section_id, is_in_vertical_section, column_id
+        self,
+        web_part_index=None,
+        horizontal_section_id=None,
+        is_in_vertical_section=None,
+        column_id=None,
     ):
         """
         Get a collection of webPart by providing webPartPosition information.
@@ -40,6 +44,13 @@ def get_web_parts_by_position(
         self.context.add_query(qry)
         return return_type
 
+    def checkin(self):
+        """
+        Check in the latest version of a sitePage resource, which makes the version of the page available to all users.
+        If the page is checked out, check in the page and publish it. If the page is checked out to the caller
+        of this API, the page is automatically checked in and then published."""
+        return self
+
     def publish(self):
         """
         Publish the latest version of a sitePage resource, which makes the version of the page available to all users.
@@ -49,7 +60,7 @@ def publish(self):
         If a page approval flow has been activated in the page library, the page is not published until the approval
         flow is completed.
         """
-        qry = ServiceOperationQuery(self, "publish")
+        qry = ServiceOperationQuery(self, "microsoft.graph.sitePage/publish")
         self.context.add_query(qry)
         return self
 

tests/onedrive/test_sitepage.py

@@ -1,23 +1,85 @@
-from tests import test_team_site_url
+from office365.onedrive.sitepages.site_page import SitePage
+from tests import create_unique_name, test_team_site_url
 from tests.graph_case import GraphTestCase
 
 
 class TestSitePage(GraphTestCase):
     """OneDrive specific test case base class"""
 
+    target_page = None  # type: SitePage
+
     @classmethod
     def setUpClass(cls):
         super(TestSitePage, cls).setUpClass()
         cls.test_site = cls.client.sites.get_by_url(test_team_site_url)
+        cls.page_name = create_unique_name("Test Page")
 
     @classmethod
     def tearDownClass(cls):
         pass
 
-    def test1_list_site_pages(self):
+    def test1_create_site_page(self):
+        result = self.test_site.pages.add(self.page_name).execute_query()
+        self.assertIsNotNone(result.resource_path)
+        self.__class__.target_page = result
+
+    def test2_get_site_page(self):
+        page = self.__class__.target_page
+        result = page.get().execute_query()
+        self.assertIsNotNone(result.resource_path)
+
+    def test3_checkin_site_page(self):
+        page_name = self.__class__.target_page.name
+        pages_list = self.test_site.lists.get_by_name("Site Pages")
+        list_item = (
+            pages_list.items.honor_nonindexed(True)
+            .get_by_name(page_name)
+            .execute_query()
+        )
+        list_item.drive_item.checkin("Initial version").execute_query()
+        self.assertIsNotNone(list_item.resource_path)
+
+    def test4_get_site_page_pub_state(self):
+        page = self.__class__.target_page
+        result = page.get().select(["publishingState"]).execute_query()
+        self.assertIsNotNone(result.publishing_state.level)
+
+    # def test5_publish_site_page(self):
+    #    page = self.__class__.target_page
+    #    result = page.publish().execute_query()
+    #    self.assertIsNotNone(result.resource_path)
+
+    def test6_list_site_pages(self):
         result = self.test_site.pages.top(10).get().execute_query()
         self.assertIsNotNone(result.resource_path)
 
-    # def test2_get_site_page_by_name(self):
-    #    result = self.test_site.pages.get_by_name("Home.aspx").execute_query()
+    # def test7_get_site_page_by_name(self):
+    #    result = self.test_site.pages.get_by_name(self.page_name).execute_query()
     #    self.assertIsNotNone(result.resource_path)
+
+    # def test8_get_site_page_by_title(self):
+    #    page = self.__class__.target_page
+    #    result = self.test_site.pages.get_by_title(page.title).execute_query()
+    #    self.assertIsNotNone(result.resource_path)
+
+    # def test9_get_web_parts_by_position(self):
+    #    page = self.__class__.target_page
+    #    result = page.get_web_parts_by_position().execute_query()
+    #    self.assertIsNotNone(result.resource_path)
+
+    def test_10_delete_site_page(self):
+        page = self.__class__.target_page
+        page.delete_object().execute_query()
+
+    def test_11_get_site_page_list(self):
+        result = self.test_site.lists.get_by_name("Site Pages").get().execute_query()
+        self.assertIsNotNone(result.resource_path)
+
+    def test_12_get_site_page_item_by_name(self):
+        pages_list = self.test_site.lists.get_by_name("Site Pages")
+        result = (
+            pages_list.items.honor_nonindexed(True)
+            .get_by_name("Home.aspx")
+            .execute_query()
+        )
+        self.assertIsNotNone(result.resource_path)