ardtweeno 0.0.2 → 0.2.5

data/public/main.css

@@ -0,0 +1,129 @@
+html, body {
+        margin: 0;
+        padding: 0;
+}
+
+body {
+        background: #1E1C17;
+        color: #ccc;
+        font-family: 'Trebuchet MS', 'Lucida Grande', Arial, Helvetica, sans-serif;
+        line-height: 1.2em;
+}
+
+img {
+        border: 0;
+}
+
+#status {
+        position: relative;
+        top: 6px;
+}
+
+
+a {
+        text-decoration: underline;
+        color: #FCC240;
+        text-decoration: none;
+}
+a:hover {
+        color: #BF4B31;
+}
+
+h1, h2, h3 {
+        font-size: 1.8em;
+        margin: 1em 0 0.5em 0;
+        padding: 0 0 0.2em 0;
+        color: #666;
+}
+h2 {
+        font-size: 1.4em;
+}
+h3 {
+        font-size: 1.2em;
+}
+
+hr {
+        position: relative;
+        background: transparent;
+        background: #ccc;
+        height: 0px;
+        border: 1px solid #ccc;
+}
+
+code {
+        background: #CED6B4;
+        padding: 0.7em;
+        font-family: Monaco, monospace;
+        color: #1E1C17;
+        border: 2px solid #444;
+        display: block;
+}
+
+div#content {
+        position: relative;
+        margin: 2em 2em;
+}
+
+div#post {
+	padding: 0 0 2.5em 0;
+}
+
+#intro {
+	padding: 0 0 2.5em 0;
+}
+
+#content p {
+        max-width: 50em;
+}
+
+div#header {
+        position: relative;
+        height: 3em;
+        margin: 0;
+        background: #4D8B4D;
+        border-bottom: 3px solid #FCC240;
+        text-align: left;
+}
+#logo {
+        position: absolute;
+        top: 15px;
+        left: 1em;
+        color: #fff;
+        font-size: 200%;
+}
+
+ul#navigation {
+        font-size: 90%;
+        position: absolute;
+        bottom: 0;
+        right: 2em;
+}
+ul#navigation li {
+        list-style-type: none;
+        display: inline;
+        margin-right: 1em;
+}
+ul#navigation a {
+        color: #ccc;
+        text-decoration: none;
+}
+ul#navigation a:hover {
+        color: #fff;
+        border-bottom: 2px solid #fff;
+}
+
+p#blurb {
+        font-size: 120%;
+        color: #CED6B4;
+}
+
+img#me {
+        float: right;
+        margin-top: -1em;
+        margin-left: 2em;
+        border: 3px solid #444;
+}
+
+.clear {
+        clear: both;
+}

data/resources/conf.yaml

@@ -0,0 +1,41 @@
+# Device the serial device to which the Ardtweeno SerialParser will connect
+dev: /dev/ttyUSB0
+speed: 9600
+
+# Administrator API Key
+adminkey: 1230aea77d7bd38898fec74a75a87738dea9f657
+
+# Settings for the Database
+db:
+  dbHost: localhost
+  dbPort: 27017
+  dbUser: herp
+  dbPass: 86ddd1420701a08d4a4380ca5d240ba7
+  dbName: ardtweeno
+  dbPacketsColl: packets
+  
+# Zone configuration
+zones:
+  -
+    zonename: testzone0 
+    zonekey: 455a807bb34b1976bac820b07c263ee81bd267cc
+    zonenodes:
+      - node0
+  -
+    zonename: testzone1
+    zonekey: 79a7c75758879243418fe2c87ec7d5d4e1451129
+    zonenodes:
+      - node1
+  
+  
+## Some spare unused hashes
+#f32b8561622c16cb0f758d2c0b4bdc3e651bbfc1
+#1b901dc0e9db739cc88a5568d201eb594742d1a2
+#0f3f3b500b694f515aa57f4ca13fc67b2f9f48d6
+#72b1a50b637f2051f1606c3997e80d33e36cba14
+#f7c98a41cc2705d9425b52d94ebd46296900d2aa
+#3dde6ae0f124c2446d7c50a6741a87e6ab0012ed
+#4ce7c012462a50256274bd38e3c12b720a99e4e0
+#b41143c153fdb15b5299c99bf451dc6a67fe2e36
+#78431dac18f37d437aa3c055d40d65d813a73143
+#8b785ee6da0a558f10db9da80e40df3fef44d43f

