ardtweeno 0.0.2 → 0.2.5

data/lib/ardtweeno/nodemanager.rb

@@ -0,0 +1,300 @@
+####################################################################################################
+# @author       David Kirwan <davidkirwanirl@gmail.com>
+# @description  Node Management class for the Ardtweeno Mesh Network
+#
+# @date         21-02-2013
+####################################################################################################
+
+# Imports
+require 'rubygems'
+require 'logger'
+require 'yaml'
+require 'json'
+require 'ardtweeno'
+require 'typhoeus'
+
+
+module Ardtweeno
+  
+  ##
+  # Ardtweeno::NodeManager class for the Ardtweeno Mesh Network
+  #
+  class NodeManager
+    
+    attr_accessor :nodeList, :zones, :log, :watchlist
+    
+    
+    ##
+    # Ardtweeno::NodeManager#new constructor
+    #
+    # * *Args*    :
+    #   - ++ ->   options Hash{:log Logger, :nodelist Array[Ardtweeno::Node]}
+    # * *Returns* :
+    #   -
+    # * *Raises* :
+    #
+    def initialize(options={})
+      @log = Ardtweeno.options[:log] ||= Logger.new(STDOUT)
+      @log.level = Ardtweeno.options[:level] ||= Logger::DEBUG
+      
+      @watchlist = Array.new
+      
+      @nodeList = options[:nodelist] ||= Array.new 
+    end
+
+
+    ##
+    # Ardtweeno::NodeManager#flush empties the packetqueue inside each Ardtweeno:Node
+    #
+    # * *Args*    :
+    #   - ++ ->   
+    # * *Returns* :
+    #   -         
+    # * *Raises* :
+    #   -         
+    #
+    def flush()
+      @nodeList.each do |i|
+        i.packetqueue = Array.new
+      end
+    end
+
+
+
+    ##
+    # Ardtweeno::NodeManager#addNode adds an Ardtweeno::Node to the managed node list
+    #
+    # * *Args*    :
+    #   - ++ ->   Ardtweeno::Node
+    # * *Returns* :
+    #   -         true || false
+    # * *Raises* :
+    #   -         Ardtweeno::NotANode
+    #
+    def addNode(node)
+      if node.class == Ardtweeno::Node
+        @log.debug "Size of nodeList before addition: #{@nodeList.size}"
+        @nodeList << node
+        @log.debug "Size of nodeList after addition: #{@nodeList.size}"
+        
+        return true
+      else
+        raise Ardtweeno::NotANode, "Error Ardtweeno::NodeManager#addNode expects an Ardtweeno::Node as a parameter"
+      end
+    end
+
+
+    ##
+    # Ardtweeno::NodeManager#removeNode removes an Ardtweeno::Node from the managed nodeList
+    #
+    # * *Args*    :
+    #   - ++ ->   {:node, :key}
+    # * *Returns* :
+    #   -         Ardtweeno::Node
+    # * *Raises* :
+    #   -         Ardtweeno::NotInNodeList
+    #    
+    def removeNode(options={})
+      @log.debug "removeNode function called, searching for node in list"
+      
+      begin
+        found = search(options)
+        @nodeList.delete(found)
+        
+        return found
+        
+      rescue Ardtweeno::NotInNodeList
+        return nil
+      end
+      
+    end
+
+
+    ##
+    # Ardtweeno::NodeManager#search provides an interface to search the managed Ardtweeno::Node list
+    # takes a single parameter hash, expects :node or :key search strings corresponding with the
+    # Ardtweeno::Node you wish to search for, and returns this Node if found
+    # Raises Ardtweeno::NotInNodeList exception if entry not found in the list
+    #
+    # * *Args*    :
+    #   - ++ ->   options Hash{:node String, :key String}
+    # * *Returns* :
+    #   -         Ardtweeno::Node
+    # * *Raises* :
+    #   -         Ardtweeno::NotInNodeList
+    #    
+    def search(options={})
+      key = options[:key] ||= nil
+      node = options[:node] ||= nil
+      
+      if key.nil? and node.nil? then 
+        raise Ardtweeno::NotInNodeList, "Error key does not match any Ardtweeno::Node being maintained by this Ardtweeno::NodeManager"
+      end
+      
+      unless key.nil? then 
+        @log.debug "Searching the Nodelist for key: " + key
+        
+        @nodeList.each do |i|
+          @log.debug "Comparing #{key} with #{i.key}"
+          if i.key == key
+            @log.debug "Match found, returning node"
+            return i       
+          end
+        end
+        
+      end
+      
+      unless node.nil? then
+        @log.debug "Searching the Nodelist for node: " + node
+        
+        @nodeList.each do |i|
+          @log.debug "Comparing #{node} with #{i.node}"
+          if i.node == node
+            @log.debug "Match found, returning #{i.to_s}"
+            return i       
+          end
+        end
+      end
+      
+      
+      @log.debug "Node not found!"
+      # Raise NotInNodeList exception if list has been traversed and a corresponding node was
+      # not found
+      raise Ardtweeno::NotInNodeList, "Error key does not match any Ardtweeno::Node being maintained by this Ardtweeno::NodeManager"
+    end
+    
+    
+    ##
+    # Ardtweeno::NodeManager#watched? checks if a node has been added to a watchlist
+    #
+    # * *Args*    :
+    #   - ++ ->   Ardtweeno::Node node
+    # * *Returns* :
+    #   -         True || False
+    # * *Raises* :
+    #   -         
+    #
+    def watched?(node)
+      
+      @watchlist.each do |i|
+        
+        @log.debug "Comparing " + i[:node].node + " and " + node.node
+        if i[:node].node == node.node 
+          return true
+        end
+      end
+      
+      return false
+      
+    end
+    
+    
+    ##
+    # Ardtweeno::NodeManager#addWatch adds a node to the watchlist
+    #
+    # * *Args*    :
+    #   - ++ ->   String node, Hash watch { String :node, String :notifyURL, 
+    #                                       String :method, String :timeouts }
+    # * *Returns* :
+    #   -        
+    # * *Raises* :
+    #   -         Ardtweeno::NotInNodeList
+    #
+    def addWatch(params)
+      begin
+        node = search({:node=>params[:node]})
+        @log.debug "Found Node: " + node.inspect
+        
+        watch = { :node=>node, 
+                  :notifyURL=> params[:notifyURL],
+                  :method=>"POST", 
+                  :timeout=>"60" 
+                }
+        
+        @log.debug "Adding watch: " + watch.inspect
+        
+        @watchlist << watch
+        
+      rescue Ardtweeno::NotInNodeList => e
+        raise e
+      rescue Exception => e
+        raise e
+      end
+    end
+    
+    
+    ##
+    # Ardtweeno::NodeManager#removeWatch removes a node from the watchlist
+    #
+    # * *Args*    :
+    #   - ++ ->   String node
+    # * *Returns* :
+    #   -        
+    # * *Raises* :
+    #   -         Ardtweeno::NotInNodeList
+    #
+    def removeWatch(node)
+      begin
+        node = search({:node=>node})
+        
+        @watchlist.each do |i|
+          if i[:node] == node
+            @watchlist.delete(i)
+          end
+        end
+        
+      rescue Ardtweeno::NotInNodeList => e
+        raise e
+      end
+    end
+    
+    
+    ##
+    # Ardtweeno::NodeManager#pushNotification pushes a notification to the node watcher
+    #
+    # * *Args*    :
+    #   - ++ ->   String node
+    # * *Returns* :
+    #   -         
+    # * *Raises* :
+    #   -         
+    #
+    def pushNotification(node)
+      
+      @log.debug "Traversing watchlist"
+      @watchlist.each do |i|
+        
+        @log.debug "Comparing " + i[:node].node + " to " + node
+                
+        if i[:node].node == node
+          
+          @log.debug "Associated watch found, checking for method " + i[:method]
+          
+          if i[:method] == "POST"
+            @log.debug "HTTP POST method executing"
+            @log.debug "URL: #{i[:notifyURL]}"
+            @log.debug "Title: Push notification"
+            @log.debug "Content: #{i[:node].node}"
+            @log.debug "Code: #{i[:node].to_s}"
+            
+            Typhoeus::Request.post(i[:notifyURL], 
+                                     :body=> { :title=>"Push notification",
+                                               :content=>"#{i[:node].node}",
+                                               :code=>""})
+          elsif i[:method] == "GET"
+            @log.debug "HTTP GET method executing" 
+            Typhoeus::Request.get(i[:notifyURL], 
+                                    :body=> { :title=>"Push notification",
+                                              :content=>"#{i[:node].node}",
+                                              :code=>""})
+          end
+
+        end
+      end
+      
+    end
+    
+    
+    
+  end
+end

