automate-em 0.0.1 → 0.0.2

data/app/assets/javascripts/jquery.automate.js

@@ -0,0 +1,439 @@
+/**
+*	ACA Control jQuery Interface Library
+*	Simplifies communication with an ACA Control server when using jQuery
+*	
+*   Copyright (c) 2011 Advanced Control and Acoustics.
+*	
+*	@author 	Stephen von Takach <steve@advancedcontrol.com.au>
+* 	@copyright  2011 advancedcontrol.com.au
+*
+*	--- Usage ---
+*	Connecting to an ACA Control Server:
+		var controller = new AutomateEm.EventsDispatcher({
+			url: 'http://my.control.server.org:8080/',
+			one_time_key: '/key/url'
+		});
+
+*	Binding to an event:
+		controller.bind('some_event', function(data){
+			alert(data.name + ' says: ' + data.message)
+		});
+
+*	Sending a command to the server:
+		controller.send('Module.function', "item1", ['item', 2], {item:3}, 4, 5.0, ...);
+
+*
+**/
+
+
+var AutomateEm = {
+	Off: false,
+	On: true,
+	Controllers: [],	// So we can inspect all instances
+	EventsDispatcher: function (options) {
+		//
+		// options contains: url, system calls, system
+		//
+		var config = {
+			servers: null,		// List of ACA Control Servers in priority order
+			system: null,		// The system we are connecting to and authentication details for re-connects
+			auto_auth: null,	// Are we using the manifest authentication system
+			idle_update: null,	// Do we want to auto-update the interface when it is idle
+			forced_update: null,// Update the interface as soon as possible
+		},
+			state ={
+				connection: null,	// Base web socket
+			    connected: true,	// Are we currently connected (initialised to true so that any initial failure is triggered)
+			    ready: false,		// Is the server ready for bindings and commands
+			    polling: false,		// Are we polling to remain connected when there is little activity
+			    resume: false,		// The reference to the resume timer
+			    updater: false,		// The reference to the update timer
+			    offline: false		// The system has indicated that it is offline
+			},
+		    bindings = {},
+		    system_calls = {
+				open: true,			// Connection to the server has been made
+				close: true,		// Connection to the server was closed or lost
+				ls: true,			// List of control systems available to the current user (paginated)
+				ready: true,		// Remote System is ready for bindings
+				authenticate: true,	// Authentication required
+				system: true,		// Please select a system
+				pong: true,			// System is idle
+				offline: true		// System is offline (slow down re-connect periods)
+			},
+			$this = this;
+		$.extend(config, options);
+		this.config = config;					// Allow external access
+
+
+		//
+		// Sends a command to the server in the appropriate format
+		//
+		var send = function (command_name) {
+			var payload = JSON.stringify({ command: command_name, data: Array.prototype.slice.call( arguments, 1 ) });
+			//	Array.prototype.slice.call( arguments, 1 ) gets all the arguments - the first in an array
+
+			if (state.connection != null && state.connection.readyState == state.connection.OPEN) {
+				state.connection.send(payload); // <= send JSON data to socket server
+				set_poll();						// Reset polling
+			}
+
+			return $this; // chainable
+		};
+		this.send = send;
+
+		//
+		// Requests to recieve notifications of a value change from the server
+		//	Triggers the functions passed in when the server informs us of an update
+		//
+		this.bind = function (events, func) {
+			if(!!func) {
+				var temp = {};
+				temp[events] = func;
+				events = temp;
+			}
+
+			jQuery.each( events, function(event_name, callback){
+				bindings[event_name] = bindings[event_name] || [];
+				bindings[event_name].push(callback);
+
+				if (!system_calls[event_name] && state.connection != null && state.connection.readyState == state.connection.OPEN){
+					var args = event_name.split('.');
+					args.splice(0,0, 'register');
+					send.apply( this, args );
+				}
+			});
+
+			return this; // chainable
+		};
+
+		this.is_connected = function(){
+			return state.connected;
+		};
+
+		//
+		// Removes all the callbacks for the event and lets the server know that we
+		//	don't want to revieve it anymore.
+		//
+		this.unbind = function (event_name) {
+			delete bindings[event_name];
+
+			if (state.connection != null && state.connection.readyState == state.connection.OPEN){
+				var args = event_name.split('.');
+				args.splice(0,0, 'unregister');
+				send.apply( this, args );
+			}
+
+			return this; // chainable
+		};
+
+		//
+		// The event trigger, calls the registered handlers in order
+		//
+		var trigger = function (event_name, message) {
+			var chain = bindings[event_name];
+			if (chain === undefined) return; // no bindings for this event
+
+			var i, result;
+			for (i = 0; i < chain.length; i = i + 1) {
+				try {
+					result = chain[i](message);
+					if(result === false)	// Return false to prevent later bindings
+						break;
+				} catch (err) { } // Catch any user code errors
+			}
+
+			return $this; // chainable
+		};
+		this.trigger = trigger;
+
+
+		//
+		// Polling functions
+		//	Only called if no other traffic is being transmitted.
+		//
+		function set_poll(){
+			if(!!state.polling) {
+				clearInterval(state.polling);
+			}
+			state.polling = setInterval(do_poll, 60000); // Maintain the connection by pinging every 1min
+		}
+
+		function do_poll(){
+			if((!!config.idle_update) && updateReady)	// Update on idle
+				window.location.reload();
+			else
+				send('ping');
+		}
+
+
+		//
+		// Sets up a new connection to the remote server
+		//
+		function setup_connection() {
+			jQuery.ajax('/tokens/servers', {
+				type: 'GET',
+				dataType: 'json',
+				success: function(data, textStatus, jqXHR){
+					config.servers = data;
+
+					if(!!window.WebSocket)
+						state.connection = new window.WebSocket("ws://" + config.servers[0].hostname + ":81/");
+					else if(!!window.MozWebSocket)
+						state.connection = new window.MozWebSocket("ws://" + config.servers[0].hostname + ":81/");
+					else
+						return;
+
+					// dispatch to the right handlers
+					state.connection.onmessage = function (evt) {
+						var json = JSON.parse(evt.data);
+
+						if (json.event == 'ready') {
+							//
+							// Re-register status events then call ready
+							//
+							for (event_name in bindings) {
+								try {
+									if(!system_calls[event_name]) {
+										var args = event_name.split('.');
+										args.splice(0,0, 'register');
+										send.apply( this, args );
+									}
+								} catch (err) { }
+							}
+
+							set_poll();	// Set the polling to occur
+						}
+
+						//
+						// Trigger callbacks
+						//
+						trigger(json.event, json.data);
+					};
+
+					state.connection.onclose = function () {
+						if (state.connected) {
+							state.connected = false;
+							if(!!state.polling) {
+								clearInterval(state.polling);
+								state.polling = false;
+							}
+							trigger('close');
+						}
+					}
+					state.connection.onopen = function () {
+						state.connected = true; // prevent multiple disconnect triggers
+						trigger('open');
+					}
+				},
+				error: function(jqXHR, textStatus, errorThrown){
+					//
+					// Damn...
+					//
+					;
+				}
+			});
+		}
+		setup_connection();
+
+
+		//
+		// Ensure the connection is resumed if disconnected
+		//	We do this in this way for mobile devices when resumed from sleep to ensure they reconnect
+		//
+		function checkResume() {
+			if (state.connection == null || state.connection.readyState == state.connection.CLOSED) {
+				setup_connection();
+			}
+		}
+		state.resume = window.setInterval(checkResume, 1000);
+		AutomateEm.Controllers.push(this);
+
+
+		//
+		// Bind events for automation (first attempt, else fall back to interface for both auth and system)
+		//
+		var	authCount = 0,
+			sysCallCount = 0,
+			oneKey;
+
+		this.bind('open', function(){
+
+			authCount = 0;
+			sysCallCount = 0;
+			oneKey = null;
+
+		});
+
+		function getCookie(c_name)
+		{
+			var i,x,y,ARRcookies=document.cookie.split(";");
+			for (i=0;i<ARRcookies.length;i++)
+			{
+				x=ARRcookies[i].substr(0,ARRcookies[i].indexOf("="));
+				y=ARRcookies[i].substr(ARRcookies[i].indexOf("=")+1);
+				x=x.replace(/^\s+|\s+$/g,"");
+				if (x==c_name)
+				{
+					return unescape(y);
+				}
+			}
+			return null;
+		}
+
+		this.bind('authenticate', function(){
+			authCount += 1;
+
+			if(authCount == 1 && (!!config.auto_auth) && (!!config.system)) {
+				oneKey = getCookie('next_key');
+				if(!!oneKey){
+					send("authenticate", oneKey);
+					return false;
+				}
+			}
+
+			authCount += 1;
+		});
+
+		this.bind('system', function(){
+			sysCallCount += 1;
+
+			if(sysCallCount == 1 && config.system !== false) {	// 0 == false
+				send("system", config.system);
+
+				return false;
+			}	// Auto login failure here will result in a disconnect
+		});
+
+		this.bind('offline', function(){
+			state.offline = true;
+			clearInterval(state.resume);
+			state.resume = window.setInterval(checkResume, 15000);
+		});
+
+		this.bind('ready', function(){
+			if(state.offline) {
+				state.offline = false;
+				clearInterval(state.resume);
+				state.resume = window.setInterval(checkResume, 1000);
+			}
+
+			if((!!config.auto_auth) && (!!config.system) && sysCallCount == 1 && authCount == 1) {
+				//
+				// Authenticate with the server
+				// Then we can safely reload the cache
+				// on cache success we accept the new key
+				//
+				jQuery.ajax('/tokens/new', {
+					type: 'GET',
+					dataType: 'text',
+					success: function(data, textStatus, jqXHR){
+						//
+						// Set the csrf token
+						// Get the new one-time-key
+						//
+						$('meta[name="csrf-token"]').attr('content', data);
+
+						jQuery.ajax('/tokens/authenticate', {
+							type: 'POST',
+							data: {
+								key: oneKey,
+								system: config.system
+							},
+							dataType: 'text',
+							success: function(data, textStatus, jqXHR){
+								// Accept the new key on success
+								jQuery.ajax('/tokens/accept', {
+									type: 'POST',
+									data: {
+										key: oneKey,
+										system: config.system
+									},
+									dataType: 'text',
+									success: function(data, textStatus, jqXHR){
+										//
+										// This can safely be ignored. Here for debugging
+										//
+										var yay = "success";
+									},
+									error: function(){
+										//
+										// This can safely be ignored. Here for debugging
+										//
+										var damn = "fail";
+									}
+								});
+							},
+							error: function(){
+								//
+								// This can safely be ignored. Here for debugging
+								//
+								var damn = "fail";
+							}
+						});
+					},
+					error: function(){
+						//
+						// This can safely be ignored. Here for debugging
+						//
+						var damn = "fail";
+					}
+				});
+			}
+
+			authCount = 0;
+			sysCallCount = 0;
+		});
+
+		//
+		// End Auto_auth ---------------
+		//
+
+
+		//
+		// Auto update functions
+		//
+		var appCache = window.applicationCache,
+			updateReady = false;
+
+		function bindCache(){
+
+			$(appCache).bind('updateready', function(){
+				appCache.swapCache();	// Swap cache has called key
+
+				if(!!config.forced_update)
+					window.location.reload();
+				else {
+					appCache = window.applicationCache;
+					bindCache();
+					updateReady = true;
+				}
+			});
+
+		}
+
+		if((!!config.idle_update) || (!!config.forced_update)) {
+			bindCache();
+
+			state.updater = setInterval('window.applicationCache.update();', 600000);
+		}
+
+		//
+		// Disconnects and removes the self reference to the object
+		//	Once all external references are removed it will be garbage collected
+		//
+		this.destroy = function(){
+			clearInterval(state.resume);
+			clearInterval(state.updater);
+			if(state.connection != null)
+				state.connection.close();
+			var i;
+			for(i = 0; i < AutomateEm.Controllers.length; i = i + 1) {
+				if(AutomateEm.Controllers[i] == this) {
+					AutomateEm.Controllers.splice(i, 1);
+					break;
+				}
+			}
+		};
+	}
+};