data/resources/nodelist.yaml

@@ -0,0 +1,26 @@
+- 
+  name: node0
+  key: 500d81aafe637717a52f8650e54206e64da33d27
+  description: This node has a temperature sensor
+  version: 0.2.1
+  sensors:
+    - Temperature
+-
+  name: node1
+  key: f937c37e949d9efa20d2958af309235c73ec039a
+  description: This node has a movement sensor
+  version: 0.2.1
+  sensors:
+    - Movement
+    
+  
+  
+ 
+#node2 : 2dbf44a68b77b15bfa5bc3d66c97892a57402bbe
+#node3 : a46fe0c4dab0453f5d86bed6206040880f59393e
+#node4 : 9da30539af3639c600c6256f7691750a581c36c2
+#node5 : b0a69b1f9fe82d6c149179ce48e22f9c8411afe3
+#node6 : 74e5a4bcab7355b8cab7df73d07747cd85c925e7
+#node7 : c03e55d15602a33922858e97664ea33f368ef5de
+#node8 : c65b8681a4eec1d41b1ba1b013535f1c96d943ab
+#node9 : 0785284586ef5810b80560319ef24968e897f7ce

data/resources/serialparser.js

@@ -0,0 +1,84 @@
+var serialport = require("serialport");
+var SerialPort = serialport.SerialPort;
+var needle = require('needle');
+
+// Read in the ARGV object parameters and remove the first two which hold the node variable
+// and the name of the script file.
+var myArgs = process.argv.slice(2);
+
+// Check to ensure the remaining parameters size is 2
+if(!(myArgs.length == 3)){
+  console.log("Usage: node serialparser.js /dev/ttyUSB0 9600 adminkey");
+  process.exit();
+}
+
+var dev = myArgs[0];
+var options = {
+  parser: serialport.parsers.raw,
+  baudrate: parseInt(myArgs[1])
+};
+
+var sp = new SerialPort(dev, options);
+var tempData = "";
+var attempts = 0;
+
+sp.on("data", function (data) {
+  data = data.toString().trim();
+
+  console.log("Data received: " + data);
+
+  try {
+    if(attempts > 0){
+      throw new Error('Preventing loss of data in buffer');
+    }
+    JSON.parse(data);
+    tempData = "";
+    attempts = 0;
+    console.log("Data for transmit: " + data);
+    var theData = 'key=' + myArgs[2] + '&payload=' + data
+
+    needle.post('http://localhost:4567/api/v1/packets', theData, function(err, resp, body){
+      try {
+        console.log("Got status code: " + resp.statusCode);
+        // you can pass params as a string or as an object
+      } catch (e){
+        console.log(e.message)
+      }
+    });
+
+  } catch (e) {
+    tempData += data;
+    tempData = tempData.trim();
+
+    if(attempts < 15){
+      try {
+        JSON.parse(tempData);
+        data = tempData;
+        tempData = "";
+        attempts = 0;
+        console.log("Data for transmit: " + data);
+        var theData = 'key=' + myArgs[2] + '&payload=' + data
+
+        needle.post('http://localhost:4567/api/v1/packets', theData, function(err, resp, body){
+        try {
+          console.log("Got status code: " + resp.statusCode);
+          // you can pass params as a string or as an object
+        } catch (e){
+            console.log(e.message)
+          }
+        });
+
+      } catch(e){
+        console.log("buffer contains: " + tempData);
+        console.log("Nope still not a valid JSON string, buffering...");
+      }
+      
+    }
+    else
+    {
+      tempData = "";
+      attempts = 0;
+    }
+    attempts += 1;
+  }
+});