data/lib/ardtweeno/packet.rb

@@ -0,0 +1,98 @@
+####################################################################################################
+# @author       David Kirwan <davidkirwanirl@gmail.com>
+# @description  Packet Communication storage class for the Ardtweeno system
+#
+# @date         14-11-2012
+####################################################################################################
+
+# Imports
+require 'rubygems'
+require 'logger'
+require 'yaml'
+require 'json'
+require 'date'
+
+
+module Ardtweeno
+  
+  ##
+  # Ardtweeno::Packet Communication storage class for the Ardtweeno system
+  #
+  class Packet
+    
+    # Class fields
+    attr_accessor :key, :seqNo, :date, :hour, :minute, :node, :data 
+    
+    ##
+    # Ardtweeno::Packet#new for the Packet class
+    # * *Args*    :
+    #   - ++ -> :seqNo, :key, :data  
+    # * *Returns* :
+    #   -
+    # * *Raises* :
+    #
+    def initialize(newSeqNo, newKey, newData)
+      
+      # Create a DateTime instance
+      today = DateTime.now
+      theDate = today.year.to_s() + "-" + "%02d" % today.month.to_s() + "-" + "%02d" % today.day.to_s()
+      
+      # Default values
+      @date = theDate
+      @hour = ("%02d" % today.hour).to_s
+      @minute = ("%02d" % today.min).to_s
+      @data = newData
+      @key = newKey
+      
+      # Need to implement a lookup function for key to node value
+      @node = "defaultNode"
+      
+      if newSeqNo.class == Fixnum
+        @seqNo = newSeqNo
+      elsif newSeqNo.class == String
+        @seqNo = newSeqNo.to_i
+      end
+      
+    end
+
+    
+    ##
+    # Ardtweeno::Packet#to_s returns a representation of the current instance state in String form
+    #
+    # * *Args*    :
+    #   - ++ ->  
+    # * *Returns* :
+    #   -         String
+    # * *Raises* :
+    #    
+    def to_s
+      # Build the string up from field data
+      str = "Packet No: " + @seqNo.to_s + " Key: " + @key + " Node: " + @node + " Date: " + @date +
+            " " + @hour + ":" + @minute + " Data: " + @data.to_s  
+      
+      # Returns the built string
+      return str
+    end
+    
+
+    ##
+    # Ardtweeno::Packet#to_json returns a representation of the current instance state in JSON form
+    #
+    # * *Args*    :
+    #   - ++ ->  
+    # * *Returns* :
+    #   -         String
+    # * *Raises* :
+    #    
+    def to_json(options={})
+      
+      jsonStr = '{"date":"' + @date + '","hour":"' + @hour + '","minute":"' +
+      @minute.to_s + '","node":"' + @node + '","key":"' + @key + '","seqNo":' +
+      @seqNo.to_s + ',"data":' + @data.to_json + '}'
+      
+      return jsonStr
+    end
+    
+    
+  end
+end

