Merge pull request #1 from jrconlin/master

Merge 0.3.4 to prod

Author: jrconlin

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.4 (2016-05-17)
+bug: make header keys case insenstive
+
+## 0.3.3 (2016-05-17)
+bug: force key string encoding to utf8
+
 ## 0.3.2 (2016-04-28)
 bug: fix setup.py issues
 

pywebpush/__init__.py

@@ -14,6 +14,33 @@ class WebPushException(Exception):
     pass
 
 
+class CaseInsensitiveDict(dict):
+    """A dictionary that has case-insensitive keys"""
+
+    def __init__(self, data={}, **kwargs):
+        for key in data:
+            dict.__setitem__(self, key.lower(), data[key])
+        self.update(kwargs)
+
+    def __contains__(self, key):
+        return dict.__contains__(self, key.lower())
+
+    def __setitem__(self, key, value):
+        dict.__setitem__(self, key.lower(), value)
+
+    def __getitem__(self, key):
+        return dict.__getitem__(self, key.lower())
+
+    def __delitem__(self, key):
+        dict.__delitem__(self, key.lower())
+
+    def get(self, key, default=None):
+        try:
+            return self.__getitem__(key)
+        except KeyError:
+            return default
+
+
 class WebPusher:
     """WebPusher encrypts a data block using HTTP Encrypted Content Encoding
     for WebPush.
@@ -68,11 +95,13 @@ def __init__(self, subscription_info):
         for k in ['p256dh', 'auth']:
             if keys.get(k) is None:
                 raise WebPushException("Missing keys value: %s", k)
-        receiver_raw = base64.urlsafe_b64decode(self._repad(keys['p256dh']))
+        receiver_raw = base64.urlsafe_b64decode(
+            self._repad(keys['p256dh'].encode('utf8')))
         if len(receiver_raw) != 65 and receiver_raw[0] != "\x04":
             raise WebPushException("Invalid p256dh key specified")
         self.receiver_key = receiver_raw
-        self.auth_key = base64.urlsafe_b64decode(self._repad(keys['auth']))
+        self.auth_key = base64.urlsafe_b64decode(
+            self._repad(keys['auth'].encode('utf8')))
 
     def _repad(self, str):
         """Add base64 padding to the end of a string, if required"""
@@ -96,7 +125,7 @@ def encode(self, data):
         server_key_id = base64.urlsafe_b64encode(server_key.get_pubkey()[1:])
 
         # http_ece requires that these both be set BEFORE encrypt or
-        # decrypt is called.
+        # decrypt is called if you specify the key as "dh".
         http_ece.keys[server_key_id] = server_key
         http_ece.labels[server_key_id] = "P-256"
 
@@ -107,12 +136,12 @@ def encode(self, data):
             dh=self.receiver_key,
             authSecret=self.auth_key)
 
-        return {
+        return CaseInsensitiveDict({
             'crypto_key': base64.urlsafe_b64encode(
                 server_key.get_pubkey()).strip('='),
             'salt': base64.urlsafe_b64encode(salt).strip("="),
             'body': encrypted,
-        }
+        })
 
     def send(self, data, headers={}, ttl=0):
         """Encode and send the data to the Push Service.
@@ -127,6 +156,7 @@ def send(self, data, headers={}, ttl=0):
         # Encode the data.
         encoded = self.encode(data)
         # Append the p256dh to the end of any existing crypto-key
+        headers = CaseInsensitiveDict(headers)
         crypto_key = headers.get("crypto-key", "")
         if crypto_key:
             crypto_key += ','

pywebpush/tests/test_webpush.py

@@ -7,7 +7,7 @@
 from nose.tools import eq_, ok_
 import pyelliptic
 
-from pywebpush import WebPusher, WebPushException
+from pywebpush import WebPusher, WebPushException, CaseInsensitiveDict
 
 
 class WebpushTestCase(unittest.TestCase):
@@ -24,11 +24,11 @@ def _gen_subscription_info(self, recv_key):
     def test_init(self):
         # use static values so we know what to look for in the reply
         subscription_info = {
-            "endpoint": "https://example.com/",
-            "keys": {
-                "p256dh": ("BOrnIslXrUow2VAzKCUAE4sIbK00daEZCswOcf8m3T"
-                           "F8V82B-OpOg5JbmYLg44kRcvQC1E2gMJshsUYA-_zMPR8"),
-                "auth": "k8JV6sjdbhAi1n3_LDBLvA"
+            u"endpoint": u"https://example.com/",
+            u"keys": {
+                u"p256dh": (u"BOrnIslXrUow2VAzKCUAE4sIbK00daEZCswOcf8m3T"
+                            "F8V82B-OpOg5JbmYLg44kRcvQC1E2gMJshsUYA-_zMPR8"),
+                u"auth": u"k8JV6sjdbhAi1n3_LDBLvA"
             }
         }
         self.assertRaises(
@@ -94,15 +94,23 @@ def test_encode(self):
     def test_send(self, mock_post):
         recv_key = pyelliptic.ECC(curve="prime256v1")
         subscription_info = self._gen_subscription_info(recv_key)
-        headers = {"crypto-key": "pre-existing",
-                   "authentication": "bearer vapid"}
+        headers = {"Crypto-Key": "pre-existing",
+                   "Authentication": "bearer vapid"}
         data = "Mary had a little lamb"
         WebPusher(subscription_info).send(data, headers)
         eq_(subscription_info.get('endpoint'), mock_post.call_args[0][0])
         pheaders = mock_post.call_args[1].get('headers')
         eq_(pheaders.get('ttl'), 0)
         ok_('encryption' in pheaders)
-        eq_(pheaders.get('authentication'), headers.get('authentication'))
+        eq_(pheaders.get('AUTHENTICATION'), headers.get('Authentication'))
         ckey = pheaders.get('crypto-key')
         ok_('pre-existing,' in ckey)
         eq_(pheaders.get('content-encoding'), 'aesgcm')
+
+    def test_ci_dict(self):
+        ci = CaseInsensitiveDict({"Foo": "apple", "bar": "banana"})
+        eq_('apple', ci["foo"])
+        eq_('apple', ci.get("FOO"))
+        eq_('apple', ci.get("Foo"))
+        del (ci['FOO'])
+        eq_(None, ci.get('Foo'))

setup.py

@@ -3,7 +3,7 @@
 
 from setuptools import find_packages, setup
 
-__version__ = "0.3.2"
+__version__ = "0.3.4"
 
 
 def read_from(file):