data/app/controllers/tokens_controller.rb

@@ -0,0 +1,99 @@
+require 'uri'
+
+class TokensController < ActionController::Base
+	
+	protect_from_forgery
+	before_filter :auth_user, :only => [:accept]
+	layout nil
+
+
+	def authenticate	# Allowed through by application controller
+		#
+		# Auth(gen)
+		# check the system matches (set user and system in session)
+		# respond with success
+		#
+		dev = TrustedDevice.try_to_login(params[:key], true)	# true means gen the next key
+		if params[:system].present? && dev.present? && params[:system].to_i == dev.control_system_id
+			session[:token] = dev.user_id
+			session[:system] = dev.control_system_id
+			session[:key] = params[:key]
+			cookies.permanent[:next_key] = {:value => dev.next_key, :path => URI.parse(request.referer).path}
+
+			render :nothing => true	# success!
+		else
+			render :nothing => true, :status => :forbidden	# 403
+		end
+	end
+
+
+	def accept
+		dev = TrustedDevice.where('user_id = ? AND control_system_id = ? AND one_time_key = ? AND (expires IS NULL OR expires > ?)', 
+				session[:token], session[:system], session[:key], Time.now).first
+
+		if dev.present?
+			dev.accept_key
+			render :nothing => true	# success!
+		else
+			render :nothing => true, :status => :forbidden	# 403
+		end
+	end
+
+
+	#
+	# Build a new session for the interface if the existing one has expired
+	#	This maintains the csrf security
+	#	We don't want to reset the session if a valid user is already authenticated either
+	#
+	def new
+		reset_session unless session[:user].present?
+
+		render :text => form_authenticity_token
+	end
+
+
+	def create
+		#
+		# Application controller ensures we are logged in as real user
+		# Ensure the user can access the control system requested (the control system does this too)
+		# Generate key, populate the session
+		#
+		user = session[:user].present? ? User.find(session[:user]) : nil	# We have to be authed to get here
+		sys = user.control_systems.where('control_systems.id = ?', params[:system]).first unless user.nil?
+		if user.present? && sys.present?
+
+			dev = TrustedDevice.new
+			dev.reason = params[:trusted_device][:reason]
+			dev.user = user
+			dev.control_system = sys
+			dev.save
+
+			if !dev.new_record?
+				cookies.permanent[:next_key] = {:value => dev.one_time_key, :path => URI.parse(request.referer).path}
+				render :json => {}	# success!
+			else
+				render :json => dev.errors.messages, :status => :not_acceptable	# 406
+			end
+		else
+			if user.present?
+				render :json => {:control => 'could not find the system selected'}, :status => :forbidden	# 403
+			else
+				render :json => {:you => 'are not authorised'}, :status => :forbidden	# 403
+			end
+		end
+	end
+
+
+	def servers
+		render :json => Server.all
+	end
+
+
+	protected
+
+
+	def auth_user
+		redirect_to root_path unless session[:user].present? || session[:token].present?
+	end
+	
+end