data/lib/ardtweeno/restapi.rb

@@ -0,0 +1,266 @@
+$stdout.sync = true
+####################################################################################################
+# @author       David Kirwan <davidkirwanirl@gmail.com>
+# @description  Ardtweeno Application Gateway HTTP REST API Sinatra Script
+#
+# @date         08-02-2013
+####################################################################################################
+##### Require statements
+require 'rubygems'
+require 'sinatra/base'
+require 'ardtweeno'
+require 'logger'
+require 'rufus/scheduler'
+
+class RESTAPI < Sinatra::Base
+
+  ##### Variables
+  enable :static, :sessions, :logging
+  set :environment, :production
+  set :root, File.join(File.dirname(__FILE__) + '/../../')
+  set :public_folder, Proc.new {File.join(root, '/public')}
+  set :views, Proc.new {File.join(root, '/views')}
+  
+  # Posts Array
+  set :posts, Array.new
+    
+  # Create the logger instance
+  set :log, Logger.new(STDOUT)
+  set :level, Logger::DEBUG
+  #set :level, Logger::INFO
+  #set :level, Logger::WARN
+  
+  # Options hash
+  set :options, {:log => settings.log, :level => settings.level}
+  
+  # Rufus-scheduler object
+  set :scheduler, Rufus::Scheduler.start_new
+  
+  # Setup the system for use
+  Ardtweeno.setup(settings.options)
+  @@theDispatcher = Ardtweeno::Dispatcher.instance
+  
+#########################################################################################################  
+
+  
+  settings.scheduler.every '60m' do
+      
+    begin
+      settings.log.debug "Running scheduled data flush"
+      @@theDispatcher.flush()
+                        
+    rescue Ardtweeno::DBError => e
+      settings.log.warn "ERROR: #{e.message}"
+    end
+     
+  end
+
+    
+#########################################################################################################
+
+    
+  get '/' do
+    redirect '/home'
+  end
+    
+    
+  get '/home' do
+    running = @@theDispatcher.running?
+    theposts = settings.posts
+
+    if theposts.length >= 5
+      theposts = theposts[(theposts.length - 5), theposts.length]
+    end
+
+    erb :home, :locals => {:running => running, :postdata => theposts.reverse}
+  end
+  
+  
+  get '/b97cb9ae44747ee263363463b7e56/create/post' do
+    running = @@theDispatcher.running?
+    erb :createpost, :locals => {:running => running}
+  end
+  
+  
+  post '/b97cb9ae44747ee263363463b7e56/create/post' do
+    settings.log.debug params.inspect
+    
+    thePost = Hash.new
+    
+    unless params["title"].nil? then thePost[:posttitle] = params["title"]; end
+    unless params["content"].nil? then thePost[:postcontent] = params["content"]; end
+    unless params["code"].nil? then thePost[:postcode] = params["code"]; end 
+    
+    settings.posts << thePost
+    
+    redirect '/home'
+  end
+      
+      
+  not_found do
+    '404 Page Not Found'
+  end
+  
+  
+#########################################################################################################
+  
+
+  get '/api/v1/zones' do
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The retrieve zones hook has been called"
+    
+    begin
+      @@theDispatcher.retrieve_zones(params).to_json # Returns String in JSON form
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end
+  end
+  
+  
+  get '/api/v1/zones/:zonename' do |zoneid|
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The retrieve zones hook has been called"
+    
+    begin
+      @@theDispatcher.retrieve_zones(params).to_json # Returns String in JSON form
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end
+  end
+  
+  
+#########################################################################################################    
+
+    
+  get '/api/v1/packets' do
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The retrieve packets hook has been called"
+    
+    begin
+      @@theDispatcher.retrieve_packets(params).to_json # Returns String in JSON form
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end
+  end
+  
+    
+  post '/api/v1/packets' do 
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The add packets hook has been called"
+      
+    settings.log.debug "Add packet API request: " + params[:payload]
+    begin
+      @@theDispatcher.store(params[:payload])
+        
+    rescue Ardtweeno::NodeNotAuthorised => e
+      throw :halt, [ 401, "401 Unauthorised" ]
+    rescue Exception => e
+      throw :halt, [ 400, "400 Bad Request" ]
+    end
+  end
+    
+
+#########################################################################################################
+
+  get '/api/v1/nodes' do
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The retrieve nodes hook has been called"
+    
+    begin
+      @@theDispatcher.retrieve_nodes(params).to_json # Returns String in JSON form
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end
+  end
+
+
+#########################################################################################################
+
+  post '/api/v1/watch/:node' do |node|
+    settings.log.debug params.inspect
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The add watch to node hook has been called"
+    
+    begin
+      @@theDispatcher.addWatch(params)
+    rescue Exception => e
+      throw :halt, [ 400, "400 Bad Request" ]
+    end
+    
+  end
+
+
+#########################################################################################################
+  
+  get '/api/v1/system/config' do
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The system config hook has been called, querying the Ardtweeno gateway to retrieve config"
+    
+    begin
+      return @@theDispatcher.config.to_json
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end
+    
+  end
+  
+  
+  get '/api/v1/system/start' do
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The system start hook has been called, launching the Ardtweeno system"
+      
+    begin
+      @@theDispatcher.start
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end 
+      
+    "The Ardtweeno system is launching, this will take a moment..."
+  end
+    
+    
+  get '/api/v1/system/stop' do
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The system stop hook has been called, shutting the Ardtweeno system down..."
+    
+    begin
+      @@theDispatcher.stop
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end
+      
+    "The Ardtweeno system is shutting down, this will take a moment..."    
+  end
+  
+  
+  # This is currently not implemented correctly  
+  get '/api/v1/system/reboot' do
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The system reboot hook has been called, rebooting the host"
+      
+    begin
+      @@theDispatcher.reboot
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end
+    
+    "The host is rebooting, this will take a moment..."
+  end
+
+
+  get '/api/v1/system/status' do
+    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    settings.log.debug "The system status hook has been called, reading the host configuration"
+
+    begin
+      return {:running=>@@theDispatcher.running?}.to_json
+    rescue Exception => e
+      throw :halt, [ 500, "500 Internal Server Error" ]
+    end
+
+  end
+
+#########################################################################################################
+
+# End of RESTAPI Class
+end