realtime 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9761455dd3d83567ee9fb1522ac53dbd6d6434cd
+  data.tar.gz: efe0161d15e2ea8662bedddb1121e55f4da43fbe
+SHA512:
+  metadata.gz: f3ec2ec5304734b1810efa90075b5debcaaa9c9c1a5c2c73281287303a9fdc672e743715709d2b7959a9bebe95d14ced65db54260d53742eaea52546f8df47a0
+  data.tar.gz: 05f0bf622d25c0289ad1d82c2d9672205e5388f4b8639291992739ad0818881e740cedc8be90926ff4458aef3cfb694ef6f38cb53cb6b3662c37759981cbb660

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Mike Atlas
+
+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.rdoc

@@ -0,0 +1 @@
+= Realtime Support for Rails

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

@@ -0,0 +1,25 @@
+<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>

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

@@ -0,0 +1,22 @@
+
+<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>

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

@@ -0,0 +1,36 @@
+<script type='text/javascript'>
+
+	window.realtime = {};
+	window.realtime.messageQueue = [];
+	window.realtime.enabled = false;
+
+</script>
+
+<script src="<%= realtime_server_url %>/socket.io/socket.io.js"></script>
+
+<script type='text/javascript'>
+
+	if (typeof io != 'undefined' && io != null) {
+		window.realtime.token = '<%= realtime_token %>';
+		window.realtime.userId = '<%= realtime_user_id %>';
+		document.cookie = "_rtUserId=" + '<%= realtime_user_id %>' + ";domain=." + '<%= realtime_domain %>' + ";path=/"
+		document.cookie = "_rtToken=" + '<%= realtime_token %>' + ";domain=." + '<%= realtime_domain %>' + ";path=/"
+		window.realtime.socketIo = io.connect('<%= realtime_server_url %>');
+	}
+
+	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);
+		});
+	}
+
+</script>

data/lib/realtime.rb

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

data/lib/realtime/railtie.rb

@@ -0,0 +1,22 @@
+module Realtime
+	
+	class Railtie < Rails::Railtie
+    
+	    initializer "realtime.action_controller" do
+		    ActiveSupport.on_load(:action_controller) do				
+				ActionController::Base.send :include, Realtime::Controller
+			end
+		end
+
+		initializer "realtime.view_helpers" do
+			ActionView::Base.send :include, ViewHelpers
+
+			# kinda blah way to force rails to load our helper views path
+			curr_path = File.expand_path(File.dirname(__FILE__))
+			view_path = "#{curr_path}/../../app/views"
+			ActionController::Base.append_view_path(view_path)
+		end
+
+	end
+
+end

data/lib/realtime/realtime_controller.rb

@@ -0,0 +1,56 @@
+module Realtime
+	module Controller
+		extend ActiveSupport::Concern
+
+		module ClassMethods
+			def realtime_controller
+			 	before_filter :do_realtime_token
+			 	before_filter :do_realtime_domain
+			 	before_filter :do_realtime_user_id
+			 	before_filter :do_realtime_server_url
+			 	after_filter  :store_realtime_session
+			end
+		end
+
+		def do_realtime_token
+			cookies["_rtToken"] = Digest::MD5.hexdigest("#{session[:session_id]}:#{realtime_user_id}")
+			@realtime_token = cookies["_rtToken"]
+			return @realtime_token
+		end
+
+		def do_realtime_domain
+			@realtime_domain = realtime_domain
+			return @realtime_domain
+		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
+			# store session data or any authentication data you want here, generate to JSON data
+			session_data = {
+					"user_id" => realtime_user_id,
+			}
+			
+			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/redis_wrapper.rb

@@ -0,0 +1,15 @@
+class RedisWrapper
+
+ def self.publish(message)
+  	redis.publish 'realtime_msg', message.to_json
+  end
+
+  def redis
+    return $redis # global set in redis.rb initializer
+  end
+
+  def self.redis
+    return $redis # global set in redis.rb initializer
+  end
+
+end

data/lib/realtime/version.rb

@@ -0,0 +1,3 @@
+module Realtime
+  VERSION = "0.0.1"
+end

data/lib/realtime/view_helpers.rb

@@ -0,0 +1,29 @@
+module Realtime
+	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_message_handler
+			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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: realtime
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Atlas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a simple Realtime framework for Rails applications.
+email:
+- mike.atlas@gmail.com
+executables: []
+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_support.html.erb
+- lib/realtime/railtie.rb
+- lib/realtime/realtime_controller.rb
+- lib/realtime/redis_wrapper.rb
+- lib/realtime/version.rb
+- lib/realtime/view_helpers.rb
+- lib/realtime.rb
+- MIT-LICENSE
+- README.rdoc
+homepage: https://github.com/mikeatlas/realtime-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Realtime support for Rails applications.
+test_files: []