data/app/models/setting.rb

@@ -19,7 +19,7 @@ class Setting < ActiveRecord::Base
 		if self[:text_value].blank?
 			self[:text_value] = ""
 		else
-			self[:text_value] = Encryptor.decrypt(Base64.decode64(self[:text_value]), {:key => CONTROL_CONFIG[:encrypt_key], :algorithm => 'aes-256-cbc'})
+			self[:text_value] = Encryptor.decrypt(Base64.decode64(self[:text_value]), {:key => Rails.application.config.automate.encrypt_key, :algorithm => 'aes-256-cbc'})
 		end
 	end
 	
@@ -29,7 +29,7 @@ class Setting < ActiveRecord::Base
 		if self[:text_value].blank?
 			self[:text_value] = ""
 		else
-			self[:text_value] = Base64.encode64(Encryptor.encrypt(self[:text_value], {:key => CONTROL_CONFIG[:encrypt_key], :algorithm => 'aes-256-cbc'}))
+			self[:text_value] = Base64.encode64(Encryptor.encrypt(self[:text_value], {:key => Rails.application.config.automate.encrypt_key, :algorithm => 'aes-256-cbc'}))
 		end
 	end
 	

data/config/routes.rb

@@ -0,0 +1,12 @@
+Rails.application.routes.draw do
+	
+	#
+	# TODO:: Namespace this
+	#
+	resources :tokens do
+		post	:authenticate,	:on => :collection
+		post	:accept,		:on => :collection
+		get		:servers,		:on => :collection
+	end
+
+end

