Merge pull request #18 from linkedin/requests

Changed out the connection logic to use requests instead of urllib2 - hooray

Author: Rachel Sanders

pyexchange/connection.py

@@ -4,19 +4,10 @@
 
 Unless required by applicable law or agreed to in writing, software?distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 """
-import logging
-import sys
-from ntlm import HTTPNtlmAuthHandler
-
-try:
-  import urllib2
-except ImportError:  # Python 3
-  import urllib.request as urllib2
+import requests
+from requests_ntlm import HttpNtlmAuth
 
-try:
-  from httplib import HTTPException
-except ImportError:  # Python 3
-  from http.client import HTTPException
+import logging
 
 from .exceptions import FailedExchangeException
 
@@ -39,7 +30,7 @@ def __init__(self, url, username, password, **kwargs):
     self.password = password
 
     self.handler = None
-    self.opener = None
+    self.session = None
     self.password_manager = None
 
   def build_password_manager(self):
@@ -48,85 +39,35 @@ def build_password_manager(self):
 
     log.debug(u'Constructing password manager')
 
-    self.password_manager = urllib2.HTTPPasswordMgrWithDefaultRealm()
-    self.password_manager.add_password(None, self.url, self.username, self.password)
+    self.password_manager = HttpNtlmAuth(self.username, self.password)
 
     return self.password_manager
 
-  def build_handler(self):
-    if self.handler:
-      return self.handler
+  def build_session(self):
+    if self.session:
+      return self.session
 
-    log.debug(u'Constructing handler')
+    log.debug(u'Constructing opener')
 
     self.password_manager = self.build_password_manager()
-    self.handler = HTTPNtlmAuthHandler.HTTPNtlmAuthHandler(self.password_manager)
 
-    return self.handler
+    self.session = requests.Session()
+    self.session.auth = self.password_manager
 
-  def build_opener(self):
-    if self.opener:
-      return self.opener
+    return self.session
 
-    log.debug(u'Constructing opener')
+  def send(self, body, headers=None, retries=2, timeout=30, encoding=u"utf-8"):
+    if not self.session:
+      self.session = self.build_session()
 
-    self.handler = self.build_handler()
-    self.opener = urllib2.build_opener(self.handler)
+    try:
+      response = self.session.post(self.url, data=body, headers=headers)
+      response.raise_for_status()
+    except requests.exceptions.RequestException as err:
+      raise FailedExchangeException(u'Unable to connect to Exchange: %s' % err)
 
-    return self.opener
+    log.info(u'Got response: {code}'.format(code=response.status_code))
+    log.debug(u'Got response headers: {headers}'.format(headers=response.headers))
+    log.debug(u'Got body: {body}'.format(body=response.text))
 
-  def send(self, body, headers=None, retries=2, timeout=30, encoding=u"utf-8"):
-    if not self.opener:
-      self.opener = self.build_opener()
-
-    url = self.url
-
-    # lxml tostring returns str in Python 2, and bytes in python 3
-    # if XML is actually unicode, urllib2 will barf.
-    # Oddly enough this only seems to be a problem in 2.7. 2.6 doesn't seem to care.
-    # The url used should be a bytestring as well. 2.6 doesn't care about this but 2.7 does.
-    if sys.version_info < (3, 0):
-      if isinstance(body, unicode):
-        body = body.encode(encoding)
-      if isinstance(url, unicode):
-        url = url.encode(encoding)
-    else:
-      if isinstance(body, str):
-        body = body.encode(encoding)
-      if isinstance(url, str):
-        url = url.encode(encoding)
-
-    request = urllib2.Request(url, body)
-
-    if headers:
-      for header in headers:
-        log.debug(u'Adding header: {name} - {value}'.format(name=header[0], value=header[1]))
-        request.add_header(header[0], header[1])
-
-    error = None
-    for retry in range(retries + 1):
-      log.info(u'Connection attempt #{0} of {1}'.format(retry + 1, retries))
-      try:
-        # retrieve the result
-        log.info(u'Sending request to url: {0}'.format(request.get_full_url()))
-        try:
-          response = self.opener.open(request, timeout=timeout)
-
-        except urllib2.HTTPError as err:
-          # Called for 500 errors
-          raise FailedExchangeException(u'Unable to connect to Exchange: %s' % err)
-
-        response_code = response.getcode()
-        body = response.read().decode(encoding)
-
-        log.info(u'Got response: {code}'.format(code=response_code))
-        log.debug(u'Got response headers: {headers}'.format(headers=response.info()))
-        log.debug(u'Got body: {body}'.format(body=body))
-
-        return body
-      except HTTPException as err:
-        log.error(u'Caught err, retrying: {err}'.format(err=err))
-        error = err
-
-    # All retries used up, re-throw the exception.
-    raise error
+    return response.text

pyexchange/exchange2010/__init__.py

@@ -37,7 +37,10 @@ def folder(self):
     return Exchange2010FolderService(service=self)
 
   def _send_soap_request(self, body, headers=None, retries=2, timeout=30, encoding="utf-8"):
-    headers = [("Accept", "text/xml"), ("Content-type", "text/xml; charset=%s " % encoding)]
+    headers = {
+      "Accept" : "text/xml",
+      "Content-type" : "text/xml; charset=%s " % encoding
+    }
     return super(Exchange2010Service, self)._send_soap_request(body, headers=headers, retries=retries, timeout=timeout, encoding=encoding)
 
   def _check_for_errors(self, xml_tree):

requirements.txt

@@ -1,3 +1,4 @@
-lxml
-python-ntlm
-pytz
+lxml==3.4.0
+pytz==2014.7
+requests==2.4.1
+requests-ntlm==0.0.3

tests/__init__.py

@@ -4,32 +4,5 @@
 
 Unless required by applicable law or agreed to in writing, software?distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 """
