realtime 0.0.12 → 0.1.0

data/app/views/realtime/_realtime_loader.html.erb

@@ -0,0 +1,14 @@
+if (window.realtime.socketIo) {
+
+  window.realtime.enabled = true;
+
+  window.realtime.socketIo.on('connect', function() {
+    // Give a nice round-trip ACK to our realtime server that we connected.
+      window.realtime.socketIo.emit('realtime_user_id_connected', { userId: window.realtime.userId });
+    });
+
+  // Queue up all incoming realtime messages.
+    window.realtime.socketIo.on('realtime_msg', function(message) {
+      window.realtime.messageQueue.push(message);
+  });
+}

data/app/views/realtime/_realtime_message_console_logger.html.erb

@@ -0,0 +1,20 @@
+if (window.realtime.enabled && window.realtime.eventBus){
+  // handle events in the queue with eventing
+  var realtimeMessageEventConsoleLogger = function(message) {
+    console.log(message);
+  };
+  window.realtime.eventBus.on('realtimeMessage', realtimeMessageEventConsoleLogger);
+
+} else if (window.realtime.enabled) {
+  // handle events in the queue without eventing
+  messageQueueConsoleLogger = function() {
+    message = window.realtime.messageQueue.shift();
+    if (message) {
+      console.log(message);
+    }
+  };
+  setInterval(messageQueueConsoleLogger, 100);
+
+} else {
+  console.log('Error: Realtime was not enabled.')
+}

data/app/views/realtime/_realtime_message_handler.html.erb

@@ -0,0 +1,13 @@
+if (window.realtime.enabled){
+
+  window.realtime.eventBus = _.extend({}, Backbone.Events);
+
+  messageQueueRunner = function() {
+    message = window.realtime.messageQueue.shift();
+    if (message) {
+      window.realtime.eventBus.trigger('realtimeMessage', message);
+    }
+  };
+
+  setInterval(messageQueueRunner, 100);
+}

data/app/views/realtime/async_realtime_support.html.erb

@@ -0,0 +1,71 @@
+<script type='text/javascript'>
+
+	window.realtime = {};
+	window.realtime.messageQueue = [];
+	window.realtime.enabled = false;
+
+  (function () {
+    // Load external scripts asynchronously
+    var loadScript = function (src, callback) {
+      var s, r, t;
+      r = false;
+      s = document.createElement('script');
+      s.type = 'text/javascript';
+      s.src = src;
+      s.onload = s.onreadystatechange = function () {
+        if (!r && (!this.readyState || this.readyState == 'complete'))
+        {
+          r = true;
+          callback();
+        }
+      };
+      t = document.getElementsByTagName('script')[0];
+      t.parentNode.insertBefore(s, t);
+    };
+
+    // Trigger a custom event that the user JS can listen for
+    // when everything finishes loading
+    var triggerEvent = function (name) {
+      var event;
+
+      if (document.createEvent) {
+        event = document.createEvent('HTMLEvents');
+        event.initEvent(name, true, true);
+        event.eventName = name;
+        document.dispatchEvent(event);
+      } else {
+        // For IE compatibility
+        event = document.createEventObject();
+        event.eventType = name;
+        event.eventName = name;
+        document.fireEvent('on' + event.eventType, event);
+      }
+    };
+
+    loadScript('<%= realtime_server_url %>/socket.io/socket.io.js', function () {
+      if (typeof io != 'undefined' && io != null) {
+        window.realtime.token = '<%= realtime_token %>';
+        window.realtime.userId = '<%= realtime_user_id %>';
+        window.realtime.socketIo = io.connect('<%= realtime_server_url %>/?_rtUserId=<%= @realtime_user_id %>&_rtToken=<%= @realtime_token %>');
+      }
+
+      <%= render "realtime/realtime_loader" %>
+
+      <% if message_handler %>
+        loadScript('//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.6.0/underscore-min.js', function () {
+          loadScript('//cdnjs.cloudflare.com/ajax/libs/backbone.js/1.1.2/backbone-min.js', function () {
+            <%= render "realtime/realtime_message_handler" %>
+
+            triggerEvent('realtime:loaded')
+          })
+        })
+      <% else %>
+        <% if message_console_logger %>
+          <%= render "realtime/realtime_message_console_logger" %>
+        <% end %>
+
+        triggerEvent('realtime:loaded')
+      <% end %>
+    })
+  })();
+</script>

data/app/views/realtime/realtime_message_console_logger.html.erb

@@ -1,25 +1,3 @@
 <script type='text/javascript'>
