ardtweeno 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d157740b9956acd9a32efa343e0f781d4aca11d
-  data.tar.gz: 6d23a441b410510a3212412e0ec9424a4d981911
+  metadata.gz: 53873386c274f4259d283b97c153f7edeb1649a7
+  data.tar.gz: 9bec1a6d15af011369aa6b7e59c1e64ce3df77d1
 SHA512:
-  metadata.gz: 4114dd22733d63b18891faaafc33f0668f45a01f6be67bc678306602283202dff74ac63bd5ee7a5bf19e4e4416c78ef0669627d1f655496822c5e33bd614888f
-  data.tar.gz: fcd8e50001b844d2b98a127253c730e5255dfaaa74a762a29d643443750d55687b03ece7904cdaff5a78045f0098b8c9506108d0a43652d2c02b8ca2fe51a588
+  metadata.gz: 9036d28f3317a76cc2a1ef61f7106916536507babf822a1b458ca7da206b9863e3c385ef01e803c358f43b3a9e4623d0e2ce2f79e4401affc24cd6b2f656e91f
+  data.tar.gz: df69ac9c1589916f2b9450327a93d99d415b0d3b0bac67484d0e1e035be36792501621dae198d9882bf96f531dfd43926a3e11b72214abbd95e127ea6829ae63

data/CHANGELOG

@@ -1,3 +1,27 @@
+## Version 0.5.0
+- Push notification cooloff periods are now respected. fixes #38
+- /api/v1/system/start stop and config endpoints only respond to the Admin apikey
+- Updated each REST API endpoint with the latest Ardtweeno::Dispatcher#authenticate? calls
+- Resolved bug with /api/v1/zones and /api/v1/zones/:zonename endpoints responding with admin responses when using zoneapi keys - Refs #35
+- Refactored /api/v1/zones and /api/v1/zones/:zonename to only return zone info as authorised by the API key 
+- Updated test fixtures to reflect this change - References #35
+- Fixed failing tests related to changes made towards fixing #35
+- Slightly refactored response generated by Ardtweeno::Dispatcher#authenticate? Refs #35
+- Updated authentication around the /api/v1/zone endpoints to only return data related to that particular zone. Refs #35
+- Switching between tabs no longer initiates a new setTimeout() to refresh the statuslist graph. Fixes #39
+- /api/v1/system/start and /api/v1/system/stop endpoints now return JSON responses 
+- Updated tests to take account for the endpoint changes - Fixes #37
+- Updated public/main.css to style the API table specification in /api view 
+- Implemented HTTP REST API specification in the /api view. Fixes 
+- Removed the /api/v1/system/reboot endpoint. - Fixes #10 - Fixes #34
+- Resolved issue with the sort parameter edgecases previously not spotted. Fixes #36
+- Updated restapi.rb to include the /api endpoint which will display the Ardtweeno API specification once fully implemented 
+- Updated index.erb to include a new API tab which points at the /api endpoint - Added an api.erb view which will hold the HTTP REST API specification for the gateway - Refs #34
+- Removed rufus scheduler from the dependencies, and the codebase.
+- Updated gemspec to 0.4.0
+- Added flot library JS files
+- Release 0.4.0 Changelog
+
 ## Version 0.4.0
 - Implemented status graph using the flot.js library. Fixes #28
 - Implemented disk utility df parser - Table in /status endpoint now populated with disk usage data. Fixes #23

data/Gemfile.lock

@@ -4,68 +4,57 @@ GEM
     ardtweeno (0.4.0)
       bson_ext (>= 1.6.2)
       bundler (>= 1.2.3)
-      foreman (>= 0.63.0)
       mongo (>= 1.6.2)
-      rufus-scheduler (>= 2.0.0)
       sinatra (>= 1.3.3)
       thin (>= 1.5.0)
       typhoeus (>= 0.6.3)
-    atomic (1.1.14)
-    bson (1.9.2)
-    bson_ext (1.9.2)
-      bson (~> 1.9.2)
+    bson (1.10.0)
+    bson_ext (1.10.0)
+      bson (~> 1.10.0)
     daemons (1.1.9)
-    diff-lcs (1.2.4)
-    dotenv (0.9.0)
-    ethon (0.6.1)
+    diff-lcs (1.2.5)
+    dotenv (0.10.0)
+    ethon (0.7.0)
       ffi (>= 1.3.0)