-from functools import wraps
-from nose.plugins.attrib import attr
-from nose.plugins.skip import SkipTest
 
-"""
-Got this from:
-
-http://www.natpryce.com/articles/000788.html
-https://gist.github.com/997195
-
-"""
-
-
-def fail(message):
-  raise AssertionError(message)
-
-def wip(f):
-  """
-  Use this as a decorator to mark tests that are "works in progress"
-  """
-  @wraps(f)
-  def run_test(*args, **kwargs):
-    try:
-      f(*args, **kwargs)
-    except Exception as e:
-      raise SkipTest("WIP test failed: " + str(e))
-    fail("test passed but marked as work in progress")
 
-  return attr('wip')(run_test)

tests/exchange2010/__init__.py

@@ -4,4 +4,3 @@
 
 Unless required by applicable law or agreed to in writing, software?distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 """
-__author__ = 'rsanders'

tests/exchange2010/test_create_event.py

@@ -14,7 +14,6 @@
 from pyexchange.exceptions import *
 
 from .fixtures import *
-from .. import wip
 
 class Test_PopulatingANewEvent(unittest.TestCase):
   """ Tests all the attribute setting works when creating a new event """

tests/exchange2010/test_delete_event.py

@@ -11,8 +11,6 @@
 from pyexchange.connection import ExchangeNTLMAuthConnection
 
 from .fixtures import *
-from .. import wip
-
 
 class Test_EventDeletion(unittest.TestCase):
   event = None

tests/exchange2010/test_event_actions.py

@@ -12,7 +12,7 @@
 from pyexchange.exceptions import *
 
 from .fixtures import *
-from .. import wip
+
 
 class Test_EventActions(unittest.TestCase):
   event = None

tests/fixtures.py

@@ -5,5 +5,5 @@
 Unless required by applicable law or agreed to in writing, software?distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 """
 FAKE_EXCHANGE_URL = u'http://10.0.0.0/nothing'
-FAKE_EXCHANGE_USERNAME = u'nobody'
+FAKE_EXCHANGE_USERNAME = u'FAKEDOMAIN\\nobody'
 FAKE_EXCHANGE_PASSWORD = u'totallyfake'