Merge pull request #78 from sailthru/INT-1681-fix-python3-bytes-compatibility

Fix Python 3 bytes/str incompatibility in simplejson and postback methods

Author: vnatakam

CHANGES

@@ -43,3 +43,10 @@
 2.3.5
 ===
 - Add request timeout argument
+
+2.3.6
+===
+- Fix Python 3 bytes/str incompatibility: use response.text instead of response.content so simplejson (required dependency) receives a str
+- Fix receive_verify_post to use the dict returned by get_body() directly instead of calling json.loads on it again
+- Fix get_signature_string returning bytes instead of str; encoding moved to get_signature_hash where hashlib requires it
+- Sync version string across __init__.py, sailthru_http.py User-Agent, and setup.py

sailthru/__init__.py

@@ -6,4 +6,4 @@
 __doc__ = 'Python binding for Sailthru API based on Requests'
 __copyright__ = 'Copyright 2012-2015, Sailthru Inc.'
 __license__ = 'MIT'
-__version__ = '2.3.1'
+__version__ = '2.3.6'

sailthru/sailthru_client.py

@@ -31,15 +31,15 @@ def get_signature_string(params, secret):
     """
     str_list = [str(item) for item in extract_params(params)]
     str_list.sort()
-    return (secret + ''.join(str_list)).encode('utf-8')
+    return secret + ''.join(str_list)
 
 def get_signature_hash(params, secret):
     """
     Returns an MD5 hash of the signature string for an API call.
     @param params: dictionary values to generate signature hash
     @param sercret: secret string
     """
-    return hashlib.md5(get_signature_string(params, secret)).hexdigest()
+    return hashlib.md5(get_signature_string(params, secret).encode('utf-8')).hexdigest()
 
 
 class SailthruClient(object):
@@ -589,14 +589,10 @@ def receive_verify_post(self, post_params):
 
         send_response = self.get_send(post_params['send_id'])
 
-        try:
-            send_body = send_response.get_body()
-            send_json = json.loads(send_body)
-            if 'email' not in send_body:
-                return False
-            if send_json['email'] != post_params['email']:
-                return False
-        except ValueError:
+        send_json = send_response.get_body()
+        if not isinstance(send_json, dict):
+            return False
+        if send_json.get('email') != post_params['email']:
             return False
 
         return True

sailthru/sailthru_http.py

@@ -34,7 +34,7 @@ def sailthru_http_request(url, data, method, file_data=None, headers=None, reque
     data = flatten_nested_hash(data)
     method = method.upper()
     params, data = (None, data) if method == 'POST' else (data, None)
-    sailthru_headers = {'User-Agent': 'Sailthru API Python Client %s; Python Version: %s' % ('2.3.5', platform.python_version())}
+    sailthru_headers = {'User-Agent': 'Sailthru API Python Client %s; Python Version: %s' % ('2.3.6', platform.python_version())}
     if headers and isinstance(headers, dict):
         for key, value in sailthru_headers.items():
             headers[key] = value

sailthru/sailthru_response.py

@@ -11,8 +11,8 @@ def __init__(self, response):
         self.json_error = None
 
         try:
-            self.json = json.loads(response.content)
-        except ValueError as e:
+            self.json = json.loads(response.text)
+        except (ValueError, TypeError) as e:
             self.json = None
             self.json_error = str(e)
 

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 setup(name='sailthru-client', 
-    version='2.3.5',
+    version='2.3.6',
     packages=find_packages(),
     description='Python client for Sailthru API',
     long_description=open('README.md').read(),

test/test_sailthru_client.py

@@ -64,7 +64,7 @@ def test_check_for_valid_actions(self):
 
     def test_receive_verify_post(self):
         mock_http_request = MagicMock()
-        mock_http_request.return_value.get_body.return_value = '{"email":"menglander@sailthru.com"}'
+        mock_http_request.return_value.get_body.return_value = {"email": "menglander@sailthru.com"}
 
         self.client._http_request = mock_http_request
 
@@ -126,7 +126,7 @@ def test_hardbounce_blast_invalid_json(self):
 
     def test_hardbounce_valid_json(self):
         mock_http_request = MagicMock()
-        mock_http_request.return_value.get_body.return_value = '{"email": "menglander@sailthru.com"}'
+        mock_http_request.return_value.get_body.return_value = {"email": "menglander@sailthru.com"}
 
         self.client._http_request = mock_http_request