Introduced support for SharePoint CAML queries

Author: vgrem

examples/settings.py

@@ -1,12 +1,12 @@
 settings = {
-    'url': 'https://mediadev20.sharepoint.com/sites/contoso',
-    'username': '[email protected]',
-    'password': 'P@ssw0rd'
+    'url': 'https://mediadev23.sharepoint.com',
+    'user_credentials': {
+        'username': '[email protected]',
+        'password': 'P@ssw0rd'
+    },
+    'client_credentials': {
+        'client_id': '',
+        'client_secret': '',
+        'redirect_url': 'https://github.com/vgrem/Office365-REST-Python-Client/'
+    }
 }
-
-app_settings = {
-    'url': 'https://mediadev20.sharepoint.com/sites/contoso',
-    'client_id': '99cbd1a9-ec8d-4e89-96c3-699993089d65',
-    'client_secret': 'VMdT8mOurDhsvG8yDnP3yFg',
-    'redirect_url': 'https://github.com/vgrem/Office365-REST-Python-Client/'
-}

examples/sharepoint_client_flow_auth.py

@@ -9,7 +9,6 @@
     'url': 'https://contoso.sharepoint.com/',
     'client_id': '8efc226b-ba3b-4def-a195-4acdb8d20ca9',
     'client_secret': '',
-    'redirect_url': 'https://github.com/vgrem/Office365-REST-Python-Client/'
 }
 
 

examples/view_operations.py

@@ -1,33 +1,56 @@
 from examples.settings import settings
 from office365.runtime.auth.authentication_context import AuthenticationContext
+from office365.sharepoint.caml_query import CamlQuery
 from office365.sharepoint.client_context import ClientContext
 
-
-listTitle = "Documents"
+list_title = "Documents"
+view_title = "All Documents"
 
 
 def print_list_views(ctx):
     """Read list view by title example"""
-    list_object = ctx.web.lists.get_by_title(listTitle)
+    list_object = ctx.web.lists.get_by_title(list_title)
     views = list_object.views
     ctx.load(views)
     ctx.execute_query()
     for view in views:
         # print "View title: {0}".format(view.Properties["Title"])
 
-        viewTitle = view.properties["Title"]
-        curView = views.get_by_title(viewTitle)
-        ctx.load(curView)
+        cur_view_title = view.properties["Title"]
+        cur_view = views.get_by_title(cur_view_title)
+        ctx.load(cur_view)
         ctx.execute_query()
-        print("View title: {0}".format(curView.properties["Title"]))
+        print("View title: {0}".format(cur_view.properties["Title"]))
+
+
+def print_view_items(ctx):
+    """Example demonstrates how to retrieve View items"""
+
+    list_object = ctx.web.lists.get_by_title(list_title)
+    # 1.get View query
+    view = list_object.views.get_by_title(view_title)
+    ctx.load(view, "ViewQuery")
+    ctx.execute_query()
+
+    # 2.get items for View query
+    qry = CamlQuery()
+    qry.ViewXml = "<View><Where>{0}</Where></View>".format(view.properties["ViewQuery"])
+    items = list_object.get_items(qry)
+    ctx.load(items)
+    ctx.execute_query()
+
+    for item in items:
+        print("Item title: {0}".format(item.properties["Title"]))
 
 
 if __name__ == '__main__':
-    ctxAuth = AuthenticationContext(url=settings['url'])
-    if ctxAuth.acquire_token_for_user(username=settings['username'], password=settings['password']):
-        ctx = ClientContext(settings['url'], ctxAuth)
+    ctx_auth = AuthenticationContext(url=settings['url'])
+    if ctx_auth.acquire_token_for_app(client_id=settings['client_credentials']['client_id'],
+                                      client_secret=settings['client_credentials']['client_secret']):
+        ctx = ClientContext(settings['url'], ctx_auth)
 
-        print_list_views(ctx)
+        # print_list_views(ctx)
+        print_view_items(ctx)
 
     else:
-        print(ctxAuth.get_last_error())
+        print(ctx_auth.get_last_error())

examples/web_operations.py

