wwl-websocket-rails 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 597346f03088e98723978a05f9a3bda02b4bb2dc
+  data.tar.gz: e6d09575099ea548eff0218b781e7ddd21484349
+SHA512:
+  metadata.gz: cecbfecaa3337f54302ce33e08ac70f1eacfcdde7582420ff51e0a89283d54a2133de131514d40b6c52e58b66fc38fb29b37199034a10b4703d3d9832aacbd76
+  data.tar.gz: 56cb845c697ae92e2328a1deb5220c12472fa90f1a2a55467e224e61355282474c772a6ef07c873bfe7f6107284e5e2eb3b534c61dd1f9a9bad3857334822954

data/CHANGELOG.md

@@ -0,0 +1,328 @@
+# WebsocketRails Change Log
+
+## Version 0.7.0
+
+March 14 2014
+
+* Add verification of parsing results in Event. (Prevents a possible
+  denial of service attack when sending improperly formatted but valid
+  JSON. Thanks to @maharifu
+
+* Support HTTP streaming for Internet Explorer versions 8+ by using
+  XDomainRequest - Thanks to @lkol
+
+* Added a possibility to set channel success and failure callbacks on
+  subscribe. - Thanks to @lkol
+
+* Rescue symbolizing of channel names. fixes #166 - Thanks to @KazW
+
+* Refactor *.coffee files. Add reconnect() method. - Thanks to @jtomaszewski
+
+* Add Channel tokens to prevent unauthorized subscriptions to channels.
+  Thanks - @moaa and @elthariel
+
+* Fixed a bug where a newline was being outputted in the log regardless of log level - Thanks to @markmalek
+
+* Properly handle WSS and WS protocols in the JavaScript client - Thanks
+  to @markee
+
+* Defer #on_open to EM.next_tick. fixes #135 - Thanks to @moaa
+
+* Add subscriber Join/Part events for channels - Thanks to @moaa
+
+* Convert controller's `action_name` to a string to get AbstractController::Callbacks (`before_action`) working properly [fixes #150] - Thanks to @Pitr
+
+## Version 0.6.2
+
+September 8 2013
+
+* Updated Dispatcher#broadcast_message to work with the new
+ConnectionManager connections hash. - Thanks to @Frustrate @moaa
+
+## Version 0.6.1
+
+September 6 2013
+
+* Fixed the loading of event routes when launched in the production
+environment.
+
+## Version 0.6.0
+
+September 3 2013
+
+* Added the UserManager accessible through the `WebsocketRails.users`
+method. This allows for triggering events on individual logged in users
+from anywhere inside of your application without the need to create a
+channel for that user.
+
+## Version 0.5.0
+
+September 2 2013
+
+* Use window.location.protocol to choose between ws:// and wss://
+shcheme. - Thanks to @depili
+* Override ConnectionManager#inspect to clean up the output from `rake
+routes`
+* Added a basic Global UserManager for triggering events on specific users
+from anywhere inside your app without creating a dedicated user channel.
+* Deprecate the old controller observer system and implement full Rails
+AbstractController::Callbacks support. - Thanks to @pitr
+* Reload the events.rb event route file each time an event is fired. -
+Thanks to @moaa
+* Separated the event route file and WebsocketRails configuration files.
+The events.rb now lives in `config/events.rb`. The configuration should
+remain in an initializer located at `config/initializers/websocket_rails.rb`. - Thanks to @moaa
+
+## Version 0.4.9
+
+July 9 2013
+
+* Updated JavaScript client to properly keep track of the connection state.
+* Added .connection_stale() function to the JavaScript client for easily checking connection state.
+
+## Version 0.4.8
+
+July 6 2013
+
+* Fix error with class reloading in development with Rails 4
+* Added `connection.close!` method to allow for manually disconnecting users from a WebsocketRails controller.
+* Add a way to unsubscribe from channels via the JavaScript client. - Thanks to @Oxynum
+* Fix handling of `on_error` event in the JavaScript client. - Thanks to @imton
+
+## Version 0.4.7
+
+June 6 2013
+
+* Fix observer system - Thanks to @pitr
+* Fix spelling mistake in ConnectionAdapters#inspect - Thanks to
+@bmxpert1
+* Prevent duplicate events from being triggered when events are added
+directly to Redis from an outside process. - Thanks to @moaa
+* Only log event data if it is a Hash or String to drastically reduce
+the log file size. - Thanks to @florianguenther
+* Fix the intermittent uninitialized constant
+"WebsocketRails::InternalEvents" error in development. - Thanks to
+@DarkSwoop
+
+## Version 0.4.6
+
+May 9 2013
+
+* Manually load the Faye::WebSocket Thin adapter to support the latest
+version of the Faye::WebSocket gem. - Thanks to @Traxmaxx
+
+## Version 0.4.5
+
+May 5 2013
+
+* Fix controller class reloading in development. - Thanks to @florianguenther
+
+## Version 0.4.4
+
+April 28 2013
+
+* Remove existing subscribers from a channel when making it private to
+eliminate the potential for malicious users to eavesdrop on private
+channels. Addresses issue #72.
+* Prevent the server from crashing when receiving an uploaded file.
+Addresses issue #68.
+* Allow custom routes for the WebSocket server. Users of are
+no longer forced to use the `/websocket` route. - Thanks to @Cominch
+
+## Version 0.4.3
+
+March 12 2013
+
+* Change the log output in Channel#trigger_event. Fixes issue #61.
+* Cancel the ping timer when removing disconnecting a Connection.
+* Fix uninitialized constant WebsocketRails::Internal controller error.
+
+## Version 0.4.2
+
+March 1 2013
+
+* Check to make sure ActiveRecord is defined before calling
+ActiveRecord::RecordInvalid in Dispatcher. Fixes issue #54. - Thanks to
+@nessche
+
+## Version 0.4.1
+
+February 28 2013
+
+* Fix bug in ControllerFactory#reload! that prevented the handling of
+internal events when running in the Development environment. Fixes issue #50. - Thanks to @nessche
+
+* Only reload controller classes when Rails config.cache_classes is set
+to false instead of always reloading when in the Rails development
+environment. This better respects the Rails configuration options.
+Addresses issue #51. - Thanks to @ngauthier
+
+* Update the Rails engine to handle the new Rails 4 route path. Checks
+the Rails version and adds the correct path for the routes file. Fixes
+issue #49. - Thanks to @sgerrand
+
+## Version 0.4.0
+
+February 27 2013
+
+__There have been a few breaking changes in the public API since the
+last release. Please review the list below and consult the Wiki for more
+information regarding the usage of the new features.__
+
+* Controller instances no longer persist between events that are
+  triggered. Each event is processed by a new controller instance,
+similar to a standard Rails request. Since you can no longer use
+instance variables to temporarily persist data between events, there is
+a new Controller Data Store that can be used for this purpose. This
+change addresses issue #31.
+
+* The original DataStore class has been deprecated. In it's place are
+  the new Controller Data Store and Connection Data Store. As mentioned
+above, the Controller Data Store can be used to persist data between
+events in much the same way that you would use instance variables. The
+Connection Data Store acts like the Rails session store. Use it to store
+data private to a connection. Data in the Connection Data Store can be
+accessed from any controller. Check out the Wiki for more information on
+both.
+
+* The `websocket_rails.reload_controllers` event has been deprecated.
+  The new Controller instantiation model allows for automatic controller
+class reloading while in the development environment. You no longer
+need to trigger an event to pick up code changes in controllers while
+connections are active.
+
+* Real logging support has _finally_ been implemented. Check out the
+  configuration WIki for more information on the various logging options
+available.
+
+## Version 0.3.0
+
+February 6 2013
+
+* Extend the event router DSL to accept routes similar to the routes.rb
+  shorthand `controller#action`. - Thanks to @nessche.
+
+* Add a custom RSpec matcher suite for verifying event routes
+  and easily asserting that WebsocketRails controller actions are
+  triggering  events correctly. - Also thanks to @nessche.
+
+* Fix fiber yielded across threads bug when running in standalone mode
+  by disabling Thin threaded mode as default option.
+
+## Version 0.2.1
+
+January 29 2013
+
+* Fix default redis driver issue that was causing problems when using
+  redis while event machine was not running.
+
+* Fix undefined data store value issue. Thanks to @burninggramma.
+
+## Version 0.2.0
+
+November 25 2012
+
+* Add standalone server mode to support non event machine
+based web servers.
+
+## Version 0.1.9
+
+November 19 2012
+
+* Fix bug that crashed the server when receiving badly formed messages
+  through an open websocket. Fixes issue #27.
+
+* Add support for communication between multiple server instances and
+  background jobs. Solves scaling problems discussed in issue #21.
+
+* Fixed client_disconnected event firing twice - Thanks to
+  @nickdesaulniers
+
+## Version 0.1.8
+
+July 18 2012
+
+* Fix bug in Channel#trigger preventing the data from coming through
+  properly.
+
+## Version 0.1.7
+
+July 17 2012
+
+* Fixed botched release of 0.1.6
+* Reorganized directory structure
+
+## Version 0.1.6
+
+July 17 2012
+
+* Added private channel support - Thanks to @MhdSyrwan
+* Added DSL method for marking channels as private.
+* Added support for attaching success and failure callbacks to triggered
+  events on the JavaScript client.
+* Fixed JSON parsing bug in HTTP streaming client when multiple events
+  were received together.
+* Added connection keepalive ping/pong timers to ensure clients do not
+  disconnect automatically. Ensures HTTP streaming works well on Heroku.
+* Removed the requirement of using the thin-socketrails executable. The
+  executable will be removed entirely in the next release.
+* Added Jasmine specs for CoffeeScript client.
+* Exceptions triggered in controller actions are now serialized and
+  passed to the failure callback on the client that triggered the
+  action.
+* Events triggered on the client before the connection is fully
+  established are now queued and sent in bulk once the connection is
+  ready.
+
+## Version 0.1.5
+
+July 3 2012
+
+* Fixed bug in JavaScript client that caused Channels not to dispatch
+  correctly.
+* Rewrote JavaScript client in CoffeeScript.
+* Created project Wiki
+
+## Version 0.1.4
+
+June 30 2012
+
+* Added channel support
+* Fix the JavaScript client to work on the iPad - Thanks to @adamkittelson
+* Add an event queue on the connection object to allow for queueing up
+  multiple events before flushing to the client.
+* Add generator for creating the events.rb intializer and requiring the
+  client in the application.js sprockets manifest file.
+
+## Version 0.1.3
+
+June 22 2012
+
+* Added support for namespaced events.
+* Improved event machine scheduling for action processing.
+* Made a client's connection ID private.
+* Bugfixes in the JavaScript event dispatchers.
+
+## Version 0.1.2
+
+June 10 2012
+
+* Added streaming HTTP support as a fallback from WebSockets.
+* Added example JavaScript event dispatchers.
+
+## Version 0.1.1
+
+June 2 2012
+
+* Created project home page.
+* Improved test coverage and cleaned up the internals.
+
+## Version 0.1.0
+
+April 14 2012
+
+* Complete project rewrite.
+* Removed websocket-rack dependency.
+* Enhanced documentation.
+* Added event observers in WebsocketRail Controllers.
+* First stable release!

data/Gemfile

@@ -0,0 +1,27 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rspec-rails", ">=2.14.0"
+gem "therubyrhino"
+gem "therubyracer"
+gem "jasmine"
+gem "headless"
+gem "selenium-webdriver"
+gem "coffee-script"
+gem "thin"
+gem "eventmachine"
+gem "faye-websocket"
+gem "simplecov"
+gem "ruby_gntp"
+gem "guard"
+gem "guard-rspec"
+gem "guard-coffeescript"
+gem "rb-fsevent"
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter', :require => 'jdbc-sqlite3', :require => 'arjdbc'
+end
+platforms :ruby do
+  gem 'sqlite3'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Dan Knox and Kyle Whalen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,239 @@
+# Websocket-Rails
+
+[![Build Status](https://travis-ci.org/websocket-rails/websocket-rails.png?branch=master)](https://travis-ci.org/websocket-rails/websocket-rails)
+[![Gem Version](https://badge.fury.io/rb/websocket-rails.png)](http://badge.fury.io/rb/websocket-rails)
+[![Code Climate](https://codeclimate.com/github/websocket-rails/websocket-rails.png)](https://codeclimate.com/github/websocket-rails/websocket-rails)
+
+
+If you haven't done so yet, check out the [Project
+Page](http://websocket-rails.github.io) 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.
+
+**Find us on IRC #websocket-rails**
+
+Stop by #websocket-rails on freenode if you would like to chat or have any
+questions.
+
+## Recent Updates
+
+Check out the [CHANGELOG](https://github.com/websocket-rails/websocket-rails/blob/master/CHANGELOG.md) to find out what's new.
+
+As of version 0.2.0, non event machine based web servers such as Phusion
+Passenger are supported through the use of the [Standalone Server Mode](https://github.com/websocket-rails/websocket-rails/wiki/Standalone-Server-Mode).
+
+## Overview
+
+Start treating client side events as first class citizens inside your
+Rails application with a built in WebSocket server. Sure, WebSockets
+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.
+
+## Installation and Usage Guides
+
+* [Installation
+  Guide](https://github.com/websocket-rails/websocket-rails/wiki/Installation-and-Setup)
+* [Event
+  Router](https://github.com/websocket-rails/websocket-rails/wiki/The-Event-Router)
+* [WebsocketRails Controllers](https://github.com/websocket-rails/websocket-rails/wiki/WebsocketRails Controllers)
+* [Using the JavaScript
+  Client](https://github.com/websocket-rails/websocket-rails/wiki/Using-the-JavaScript-Client)
+* [Using
+  Channels](https://github.com/websocket-rails/websocket-rails/wiki/Working-with-Channels)
+* [Using Private Channels](https://github.com/websocket-rails/websocket-rails/wiki/Using-Private-Channels)
+* [The
+  DataStore](https://github.com/websocket-rails/websocket-rails/wiki/Using-the-DataStore)
+* [Reloading Controllers In Development](https://github.com/websocket-rails/websocket-rails/wiki/Reloading-Controllers-In-Development)
+* [Multiple Servers and Background Jobs](https://github.com/websocket-rails/websocket-rails/wiki/Multiple-Servers-and-Background-Jobs)
+* [Standalone Server Mode](https://github.com/websocket-rails/websocket-rails/wiki/Standalone-Server-Mode)
+
+## Handle Events With Class
+
+Map events to controller actions using an Event Router.
+
+````ruby
+WebsocketRails::EventMap.describe do
+  namespace :tasks do
+  
+    # using a Hash to specify the target
+    subscribe :create, :to => TaskController, :with_method => :create
+    
+    # using the same syntax as routes.rb
+    subscribe :update, 'task#update'
+    
+    # if your controller is not a top-level object
+    subscribe :create_admin, :to => Admin::TaskController, :with_method => :create
+
+    subscribe :update_admin, 'admin/task#update'
+
+  end
+end
+````
+
+Trigger events using our JavaScript client.
+
+````javascript
+var task = {
+  name: 'Start taking advantage of WebSockets',
+  completed: false
+}
+
+var dispatcher = new WebSocketRails('localhost:3000/websocket');
+
+dispatcher.trigger('tasks.create', task);
+````
+
+Handle events in your controller.
+
+````ruby
+class TaskController < WebsocketRails::BaseController
+  def create
+    # The `message` method contains the data received
+    task = Task.new message
+    if task.save
+      send_message :create_success, task, :namespace => :tasks
+    else
+      send_message :create_fail, task, :namespace => :tasks
+    end
+  end
+end
+````
+
+Receive the response in the client.
+
+````javascript
+dispatcher.bind('tasks.create_success', function(task) {
+  console.log('successfully created ' + task.name);
+});
+````
+
+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', task, 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
+````
+
+Note that if you do not trigger the event, a success will be automatically triggered with no data. You can change this behavior by editing the gem configurations and add : `config.trigger_success_by_default = false`.
+
+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." );
+}
+````
+
+You can stop listening to an event now by using the unbind function.
+
+````javascript
+dispatcher.unbind('tasks.create_success');
+````
+
+## Channel Support
+
+Keep your users up to date without waiting for them to refresh the page.
+Subscribe them to a channel and update it from wherever you please.
+
+Tune in on the client side.
+
+````javascript
+channel = dispatcher.subscribe('posts');
+channel.bind('new', function(post) {
+  console.log('a new post about '+post.title+' arrived!');
+});
+````
+
+Broadcast to the channel from anywhere inside your Rails application. An
+existing controller, a model, a background job, or a new WebsocketRails
+controller.
+
+````ruby
+latest_post = Post.latest
+WebsocketRails[:posts].trigger 'new', latest_post
+````
+
+## Private Channel Support
+
+Need to restrict access to a particular channel? No problem. We've got
+that. 
+
+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/websocket-rails/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.
+
+## Credit where credit is due
+
+Big thanks to our [contributors](https://github.com/websocket-rails/websocket-rails/graphs/contributors) who have helped keep this project moving.
+
+Special thanks to [@nessche](https://github.com/nessche) who provided the improved routing DSL and RSpec matcher suite.
+
+The `websocket-rails` organization logo was kindly provided by [Uken Games](http://www.uken.com/).
+
+## Development
+
+Please check out the [Development Guide](https://github.com/websocket-rails/websocket-rails/wiki/Development) if you are interested in contributing. It should cover everything you need to get up and running.
+
+## Core Team
+
+The current `websocket-rails` core team consists of the following individuals:
+
+* [@DanKnox](https://github.com/DanKnox)
+* [@Pitr](https://github.com/pitr)
+* [@moaa](https://github.com/moaa)
+
+New contributors and pull requests are always welcome.

data/Rakefile

@@ -0,0 +1,72 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'rake'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+Bundler::GemHelper.install_tasks
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'websocket-rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run RSpec and Jasmine specs.'
+task :default => :spec_and_jasmine
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+desc "Run rspec and jasmine:ci at the same time"
+task :spec_and_jasmine do
+  Rake::Task["spec"].execute
+  Rake::Task["jasmine:ci:headless"].execute
+end
+
+desc "Generate code coverage"
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task["spec"].execute
+  `open coverage/index.html`
+end
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end
+
+require 'headless'
+require 'selenium-webdriver'
+
+namespace :jasmine do
+  namespace :ci do
+    desc "Run Jasmine CI build headlessly"
+    task :headless do
+      ENV['DISPLAY'] = ':99.0'
+      puts "Running Jasmine Headlessly"
+      Rake::Task['jasmine:ci'].invoke
+    end
+  end
+end