websocket-rails 0.1.7 → 0.1.8

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # WebsocketRails Change Log
 
+## Version 0.1.8
+
+July 18
+
+* Fix bug in Channel#trigger preventing the data from coming through
+  properly.
+
+## Version 0.1.7
+
+July 17
+
+* Fixed botched release of 0.1.6
+* Reorganized directory structure
+
 ## Version 0.1.6
 
 July 17 2012

data/README.md

@@ -2,22 +2,11 @@
 
 [![Build Status](https://secure.travis-ci.org/DanKnox/websocket-rails.png)](https://secure.travis-ci.org/DanKnox/websocket-rails)
 
-If you haven't done so yet, check out the [Project Page](http://danknox.github.com/websocket-rails/) to get a feel for the project direction. Feedback is very much appreciated. Post an issue on the issue tracker or [shoot us an email](mailto://support@threedotloft.com) to give us your thoughts.
+If you haven't done so yet, check out the [Project Page](http://danknox.github.com/websocket-rails/) to get a feel for the project direction. Feedback is very much appreciated. Post an issue on the issue tracker or [shoot us an email](mailto:support@threedotloft.com) to give us your thoughts.
 
-## IMPORTANT NOTE
+## Recent Updates
 
-Not sure what happened when I released last night, but version 0.1.6 is
-currently broken if you download it from Rubygems. Please use `gem
-'websocket-rails', :git =>
-'git://github.com/DanKnox/websocket-rails.git'` in your Gemfile until I
-resolve the broken package.
-
-## Update July 17 2012
-
-We just released a new version containing significant new functionality. 
-We will be updating the documentation and wiki guides to cover it all over the next day
-or two but check out the
-[CHANGELOG](https://github.com/DanKnox/websocket-rails/blob/master/CHANGELOG.md) to get an early preview.
+Check out the [CHANGELOG](https://github.com/DanKnox/websocket-rails/blob/master/CHANGELOG.md) to find out what's new.
 
 ## Overview
 
@@ -27,7 +16,25 @@ aren't quite universal yet. That's why we also support streaming HTTP.
 Oh, and if you don't mind running a separate process, you can support
 just about any browser with Flash sockets.
 
-## Respond Quicker with Socket Events
+## Installation and Usage Guides
+
+Check out the [Example Application](https://github.com/DanKnox/websocket-rails-Example-Project) for an example implementation.
+
+* [Installation
+  Guide](https://github.com/DanKnox/websocket-rails/wiki/Installation-and-Setup)
+* [Event
+  Router](https://github.com/DanKnox/websocket-rails/wiki/The-Event-Router)
+* [WebsocketRails Controllers](https://github.com/DanKnox/websocket-rails/wiki/WebsocketRails Controllers)
+* [Using the JavaScript
+  Client](https://github.com/DanKnox/websocket-rails/wiki/Using-the-JavaScript-Client)
+* [Using
+  Channels](https://github.com/DanKnox/websocket-rails/wiki/Working-with-Channels)
+* [Using Private Channels](https://github.com/DanKnox/websocket-rails/wiki/Using-Private-Channels)
+* [The
+  DataStore](https://github.com/DanKnox/websocket-rails/wiki/Using-the-DataStore)
+* [Reloading Controllers In Development](https://github.com/DanKnox/websocket-rails/wiki/Reloading-Controllers-In-Development)
+
+## Handle Events With Class
 
 Map events to controller actions using an Event Router.
 
@@ -46,7 +53,9 @@ var task = {
   name: 'Start taking advantage of WebSockets',
   completed: false
 }
-dispatcher = new WebSocketRails('localhost:3000/websocket');
+
+var dispatcher = new WebSocketRails('localhost:3000/websocket');
+
 dispatcher.trigger('tasks.create', task);
 ````
 
@@ -74,6 +83,54 @@ dispatcher.bind('tasks.create_successful', function(task) {
 });
 ````
 
+Or just attach success and failure callbacks to your client events.
+
+````javascript
+var success = function(task) { console.log("Created: " + task.name); }
+
+var failure = function(task) {
+  console.log("Failed to create Product: " + product.name)
+}
+
+dispatcher.trigger('products.create', success, failure);
+````
+
+Then trigger them in your controller:
+
+````ruby
+def create
+  task = Task.create message
+  if task.save
+    trigger_success task
+  else
+    trigger_failure task
+  end
+end
+````
+
+If you're feeling truly lazy, just trigger the failure callback with an
+exception.
+
+````ruby
+def create
+  task = Task.create! message
+  trigger_success task # trigger success if the save went alright
+end
+````
+
+That controller is starting to look pretty clean.
+
+Now in the failure callback on the client we have access to the record
+and the errors.
+
+````javascript
+var failureCallback = function(task) {
+  console.log( task.name );
+  console.log( task.errors );
+  console.log( "You have " + task.errors.length + " errors." );
+}
+````
+
 ## Channel Support
 
 Keep your users up to date without waiting for them to refresh the page.
@@ -94,24 +151,41 @@ controller.
 
 ````ruby
 latest_post = Post.latest
-WebsocketRails[:posts].trigger('new', latest_post)
+WebsocketRails[:posts].trigger 'new', latest_post
 ````
 
-## Installation and Usage Guides
+## Private Channel Support
 
-Check out the [Example Application](https://github.com/DanKnox/websocket-rails-Example-Project) for an example implementation.
+Need to restrict access to a particular channel? No problem. We've got
+that. 
 
-* [Installation
-  Guide](https://github.com/DanKnox/websocket-rails/wiki/Installation-and-Setup)
-* [Event
-  Router](https://github.com/DanKnox/websocket-rails/wiki/The-Event-Router)
-* [WebsocketRails Controllers](https://github.com/DanKnox/websocket-rails/wiki/WebsocketRails Controllers)
-* [Using the JavaScript
-  Client](https://github.com/DanKnox/websocket-rails/wiki/Using-the-JavaScript-Client)
-* [Using
-  Channels](https://github.com/DanKnox/websocket-rails/wiki/Working-with-Channels)
-* [The
-  DataStore](https://github.com/DanKnox/websocket-rails/wiki/Using-the-DataStore)
+Private channels give you the ability to authorize a user's
+subscription using the authorization mechanism of your choice.
+
+Just tell WebsocketRails which channels you would like to make private by using the `private_channel` method in the Event Router.
+Then handle the channel authorization by subscribing to the `websocket_rails.subscribe_private` event.
+
+````ruby
+WebsocketRails::EventMap.describe do
+  private_channel :secret_posts
+  
+  namespace :websocket_rails
+    subscribe :subscribe_private, :to => AuthorizationController, :with_method => :authorize_channels
+  end
+```` 
+
+Or you can always mark any channel as private later on.
+
+````ruby
+WebsocketRails[:secret_posts].make_private
+````
+
+On the client side, you can use the `dispatcher.subscribe_private()`
+method to subscribe to a private channel.
+
+Read the [Private Channel Wiki](https://github.com/DanKnox/websocket-rails/wiki/Using-Private-Channels) for more information on subscribing to
+private channels from the JavaScript client and handling the
+authorization in your controller.
 
 ## Development
 

data/lib/websocket_rails/channel.rb

@@ -14,9 +14,9 @@ module WebsocketRails
     end
 
     def trigger(event_name,data={})
-      data.merge! :channel => name
-      event = Event.new event_name, data
-      send_data event
+      event_data    = {:data => data, :channel => name}
+      channel_event = Event.new event_name, event_data
+      send_data channel_event
     end
 
     def trigger_event(event)

data/lib/websocket_rails/version.rb

@@ -1,3 +1,3 @@
 module WebsocketRails
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-17 00:00:00.000000000Z
+date: 2012-07-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -232,7 +232,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1609185237032377191
+      hash: -2237718608609938640
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1609185237032377191
+      hash: -2237718608609938640
 requirements: []
 rubyforge_project: websocket-rails
 rubygems_version: 1.8.19