-
-
-	if (window.realtime.enabled && window.realtime.eventBus){
-		// handle events in the queue with eventing
-		var realtimeMessageEventConsoleLogger = function(message) {
-			console.log(message);
-		};
-		window.realtime.eventBus.on('realtimeMessage', realtimeMessageEventConsoleLogger);
-
-	} else if (window.realtime.enabled) {
-		// handle events in the queue without eventing
-		messageQueueConsoleLogger = function() {
-			message = window.realtime.messageQueue.shift();
-			if (message) {
-				console.log(message);
-			}
-		};
-		setInterval(messageQueueConsoleLogger, 100);
-
-	} else {
-		console.log('Error: Realtime was not enabled.')
-	}
-	
-</script>
+  <%= render "realtime/realtime_message_console_logger" %>
+</script>

data/app/views/realtime/realtime_message_handler.html.erb

@@ -1,22 +1,7 @@
-
 <script src="//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.6.0/underscore-min.js"></script>
 
 <script src="//cdnjs.cloudflare.com/ajax/libs/backbone.js/1.1.2/backbone-min.js"></script>
 
 <script type='text/javascript'>
-
-	if (window.realtime.enabled){
-
-		window.realtime.eventBus = _.extend({}, Backbone.Events);
-		
-		messageQueueRunner = function() {
-			message = window.realtime.messageQueue.shift();
-			if (message) {
-				window.realtime.eventBus.trigger('realtimeMessage', message);
-			}
-		};
-
-		setInterval(messageQueueRunner, 100);
-	}
-
-</script>
+  <%= render "realtime/realtime_message_handler" %>
+</script>

data/app/views/realtime/realtime_support.html.erb

@@ -16,19 +16,22 @@
 		window.realtime.socketIo = io.connect('<%= realtime_server_url %>/?_rtUserId=<%= @realtime_user_id %>&_rtToken=<%= @realtime_token %>');
 	}
 
-	if (window.realtime.socketIo) {
-	
-		window.realtime.enabled = true;
-
-		window.realtime.socketIo.on('connect', function() {
-			// Give a nice round-trip ACK to our realtime server that we connected.
-    		window.realtime.socketIo.emit('realtime_user_id_connected', { userId: window.realtime.userId });
-  		});
-
-		// Queue up all incoming realtime messages.
-  		window.realtime.socketIo.on('realtime_msg', function(message) {
-    		window.realtime.messageQueue.push(message);
-		});
-	}
+  <%= render "realtime/realtime_loader" %>
+
+</script>
+
+<% if message_handler %>
+  <script src="//cdnjs.cloudflare.com/ajax/libs/underscore.js/1.6.0/underscore-min.js"></script>
+
+  <script src="//cdnjs.cloudflare.com/ajax/libs/backbone.js/1.1.2/backbone-min.js"></script>
+
+  <script type='text/javascript'>
+    <%= render "realtime/realtime_message_handler" %>
+  </script>
+<% end %>
 
-</script>
+<% if message_console_logger %>
+  <script type='text/javascript'>
+    <%= render "realtime/realtime_message_console_logger" %>
+  </script>
+<% end %>

data/lib/realtime.rb

@@ -1,6 +1,6 @@
-
-require "realtime/realtime_controller.rb" 
-require "realtime/redis_wrapper.rb"
-require "realtime/zmq_wrapper.rb"
-require 'realtime/view_helpers.rb'
-require 'realtime/railtie.rb' 
+
+require "realtime/realtime_controller.rb" 
+require "realtime/redis_wrapper.rb"
+require "realtime/zmq_wrapper.rb"
+require 'realtime/view_helpers.rb'
+require 'realtime/railtie.rb' 

data/lib/realtime/realtime_controller.rb

