automate-em 0.0.1

data/LGPL3-LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.textile

@@ -0,0 +1,48 @@
+h1. automate-em
+
+A framework for building automation and control.
+
+
+h2. Creating a control project
+
+# Create a new rails project
+#* Configure your database etc
+# Add @gem "automate-em"@ to your gem file
+#* Also add @gem 'login', :git => 'git://github.com/stakach/advanced-authenticator.git'@
+#* This dependency will be removed soon to allow for any authentication system to be utilised
+# From a console type:
+## @bundle install@
+## @rake railties:install:migrations FROM=login_engine@
+## @rake railties:install:migrations FROM=automate@
+## @rake db:migrate@
+
+You now have a blank control project
+
+
+h2. Generating module scaffolding
+
+From a console
+
+# type: @rails g module module/scope/and_name@
+#* An example would be: @rails g module NEC/Projectors/NP2000@
+#* This will create a file at @app/modules/nec/projectors/np2000.rb@
+# You will be asked what type of module you would like to generate
+#* Type: @device@ for a generic device module (a raw TCP or UDP protocol including telnet)
+#* Type: @service@ for any module that will be interfacing with a HTTP(S) service
+#* Type: @logic@ to generate a controller/interfacing module
+
+Note: The scope (@NEC/Projectors@ in the example above) is optional and can be as deep or shallow as makes sense.
+
+h2. Writing Modules
+
+Please see: "writing modules":https://github.com/stakach/automate-em/wiki/writing-modules
+
+
+h2. Database Configuration
+
+Please see: "system configuration":https://github.com/stakach/automate-em/wiki/system-configuration
+
+
+h2. Running
+
+From a command console type: @rake automate@

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env 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
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AutomateEm'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/models/control_system.rb

@@ -0,0 +1,20 @@
+class ControlSystem < ActiveRecord::Base
+	has_many :devices,	:class_name => "ControllerDevice",		:order => 'priority ASC',	:dependent => :destroy
+	has_many :logics,	:class_name => "ControllerLogic",		:order => 'priority ASC',	:dependent => :destroy
+	has_many :services,	:class_name => "ControllerHttpService",	:order => 'priority ASC',	:dependent => :destroy
+	
+	has_many :controller_zones,		:dependent => :destroy
+	has_many :zones,				:through => :controller_zones
+	has_many :user_zones,			:through => :zones
+	has_many :groups,				:through => :user_zones
+	has_many :users,				:through => :groups
+	
+	has_many :trusted_devices,		:dependent => :destroy
+	
+	
+	protected
+	
+	
+	validates_presence_of :name
+	validates_uniqueness_of :name
+end

data/app/models/controller_device.rb

@@ -0,0 +1,21 @@
+class ControllerDevice < ActiveRecord::Base
+	belongs_to	:control_system
+	belongs_to	:dependency
+	has_many :settings, :as => :object,		:dependent => :destroy
+	
+	
+	before_validation :check_port
+	
+	
+	protected
+	
+	
+	def check_port
+		if self[:port].nil?
+			self[:port] = dependency.default_port
+		end
+	end
+	
+	
+	validates_presence_of :control_system, :dependency, :ip, :port
+end

data/app/models/controller_http_service.rb

@@ -0,0 +1,17 @@
+class ControllerHttpService < ActiveRecord::Base
+	belongs_to	:control_system
+	belongs_to	:dependency
+	has_many :settings, :as => :object,		:dependent => :destroy
+	
+	before_validation :check_uri
+	
+	protected
+	
+	def check_uri
+		if self[:uri].nil?
+			self[:uri] = dependency.default_uri
+		end
+	end
+	
+	validates_presence_of :control_system, :dependency, :uri
+end

data/app/models/controller_logic.rb

@@ -0,0 +1,5 @@
+class ControllerLogic < ActiveRecord::Base
+	belongs_to	:control_system
+	belongs_to	:dependency
+	has_many :settings, :as => :object,	:dependent => :destroy
+end

data/app/models/controller_zone.rb

@@ -0,0 +1,10 @@
+class ControllerZone < ActiveRecord::Base
+	belongs_to	:control_system
+	belongs_to	:zone
+	
+	
+	protected
+	
+	
+	validates_presence_of :control_system, :zone
+end

