Pusher plugin

  • Tags : /
  • Latest : 0.5
  • Last Updated: 08 May 2013
  • Grails version : 2.0.3 > *
  • Authors : Michael Pangopoulos
0 vote
Dependency : 
runtime ":pusher:0.5"
Custom repositories : 
mavenRepo "http://repository.codehaus.org/"

Documentation

Summary

Plugin for adding Pusher support into your application.

Installation

grails install-plugin pusher

Description

Pusher plugin

This plugin is a wrapper for the Pusher Publisher API.

Source code available on Github. Collaborations are welcome :)

Configuration

When installing the plugin, placeholders for your Pusher credentials are added to your Config.groovy file. Fill in the credentials:

pusherapp.host = "api.pusherapp.com"
pusherapp.applicationId = ""
pusherapp.applicationKey = ""
pusherapp.applicationSecret = ""

PusherService

The plugin provides this service to communicate with the Pusher API. Inject it in your artifacts declaring this attribute:

def pusherService

Call one of the two methods called "triggerPush" and pass channel name, event name and the message body (JSON as String) as parameters:

pusherService.triggerPush(channel, event, jsonData)

The second "triggerPush" method provides an additional parameter for the socket_id:

pusherService.triggerPush(channel, event, jsonData, socketId)

Helper method for generating authorization string required for private and presence channels:

pusherService.genAuthString(socketId, channel, userData)