Merge pull request #98 from pusher/batch-events

Add support for batch events

Author: zimbatm

README.md

@@ -131,6 +131,18 @@ An optional fourth argument may be used to send additional parameters to the API
 Pusher.trigger('channel', 'event', {foo: 'bar'}, {socket_id: '123.456'})
 ```
 
+#### Batches
+
+It's also possible to send multiple events with a single API call (max 10
+events per call on multi-tenant clusters):
+
+``` ruby
+Pusher.trigger_batch([
+  {channel: 'channel_1', name: 'event_name', data: { foo: 'bar' }}
+  {channel: 'channel_1', name: 'event_name', data: { hello: 'world' }}
+])
+```
+
 #### Deprecated publisher API
 
 Most examples and documentation will refer to the following syntax for triggering an event:

lib/pusher/client.rb

@@ -269,13 +269,35 @@ def trigger(channels, event_name, data, params = {})
       post('/events', trigger_params(channels, event_name, data, params))
     end
 
+    # Trigger multiple events at the same time
+    #
+    # POST /apps/[app_id]/batch_events
+    #
+    # @param events [Array] List of events to publish
+    #
+    # @return [Hash] See Pusher API docs
+    #
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside http client. The original error is wrapped in error.original_error
+    #
+    def trigger_batch(*events)
+      post('/batch_events', trigger_batch_params(events.flatten))
+    end
+
     # Trigger an event on one or more channels asynchronously.
     # For parameters see #trigger
     #
     def trigger_async(channels, event_name, data, params = {})
       post_async('/events', trigger_params(channels, event_name, data, params))
     end
 
+    # Trigger multiple events asynchronously.
+    # For parameters see #trigger_batch
+    #
+    def trigger_batch_async(*events)
+      post_async('/batch_events', trigger_batch_params(events.flatten))
+    end
+
     # Generate the expected response for an authentication endpoint.
     # See http://pusher.com/docs/authenticating_users for details.
     #
@@ -351,23 +373,27 @@ def trigger_params(channels, event_name, data, params)
       channels = Array(channels).map(&:to_s)
       raise Pusher::Error, "Too many channels (#{channels.length}), max 10" if channels.length > 10
 
-      encoded_data = case data
-      when String
-        data
-      else
-        begin
-          MultiJson.encode(data)
-        rescue MultiJson::DecodeError => e
-          Pusher.logger.error("Could not convert #{data.inspect} into JSON")
-          raise e
+      params.merge({
+        name: event_name,
+        channels: channels,
+        data: encode_data(data),
+      })
+    end
+
+    def trigger_batch_params(events)
+      {
+        batch: events.map do |event|
+          event.dup.tap do |e|
+            e[:data] = encode_data(e[:data])
+          end
         end
-      end
+      }
+    end
 
-      return params.merge({
-        :name => event_name,
-        :channels => channels,
-        :data => encoded_data,
-      })
+    # JSON-encode the data if it's not a string
+    def encode_data(data)
+      return data if data.is_a? String
+      MultiJson.encode(data)
     end
 
     def configured?

spec/client_spec.rb

@@ -274,6 +274,37 @@
         end
       end
 
+      describe '#trigger_batch' do
+        before :each do
+          @api_path = %r{/apps/20/batch_events}
+          stub_request(:post, @api_path).to_return({
+            :status => 200,
+            :body => MultiJson.encode({})
+          })
+        end
+
+        it "should call correct URL" do
+          expect(@client.trigger_batch(channel: 'mychannel', name: 'event', data: {'some' => 'data'})).
+            to eq({})
+        end
+
+        it "should convert non string data to JSON before posting" do
+          @client.trigger_batch(
+            {channel: 'mychannel', name: 'event', data: {'some' => 'data'}},
+            {channel: 'mychannel', name: 'event', data: 'already encoded'},
+          )
+          expect(WebMock).to have_requested(:post, @api_path).with { |req|
+            parsed = MultiJson.decode(req.body)
+            expect(parsed).to eq(
+              "batch" => [
+                { "channel" => "mychannel", "name" => "event", "data" => "{\"some\":\"data\"}"},
+                { "channel" => "mychannel", "name" => "event", "data" => "already encoded"}
+              ]
+            )
+          }
+        end
+      end
+
       describe '#trigger_async' do
         before :each do
           @api_path = %r{/apps/20/events}