@@ -48,7 +48,8 @@ def list_site_users(ctx):
 
 if __name__ == '__main__':
     ctxAuth = AuthenticationContext(url=settings['url'])
-    if ctxAuth.acquire_token_for_user(username=settings['username'], password=settings['password']):
+    if ctxAuth.acquire_token_for_user(username=settings['user_credentials']['username'],
+                                      password=settings['user_credentials']['password']):
         ctx = ClientContext(settings['url'], ctxAuth)
         # web = load_web(ctx)
         web = create_web(ctx)

examples/web_read_direct.py

@@ -8,7 +8,8 @@
 
 if __name__ == '__main__':
     context_auth = AuthenticationContext(url=settings['url'])
-    if context_auth.acquire_token_for_user(username=settings['username'], password=settings['password']):
+    if context_auth.acquire_token_for_user(username=settings['user_credentials']['username'],
+                                           password=settings['user_credentials']['password']):
         """Read Web client object"""
         ctx = ClientContext(settings['url'], context_auth)
 

office365/sharepoint/caml_query.py

@@ -0,0 +1,30 @@
+from office365.runtime.client_value_object import ClientValueObject
+
+
+class CamlQuery(ClientValueObject):
+    """Specifies a Collaborative Application Markup Language (CAML) query on a list or joined lists."""
+
+    def __init__(self):
+        super(CamlQuery, self).__init__()
+        self.DatesInUtc = None
+        self.FolderServerRelativeUrl = None
+        self.ViewXml = None
+        self.metadata_type = "SP.CamlQuery"
+
+    @staticmethod
+    def create_all_items_query():
+        qry = CamlQuery()
+        qry.view_xml = "<View Scope=\"RecursiveAll\"><Query></Query></View>"
+        return qry
+
+    @staticmethod
+    def create_all_folders_query():
+        qry = CamlQuery()
+        qry.view_xml = "<View Scope=\"RecursiveAll\"><Query>" \
+                       "<Where><Eq><FieldRef Name=\"FSObjType\" /><Value Type=\"Integer\">1</Value></Eq></Where>" \
+                       "</Query></View>"
+        return qry
+
+    @property
+    def payload(self):
+        return {'query': super(CamlQuery, self).payload}

office365/sharepoint/list.py

@@ -16,9 +16,12 @@
 class List(SecurableObject):
     """List client object"""
 
-    def get_items(self):
+    def get_items(self, caml_query=None):
         """Returns a collection of items from the list based on the specified query."""
         items = ListItemCollection(self.context, ResourcePathEntry(self.context, self.resource_path, "items"))
+        if caml_query:
+            qry = ClientQuery.service_operation_query(self, ActionType.PostMethod, "GetItems", None, caml_query.payload)
+            self.context.add_query(qry, items)
         return items
 
     def add_item(self, list_item_creation_information):

setup.py

@@ -11,7 +11,7 @@ def read(fname):
 
 setup(
     name="Office365-REST-Python-Client",
-    version="2.1.0",
+    version="2.1.1",
     author="Vadim Gremyachev",
     author_email="[email protected]",
     maintainer="Konrad Gądek",

tests/outlook_client_case.py

@@ -9,5 +9,6 @@ class OutlookClientTestCase(TestCase):
 
     @classmethod
     def setUpClass(cls):
-        ctx_auth = NetworkCredentialContext(username=settings['username'], password=settings['password'])
+        ctx_auth = NetworkCredentialContext(username=settings['user_credentials']['username'],
+                                            password=settings['user_credentials']['password'])
         cls.client = OutlookClient(ctx_auth)

tests/sharepoint_case.py

@@ -10,6 +10,7 @@ class SPTestCase(TestCase):
     @classmethod
     def setUpClass(cls):
         ctx_auth = AuthenticationContext(url=settings['url'])
-        ctx_auth.acquire_token_for_user(username=settings['username'], password=settings['password'])
+        ctx_auth.acquire_token_for_user(username=settings['user_credentials']['username'],
+                                        password=settings['user_credentials']['password'])
         cls.context = ClientContext(settings['url'], ctx_auth)