python 3 compatability

ims_lti_py/__init__.py

@@ -1,9 +1,9 @@
 # Classes
-from tool_config import ToolConfig
-from tool_consumer import ToolConsumer
-from tool_provider import ToolProvider
-from outcome_request import OutcomeRequest
-from outcome_response import OutcomeResponse
+from .tool_config import ToolConfig
+from .tool_consumer import ToolConsumer
+from .tool_provider import ToolProvider
+from .outcome_request import OutcomeRequest
+from .outcome_response import OutcomeResponse
 
 # Exceptions
-from utils import InvalidLTIConfigError, InvalidLTIRequestError
+from .utils import InvalidLTIConfigError, InvalidLTIRequestError

ims_lti_py/launch_params.py

@@ -5,7 +5,7 @@
 if py <  (2, 6, 0): bytes=str
 
 def touni(s, enc='utf8', err='strict'):
-    return s.decode(enc, err) if isinstance(s, bytes) else unicode(s)
+    return s.decode(enc, err) if isinstance(s, bytes) else str(s)
 
 
 # List of the standard launch parameters for an LTI launch
@@ -93,7 +93,7 @@ def roles(self, roles_list):
         '''
         if roles_list and isinstance(roles_list, list):
             self.roles = [].extend(roles_list)
-        elif roles_list and isinstance(roles_list, basestring):
+        elif roles_list and isinstance(roles_list, str):
             self.roles = [role.lower() for role in roles_list.split(',')]
 
     def process_params(self, params):
@@ -102,7 +102,7 @@ def process_params(self, params):
         the LAUNCH_DATA_PARAMETERS list, or that start with 'custom_' or
         'ext_'.
         '''
-        for key, val in params.items():
+        for key, val in list(params.items()):
             if key in LAUNCH_DATA_PARAMETERS and val != 'None':
                 if key == 'roles':
                     if isinstance(val, list):

ims_lti_py/outcome_request.py

@@ -3,8 +3,8 @@
 
 import oauth2
 
-from outcome_response import OutcomeResponse
-from utils import InvalidLTIConfigError
+from .outcome_response import OutcomeResponse
+from .utils import InvalidLTIConfigError
 
 REPLACE_REQUEST = 'replaceResult'
 DELETE_REQUEST = 'deleteResult'
@@ -41,7 +41,7 @@ def __init__(self, opts=defaultdict(lambda: None)):
             setattr(self, accessor, None)
 
         # Store specified options in our accessors
-        for (key, val) in opts.iteritems():
+        for (key, val) in opts.items():
             setattr(self, key, val)
 
     @staticmethod
@@ -144,11 +144,11 @@ def post_outcome_request(self):
             normalize = http._normalize_headers
 
             def my_normalize(self, headers):
-                print("My Normalize", headers)
+                print(("My Normalize", headers))
                 ret = normalize(self, headers)
                 if 'authorization' in ret:
                     ret['Authorization'] = ret.pop('authorization')
-                print("My Normalize", ret)
+                print(("My Normalize", ret))
                 return ret
             http._normalize_headers = my_normalize
             monkey_patch_function = normalize

ims_lti_py/outcome_response.py

@@ -48,7 +48,7 @@ def __init__(self, **kwargs):
             setattr(self, opt, None)
 
         # Store specified options in our options member
-        for (key, val) in kwargs.iteritems():
+        for (key, val) in kwargs.items():
             setattr(self, key, val)
 
     @staticmethod

ims_lti_py/request_validator.py

@@ -1,4 +1,5 @@
 import oauth2
+import six
 
 
 class RequestValidatorMixin(object):
@@ -36,10 +37,13 @@ def is_valid_request(self, request, parameters={},
                 headers=headers,
                 parameters=parameters)
 
+            if isinstance(oauth_request['oauth_signature'], six.string_types):
+                oauth_request['oauth_signature'] = oauth_request['oauth_signature'].encode('utf-8')
+
             self.oauth_server.verify_request(
                 oauth_request, self.oauth_consumer, {})
 
-        except oauth2.MissingSignature, e:
+        except oauth2.MissingSignature as e:
             if handle_error:
                 return False
             else:
