SharePoint API: introduced SearchService API support, bug fixes (#210 and #213)

Author: [email protected]

.travis.yml

@@ -34,4 +34,3 @@ jobs:
           tags: true
           python: 3.6
           repo: "vgrem/Office365-REST-Python-Client"
-          twine_version: 3.1.1

examples/sharepoint/AppPermissionRequests.xml

@@ -1,3 +1,4 @@
 <AppPermissionRequests AllowAppOnlyPolicy="true">
-     <AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web" Right="Read"/>
+     <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" />
+     <AppPermissionRequest Scope="http://sharepoint/search" Right="QueryAsUserIgnoreAppPrincipal"/>
 </AppPermissionRequests>

examples/sharepoint/connect_with_app.py

@@ -2,12 +2,14 @@
 from office365.sharepoint.client_context import ClientContext
 from settings import settings
 
-ctx = ClientContext.connect_with_credentials(settings['url'],
-                                             ClientCredential(settings['client_credentials']['client_id'],
-                                                              settings['client_credentials']['client_secret']))
+credentials = ClientCredential(settings['client_credentials']['client_id'],
+                               settings['client_credentials']['client_secret'])
+ctx = ClientContext(settings['url']).with_credentials(credentials)
+if not ctx.authentication_context.acquire_token():
+    print("Acquire token failed")
+
 
 target_web = ctx.web
 ctx.load(target_web)
 ctx.execute_query()
-
-
+print(target_web.url)

examples/sharepoint/requirements.txt

@@ -1,5 +1,4 @@
-import ast
-
+from generator.typeBuilder import TypeBuilder
 from office365.runtime.odata.odata_v3_reader import ODataV3Reader
 from office365.runtime.odata.odata_v4_reader import ODataV4Reader
 
@@ -10,9 +9,9 @@ def generate_files(model):
 
 
 def generate_type_file(type_schema):
-    if type_schema['state'] == 'attached':
-        tree = ast.parse(open(type_schema['file']).read())
-        print(type_schema['file'])
+    builder = TypeBuilder(type_schema)
+    if builder.build():
+        builder.save()
 
 
 def generate_sharepoint_model():

generator/generate.py

@@ -0,0 +1,21 @@
+import ast
+import astunparse
+
+
+class TypeBuilder(object):
+
+    def __init__(self, schema):
+        self._schema = schema
+        self._node = None
+
+    def build(self):
+        if self._schema['state'] == 'attached':
+            with open(self._schema['file']) as f:
+                self._node = ast.parse(f.read())
+            return True
+        return False
+
+    def save(self):
+        code = astunparse.unparse(self._node)
+        with open(self._schema['file']) as f:
+            f.write(code)

generator/metadata/SharePoint.xml

@@ -10,17 +10,38 @@
 
 class OutlookClient(ClientRuntimeContext):
 
-    def __init__(self, ctx_auth):
+    def __init__(self, auth_context):
         """
         Office365 Outlook client context
         Status: deprecated, prefer GraphClient instead
 
-        :type ctx_auth: AuthenticationContext
+        :type auth_context: AuthenticationContext
         """
-        self.__service_root_url = "https://outlook.office365.com/api/v1.0/"
-        super(OutlookClient, self).__init__(self.__service_root_url, ctx_auth)
+        self._resource = "https://outlook.office365.com"
+        self.__service_root_url = "{resource}/api/v1.0/".format(resource=self._resource)
+        super(OutlookClient, self).__init__(self.__service_root_url, auth_context)
         self._pendingRequest = ODataRequest(self, V4JsonFormat("minimal"))
         self._pendingRequest.beforeExecute += self._build_specific_query
+        self._token_parameters = None
+
+    @classmethod
+    def from_tenant(cls, tenant):
+        return OutlookClient(AuthenticationContext(tenant))
+
+    def with_user_credentials(self, client_id, user_name, password):
+        self._token_parameters = {
+            "client_id": client_id,
+            "username": user_name,
+            "password": password,
+            "resource": self._resource,
+            "scope": ("openid", "profile", "offline_access")
+        }
+        return self
+
+    def authenticate_request(self, request):
+        if not self._auth_context.is_authenticated:
+            self._auth_context.acquire_token_password_grant(**self._token_parameters)
+        super(OutlookClient, self).authenticate_request(request)
 
     def get_pending_request(self):
         return self._pendingRequest

generator/templates/__init__.py

@@ -12,7 +12,7 @@ class AuthenticationContext(BaseAuthenticationContext):
 
     def __init__(self, url, credentials=None):
         """
-        Authentication context for SharePoint Online/One Drive
+        Authentication context for SharePoint Online/OneDrive
 
         :param str url:  authority url
         :param ClientCredential or UserCredential credentials: credentials
@@ -33,9 +33,9 @@ def set_token(self, token):
 
     def acquire_token(self):
         if isinstance(self.credentials, ClientCredential):
-            self.acquire_token_for_app(self.credentials.clientId, self.credentials.clientSecret)
+            return self.acquire_token_for_app(self.credentials.clientId, self.credentials.clientSecret)
         elif isinstance(self.credentials, UserCredential):
-            self.acquire_token_for_user(self.credentials.userName, self.credentials.password)
+            return self.acquire_token_for_user(self.credentials.userName, self.credentials.password)
         else:
             raise ValueError("Unknown credential type")
 
@@ -48,19 +48,30 @@ def acquire_token_for_user(self, username, password):
         self.provider = SamlTokenProvider(self.url, username, password)
         if not self.provider.acquire_token():
             raise ValueError('Acquire token failed: {0}'.format(self.provider.error))
+        return True
 
     def acquire_token_for_app(self, client_id, client_secret):
         """Acquire token via client credentials (SharePoint App Principal)"""
         self.provider = ACSTokenProvider(self.url, client_id, client_secret)
         if not self.provider.acquire_token():
             raise ValueError('Acquire token failed: {0}'.format(self.provider.error))
+        return True
 
-    def acquire_token_password_grant(self, client_credentials, user_credentials):
-        """Acquire token via resource owner password credential (ROPC) grant"""
+    def acquire_token_password_grant(self, client_id, username, password, resource, scope):
+        """
+        Acquire token via resource owner password credential (ROPC) grant
+
+        :param str resource: A URI that identifies the resource for which the token is valid.
+        :param str username: : The username of the user on behalf this application is authenticating.
+        :param str password: The password of the user named in the username parameter.
+        :param str client_id: str The OAuth client id of the calling application.
+        :param list[str] scope:
+        """
         self.provider = OAuthTokenProvider(self.url)
-        return self.provider.acquire_token_password_type("https://outlook.office365.com",
-                                                         client_credentials,
-                                                         user_credentials)
+        return self.provider.acquire_token_password_type(resource=resource,
+                                                         client_id=client_id,
+                                                         user_credentials=UserCredential(username, password),
+                                                         scope=scope)
 
     def authenticate_request(self, request_options):
         """Authenticate request