Merge pull request #80 from pusher/899-report-name-and-version

[PROD-899] report library name and version in X-Pusher-Library header

Author: jameshfisher

pusher/http.py

@@ -4,6 +4,7 @@
                         division)
 from pusher.errors import *
 from pusher.signature import sign
+from pusher.version import VERSION
 
 import copy
 import hashlib
@@ -117,7 +118,7 @@ def base_url(self):
 
     @property
     def headers(self):
+        hdrs = {"X-Pusher-Library": "pusher-http-python " + VERSION}
         if self.method == POST:
-            return {"Content-Type": "application/json"}
-        else:
-            return {}
+            hdrs["Content-Type"] = "application/json"
+        return hdrs

pusher/version.py

@@ -0,0 +1,2 @@
+# Don't change the format of this line: the version is extracted by ../setup.py
+VERSION = '1.4rc3'

pusher_tests/test_request.py

@@ -3,6 +3,7 @@
 from __future__ import print_function, absolute_import, division
 
 import unittest
+import re
 
 from pusher import Pusher
 from pusher.http import Request
@@ -41,13 +42,34 @@ def test_post_signature_generation(self):
         }
 
         with mock.patch('time.time', return_value=1000):
-            # patching this, because json can be unambiguously parsed, but not 
+            # patching this, because json can be unambiguously parsed, but not
             # unambiguously generated (think whitespace).
             with mock.patch('json.dumps', return_value='{"foo": "bar"}') as json_dumps_mock:
                 req = Request(conf, u'POST', u'/some/obscure/api', {u'foo': u'bar'})
                 self.assertEqual(req.query_params, expected)
 
             json_dumps_mock.assert_called_once_with({u"foo": u"bar"})
 
+    # Copied wholesale from https://github.com/python/cpython/blob/2d305e1c46abfcd609bf8b2dff8d2065e6af8ab2/Lib/unittest/case.py#L1279-L1289
+    # This can be removed when we no longer support Python 2.6
+    def assertRegexpMatches(self, text, expected_regex, msg=None):
+        """Fail the test unless the text matches the regular expression."""
+        if isinstance(expected_regex, (str, bytes)):
+            assert expected_regex, "expected_regex must not be empty."
+            expected_regex = re.compile(expected_regex)
+        if not expected_regex.search(text):
+            standardMsg = "Regex didn't match: %r not found in %r" % (
+                expected_regex.pattern, text)
+            # _formatMessage ensures the longMessage option is respected
+            msg = self._formatMessage(msg, standardMsg)
+            raise self.failureException(msg)
+
+    def test_x_pusher_library_header(self):
+        conf = Pusher.from_url(u'http://key:secret@somehost/apps/4')
+        req = Request(conf, u'GET', u'/some/obscure/api', {u'foo': u'bar'})
+        self.assertTrue('X-Pusher-Library' in req.headers)
+        pusherLib = req.headers['X-Pusher-Library']
+        self.assertRegexpMatches(pusherLib, r'^pusher-http-python \d+(\.\d+)+(rc\d+)?$')
+
 if __name__ == '__main__':
     unittest.main()

setup.py

@@ -1,8 +1,19 @@
 # -*- coding: utf-8 -*-
 from setuptools import setup
+import os
+import re
+
+# Lovingly adapted from https://github.com/kennethreitz/requests/blob/39d693548892057adad703fda630f925e61ee557/setup.py#L50-L55
+with open(os.path.join(os.path.dirname(os.path.abspath(__file__)), 'pusher/version.py'), 'r') as fd:
+    VERSION = re.search(r'^VERSION = [\']([^\']*)[\']',
+                        fd.read(), re.MULTILINE).group(1)
+
+if not VERSION:
+    raise RuntimeError('Ensure `VERSION` is correctly set in ./pusher/version.py')
+
 setup(
     name='pusher',
-    version='1.4rc3',
+    version=VERSION,
     description='A Python library to interract with the Pusher API',
     url='https://github.com/pusher/pusher-http-python',
     author='Pusher',