@@ -1,75 +1,75 @@
-module Realtime
-	module Controller
-		extend ActiveSupport::Concern
-
-		module ClassMethods
-			def realtime_controller(options = nil)
-			 	before_filter :do_realtime_token
-			 	before_filter :do_realtime_user_id
-			 	before_filter :do_realtime_server_url
-			 	if options.nil?
-			 		after_filter :store_realtime_session_redis
-			 	elsif options[:queue] == :redis
-			 		after_filter :store_realtime_session_redis
-			 	elsif options[:queue] == :zmq
-			 		after_filter :store_realtime_session_zmq
-			 	end
-			end
-		end
-
-		def do_realtime_token
-			@realtime_token = Digest::MD5.hexdigest("#{session[:session_id]}:#{realtime_user_id}")
-			return @realtime_token
-		end
-
-		def do_realtime_user_id
-			@realtime_user_id = realtime_user_id
-			return @realtime_user_id
-		end
-
-		def do_realtime_server_url
-			@realtime_server_url = realtime_server_url
-			return @realtime_server_url
-		end
-
-		 # create shared session tokens for redis/socketio realtime server running on node.js
-		def store_realtime_session_zmq
-			# store session data or any authentication data you want here, generate to JSON data
-			session_data = {
-					"user_id" => realtime_user_id,
-			}
-
-			# todo: merge additional session data passed in
-			stored_session_data = JSON.generate(session_data)
-
-			ZmqWrapper.store_session(
-				realtime_user_id, 
-				@realtime_token, 
-				stored_session_data, 
-				86400
-			)
-		end
-
-	    # create shared session tokens for redis/socketio realtime server running on node.js
-		def store_realtime_session_redis
-			# store session data or any authentication data you want here, generate to JSON data
-			session_data = {
-					"user_id" => realtime_user_id,
-			}
-
-			# todo: merge additional session data passed in
-			
-			stored_session_data = JSON.generate(session_data)
-
-			RedisWrapper.redis.hset(
-				"rtSession-" + realtime_user_id.to_s,
-				@realtime_token,
-				stored_session_data,
-			)
-			
-			# expire this realtime session after one day.
-			RedisWrapper.redis.expire("rtSession-" + realtime_user_id.to_s, 86400)
-		end
-
-	end
+module Realtime
+	module Controller
+		extend ActiveSupport::Concern
+
+		module ClassMethods
+			def realtime_controller(options = nil)
+			 	before_filter :do_realtime_token
+			 	before_filter :do_realtime_user_id
+			 	before_filter :do_realtime_server_url
+			 	if options.nil?
+			 		after_filter :store_realtime_session_redis
+			 	elsif options[:queue] == :redis
+			 		after_filter :store_realtime_session_redis
+			 	elsif options[:queue] == :zmq
+			 		after_filter :store_realtime_session_zmq
+			 	end
+			end
+		end
+
+		def do_realtime_token
+			@realtime_token = Digest::MD5.hexdigest("#{session[:session_id]}:#{realtime_user_id}")
+			return @realtime_token
+		end
+
+		def do_realtime_user_id
+			@realtime_user_id = realtime_user_id
+			return @realtime_user_id
+		end
+
+		def do_realtime_server_url
+			@realtime_server_url = realtime_server_url
+			return @realtime_server_url
+		end
+
+		 # create shared session tokens for redis/socketio realtime server running on node.js
+		def store_realtime_session_zmq
+			# store session data or any authentication data you want here, generate to JSON data
+			session_data = {
+					"user_id" => realtime_user_id,
+			}
+
+			# todo: merge additional session data passed in
+			stored_session_data = JSON.generate(session_data)
+
+			ZmqWrapper.store_session(
+				realtime_user_id, 
+				@realtime_token, 
+				stored_session_data, 
+				86400
+			)
+		end
+
+	    # create shared session tokens for redis/socketio realtime server running on node.js
+		def store_realtime_session_redis
+			# store session data or any authentication data you want here, generate to JSON data
+			session_data = {
+					"user_id" => realtime_user_id,
+			}
+
+			# todo: merge additional session data passed in
+			
+			stored_session_data = JSON.generate(session_data)
+
+			RedisWrapper.redis.hset(
+				"rtSession-" + realtime_user_id.to_s,
+				@realtime_token,
+				stored_session_data,
+			)
+			
+			# expire this realtime session after one day.
+			RedisWrapper.redis.expire("rtSession-" + realtime_user_id.to_s, 86400)
+		end
+
+	end
 end

data/lib/realtime/version.rb

@@ -1,3 +1,3 @@
-module Realtime
-  VERSION = "0.0.12"
-end
+module Realtime
+  VERSION = "0.1.0"
+end

data/lib/realtime/view_helpers.rb

@@ -1,29 +1,33 @@
 module Realtime
-	module ViewHelpers
+  module ViewHelpers
 
-		def realtime_support
-			return render(:template =>"realtime/realtime_support", 
-					:layout => nil, 
-					:locals => 
-					{ :realtime_token => @realtime_token,
-					  :realtime_domain => @realtime_domain,
-					  :realtime_server_url => @realtime_server_url,
-					  :realtime_user_id => @realtime_user_id }).to_s
-			
-		end
+    def realtime_support(args = {})
+      async = args[:async] ? 'async_' : ''
+      return render(template: "realtime/#{async}realtime_support",
+                    layout: nil,
+                    locals:
+                    { realtime_token: @realtime_token,
+                      realtime_domain: @realtime_domain,
+                      realtime_server_url: @realtime_server_url,
+                      realtime_user_id: @realtime_user_id,
+                      message_handler: args[:message_handler],
+                      message_console_logger: args[:message_console_logger] }).to_s
+    end
 
-		def realtime_message_handler
-			return render(:template =>"realtime/realtime_message_handler", 
-					:layout => nil, 
-					:locals => {}).to_s
-			
-		end
+    def realtime_message_handler
+      ActiveSupport::Deprecation.warn("'realtime_message_handler' is deprecated, "\
+                                      "please refer to the documentation for details.")
+      return render(template: "realtime/realtime_message_handler",
+                    layout: nil,
+                    locals: {}).to_s
+    end
 
