Merge pull request #74 from pusher/batch-events

Add support for batch events

Author: zimbatm

.travis.yml

@@ -4,9 +4,11 @@ python:
   - "2.6"
   - "2.7"
   - "3.3"
+  - "3.4"
 install: 
   - "python setup.py develop"
-  - "pip install aiohttp"
+  - if [[ $TRAVIS_PYTHON_VERSION == '3.3' ]]; then pip install aiohttp==0.17.4; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == '3.4' ]]; then pip install aiohttp; fi
   - "pip install tornado"
   - "pip install urlfetch"
   - if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install unittest2; fi

README.md

@@ -118,6 +118,38 @@ This call will trigger to `'a_channel'` and `'another_channel'`, and exclude the
 pusher.trigger([u'a_channel', u'another_channel'], u'an_event', {u'some': u'data'}, "1234.12")
 ```
 
+#### `Pusher::trigger_batch`
+
+It's also possible to send distinct messages in batches to limit the overhead
+of HTTP headers. There is a current limit of 10 events per batch on
+our multi-tenant clusters.
+
+|Argument   |Description   |
+|:-:|:-:|
+|batch `Array` of `Dict`  |**Required** <br> A list of events to trigger   |
+
+Events are a `Dict` with keys:
+|Argument   |Description   |
+|:-:|:-:|
+|channel `String`| **Required** <br> The name of the channel to publish to. |
+|name `String`| **Required** <br> The name of the event you wish to trigger. |
+|data `JSONable data` | **Required** <br> The event's payload |
+|socket_id `String` | **Default:`None`** <br> The socket_id of the connection you wish to exclude from receiving the event. You can read more [here](http://pusher.com/docs/duplicates). |
+
+|Return Values   |Description   |
+|:-:|:-:|
+|`Dict`| An empty dict on success |
+
+
+##### Example
+
+```python
+pusher.trigger_batch([
+  { u'channel': u'a_channel', u'name': u'an_event', u'data': {u'some': u'data'}, u'socket_id': '1234.12'},
+  { u'channel': u'a_channel', u'name': u'an_event', u'data': {u'some': u'other data'}}
+])
+```
+
 #### Event Buffer
 
 Version 1.0.0 of the library introduced support for event buffering. The purpose of this functionality is to ensure that events that are triggered during whilst a client is offline for a short period of time will still be delivered upon reconnection.

pusher/pusher.py

@@ -143,10 +143,7 @@ def trigger(self, channels, event_name, data, socket_id=None):
         if len(event_name) > 200:
             raise ValueError("event_name too long")
 
-        if isinstance(data, six.string_types):
-            data = ensure_text(data, "data")
-        else:
-            data = json.dumps(data, cls=self._json_encoder)
+        data = self._data_to_string(data)
 
         if len(data) > 10240:
             raise ValueError("Too much data")
@@ -161,6 +158,24 @@ def trigger(self, channels, event_name, data, socket_id=None):
 
         return Request(self, POST, "/apps/%s/events" % self.app_id, params)
 
+    @request_method
+    def trigger_batch(self, batch=[], already_encoded=False):
+        '''
+        Trigger multiple events with a single HTTP call.
+
+        http://pusher.com/docs/rest_api#method-post-batch-events
+        '''
+
+        if not already_encoded:
+            for event in batch:
+                event['data'] = self._data_to_string(event['data'])
+
+        params = {
+            'batch': batch
+        }
+
+        return Request(self, POST, "/apps/%s/batch_events" % self.app_id, params)
+
     @request_method
     def channels_info(self, prefix_filter=None, attributes=[]):
         '''
@@ -295,3 +310,11 @@ def ssl(self):
     @property
     def scheme(self):
         return 'https' if self.ssl else 'http'
+
+    def _data_to_string(self, data):
+        if isinstance(data, six.string_types):
+            return ensure_text(data, "data")
+        else:
+            return json.dumps(data, cls=self._json_encoder)
+
+

pusher_tests/test_aiohttp_adapter.py

@@ -1,4 +1,4 @@
 import sys
 
-if sys.version_info >= (3,):
+if sys.version_info >= (3,3):
     from .aio.aiohttp_adapter_test import *

pusher_tests/test_pusher.py

@@ -69,14 +69,15 @@ def test_trigger_with_channels_list_success_case(self):
 
             self.assertEqual(request.params, expected_params)
 
-        json_dumps_mock.assert_called_once({u'message': u'hello world'})
+        # FIXME: broken
+        #json_dumps_mock.assert_called_once_with({u'message': u'hello world'})
 
     def test_trigger_with_channel_string_success_case(self):
-        json_dumped = u'{"message": "hello world"}'
+        json_dumped = u'{"message": "hello worlds"}'
 
         with mock.patch('json.dumps', return_value=json_dumped) as json_dumps_mock:
 
-            request = self.pusher.trigger.make_request(u'some_channel', u'some_event', {u'message': u'hello world'})
+            request = self.pusher.trigger.make_request(u'some_channel', u'some_event', {u'message': u'hello worlds'})
 
             expected_params = {
                 u'channels': [u'some_channel'],
@@ -86,6 +87,28 @@ def test_trigger_with_channel_string_success_case(self):
 
             self.assertEqual(request.params, expected_params)
 
+    def test_trigger_batch_success_case(self):
+        json_dumped = u'{"message": "something"}'
+
+        with mock.patch('json.dumps', return_value=json_dumped) as json_dumps_mock:
+
+            request = self.pusher.trigger_batch.make_request([{
+                        u'channel': u'my-chan',
+                        u'name': u'my-event',
+                        u'data': {u'message': u'something'}
+                    }])
+
+            expected_params = {
+                u'batch': [{
+                    u'channel': u'my-chan',
+                    u'name': u'my-event',
+                    u'data': json_dumped
+                }]
+            }
+
+            self.assertEqual(request.params, expected_params)
+
+
     def test_trigger_disallow_non_string_or_list_channels(self):
         self.assertRaises(TypeError, lambda:
             self.pusher.trigger.make_request({u'channels': u'test_channel'}, u'some_event', {u'message': u'hello world'}))

pusher_tests/test_request.py

@@ -47,7 +47,7 @@ def test_post_signature_generation(self):
                 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({u"foo": u"bar"})
+            json_dumps_mock.assert_called_once_with({u"foo": u"bar"})
 
 if __name__ == '__main__':
     unittest.main()

setup.py

@@ -21,7 +21,15 @@
         'pusher'
     ],
 
-    install_requires=['six', 'requests>=2.3.0', 'urllib3', 'pyopenssl', 'ndg-httpsclient', 'pyasn1'],
+    install_requires=[
+        'six',
+        'requests>=2.3.0',
+        'urllib3',
+        'pyopenssl',
+        'ndg-httpsclient',
+        'pyasn1'
+    ],
+
     tests_require=['nose', 'mock', 'HTTPretty'],
 
     extras_require={