Merge pull request #36 from dokterbob/unicode_regression

Unicode regression

Author: geeknam

.gitignore

@@ -1,3 +1,4 @@
 *.pyc
 build
-dist
+dist
+.coverage

.travis.yml

@@ -3,4 +3,7 @@ python:
   - "2.7"
 install:
   - pip install mock
-script: python gcm/test.py
+  - pip install coveralls
+script: coverage run --source=gcm gcm/test.py
+after_success:
+    coveralls

gcm/gcm.py

@@ -48,6 +48,25 @@ def group_response(response, registration_ids, key):
     return grouping
 
 
+def urlencode_utf8(params):
+    """
+    UTF-8 safe variant of urllib.urlencode.
+    http://stackoverflow.com/a/8152242
+    """
+
+    if hasattr(params, 'items'):
+        params = params.items()
+
+    params =  (
+        '='.join((
+            urllib.quote_plus(k.encode('utf8'), safe='/'),
+            urllib.quote_plus(v.encode('utf8'), safe='/')
+        )) for k, v in params
+    )
+
+    return '&'.join(params)
+
+
 class GCM(object):
 
     # Timeunit is milliseconds.
@@ -133,7 +152,7 @@ def make_request(self, data, is_json=True):
             headers['Content-Type'] = 'application/json'
 
         if not is_json:
-            data = urllib.urlencode(data)
+            data = urlencode_utf8(data)
         req = urllib2.Request(self.url, data, headers)
 
         try:

gcm/test.py

@@ -1,7 +1,7 @@
 import unittest
 from gcm import *
 import json
-from mock import MagicMock
+from mock import MagicMock, patch
 import time
 
 
@@ -15,6 +15,24 @@ def side_effect(*args, **kwargs):
     return side_effect
 
 
+class MockResponse(object):
+    """
+    Mock urllib2.urlopen response.
+    http://stackoverflow.com/a/2276727
+    """
+    def __init__(self, resp_data, code=200, msg='OK'):
+        self.resp_data = resp_data
+        self.code = code
+        self.msg = msg
+        self.headers = {'content-type': 'text/xml; charset=utf-8'}
+
+    def read(self):
+        return self.resp_data
+
+    def getcode(self):
+        return self.code
+
+
 class GCMTest(unittest.TestCase):
 
     def setUp(self):
@@ -166,6 +184,44 @@ def test_handle_plaintext_response(self):
         res = self.gcm.handle_plaintext_response(response)
         self.assertEqual(res, '3456')
 
+    @patch('urllib2.urlopen')
+    def test_make_request_plaintext(self, urlopen_mock):
+        """ Test plaintext make_request. """
+
+        # Set mock value for urlopen return value
+        urlopen_mock.return_value = MockResponse('blah')
+
+        # Perform request
+        response = self.gcm.make_request({'message': 'test'}, is_json=False)
+
+        # Get request (first positional argument to urlopen)
+        # Ref: http://www.voidspace.org.uk/python/mock/mock.html#mock.Mock.call_args
+        request = urlopen_mock.call_args[0][0]
+
+        # Test encoded data
+        encoded_data = request.get_data()
+        self.assertEquals(
+            encoded_data, 'message=test'
+        )
+
+        # Assert return value
+        self.assertEquals(
+            response,
+            'blah'
+        )
+
+
+    @patch('urllib2.urlopen')
+    def test_make_request_unicode(self, urlopen_mock):
+        """ Regression: Test make_request with unicode payload. """
+
+        # Unicode character in data
+        data = {
+            'message': u'\x80abc'
+        }
+
+        self.gcm.make_request(data, is_json=False)
+
     def test_retry_plaintext_request_ok(self):
         returns = [GCMUnavailableException(), GCMUnavailableException(), 'id=123456789']