data/app/models/dependency.rb

@@ -0,0 +1,20 @@
+class Dependency < ActiveRecord::Base
+	has_many :devices,	:class_name => "ControllerDevice",		:dependent => :destroy
+	has_many :logics,	:class_name => "ControllerLogic",		:dependent => :destroy
+	has_many :services,	:class_name => "ControllerHttpService",	:dependent => :destroy
+	
+	has_many :settings,	:as => :object,		:dependent => :destroy
+	
+	scope :for_controller, lambda {|controller|
+		includes(:controller_devices, :controller_logics, :controller_http_services)
+		.where("(controller_devices.dependency_id = dependencies.id AND controller_devices.control_system_id = ?) OR (controller_logics.dependency_id = dependencies.id AND controller_logics.control_system_id = ?) OR (controller_http_services.dependency_id = dependencies.id AND controller_http_services.control_system_id = ?)", controller.id, controller.id, controller.id)
+	}
+	
+	
+	protected
+	
+	
+	validates_presence_of :classname, :filename, :module_name, :actual_name
+	validates_uniqueness_of :filename
+	validates_uniqueness_of :actual_name
+end

data/app/models/server.rb

@@ -0,0 +1,12 @@
+class Server < ActiveRecord::Base
+	#
+	# When converting to json don't include the root element (:Server => {})
+	#
+	self.include_root_in_json = false
+		
+	
+	protected
+	
+	
+	validates_presence_of :hostname, :online
+end

data/app/models/setting.rb

@@ -0,0 +1,38 @@
+
+require 'base64'
+require 'encryptor'
+
+
+class Setting < ActiveRecord::Base
+	belongs_to :object, :polymorphic => true
+	
+	after_initialize	:decrypt_setting
+	before_save			:do_encrypt_setting
+	
+	
+	protected
+	
+	
+	def decrypt_setting
+		return unless self[:encrypt_setting]
+		
+		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'})
+		end
+	end
+	
+	def do_encrypt_setting
+		return unless self[:encrypt_setting]
+		
+		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'}))
+		end
+	end
+	
+	
+	validates_presence_of :name, :object, :value_type
+end

data/app/models/trusted_device.rb

@@ -0,0 +1,63 @@
+require 'digest/sha1'	# For one time key
+
+#
+# This is a list of devices that are trusted
+#	A one time key is used to authenticate and re-generated for the next logon
+#
+class TrustedDevice < ActiveRecord::Base
+	belongs_to	:user
+	belongs_to	:control_system
+	
+	
+	before_create :generate_keys
+	
+	
+	#
+	# Generates a one-time key that will allow this device to login without interaction
+	#
+	def generate_key
+		self[:last_authenticated] = Time.now
+		self[:next_key] = Digest::SHA1.hexdigest "#{Time.now.to_f.to_s}#{id}"
+		save!
+	end
+	
+	def accept_key
+		self[:one_time_key] = self[:next_key]
+		save!
+	end
+	
+	#
+	# Attempts to login using a one time key and generates a new one if it is accepted
+	#
+	def self.try_to_login(key, gen = false)
+		entry = TrustedDevice.where("one_time_key = ? or next_key = ?", key, key).first
+		if entry.nil?
+			return nil
+		else
+			if !entry.expires.nil? && (entry.expires <=> Time.now) > 0	# We are past the expired time
+				entry.destroy
+				return nil
+			end
+			if entry.one_time_key != entry.next_key && entry.next_key == key	# so the accept failed?
+				entry.one_time_key = entry.next_key # Perform an implicit accept
+				entry.save							# Prevents the same key being used again
+			end
+			
+			entry.generate_key if gen		# Key accepted, generate a new one
+			return entry
+		end
+	end
+	
+	
+	protected
+	
+	
+	def generate_keys
+		self[:last_authenticated] = Time.now
+		self[:one_time_key] = Digest::SHA1.hexdigest "#{Time.now.to_f.to_s}#not so strong"
+		self[:next_key] = Digest::SHA1.hexdigest "#{self[:last_authenticated].to_f.to_s}different"
+	end
+	
+	
+	validates_presence_of :user, :control_system, :reason
+end