-		def realtime_message_console_logger
-			return render(:template =>"realtime/realtime_message_console_logger", 
-					:layout => nil, 
-					:locals => {}).to_s
-			
-		end
-	end
-end
+    def realtime_message_console_logger
+      ActiveSupport::Deprecation.warn("'realtime_message_console_logger' is deprecated, "\
+                                      "please refer to the documentation for details.")
+      return render(template: "realtime/realtime_message_console_logger",
+                    layout: nil,
+                    locals: {}).to_s
+    end
+  end
+end

data/lib/realtime/zmq_wrapper.rb

@@ -1,34 +1,34 @@
-class ZmqWrapper
-
-	if defined?(ZMQ) && defined?(EmZeromq)
-		require 'em-zeromq'
-
-		def self.publish(the_message)
-			EM.run {
-				zmq = EM::ZeroMQ::Context.new(1)
-				pusher = zmq.socket(ZMQ::PUSH)
-				pusher.connect($zmq_server)
-				message = "realtime_msg:" + the_message.to_json	
-				puts "Pushing realtime message: " + message
-				pusher.send_msg(message)
-				EM.stop
-			}
-		end
-
-		def self.store_session(user_id, session_id, session_data, expiration)
-			EM.run {
-				zmq = EM::ZeroMQ::Context.new(1)
-				pusher = zmq.socket(ZMQ::PUSH)
-				pusher.connect($zmq_server)
-				the_message = {user_id: user_id, 
-					session_id: session_id,
-					session_data: session_data,
-					expiration: expiration}
-					message = "rtSession:" + the_message.to_json	
-					puts "Pushing session message: " + message
-					pusher.send_msg(message)
-					EM.stop
-				}
-		end
-	end
-end
+class ZmqWrapper
+
+	if defined?(ZMQ) && defined?(EmZeromq)
+		require 'em-zeromq'
+
+		def self.publish(the_message)
+			EM.run {
+				zmq = EM::ZeroMQ::Context.new(1)
+				pusher = zmq.socket(ZMQ::PUSH)
+				pusher.connect($zmq_server)
+				message = "realtime_msg:" + the_message.to_json	
+				puts "Pushing realtime message: " + message
+				pusher.send_msg(message)
+				EM.stop
+			}
+		end
+
+		def self.store_session(user_id, session_id, session_data, expiration)
+			EM.run {
+				zmq = EM::ZeroMQ::Context.new(1)
+				pusher = zmq.socket(ZMQ::PUSH)
+				pusher.connect($zmq_server)
+				the_message = {user_id: user_id, 
+					session_id: session_id,
+					session_data: session_data,
+					expiration: expiration}
+					message = "rtSession:" + the_message.to_json	
+					puts "Pushing session message: " + message
+					pusher.send_msg(message)
+					EM.stop
+				}
+		end
+	end
+end

metadata

@@ -1,27 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: realtime
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Mike Atlas
+- Ahmad Abdel-Yaman (@ayaman)
+- Nick Prokesch (@prokizzle)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-11 00:00:00.000000000 Z
+date: 2016-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '4.0'
 description: Provides a simple Realtime framework for Rails applications.
@@ -32,38 +37,43 @@ extensions: []
 extra_rdoc_files: []
 files:
 - app/views/realtime/realtime_message_console_logger.html.erb
+- app/views/realtime/_realtime_message_handler.html.erb
 - app/views/realtime/realtime_message_handler.html.erb
+- app/views/realtime/async_realtime_support.html.erb
 - app/views/realtime/realtime_support.html.erb
+- app/views/realtime/_realtime_message_console_logger.html.erb
+- app/views/realtime/_realtime_loader.html.erb
 - lib/realtime/railtie.rb
 - lib/realtime/realtime_controller.rb
+- lib/realtime/zmq_wrapper.rb
 - lib/realtime/redis_wrapper.rb
 - lib/realtime/version.rb
 - lib/realtime/view_helpers.rb
-- lib/realtime/zmq_wrapper.rb
 - lib/realtime.rb
 - MIT-LICENSE
 homepage: http://mikeatlas.github.io/realtime-rails/
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Realtime support for Rails applications.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: c3ec19eba97229354e064d27bfc0b92b0911a3d8
-  data.tar.gz: 4ea1fd69755b1b971838b592ccb5eac0caa06e3d
-SHA512:
-  metadata.gz: df907e7537971450e92f4ca3960a1cb53b5bae9deb9d4db38732709487021c10772f6bf7f560b444812a8f3c402768b4aa29dabdc11dcdbdf30212328fa656c7
-  data.tar.gz: ea678d1709d3eff430de67e890528fbe5ef43f3b994af83ac0f67366099ca83ad6bf5f99f64d5800a4ae448da0722d65c87cc2700ce99981519f9b7693f0190e