-      mime-types (~> 1.18)
     eventmachine (1.0.3)
-    ffi (1.9.1)
+    ffi (1.9.3)
     foreman (0.63.0)
       dotenv (>= 0.7)
       thor (>= 0.13.6)
     json (1.8.1)
-    mime-types (1.25)
-    mini_portile (0.5.2)
-    mongo (1.9.2)
-      bson (~> 1.9.2)
-    nokogiri (1.6.0)
+    mini_portile (0.5.3)
+    mongo (1.10.0)
+      bson (~> 1.10.0)
+    nokogiri (1.6.1)
       mini_portile (~> 0.5.0)
     rack (1.5.2)
-    rack-protection (1.5.1)
+    rack-protection (1.5.2)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (10.1.0)
+    rake (10.2.2)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.6)
-    rspec-expectations (2.14.3)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    rufus-scheduler (3.0.2)
-      tzinfo
-    serialport (1.2.1)
+    rspec-mocks (2.14.6)
+    serialport (1.3.0)
     sinatra (1.4.4)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     test-unit (2.5.5)
-    thin (1.6.0)
+    thin (1.6.2)
       daemons (>= 1.0.9)
       eventmachine (>= 1.0.0)
-      rack (>= 1.5.0)
-    thor (0.18.1)
-    thread_safe (0.1.3)
-      atomic
+      rack (>= 1.0.0)
+    thor (0.19.1)
     tilt (1.4.1)
-    typhoeus (0.6.5)
-      ethon (~> 0.6.1)
-    tzinfo (1.1.0)
-      thread_safe (~> 0.1)
+    typhoeus (0.6.8)
+      ethon (>= 0.7.0)
 
 PLATFORMS
   ruby

data/lib/ardtweeno/api.rb

@@ -191,8 +191,8 @@ module Ardtweeno
         containerArray = Array.new
         
         theArray.each do |i|
-          # Found the node required
-          if i[:zonename] == theParams[:zonename]
+          # Found the zone required
+          if i[:zonename] == theParams[:zonename] or theParams[:role] == "admin"
             containerArray << i
           end
         end
@@ -520,8 +520,13 @@ module Ardtweeno
         @log.debug "handleSort function executing"
         
         if theParams.has_key?(:sort) and theParams[:sort] == "desc"
-          theArray = theArray.sort_by {|x| x.seqNo}
-          return theArray.reverse()
+          begin
+          
+            theArray = theArray.sort_by {|x| x.seqNo}
+            return theArray.reverse()
+          rescue Exception => e
+            return theArray.reverse()
+          end
 
         else
           return theArray # Order is already ascending, return original array

data/lib/ardtweeno/dispatcher.rb

@@ -630,18 +630,19 @@ module Ardtweeno
     #   -          true/false
     # * *Raises* :
     #
-    def authenticate?(key)
+    def authenticate?(key)      
       if key == @confdata["adminkey"]
-        return true
+        return true, {:role=>"admin"}
       else
         
         @confdata["zones"].each do |i|
           if i["zonekey"] == key
-            return true
+            i[:role] = "zone"
+            return true, i
           end
         end
         
-        return false
+        return false, {}
       end
     end
     

data/lib/ardtweeno/nodemanager.rb

@@ -297,9 +297,19 @@ module Ardtweeno
         @log.debug "Comparing " + i[:node] + " to " + node
                 
         if i[:node] == node
+          @log.debug "Ensuring the timeout cooloff period is respected"
+          now = Time.now.to_i
           
-          @log.debug "Associated watch found, checking for method " + i[:method]
+          if i.has_key?(:last_push)
+            timeout = i[:last_push] + i[:timeout].to_i
+            
+            if timeout > now
+              @log.debug "We are within the cooloff period, ignoring the push notification"
+              return 
+            end
+          end          
           
+          @log.debug "Associated watch found, checking for method " + i[:method]
           if i[:method] == "POST"
             @log.debug "HTTP POST method executing"
             Typhoeus::Request.post(i[:notifyURL], 
@@ -313,6 +323,8 @@ module Ardtweeno
                                               :content=>"#{i[:node]}",
                                               :code=>""})
           end