data/test/api_test.rb

@@ -0,0 +1,255 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require 'ardtweeno'
+require 'logger'
+require 'json'
+require 'date'
+
+ENV['RACK_ENV'] = 'test'
+
+
+class APITest < Test::Unit::TestCase
+
+  include Rack::Test::Methods
+  
+  attr_accessor :dispatch, :nodelist, :nodemanager, :params, :date, :hour, :minute
+  
+  
+  # Test suite fixtures
+  def setup
+    
+    begin
+      # Inform the Ardtweeno::Dispatcher we are in testing mode so do not run the bootstrap()
+      # method as we will be creating instances of all required classes in the fixtures then
+      # injecting them into the dispatcher
+      Ardtweeno.setup({:test=>true, :log=>Logger.new(STDOUT), :level=>Logger::DEBUG})
+      @dispatch = Ardtweeno::Dispatcher.instance
+      
+      
+      # 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      
+      
+      @nodeList = Array.new
+      
+      5.times do |i|
+        @nodeList << Ardtweeno::Node.new("node#{i}", "abcdef#{i}", {:version=>"0.5.0"})
+      end
+      
+      @nodemanager = Ardtweeno::NodeManager.new({:nodelist => @nodeList})
+      
+      @dispatch.nodeManager = @nodemanager
+      
+      @params = { :empty=> {},
+                  :withnode=> {:node=>"node1"},
+                  :withinvalidnode=> {:node=>"node7"},
+                  :withoffset=> {:offset=>2},
+                  :withnegativeoffset=> {:offset=>-32},
+                  :withoffsetbordertest=> {:offset=>5},
+                  :withlength=> {:length=>2},
+                  :withzerolength=> {:length=>0},
+                  :withlargelength=> {:length=>500},
+                  :withsort=> {:sort=>"asc"},
+                  :withsortreverse=> {:sort=>"desc"},
+                  :withdate=> {:date=>@date},
+                  :withhour=> {:hour=>@hour},
+                  :withdatewrong=> {:date=>"11-111-1111"},
+                  :withhourwrong=> {:hour=>"022"},
+                  :withminute=> {:minute=>@minute},
+                  :withminutewrong=> {:minute=>"022"},
+                  :withseqno=> {:seqno=>35},
+                  :withseqnowrong=> {:seqno=>50000},
+                  :withversion=> {:version=> "0.5.0"},
+                  :withversionwrong=> {:version=> "0.0.0"},
+                  :withname=> {:name=>"node0"},
+                  :withnamewrong=> {:name=>"node28"},
+                  :withnodekey=> {:nodekey=>"abcdef1"},
+                  :withnodekeywrong=> {:nodekey=>"fffffffffff"},
+                  :withzonename=> {:zonename=>"testzone0"},
+                  :withoutzonename=> {:zonename=>"notazonename"}
+                }
+      
+      5.times do |i|
+        @dispatch.store('{"data":[23.5,997.5,65],"key":"abcdef1"}')
+      end
+      
+    rescue Exception => e
+      puts e.message
+      puts e.backtrace
+      exit
+    end
+    
+  end
+  
+
+  # tear down the test fixtures between each test
+  def teardown
+    
+  end
+  
+  
+  # Test the retrievezones method
+  def test_retrievezones
+    results = @dispatch.retrieve_zones(@params[:withzonename])
+    assert_equal(1, results[:zones].size)
+    
+    results = @dispatch.retrieve_zones(@params[:withoutzonename])
+    assert_equal(0, results[:zones].size)
+    
+    results = @dispatch.retrieve_zones(@params[:empty])
+    assert_equal(2, results[:zones].size)
+    
+  end
+  
+  
+    
+  # Test the retrievenodes method
+  def test_retrievenodes
+    results = @dispatch.retrieve_nodes(@params[:empty])
+    assert_equal(5, results[:nodes].size)
+  end
+  
+  
+  # Test the retrievepackets method
+  def test_retrievepackets
+    results = @dispatch.retrieve_packets(@params[:withnode])
+    assert_equal(5, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withinvalidnode])
+    assert_equal(0, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:empty])
+    assert_equal(5, results[:packets].size)
+    
+  end
+  
+  
+  # Test the handleVersion method
+  def test_handleVersion
+    results = @dispatch.retrieve_nodes(@params[:withversion])
+    assert_equal(5, results[:nodes].size)
+
+    results = @dispatch.retrieve_nodes(@params[:withversionwrong])
+    assert_equal(0  , results[:nodes].size)
+  end
+  
+  
+  # Test the handleName method
+  def test_handleName
+    results = @dispatch.retrieve_nodes(@params[:withname])
+    assert_equal(1, results[:nodes].size)
+
+    results = @dispatch.retrieve_nodes(@params[:withnamewrong])
+    assert_equal(0  , results[:nodes].size)
+  end
+  
+  
+  # Test the handleNodeKey method
+  def test_handleNodeKey
+    results = @dispatch.retrieve_nodes(@params[:withnodekey])
+    assert_equal(1, results[:nodes].size)
+
+    results = @dispatch.retrieve_nodes(@params[:withnodekeywrong])
+    assert_equal(0  , results[:nodes].size)
+  end
+  
+  
+  # Test the handleSeqNo method
+  def test_handleSeqNo
+    results = @dispatch.retrieve_packets(@params[:withseqno])   
+    assert_equal(1, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withseqnowrong])
+    assert_equal(0, results[:packets].size)
+  end
+  
+  # Test the handleMinute method
+  def test_handleMinute
+    results = @dispatch.retrieve_packets(@params[:withminute])
+    assert_equal(5, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withminutewrong])
+    assert_equal(0, results[:packets].size)
+  end
+  
+  
+  # Test the handleHour method
+  def test_handleHour
+    results = @dispatch.retrieve_packets(@params[:withhour])
+    assert_equal(5, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withhourwrong])
+    assert_equal(0, results[:packets].size)
+  end
+  
+  
+  # Test the handleDate method
+  def test_handleDate
+    results = @dispatch.retrieve_packets(@params[:withdate])
+    assert_equal(5, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withdatewrong])
+    assert_equal(0, results[:packets].size)
+  end
+  
+  
+  # Test the handleOffset method
+  def test_handleOffset
+    results = @dispatch.retrieve_packets(@params[:withoffset])
+    assert_equal(3, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withoffsetbordertest])
+    assert_equal(0, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withnegativeoffset])
+    assert_equal(5, results[:packets].size)
+
+  end
+
+  
+  # Test the handleLenght method
+  def test_handleLength
+    results = @dispatch.retrieve_packets(@params[:withlength])
+    assert_equal(2, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withzerolength])
+    assert_equal(0, results[:packets].size)
+    
+    results = @dispatch.retrieve_packets(@params[:withlargelength])
+    assert_equal(5, results[:packets].size)
+
+  end
+  
+  
+  # Test the handleSort method
+  def test_handleSort
+    results = @dispatch.retrieve_packets(@params[:withsort])
+    assert_equal(5, results[:packets].size)
+    
+    assert_block do
+      val1 = results[:packets][0].seqNo
+      val2 = results[:packets][4].seqNo
+      
+      if val2 > val1 then return true; else return false; end
+    end
+    
+    
+    results = @dispatch.retrieve_packets(@params[:withsortreverse])
+    assert_equal(5, results[:packets].size)
+    
+    assert_block do
+      val1 = results[:packets][0].seqNo
+      val2 = results[:packets][4].seqNo
+      
+      if val2 < val1 then return true; else return false; end
+    end
+    
+  end
+
+end

