A library for declaratively managing connections to Pusher channels and events in your Ember application.
You are able to connect to different channels and events declaratively as the user traverses through your application. The interface to event handlers are natural methods on your controllers. In fact: The full event bubbling framework is available to the pusher initiated events.
Yes
I guess? Ship it!
Good question!
First things first: Stick your pusher connection options on your Application
object. Anything you pass into the connection
hash will be passed in as
options to the pusher connection. This is a good place for auth params, and
things like that. You can get a list of all the options from
Pusher's API.
App = Ember.Application.create({
PUSHER_OPTS: { key: 'foo', connection: {} }
});
Next, for any controllers that you want to catch pusher events on:
- Extend
EmberPusher.Bindings
. - Define
PUSHER_SUBSCRIPTIONS
where the keys are channel names and the values are arrays of events for the channel. If you have dynamic channel names or events, you can totally just construct yourPUSHER_SUBSCRIPTIONS
hash ininit()
of your controller. Private channels are fine. - Implement your event handlers on the controller.
var YourController = Em.Controller.extend(EmberPusher.Bindings, {
PUSHER_SUBSCRIPTIONS: {
craycray: ['event-one', 'event-two'],
anotherone: ['event-three']
},
actions: {
eventOne: function(){ console.log("eventOne is working!"); },
eventTwo: function(){ console.log("eventTwo is working!"); }
eventThree: function(){ console.log("eventThree is working!"); }
}
});
Note: The event names have camelize()
called on them, so that you can
keep your controller's methods looking consistent. Event handlers are tracked
and torn down when a controller is destroyed.
That's about it! When events come in, they should be triggered on the listening controllers. It should be noted that event bubbling will all work as expected, so you can actually implement your handlers wherever suits your needs best.
Have fun! Certainly let me know if you see any bugs.
Are you sure you've got the right event name on your controller? Do
an Em.String.camelize('foo-bar')
on your event name. That's what you should
have implemented on your controller. Did you make sure to extend
EmberPusher.Bindings
on the controller(s) you want to catch events on?
Can I connect to a private channel!?
Yes.
What versions of Ember are supported!?
~>1.0.0
Can I bind to connection events!?
Indeed! I do this in my apps to attach the pusher socket ID as a header to xhr requests. It would look like this:
App.MyController = Ember.Controller.extend(EmberPusher.Bindings, {
needs: ['pusher'],
PUSHER_SUBSCRIPTIONS: {
my-channel: ['pusher:subscription_succeeded']
},
actions: {
'pusher:subscriptionSucceeded': function() {
console.log("Socket ID:", this.get('controllers.pusher.socketId'));
}
}
});
grunt test
- Runs Mocha tests through PhantomJS
grunt server
- Run tests through a browser. Visit http://localhost:8000/test
.
grunt build
- build 'er
@wycats - Architectural advise.