+          
+          i[:last_push] = now
 
         end
       end

data/lib/ardtweeno/restapi.rb

@@ -116,6 +116,11 @@ class RESTAPI < Sinatra::Base
   end
   
   
+  get '/api' do
+    erb :api
+  end
+  
+  
   get '/graph/v1/punchcard/:node' do |node|
     begin
       theData, theDays, theRange= @@theDispatcher.constructPunchcard(params)
@@ -164,8 +169,14 @@ class RESTAPI < Sinatra::Base
   
 
   get '/api/v1/zones' do
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
     settings.log.debug "The retrieve zones hook has been called"
+
+    unless zonedata.nil?
+      params["role"] = zonedata[:role]
+      unless params.has_key?("zonename") then params["zonename"] = zonedata["zonename"]; end
+    end
     
     begin
       @@theDispatcher.retrieve_zones(params).to_json # Returns String in JSON form
@@ -175,9 +186,14 @@ class RESTAPI < Sinatra::Base
   end
   
   
-  get '/api/v1/zones/:zonename' do |zoneid|
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+  get '/api/v1/zones/:zonename' do |zonename|
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
     settings.log.debug "The retrieve zones hook has been called"
+
+    unless zonedata.nil?
+      params["role"] = zonedata[:role]
+    end
     
     begin
       @@theDispatcher.retrieve_zones(params).to_json # Returns String in JSON form
@@ -191,7 +207,8 @@ class RESTAPI < Sinatra::Base
 
     
   get '/api/v1/packets' do
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
     settings.log.debug "The retrieve packets hook has been called"
     
     begin
@@ -203,7 +220,8 @@ class RESTAPI < Sinatra::Base
   
     
   post '/api/v1/packets' do 
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
     settings.log.debug "The add packets hook has been called"
       
     settings.log.debug "Add packet API request: " + params[:payload]
@@ -221,13 +239,15 @@ class RESTAPI < Sinatra::Base
 #########################################################################################################
 
   get '/api/v1/nodes' do
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
     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" ]
+      raise e
+      #throw :halt, [ 500, "500 Internal Server Error" ]
     end
   end
 
@@ -235,8 +255,8 @@ class RESTAPI < Sinatra::Base
 #########################################################################################################
 
   post '/api/v1/watch/:node' do |node|
-    settings.log.debug params.inspect
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
     settings.log.debug "The add watch to node hook has been called"
     
     begin
@@ -248,8 +268,8 @@ class RESTAPI < Sinatra::Base
   
   
   get '/api/v1/watch/:node' do |node|
-    settings.log.debug params.inspect
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
     settings.log.debug "Check if a node is being watched"
     
     begin
@@ -261,8 +281,8 @@ class RESTAPI < Sinatra::Base
 
 
   get '/api/v1/watch' do
-    settings.log.debug params.inspect
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
     settings.log.debug "Check if a node is being watched"
     
     begin
@@ -276,7 +296,9 @@ class RESTAPI < Sinatra::Base
 #########################################################################################################
   
   get '/api/v1/system/config' do
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
+    throw :halt, [ 401, "401 Not Authorised" ] unless zonedata[:role] == "admin"
     settings.log.debug "The system config hook has been called, querying the Ardtweeno gateway to retrieve config"
     
     begin
@@ -289,46 +311,36 @@ class RESTAPI < Sinatra::Base
   
   
   get '/api/v1/system/start' do
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
+    throw :halt, [ 401, "401 Not Authorised" ] unless zonedata[:role] == "admin"
     settings.log.debug "The system start hook has been called, launching the Ardtweeno system"
       
     begin
-      @@theDispatcher.start
+      theResponse = @@theDispatcher.start
     rescue Exception => e
       throw :halt, [ 500, "500 Internal Server Error" ]
     end 
       
-    "The Ardtweeno system is launching, this will take a moment..."
+    return {:response=>theResponse, :running=>@@theDispatcher.running?}.to_json
   end
     
     
   get '/api/v1/system/stop' do