data/test/dispatcher_test.rb

@@ -0,0 +1,115 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+require 'ardtweeno'
+require 'logger'
+require 'json'
+
+ENV['RACK_ENV'] = 'test'
+
+
+class DispatcherTest < Test::Unit::TestCase
+
+  include Rack::Test::Methods
+  
+  attr_accessor :dispatch
+  
+  
+  # Test suite fixtures
+  def setup
+    
+    begin
+      # Inform the Ardtweeno::Dispatcher we are in testing mode so do not run the bootstrap()
+      # method as we will be creating instances of all required classes in the fixtures then
+      # injecting them into the dispatcher
+      Ardtweeno.setup({:test=>true, :log=>Logger.new(STDOUT), :level=>Logger::DEBUG})
+      @dispatch = Ardtweeno::Dispatcher.instance
+      
+      @nodeList = Array.new
+      
+      5.times do |i|
+        @nodeList << Ardtweeno::Node.new("node#{i}", "abcdef#{i}")
+      end
+      
+      @nodemanager = Ardtweeno::NodeManager.new({:nodelist => @nodeList})
+      
+      @dispatch.nodeManager = @nodemanager
+      
+    rescue Exception => e
+      puts e.message
+      puts e.backtrace
+      exit
+    end
+    
+  end
+  
+
+  # tear down the test fixtures between each test
+  def teardown
+
+  end
+  
+  # Test to ensure the Ardtweeno::Dispatcher#running? is operating correctly
+  def test_running
+    assert_equal(false, @dispatch.running?)
+    
+    @dispatch.start
+    assert_equal(true, @dispatch.running?)
+    
+    @dispatch.stop
+    assert_equal(false, @dispatch.running?)
+  end
+  
+  # Test to ensure the Ardtweeno::Dispatcher#start can launch the system correctly
+  def test_start
+    assert_equal(true, @dispatch.start)
+    assert_equal(false, @dispatch.start)
+  end
+  
+  # Test to ensure the Ardtweeno::Dispatcher#stop can terminate the system correctly.
+  def test_stop
+    @dispatch.start
+    assert_equal(true, @dispatch.stop)
+    assert_equal(false, @dispatch.stop)
+  end
+  
+  # Test to ensure the Ardtweeno::Dispatcher#store method is operating correctly
+  def test_store
+    # Test to ensure it will raise an exception if we try to add something other than an
+    # Ardtweeno::Packet
+    assert_raise TypeError do
+      @dispatch.store(Hash.new)
+    end
+    
+    # Raise a JSON ParserError if we send a string but invalid JSON
+    assert_raise JSON::ParserError do
+      @dispatch.store("{derp:}")
+    end
+    
+    # Raises Ardtweeno InvalidData if we send valid JSON but invalid Packet data
+    assert_raise Ardtweeno::InvalidData do
+      @dispatch.store("{}")
+    end
+    
+    # Raises Ardtweeno InvalidData if we send valid JSON but invalid Packet data
+    assert_raise Ardtweeno::InvalidData do
+      @dispatch.store('{"key":"500d81aafe637717a52f8650e54206e64da33d27"}')
+    end
+    
+    # Raises Ardtweeno InvalidData if we send valid JSON but invalid Packet data
+    assert_raise Ardtweeno::InvalidData do
+      @dispatch.store('{"data":[23.5,997.5,65]}')
+    end
+    
+    # Raises Ardtweeno NodeNotAuthorised if valid JSON, valid Packet but unauthorised node key
+    assert_raise Ardtweeno::NodeNotAuthorised do
+      @dispatch.store('{"data":[23.5,997.5,65],"key":"500d81aafe637717a52f8650e54206e64da33d27"}')
+    end
+    
+    # Valid Packet
+    assert_equal(true, @dispatch.store('{"data":[23.5,997.5,65],"key":"abcdef0"}'))
+    
+  end
+  
+
+end