@@ -93,7 +97,7 @@ def parse_request(self, request, parameters, fake_method=None):
         return (fake_method or request.method,
                 request.build_absolute_uri(),
                 request.META,
-                (dict(request.POST.iteritems())
+                (dict(iter(request.POST.items()))
                     if request.method == 'POST'
                     else parameters))
 

ims_lti_py/tool_config.py

@@ -1,7 +1,7 @@
 from collections import defaultdict
 from lxml import etree, objectify
 
-from utils import InvalidLTIConfigError
+from .utils import InvalidLTIConfigError
 
 accessors = [
         'title',
@@ -51,7 +51,7 @@ def __init__(self, **kwargs):
                 else defaultdict(lambda: None)
 
         # Iterate over all provided options and save to class instance members
-        for (key, val) in kwargs.iteritems():
+        for (key, val) in kwargs.items():
             setattr(self, key, val)
 
     @staticmethod
@@ -170,12 +170,12 @@ def process_xml(self, xml):
                 self.set_ext_params(platform, properties)
 
     def recursive_options(self,element,params):
-        for key, val in params.iteritems():
+        for key, val in params.items():
             if isinstance(val, dict):
                 options_node = etree.SubElement(element,
                       '{%s}%s' %(NSMAP['lticm'], 'options'), name =
                       key)
-                for key, val in val.iteritems():
+                for key, val in val.items():
                     self.recursive_options(options_node,{key:val})
             else:
                 param_node = etree.SubElement(element, '{%s}%s'

ims_lti_py/tool_consumer.py

@@ -1,12 +1,12 @@
 from collections import defaultdict
-from urllib2 import urlparse, unquote
+from urllib.parse import unquote
 
 import oauth2
 import time
 
-from launch_params import LaunchParamsMixin
-from request_validator import RequestValidatorMixin
-from utils import InvalidLTIConfigError, generate_identifier
+from .launch_params import LaunchParamsMixin
+from .request_validator import RequestValidatorMixin
+from .utils import InvalidLTIConfigError, generate_identifier
 
 accessors = [
     'consumer_key',

ims_lti_py/tool_provider.py

@@ -1,18 +1,18 @@
-from launch_params import LaunchParamsMixin
-from request_validator import (
+from .launch_params import LaunchParamsMixin
+from .request_validator import (
     RequestValidatorMixin,
     FlaskRequestValidatorMixin,
     DjangoRequestValidatorMixin,
     WebObRequestValidatorMixin
 )
-from outcome_request import OutcomeRequest
+from .outcome_request import OutcomeRequest
 from collections import defaultdict
 import re
-from urllib import urlencode
-from urlparse import urlsplit, urlunsplit
+from urllib.parse import urlencode
+from urllib.parse import urlsplit, urlunsplit
 
 try:
-    from urlparse import parse_qsl
+    from urllib.parse import parse_qsl
 except ImportError:
     # fall back for Python 2.5
     from cgi import parse_qsl  # NOQA

setup.py

@@ -9,7 +9,7 @@
     author_email='[email protected]',
     url='https://github.com/tophatmonocle/ims_lti_py',
     packages=find_packages(),
-    install_requires=['lxml', 'oauth2'],
+    install_requires=['lxml', 'oauth2', 'six'],
     license='MIT License',
     keywords='lti',
     zip_safe=True,

tests/launch_params_test.py

@@ -7,11 +7,11 @@ def test_process_params(self):
         '''
         Should process parameters.
         '''
-        for (key, val) in self.params.iteritems():
+        for (key, val) in self.params.items():
             if not 'custom_' in key\
                     and not 'ext_' in key\
                     and not 'roles' in key:
-                self.assertEquals(getattr(self.tool, key), val)
+                self.assertEqual(getattr(self.tool, key), val)
 
         # Test roles
         self.assertTrue(sorted(self.tool.roles) == sorted(['Learner',\
@@ -21,20 +21,20 @@ def test_custom_extension_parameters(self):
         '''
         Should handle custom/extension parameters.
         '''
-        self.assertEquals(self.tool.get_custom_param('param1'), 'custom1')
-        self.assertEquals(self.tool.get_custom_param('param2'), 'custom2')
-        self.assertEquals(self.tool.get_ext_param('lti_message_type'),
+        self.assertEqual(self.tool.get_custom_param('param1'), 'custom1')
+        self.assertEqual(self.tool.get_custom_param('param2'), 'custom2')
+        self.assertEqual(self.tool.get_ext_param('lti_message_type'),
                 'extension-lti-launch')
         self.tool.set_custom_param('param3', 'custom3')
         self.tool.set_ext_param('user_id', 'bob')
 
         params = self.tool.to_params()
-        self.assertEquals(params['custom_param1'], 'custom1')
-        self.assertEquals(params['custom_param2'], 'custom2')
-        self.assertEquals(params['custom_param3'], 'custom3')
-        self.assertEquals(params['ext_lti_message_type'],
+        self.assertEqual(params['custom_param1'], 'custom1')
+        self.assertEqual(params['custom_param2'], 'custom2')
+        self.assertEqual(params['custom_param3'], 'custom3')
+        self.assertEqual(params['ext_lti_message_type'],
                 'extension-lti-launch')
-        self.assertEquals(params['ext_user_id'], 'bob')
+        self.assertEqual(params['ext_user_id'], 'bob')
 
     def test_invalid_request(self):
         '''

tests/tool_consumer_tests.py

@@ -21,9 +21,9 @@ def test_url_query_parameters(self):
         tc.launch_url = 'http://dr-chuck.com/ims/php-simple/tool.php?a=1&b=2&c=3%20%26a'
         result = tc.generate_launch_data()
         self.assertNotEqual(result, None)
-        self.assertEquals(result['oauth_signature'], 
+        self.assertEqual(result['oauth_signature'], 
                 'kiObbrNVu4vHzd0+yVDHvrsvegQ=')
-        self.assertEquals(result['c'], '3 &a')
+        self.assertEqual(result['c'], '3 &a')
 
     def test_signature_port(self):
         '''
@@ -35,7 +35,7 @@ def test_url(url, sig):
             tc.launch_url = url
             ld = tc.generate_launch_data()
             self.assertNotEqual(ld, None)
-            self.assertEquals(ld['oauth_signature'], sig)
+            self.assertEqual(ld['oauth_signature'], sig)
 
         test_url('http://dr-chuck.com:123/ims/php-simple/tool.php',
                 'I2zrOsXkLvBMbb5HzRXZrZAQVOg=')