-    throw :halt, [ 404, "404 Page Not Found" ] unless @@theDispatcher.authenticate?(params[:key])
+    auth, zonedata = @@theDispatcher.authenticate?(params[:key])
+    throw :halt, [ 404, "404 Page Not Found" ] unless auth
+    throw :halt, [ 401, "401 Not Authorised" ] unless zonedata[:role] == "admin"
     settings.log.debug "The system stop hook has been called, shutting the Ardtweeno system down..."
     
     begin
-      @@theDispatcher.stop
+      theResponse = @@theDispatcher.stop
     rescue Exception => e
       throw :halt, [ 500, "500 Internal Server Error" ]
     end
       
-    "The Ardtweeno system is shutting down, this will take a moment..."    
+    return {:response=>theResponse, :running=>@@theDispatcher.running?}.to_json    
   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

data/lib/ardtweeno.rb

@@ -31,7 +31,7 @@ module Ardtweeno
     
     
     # Constants
-    Ardtweeno::VERSION = "0.3.1" unless defined? Ardtweeno::VERSION
+    Ardtweeno::VERSION = "0.5.0" unless defined? Ardtweeno::VERSION
     Ardtweeno::CONFIGPATH = ENV['HOME'] + "/.ardtweeno" unless defined? Ardtweeno::CONFIGPATH
     Ardtweeno::DBPATH = Ardtweeno::CONFIGPATH + "/conf.yaml" unless defined? Ardtweeno::DBPATH
     Ardtweeno::NODEPATH = Ardtweeno::CONFIGPATH + "/nodelist.yaml" unless defined? Ardtweeno::NODEPATH

data/public/main.css

@@ -528,3 +528,13 @@ table th[class*="span"],
 .legend table {
 	border-spacing: 5px;
 }
+
+
+#apitable td, th { font: 12px Verdana,sans-serif; color: #444; }
+#apitable td.path { font-family: monospace; }
+#apitable th { font-size 1em; font-weight: bold; }
+#apitable table { background: #F0F0F0; border-collapse: collapse; }
+#apitable table th, table td { vertical-align: top; border: 1px solid #bbb; padding: 5px; }
+#apitable code { background: #ffa; }
+#apitable pre { background: black; color: #0f0; padding: 10px; word-wrap: break-word;}
+#apitable table pre { background: #ffa; color: black; }

data/public/main.js

@@ -3,10 +3,6 @@ var tabsId = '#tabs';
 var keepUpdating = false;
 
 