data/lib/automate-em/core/modules.rb

@@ -14,20 +14,21 @@ module AutomateEm
 			@@load_lock.mon_synchronize {
 				begin
 					found = false
+					file = "#{dep.classname.underscore}.rb"
 					
 					Rails.configuration.automate.module_paths.each do |path|
-						if File.exists?("#{path}/#{dep.filename}")
-							load "#{path}/#{dep.filename}"
+						if File.exists?("#{path}/#{file}")
+							load "#{path}/#{file}"
 							found = true
 							break
 						end
 					end
 					
 					if not found
-						raise "File not found!"
+						raise "File not found! (#{file})"
 					end
 					
-					@@modules[dep.id] = dep.classname.classify.constantize
+					@@modules[dep.id] = dep.classname.constantize
 				rescue => e
 					AutomateEm.print_error(System.logger, e, {
 						:message => "device module #{dep.actual_name} error whilst loading",
@@ -116,12 +117,15 @@ module AutomateEm
 				#
 				# Instance of a user module
 				#
-				@instance = Modules[controllerDevice.dependency_id].new(controllerDevice.tls, controllerDevice.makebreak)
-				@instance.join_system(@system)
-				@@instances[@device] = @instance
-				@@devices[baselookup] = @instance
-				@@lookup[@instance] = [@device]
-				@@lookup_lock.unlock	#UNLOCK!! so we can lookup settings in on_load
+				begin
+					@instance = Modules[controllerDevice.dependency_id].new(controllerDevice.tls, controllerDevice.makebreak)
+					@instance.join_system(@system)
+					@@instances[@device] = @instance
+					@@devices[baselookup] = @instance
+					@@lookup[@instance] = [@device]
+				ensure
+					@@lookup_lock.unlock	#UNLOCK!! so we can lookup settings in on_load
+				end
 				
 				devBase = nil
 				
@@ -179,13 +183,16 @@ module AutomateEm
 				#
 				# add parent may lock at this point!
 				#
-				@instance = @@devices[baselookup]
-				@@lookup[@instance] << @device
-				@@instances[@device] = @instance
-				EM.defer do
-					@instance.join_system(@system)
+				begin
+					@instance = @@devices[baselookup]
+					@@lookup[@instance] << @device
+					@@instances[@device] = @instance
+					EM.defer do
+						@instance.join_system(@system)
+					end
+				ensure
+					@@lookup_lock.unlock	#UNLOCK!!
 				end
-				@@lookup_lock.unlock	#UNLOCK!!
 			end
 		end
 	end

data/lib/automate-em/core/system.rb

@@ -190,7 +190,7 @@ module AutomateEm
 				if !@controller.active || force
 					if @logger.nil?
 						if Rails.env.production?
-							@logger = Logger.new("#{ROOT_DIR}/interface/log/system_#{@controller.id}.log", 10, 4194304)
+							@logger = Logger.new(Rails.root.join("log/system_#{@controller.id}.log").to_s, 10, 4194304)
 						else
 							@logger = Logger.new(STDOUT)
 						end

data/lib/automate-em/engine.rb

@@ -14,6 +14,7 @@ module AutomateEm
 			app.config.automate = ActiveSupport::OrderedOptions.new
 			app.config.automate.module_paths = []
 			app.config.automate.log_level = Logger::INFO
+			app.config.automate.encrypt_key = "Lri2B0yvEVag+raqX9uqMFu9LmGoGwbaO8fzNidf"
 		end
 		
 		#

data/lib/automate-em/version.rb

@@ -1,3 +1,3 @@
 module AutomateEm
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/generators/module/module_generator.rb

@@ -12,12 +12,12 @@ class ModuleGenerator < Rails::Generators::NamedBase
 		scope = []
 		text = ""
 		param.map! {|item|
-			item = item.classify
+			item = item.camelcase
 			scope << item
 			text += "module #{scope.join('::')}; end\n"
 			item
 		}
-		param << name.classify
+		param << name.camelcase
 		scope = param.join('::')
 		
 		
@@ -27,7 +27,7 @@ class ModuleGenerator < Rails::Generators::NamedBase
 			text += <<-FILE
 
 
-class #{scope} < AutomateEm::#{type.downcase.classify}
+class #{scope} < AutomateEm::#{type.downcase.camelcase}
 	def on_load
 	end
 	

data/test/functional/tokens_controller_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class TokensControllerTest < ActionController::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/unit/helpers/tokens_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class TokensHelperTest < ActionView::TestCase
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: automate-em
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -194,6 +194,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/assets/javascripts/jquery.automate.js
+- app/controllers/tokens_controller.rb
 - app/models/controller_device.rb
 - app/models/controller_http_service.rb
 - app/models/controller_logic.rb
@@ -205,6 +207,7 @@ files:
 - app/models/trusted_device.rb
 - app/models/user_zone.rb
 - app/models/zone.rb
+- config/routes.rb
 - db/migrate/20111001022500_init.rb
 - db/migrate/20111017213801_one_time_key.rb
 - db/migrate/20111021071632_encrypt_setting.rb
@@ -268,8 +271,10 @@ files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/dummy/script/rails
+- test/functional/tokens_controller_test.rb
 - test/integration/navigation_test.rb
 - test/test_helper.rb
+- test/unit/helpers/tokens_helper_test.rb
 homepage: http://advancedcontrol.com.au/
 licenses: []
 post_install_message: 
@@ -324,5 +329,7 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/dummy/script/rails
+- test/functional/tokens_controller_test.rb
 - test/integration/navigation_test.rb
 - test/test_helper.rb
+- test/unit/helpers/tokens_helper_test.rb