websocket-rails 0.6.2 → 0.7.0

data/lib/assets/javascripts/websocket_rails/websocket_connection.js.coffee

@@ -1,43 +1,29 @@
 ###
 WebSocket Interface for the WebSocketRails client.
 ###
-class WebSocketRails.WebSocketConnection
-
-  constructor: (@url,@dispatcher) ->
+class WebSocketRails.WebSocketConnection extends WebSocketRails.AbstractConnection
+  connection_type: 'websocket'
+  
+  constructor: (@url, @dispatcher) ->
+    super
     if @url.match(/^wss?:\/\//)
         console.log "WARNING: Using connection urls with protocol specified is depricated"
-    else if window.location.protocol == 'http:'
-        @url             = "ws://#{@url}"
-    else
+    else if window.location.protocol == 'https:'
         @url             = "wss://#{@url}"
-    
-    @message_queue   = []
-    @_conn           = new WebSocket(@url)
-    @_conn.onmessage = @on_message
-    @_conn.onclose   = @on_close
-    @_conn.onerror   = @on_error
-
-  trigger: (event) =>
-    if @dispatcher.state != 'connected'
-      @message_queue.push event
     else
-      @_conn.send event.serialize()
-
-  on_message: (event) =>
-    data = JSON.parse event.data
-    @dispatcher.new_message data
-
-  on_close: (event) =>
-    close_event = new WebSocketRails.Event(['connection_closed', event])
-    @dispatcher.state = 'disconnected'
-    @dispatcher.dispatch close_event
+        @url             = "ws://#{@url}"
+    @_conn           = new WebSocket(@url)
+    @_conn.onmessage = (event) => 
+      event_data = JSON.parse event.data
+      @on_message(event_data)
+    @_conn.onclose   = (event) => 
+      @on_close(event)
+    @_conn.onerror   = (event) => 
+      @on_error(event)
 
-  on_error: (event) =>
-    error_event = new WebSocketRails.Event(['connection_error', event])
-    @dispatcher.state = 'disconnected'
-    @dispatcher.dispatch error_event
+  close: ->
+    @_conn.close()
 
-  flush_queue: =>
-    for event in @message_queue
-      @_conn.send event.serialize()
-    @message_queue = []
+  send_event: (event) ->
+    super
+    @_conn.send event.serialize()

data/lib/assets/javascripts/websocket_rails/websocket_rails.js.coffee

@@ -18,24 +18,55 @@ Listening for new events from the server
 ###
 class @WebSocketRails
   constructor: (@url, @use_websockets = true) ->
-    @state     = 'connecting'
     @callbacks = {}
     @channels  = {}
     @queue     = {}
 
+    @connect()
+
+  connect: ->
+    @state = 'connecting'
+
     unless @supports_websockets() and @use_websockets
-      @_conn = new WebSocketRails.HttpConnection url, @
+      @_conn = new WebSocketRails.HttpConnection @url, @
     else
-      @_conn = new WebSocketRails.WebSocketConnection url, @
+      @_conn = new WebSocketRails.WebSocketConnection @url, @
 
     @_conn.new_message = @new_message
 
+  disconnect: ->
+    if @_conn
+      @_conn.close()
+      delete @_conn._conn
+      delete @_conn
+
+    @state     = 'disconnected'
+
+  # Reconnects the whole connection, 
+  # keeping the messages queue and its' connected channels.
+  # 
+  # After successfull connection, this will:
+  # - reconnect to all channels, that were active while disconnecting
+  # - resend all events from which we haven't received any response yet
+  reconnect: =>
+    old_connection_id = @_conn?.connection_id
+
+    @disconnect()
+    @connect()
+
+    # Resend all unfinished events from the previous connection.
+    for id, event of @queue
+      if event.connection_id == old_connection_id && !event.is_result()
+        @trigger_event event
+
+    @reconnect_channels()
+
   new_message: (data) =>
     for socket_message in data
       event = new WebSocketRails.Event( socket_message )
       if event.is_result()
         @queue[event.id]?.run_callbacks(event.success, event.data)
-        @queue[event.id] = null
+        delete @queue[event.id]
       else if event.is_channel()
         @dispatch_channel event
       else if event.is_ping()
@@ -48,8 +79,8 @@ class @WebSocketRails
 
   connection_established: (data) =>
     @state         = 'connected'
-    @connection_id = data.connection_id
-    @_conn.flush_queue data.connection_id
+    @_conn.setConnectionId(data.connection_id)
+    @_conn.flush_queue()
     if @on_open?
       @on_open(data)
 
@@ -58,30 +89,30 @@ class @WebSocketRails
     @callbacks[event_name].push callback
 
   trigger: (event_name, data, success_callback, failure_callback) =>
-    event = new WebSocketRails.Event( [event_name, data, @connection_id], success_callback, failure_callback )
-    @queue[event.id] = event
-    @_conn.trigger event
+    event = new WebSocketRails.Event( [event_name, data, @_conn?.connection_id], success_callback, failure_callback )
+    @trigger_event event
 
   trigger_event: (event) =>
     @queue[event.id] ?= event # Prevent replacing an event that has callbacks stored
-    @_conn.trigger event
+    @_conn.trigger event if @_conn
+    event
 
   dispatch: (event) =>
     return unless @callbacks[event.name]?
     for callback in @callbacks[event.name]
       callback event.data
 
-  subscribe: (channel_name) =>
+  subscribe: (channel_name, success_callback, failure_callback) =>
     unless @channels[channel_name]?
-      channel = new WebSocketRails.Channel channel_name, @
+      channel = new WebSocketRails.Channel channel_name, @, false, success_callback, failure_callback
       @channels[channel_name] = channel
       channel
     else
       @channels[channel_name]
 
-  subscribe_private: (channel_name) =>
+  subscribe_private: (channel_name, success_callback, failure_callback) =>
     unless @channels[channel_name]?
-      channel = new WebSocketRails.Channel channel_name, @, true
+      channel = new WebSocketRails.Channel channel_name, @, true, success_callback, failure_callback
       @channels[channel_name] = channel
       channel
     else
@@ -100,8 +131,22 @@ class @WebSocketRails
     (typeof(WebSocket) == "function" or typeof(WebSocket) == "object")
 
   pong: =>
-    pong = new WebSocketRails.Event( ['websocket_rails.pong',{},@connection_id] )
+    pong = new WebSocketRails.Event( ['websocket_rails.pong', {}, @_conn?.connection_id] )
     @_conn.trigger pong
 
   connection_stale: =>
     @state != 'connected'
+
+  # Destroy and resubscribe to all existing @channels.
+  reconnect_channels: ->
+    for name, channel of @channels
+      callbacks = channel._callbacks
+      channel.destroy()
+      delete @channels[name]
+
+      channel = if channel.is_private
+        @subscribe_private name
+      else
+        @subscribe name
+      channel._callbacks = callbacks
+      channel

data/lib/generators/websocket_rails/install/templates/websocket_rails.rb

@@ -22,6 +22,9 @@ WebsocketRails.setup do |config|
   # * Requires Redis.
   config.synchronize = false
 
+  # Prevent Thin from daemonizing (default is true)
+  # config.daemonize = false
+
   # Uncomment and edit to point to a different redis instance.
   # Will not be used unless standalone or synchronization mode
   # is enabled.
@@ -33,6 +36,13 @@ WebsocketRails.setup do |config|
   # when making it private, set the following to true.
   # config.keep_subscribers_when_private = false
 
+  # Set to true if you wish to broadcast channel subscriber_join and
+  # subscriber_part events. All subscribers of a channel will be 
+  # notified when other clients join and part the channel. If you are
+  # using the UserManager, the current_user object will be sent along
+  # with the event.
+  # config.broadcast_subscriber_events = true
+
   # Used as the key for the WebsocketRails.users Hash. This method
   # will be called on the `current_user` object in your controller
   # if one exists. If `current_user` does not exist or does not
@@ -45,4 +55,9 @@ WebsocketRails.setup do |config|
   # jobs using the WebsocketRails.users UserManager.
   # config.user_class = User
 
+  # Supporting HTTP streaming on Internet Explorer versions 8 & 9
+  # requires CORS to be enabled for GET "/websocket" request.
+  # List here the origin domains allowed to perform the request.
+  # config.allowed_origins = ['http://localhost:3000']
+
 end

data/lib/rails/config/routes.rb

@@ -1,6 +1,6 @@
 Rails.application.routes.draw do
   if Rails.version >= '4.0.0'
-    get "/websocket", :to => WebsocketRails::ConnectionManager.new
+    match "/websocket", :to => WebsocketRails::ConnectionManager.new, via: [:get, :post]
   else
     match "/websocket", :to => WebsocketRails::ConnectionManager.new
   end

data/lib/rails/tasks/websocket_rails.tasks

@@ -9,8 +9,12 @@ namespace :websocket_rails do
 
     warn_if_standalone_not_enabled!
 
-    fork do
-      Thin::Controllers::Controller.new(options).start
+    if options[:daemonize]
+      fork do
+        Thin::Controllers::Controller.new(options).start
+      end
+    else
+        Thin::Controllers::Controller.new(options).start
     end
 
     puts "Websocket Rails Standalone Server listening on port #{options[:port]}"

data/lib/websocket_rails/channel.rb

@@ -3,7 +3,7 @@ module WebsocketRails
 
     include Logging
 
-    delegate :config, :to => WebsocketRails
+    delegate :config, :channel_tokens, :channel_manager, :to => WebsocketRails
 
     attr_reader :name, :subscribers
 
@@ -15,17 +15,20 @@ module WebsocketRails
 
     def subscribe(connection)
       info "#{connection} subscribed to channel #{name}"
+      trigger 'subscriber_join', connection.user if config.broadcast_subscriber_events?
       @subscribers << connection
+      send_token connection
     end
 
     def unsubscribe(connection)
       return unless @subscribers.include? connection
       info "#{connection} unsubscribed from channel #{name}"
       @subscribers.delete connection
+      trigger 'subscriber_part', connection.user if config.broadcast_subscriber_events?
     end
 
     def trigger(event_name,data={},options={})
-      options.merge! :channel => name
+      options.merge! :channel => name, :token => token
       options[:data] = data
 
       event = Event.new event_name, options
@@ -35,6 +38,7 @@ module WebsocketRails
     end
 
     def trigger_event(event)
+      return if event.token != token
       info "[#{name}] #{event.data.inspect}"
       send_data event
     end
@@ -50,8 +54,30 @@ module WebsocketRails
       @private
     end
 
+    def token
+      @token ||= channel_tokens[@name] ||= generate_unique_token
+    end
+
     private
 
+    def generate_unique_token
+      begin
+        new_token = SecureRandom.uuid
+      end while channel_tokens.values.include?(new_token)
+
+      new_token
+    end
+
+    def send_token(connection)
+      options = {
+        :channel => @name,
+        :data => {:token => token},
+        :connection => connection
+      }
+      info 'sending token'
+      Event.new('websocket_rails.channel_token', options).trigger
+    end
+
     def send_data(event)
       if WebsocketRails.synchronize? && event.server_token.nil?
         Synchronization.publish event

data/lib/websocket_rails/channel_manager.rb

@@ -1,3 +1,5 @@
+require 'redis-objects'
+
 module WebsocketRails
 
   class << self
@@ -10,6 +12,10 @@ module WebsocketRails
       channel_manager[channel]
     end
 
+    def channel_tokens
+      channel_manager.channel_tokens
+    end
+
   end
 
   class ChannelManager
@@ -20,6 +26,16 @@ module WebsocketRails
       @channels = {}.with_indifferent_access
     end
 
+    def channel_tokens
+      @channel_tokens ||= begin
+        if WebsocketRails.synchronize?
+          ::Redis::HashKey.new('websocket_rails.channel_tokens', Synchronization.redis)
+        else
+          {}
+        end
+      end
+    end
+
     def [](channel)
       @channels[channel] ||= Channel.new channel
     end

data/lib/websocket_rails/configuration.rb

@@ -25,6 +25,23 @@ module WebsocketRails
       @keep_subscribers_when_private = value
     end
 
+    def allowed_origins
+      # allows the value to be string or array
+      [@allowed_origins].flatten.compact.uniq ||= []
+    end
+
+    def allowed_origins=(value)
+      @allowed_origins = value
+    end
+
+    def broadcast_subscriber_events?
+      @broadcast_subscriber_events ||= false
+    end
+
+    def broadcast_subscriber_events=(value)
+      @broadcast_subscriber_events = value
+    end
+
     def route_block=(routes)
       @event_routes = routes
     end
@@ -73,6 +90,14 @@ module WebsocketRails
       @log_internal_events = value
     end
 
+    def daemonize?
+      @daemonize.nil? ? true : @daemonize
+    end
+
+    def daemonize=(value)
+      @daemonize = value
+    end
+
     def synchronize
       @synchronize ||= false
     end
@@ -125,7 +150,7 @@ module WebsocketRails
         :tag => 'websocket_rails',
         :rackup => "#{Rails.root}/config.ru",
         :threaded => false,
-        :daemonize => true,
+        :daemonize => daemonize?,
         :dirname => Rails.root,
         :max_persistent_conns => 1024,
         :max_conns => 1024

data/lib/websocket_rails/connection_adapters/http.rb

@@ -21,6 +21,13 @@ module WebsocketRails
 
         define_deferrable_callbacks
 
+        origin = "#{request.protocol}#{request.raw_host_with_port}"
+        @headers.merge!({'Access-Control-Allow-Origin' => origin}) if WebsocketRails.config.allowed_origins.include?(origin)
+        # IE < 10.0 hack
+        # XDomainRequest will not bubble up notifications of download progress in the first 2kb of the response
+        # http://blogs.msdn.com/b/ieinternals/archive/2010/04/06/comet-streaming-in-internet-explorer-with-xmlhttprequest-and-xdomainrequest.aspx
+        @body.chunk(encode_chunk(" " * 2048))
+
         EM.next_tick do
           @env['async.callback'].call [200, @headers, @body]
           on_open

data/lib/websocket_rails/connection_adapters/web_socket.rb

@@ -12,7 +12,9 @@ module WebsocketRails
         @connection.onmessage = method(:on_message)
         @connection.onerror   = method(:on_error)
         @connection.onclose   = method(:on_close)
-        on_open
+        EM.next_tick do
+          on_open
+        end
       end
 
       def send(message)

data/lib/websocket_rails/connection_manager.rb

@@ -63,7 +63,7 @@ module WebsocketRails
     private
 
     def parse_incoming_event(params)
-      connection = find_connection_by_id(params["client_id"].to_i)
+      connection = find_connection_by_id(params["client_id"])
       connection.on_message params["data"]
       SuccessfulResponse
     end

data/lib/websocket_rails/controller_factory.rb

@@ -47,7 +47,7 @@ module WebsocketRails
     end
 
     def set_action_name(controller, method)
-      set_ivar :@_action_name, controller, method
+      set_ivar :@_action_name, controller, method.to_s
     end
 
     def set_ivar(ivar, object, value)