-function hashchanged(){
-	keepUpdating = false;	
-}
-
 $(document).ready(function(){
 	// Preload tab on page load
 	if($(tabsId + ' LI.current A').length > 0){

data/test/debug/run_mock

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'serialport'
 require 'json'
-require "../serialport_mock.rb"
+require "./serialport_mock.rb"
 
 mock = SerialDeviceMock.new('/dev/pts/3', 9600, 100)
   

data/test/debug/run_packet_push

@@ -8,7 +8,7 @@ while true
   testData2 = {"data" => [rand(0..100), rand(0..1000)], "key" => "a46fe0c4dab0453f5d86bed6206040880f59393e"}.to_json
   
   puts Typhoeus::Request.post("http://localhost:4567/api/v1/packets", :body=> {:key => key, :payload=>testData})
-  sleep(rand(0..9))
+  sleep(rand(0..90))
   puts Typhoeus::Request.post("http://localhost:4567/api/v1/packets", :body=> {:key => key, :payload=>testData2})
-  sleep(rand(0.9))
+  sleep(rand(0.90))
 end

data/test/debug/run_post_watch

@@ -5,8 +5,8 @@ require 'json'
 
 body = {:key=> "1230aea77d7bd38898fec74a75a87738dea9f657", 
 #		:node=>"node1",
-		:notifyURL=>"http://localhost:5000/push/node1", 
+		:notifyURL=>"http://192.168.1.2:5000/push/node1", 
 		:method=>"GET", 
-		:timeout=>60}
+		:timeout=>"60"}
 
-puts Typhoeus::Request.post("http://localhost:4567/api/v1/watch/node1", :body=>body)
+puts Typhoeus::Request.post("http://192.168.1.14:4567/api/v1/watch/node1", :body=>body)

data/test/rest_api_test.rb

@@ -104,28 +104,28 @@ class RESTAPITest < Test::Unit::TestCase
 
   # Test retrieval of zones
   def test_retrieve_zones
-    get "/api/v1/zones", params={:zonename=>"testzone0", :key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
+    get "/api/v1/zones", params={:key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
     json = JSON.parse(last_response.body)
     
-    assert_equal(1, json["found"])
+    assert_equal(2, json["found"])
     assert_equal(2, json["total"])
     
     get "/api/v1/zones", params={:zonename=>"testzonez", :key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
     json = JSON.parse(last_response.body)
-    assert_equal(0, json["found"])
+    assert_equal(2, json["found"])
     assert_equal(2, json["total"])
     
-    get "/api/v1/zones", params={:key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
+    get "/api/v1/zones", params={:key=>"455a807bb34b1976bac820b07c263ee81bd267cc"}
     json = JSON.parse(last_response.body)
-    assert_equal(2, json["found"])
+    assert_equal(1, json["found"])
     assert_equal(2, json["total"])
     
-    get "/api/v1/zones/testzone0", params={:zonename=>"testzone0", :key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
+    get "/api/v1/zones/testzone0", params={:key=>"455a807bb34b1976bac820b07c263ee81bd267cc"}
     json = JSON.parse(last_response.body)
     assert_equal(1, json["found"])
     assert_equal(2, json["total"])
     
-    get "/api/v1/zones/testzonez", params={:zonename=>"testzonez", :key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
+    get "/api/v1/zones/testzonez", params={:key=>"79a7c75758879243418fe2c87ec7d5d4e1451129"}
     json = JSON.parse(last_response.body)
     assert_equal(0, json["found"])
     assert_equal(2, json["total"])
@@ -232,24 +232,26 @@ class RESTAPITest < Test::Unit::TestCase
   # Test the system start parser command
   def test_system_start
     get "/api/v1/system/start", params={:node=>"node1", :key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
-    assert_equal("The Ardtweeno system is launching, this will take a moment...", last_response.body)
+    assert_equal('{"response":true,"running":true}', last_response.body)
     assert last_response.ok?
     
     # Test call with invalid key fails
-    get "/api/v1/system/start", params={:node=>"node1", :key=>"898fec74a75a87738dea9f657"}
-    assert not(last_response.ok?)
+    get "/api/v1/system/start", params={:node=>"node1", :key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
+    assert_equal('{"response":false,"running":true}', last_response.body)
+    assert last_response.ok?
   end
   
   
   # Test the system stop parser command
   def test_system_stop
     get "/api/v1/system/stop", params={:node=>"node1", :key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
-    assert_equal("The Ardtweeno system is shutting down, this will take a moment...", last_response.body)
+    assert_equal('{"response":true,"running":false}', last_response.body)
     assert last_response.ok?
     
     # Test call with invalid key fails
-    get "/api/v1/system/stop", params={:node=>"node1", :key=>"898fec74a75a87738dea9f657"}
-    assert not(last_response.ok?)
+    get "/api/v1/system/stop", params={:node=>"node1", :key=>"1230aea77d7bd38898fec74a75a87738dea9f657"}
+    assert_equal('{"response":false,"running":false}', last_response.body)
+    assert last_response.ok?
   end
   
   

data/views/api.erb

@@ -0,0 +1,252 @@
+<p id="blurb">
+Ardtweeno Gateway HTTP REST API specification. For more information see <a href="https://github.com/davidkirwan/ardtweeno/wiki/API">here</a>
+</p>
+
+<div id="apitable">
+<table>
+      <tbody>
+      <tr>
+        <th>GET</th>
+        <th>PUT</th>
+        <th>DELETE</th>
+        <th>POST</th>
+        <th>Path</th>
+        <th>Description</th>
+      </tr>
+      <tr>
+        <td>X</td>
+        <td>X</td>
+        <td>X</td>
+        <td>X</td>
+        <td class="path">Common to all endpoints:</td>
+        <td>
+          Parameters:
+          <ul>
+            <li>sort the result set, defaults to asc<code>/api/v1/packets?sort=(desc or asc)</code></li>
+            <li>offset the result set, by the passed integer number<code>/api/v1/packets?offset=(positive and negative work)</code></li>
+            <li>length the result set, is limited to only return the first integer number of results. Max of 200<code>/api/v1/packets?length=(positive integer)</code></li>
+          </ul>
+        </td>
+      </tr>
+      <tr>
+        <td>X</td>
+        <td></td>
+        <td></td>
+        <td></td>
+        <td class="path">/api/v1/nodes</td>
+        <td>
+          Retrieve a list of Nodes and authenticate with API Key:
+          <pre>/api/v1/nodes?key=0dfdFFeeDx</pre>
+          The following Parameters are respected:
+          <ul>
+            <li>name</li>
+            <li>nodekey</li>
+            <li>nodename</li>
+          </ul>
+          Typical response from the gateway:
+          <code>
+<pre>
+{
+  "nodes": [
+    {
+      "name": "node0",
+      "key": "500d81aafe637717a52f8650e54206e64da33d27",
+      "description": "This node has a temperature sensor",
+      "version": "0.2.1",
+      "sensors": [
+        "Temperature"
+      ],
+      "packets": 0
+    },
+    {
+      "name": "node1",
+      "key": "f937c37e949d9efa20d2958af309235c73ec039a",
+      "description": "This node has a movement sensor",
+      "version": "0.2.1",
+      "sensors": [
+        "Movement"
+      ],
+      "packets": 0
+    }
+  ],
+  "total": 2,
+  "found": 2
+}
+</pre>
+          </code>
+        </td>
+      </tr>
+      <tr>
+        <td>X</td>
+        <td></td>
+        <td></td>
+        <td>X</td>
+        <td class="path">/api/v1/packets</td>
+        <td>
+          Retrieve a list of packets and authenticate with API Key:
+          <pre>/api/v1/packets?key=0dfdFFeeDx</pre>
+          The following parameters are respected:
+          <ul>
+            <li>node</li>
+            <li>seqno</li>
+            <li>hour</li>
+            <li>minute</li>
+            <li>date</li>
+          </ul>
+          Typical response from the gateway:
+          <code>
+<pre>
+{
+  "packets": [
+    {
+      "date": "2013-11-11",
+      "hour": "22",
+      "minute": "04",
+      "node": "node0",
+      "key": "500d81aafe637717a52f8650e54206e64da33d27",
+      "seqNo": 0,
+      "data": [
+        13
+      ]
+    }
+  ],
+  "total": 1,
+  "found": 1
+}
+</pre>
+          </code>
+        </td>
+      </tr>
+      <tr>
+        <td>X</td>
+        <td></td>
+        <td></td>
+        <td></td>
+        <td class="path">/api/v1/zones</td>
+        <td>
+          Retrieve a list of zones and authenticate with API Key:
+          <pre>/api/v1/zones?key=0dfdFFeeDx</pre>
+          The following parameters are respected:
+          <ul>
+            <li>zonename</li>
+          </ul>
+          Typical response from the gateway:
+          <code>
+<pre>
+{
+  "zones": [
+    {
+      "zonename": "testzone1",
+      "key": "79a7c75758879243418fe2c87ec7d5d4e1451129",
+      "nodes": [
+        "node1"
+      ]
+    },
+    {
+      "zonename": "testzone0",
+      "key": "455a807bb34b1976bac820b07c263ee81bd267cc",
+      "nodes": [
+        "node0"
+      ]
+    }
+  ],
+  "total": 2,
+  "found": 2
+}
+</pre>
+          </code>
+        </td>
+      </tr>
+      <tr>
+        <td>X</td>
+        <td></td>
+        <td></td>
+        <td></td>
+        <td class="path">/api/v1/zones/:zonename</td>
+        <td>
+          Retrieve a list of zones and authenticate with API Key:
+          <pre>/api/v1/zones/testzone1?key=0dfdFFeeDx</pre>
+          Typical response from the gateway:
+          <code>
+<pre>
+{
+  "zones": [
+    {
+      "zonename": "testzone1",
+      "key": "79a7c75758879243418fe2c87ec7d5d4e1451129",
+      "nodes": [
+        "node1"
+      ]
+    }
+  ],
+  "total": 2,
+  "found": 1
+}
+</pre>
+          </code>
+        </td>
+      </tr>
+      <tr>
+        <td>X</td>
+        <td></td>
+        <td></td>
+        <td></td>
+        <td class="path">/api/v1/watch</td>
+        <td>
+          Retrieve a list of nodes currently on the watch list and authenticate with API Key:
+          <pre>/api/v1/watch?key=0dfdFFeeDx</pre>
+          Typical response from the gateway:
+          <code>
+<pre>
+{
+  "watched": [
+    
+  ]
+}
+</pre>
+      </tr>
+      <tr>
+        <td>X</td>
+        <td></td>
+        <td></td>
+        <td>X</td>
+        <td class="path">/api/v1/watch/:node</td>
+        <td>
+          Retrieve a list of nodes currently on the watch list and authenticate with API Key:
+          <pre>/api/v1/watch/node0?key=0dfdFFeeDx</pre>
+          Typical response from the gateway:
+          <code>
+<pre>
+{
+  "watched": false
+}
+</pre>
+          </code>
+          To add a node to the watchlist use the following parameters in a POST request:
+          <ul>
+            <li>node</li>
+            <li>notifyURL</li>
+            <li>method</li>
+            <li>timeout</li>
+            See the following full example for more information:
+          <code>
+<pre>
+require 'rubygems'
+require 'typhoeus'
+require 'json'
+
+
+body = {:key=> "1230aea77d7bd38898fec74a75a87738dea9f657",
+                :notifyURL=>"http://some-server/push/notifications",
+                :method=>"POST",
+                :timeout=>"60"}
+
+puts Typhoeus::Request.post("http://localhost:4567/api/v1/watch/node2", :body=>body)
+</pre>
+          </code>            
+          </ul>
+        </td>
+      </tr>
+    </tbody>
+    </table>
+</div>

data/views/index.erb

@@ -29,6 +29,7 @@
         <li class="current"><a href="/home">Home</a></li>
         <li><a href="/status">Status</a></li>
         <li><a href="/topology">Topology</a></li>
+        <li><a href="/api">API</a></li>
       </ul>
       <div class="mytabs-container" id="tabs-container">
         <img src="/img/ajax_preloader.gif" width="64" height="64" class="preloader" />

data/views/status.erb

@@ -5,6 +5,7 @@
 <script type="text/javascript">
   $(function() {
 
+	keepUpdating = true;
     var options = {
       xaxis: { mode: 'time' },
             legend: { show: true,
@@ -31,7 +32,9 @@
         success: onDataReceived
       });
 
-      setTimeout(fetchData, 10000);
+	  if(keepUpdating){
+	  	setTimeout(fetchData, 10000);
+	  }
     }
 
     setTimeout(fetchData, 1000);

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: ardtweeno
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - David Kirwan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: mongo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.2
 - !ruby/object:Gem::Dependency
   name: bson_ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.2
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.3
 description: "Ardtweeno - Application Gateway bridges device connected through a serial
@@ -104,6 +104,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG
+- COPYING
+- Gemfile
+- Gemfile.lock
+- INSTALL
+- Procfile
+- README.md
+- Rakefile
 - lib/ardtweeno.rb
 - lib/ardtweeno/api.rb
 - lib/ardtweeno/configreader.rb
@@ -116,23 +124,9 @@ files:
 - lib/ardtweeno/restapi.rb
 - lib/ardtweeno/ringbuffer.rb
 - lib/ardtweeno/serialparser.rb
-- CHANGELOG
-- COPYING
-- Gemfile
-- Gemfile.lock
-- INSTALL
-- Procfile
-- README.md
-- Rakefile
 - public/favicon.ico
 - public/main.css
 - public/main.js
-- views/createpost.erb
-- views/home.erb
-- views/index.erb
-- views/punchcard.erb
-- views/status.erb
-- views/topology.erb
 - resources/conf.yaml
 - resources/nodelist.yaml
 - resources/posts.yaml
@@ -167,6 +161,13 @@ files:
 - test/ringbuffer_test.rb
 - test/serialport_mock.rb
 - test/test_helper.rb
+- views/api.erb
+- views/createpost.erb
+- views/home.erb
+- views/index.erb
+- views/punchcard.erb
+- views/status.erb
+- views/topology.erb
 homepage: http://rubygems.org/gems/ardtweeno
 licenses:
 - CC BY-NC 3.0
@@ -179,20 +180,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Serial Device / IP Network Gateway designed as a PaaS to be run on the Raspberry
   Pi, exposes Sinatra API
 test_files: []
-has_rdoc: