Initial

Author: vgrem

Diff for: .gitignore

@@ -0,0 +1,62 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints

Diff for: .vs/SharePointOnline-REST-Python-Client/v14/.suo

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vadim Gremyachev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Diff for: LICENSE

@@ -0,0 +1,38 @@
+# About
+This is a SharePoint Online REST API client for Python
+
+
+# Installation
+
+Todo
+
+
+# Usage
+
+The first example demonstrates how to read Web client object
+
+```
+ctxAuth = AuthenticationContext(url)
+if ctxAuth.acquireTokenForUser(username, password):
+  request = ClientRequest(url,ctxAuth)
+  requestUrl = "/_api/web/"   #Web resource endpoint
+  data = request.executeQuery(requestUrl=requestUrl)
+
+  webTitle = data['d']['Title']
+  print "Web title: {0}".format(webTitle)
+
+else:
+  print ctxAuth.getLastErrorMessage()
+```
+
+# Python Version
+Python 2.7 is fully supported.
+
+
+# Third Party Libraries and Dependencies
+The following libraries will be installed when you install the client library:
+* [requests](https://github.com/kennethreitz/requests)
+
+
+
+

Diff for: README.md

@@ -0,0 +1 @@
+ 

Diff for: client/__init__.py

@@ -0,0 +1,27 @@
+<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+  <s:Header>
+    <a:Action s:mustUnderstand="1">http://schemas.xmlsoap.org/ws/2005/02/trust/RST/Issue</a:Action>
+    <a:ReplyTo>
+      <a:Address>http://www.w3.org/2005/08/addressing/anonymous</a:Address>
+    </a:ReplyTo>
+    <a:To s:mustUnderstand="1">https://login.microsoftonline.com/extSTS.srf</a:To>
+    <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
+      <o:UsernameToken>
+        <o:Username>[username]</o:Username>
+        <o:Password>[password]</o:Password>
+      </o:UsernameToken>
+    </o:Security>
+  </s:Header>
+  <s:Body>
+    <t:RequestSecurityToken xmlns:t="http://schemas.xmlsoap.org/ws/2005/02/trust">
+      <wsp:AppliesTo xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
+        <a:EndpointReference>
+          <a:Address>[endpoint]</a:Address>
+        </a:EndpointReference>
+      </wsp:AppliesTo>
+      <t:KeyType>http://schemas.xmlsoap.org/ws/2005/05/identity/NoProofKey</t:KeyType>
+      <t:RequestType>http://schemas.xmlsoap.org/ws/2005/02/trust/Issue</t:RequestType>
+      <t:TokenType>urn:oasis:names:tc:SAML:1.0:assertion</t:TokenType>
+    </t:RequestSecurityToken>
+  </s:Body>
+</s:Envelope>

Diff for: client/auth/SAML.xml

@@ -0,0 +1 @@
+ 

Diff for: client/auth/__init__.py

@@ -0,0 +1,110 @@
+import os
+from xml.etree import ElementTree
+
+import requests
+import requests.utils
+import urlparse
+
+
+class AuthenticationContext(object):
+    """SharePoint Online Authentication Context"""
+
+    def __init__(self, url):
+
+        self.url = url
+
+        # External Security Token Service for SPO
+        self.sts = {
+            'host': 'login.microsoftonline.com',
+            'path': '/extSTS.srf'
+        }
+
+        # Sign in page url
+        self.login = '/_forms/default.aspx?wa=wsignin1.0'
+
+        # Last occurred error
+        self.error = ''
+
+    def acquire_token_for_user(self, username, password):
+        """Acquire user token"""
+        try:
+            url = urlparse.urlparse(self.url)
+            options = {
+                'username': username,
+                'password': password,
+                'sts': self.sts,
+                'endpoint': url.scheme + '://' + url.hostname + self.login
+            }
+
+            if self.acquire_service_token(options) and self.acquire_authentication_cookie(options):
+                return True
+            return False
+        except requests.exceptions.RequestException as e:
+            self.error = "Error: {}".format(e)
+            return False
+
+    def get_authentication_cookie(self):
+        """Generate Auth Cookie"""
+        return 'FedAuth=' + self.FedAuth + '; rtFa=' + self.rtFa
+
+    def get_last_error(self):
+        return self.error
+
+    def acquire_service_token(self, options):
+        """Retrieve service token"""
+        samlMessage = self.prepare_saml_message({
+            'username': options['username'],
+            'password': options['password'],
+            'endpoint': self.url
+        })
+
+        stsUrl = 'https://' + options['sts']['host'] + options['sts']['path']
+        response = requests.post(stsUrl, data=samlMessage)
+        token = self.process_service_token_response(response)
+        if (token):
+            self.token = token
+            return True
+        return False
+
+    def process_service_token_response(self, response):
+        xml = ElementTree.fromstring(response.content)
+        nsPrefixes = {'S': '{http://www.w3.org/2003/05/soap-envelope}',
+                      'psf': '{http://schemas.microsoft.com/Passport/SoapServices/SOAPFault}',
+                      'wst': '{http://schemas.xmlsoap.org/ws/2005/02/trust}',
+                      'wsse': '{http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd}'}
+
+        # check for errors
+        if xml.find('{0}Body/{0}Fault'.format(nsPrefixes['S'])) is not None:
+            error = xml.find('{0}Body/{0}Fault/{0}Detail/{1}error/{1}internalerror/{1}text'.format(nsPrefixes['S'],
+                                                                                                   nsPrefixes['psf']))
+            self.error = 'An error occurred while retrieving token: {0}'.format(error.text)
+            return None
+
+        # extract token
+        token = xml.find(
+            '{0}Body/{1}RequestSecurityTokenResponse/{1}RequestedSecurityToken/{2}BinarySecurityToken'.format(
+                nsPrefixes['S'], nsPrefixes['wst'], nsPrefixes['wsse']))
+        return token.text
+
+    def acquire_authentication_cookie(self, options):
+        """Retrieve SPO auth cookie"""
+        url = options['endpoint']
+
+        session = requests.session()
+        response = session.post(url, data=self.token)
+        cookies = requests.utils.dict_from_cookiejar(session.cookies);
+        if 'FedAuth' in cookies and 'rtFa' in cookies:
+            self.FedAuth = cookies['FedAuth']
+            self.rtFa = cookies['rtFa']
+            return True
+        self.error = "An error occurred while retrieving auth cookies"
+        return False
+
+    @staticmethod
+    def prepare_saml_message(params):
+        """Read & prepare SAML envelope"""
+        f = open(os.path.join(os.path.dirname(__file__), 'SAML.xml'))
+        saml = f.read()
+        for key in params:
+            saml = saml.replace('[' + key + ']', params[key]);
+        return saml

Diff for: client/auth/authentication_context.py

@@ -0,0 +1,65 @@
+from site import Site
+from web import Web
+from client.client_object import ClientObject
+from client.runtime.client_action_type import ClientActionType
+from client.runtime.client_query import ClientQuery
+from client.runtime.client_request import ClientRequest
+
+
+class ClientContext(object):
+    """SharePoint client context"""
+
+    def __init__(self, url, auth_context):
+        self.__base_url = url
+        self.__auth_context = auth_context
+        self.__web = None
+        self.__site = None
+        self.__pending_request = None
+        self.__queries = []
+
+    @property
+    def web(self):
+        """Get Web client object"""
+        if not self.__web:
+            self.__web = Web(self)
+        return self.__web
+
+    @property
+    def site(self):
+        """Get Site client object"""
+        if not self.__site:
+            self.__site = Site(self)
+        return self.__site
+
+    @property
+    def pending_request(self):
+        if not self.__pending_request:
+            self.__pending_request = ClientRequest(self.__base_url, self.__auth_context)
+        return self.__pending_request
+
+    def load(self, client_object):
+        """Prepare query for the server"""
+        qry = ClientQuery(client_object.url, ClientActionType.Read)
+        qry.add_result_object(client_object)
+        self.add_query(qry)
+
+    def execute_query(self):
+        """Submit pending request to the server"""
+        for qry in self.__queries:
+            data = self.pending_request.execute_query(qry)
+            if any(data):
+                if 'results' in data['d']:
+                    for item in data['d']['results']:
+                        clientObject = ClientObject.create_typed_object(self, item)
+                        qry.result_object.add_child(clientObject)
+                else:
+                    qry.result_object.properties = data['d']
+            self.__queries.remove(qry)
+
+    def add_query(self, query):
+        self.__queries.append(query)
+
+    @property
+    def url(self):
+        """Get base url"""
+        return self.__base_url