ardtweeno 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de2155a5613ee239c1fd8550efb5a2a03865b408
-  data.tar.gz: f88696b2dd4ef73a36e0b485eaf073a6cce43c6a
+  metadata.gz: 7d157740b9956acd9a32efa343e0f781d4aca11d
+  data.tar.gz: 6d23a441b410510a3212412e0ec9424a4d981911
 SHA512:
-  metadata.gz: 8c0ea2bb9a3cc5e8c7b9b1e429ea2a0cec8479c5b3a4fbdfa6e0bb62826e91428af4710278340fd17b77faef907c1f07daf4e9d97333001baf1f1d4ee131061b
-  data.tar.gz: eb2e25c5eb5525974c2a547373450c4f9ea40b7ce235145b4524f6d664afd9ad510936c465de33024691305b981375d1cf5257def173b8224ae7d8fdc2a47f3a
+  metadata.gz: 4114dd22733d63b18891faaafc33f0668f45a01f6be67bc678306602283202dff74ac63bd5ee7a5bf19e4e4416c78ef0669627d1f655496822c5e33bd614888f
+  data.tar.gz: fcd8e50001b844d2b98a127253c730e5255dfaaa74a762a29d643443750d55687b03ece7904cdaff5a78045f0098b8c9506108d0a43652d2c02b8ca2fe51a588

data/CHANGELOG

@@ -1,3 +1,63 @@
+## 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
+- Refactored Ardtweeno::Dispatcher#status? and broke functionality to Ardtweeno::API#status. Refs #23
+- Implemented tests to cover Ardtweeno::API.buildPunchcard. Fixes #33
+- Added retrieve-zones to the api-examples directory. Refs #27
+- Updated retrieve-status.rb, and added retrieve-config and retrieve-nodes. Refs #28
+- Fleshed out implementation of the api example retrieve-status.rb. Refs #27
+- Renamed api example to fix typo
+- Initial implementation of API Example demonstrating how to retrieve   information about gateway status and load. Refs #27
+- Incorporated the Ardtweeno::RingBuffer into a buffer containing the last 15 minutes worth of status data. - Exposed the buffer through /api/v1/system/status/list it does not require authentication to use.
+- Added Ardtweeno::RingBuffer class to the Ardtweeno gem - Implemented test fixtures for the Ardtweeno::RingBuffer class
+- Resolved an issue in the example-app where the application was not handling an exception correctly when the gateway was unavailable. Refs #26
+- Resolved issue with date ranges during the first 7 days of the month. Punchcard graph generator now correctly calculates this range. Fixes #32
+- Added api-sample-usage directory containing snippets of examples of the API being used. Refs #27
+- Dispatcher#store was incorrectly sending invalid parameters to NodeManager#watched? Now resolved
+- Fixed issue with disabled buttons in the example-app controlpanel view continuing to generate AJAX calls 
+- Navbar now correctly sets the active class to the selected menu link. Refs #26
+- Added unit tests to cover functionality added to the API regarding querying the gateway for watch information
+- API extended to query the gateway for all nodes currently watched, with the details of the watchee 
+- API extended to query the gateway if an individual node is watched. Fixes #31 
+- Example app example-app now queries the API and displays whether or not the nodes are watched in the control panel view. Refs #26
+- Adding a watch now disables the button. Refs #26
+- Hardened the implementation of watch lists - example-app now listens for return codes from the /api/v1/watch/node and behaves accordingly. Refs #26
+- Tidied up the watch notification system slightly - Implemented means to add a node to a watchlist from the example-app control panel page. Refs #26
+- Alterered logging output from fatal to warn for error messages surrounding the MongoDB connector creation
+- Added skeleton interface for adding nodes to a watchlist from the example-app. Refs #26
+- continuing development on the example-app refs #26
+Merge branch 'punchcard-graph-date-range' into dev
+- Ardtweeno punchcard graph v1 now produces date range information which is available from the node URI in the topology graph. Fixes #29
+- Updated main README
+- Fleshing out basic functionality of the example-app 
+- last 5 packets and zone information listed on front page. Refs #26
+- Updated README for the ardtweeno-gem directory
+- Slightly updated install instructions 
+- Noticed issue with Rakefile on system before bundle and dependencies were installed was not exiting gracefully, hopefully fixed this issue now
+- example-app now correctly raises the desired HTML status codes when the Ardtweeno gateway is inaccessible. Refs #26
+- Further refactorisation of the example-app. Refs #26
+- Hardened example-app starting and stopping the gateway, while updating the interface with current status. Refs #26
+- example-app is aware if the Ardtweeno gateway is accessible, and whether the SerialParser is running 
+- example-app now has a basic interface developed to allow the starting of the SerialParser.  Refs #26
+- Refactored example-app view templates into reusable layouts. Refs #26
+- Adding some basic functionality to the example-app. Refs #26
+- Added skeleton example-app which consumes the Ardtweeno API. Refs #26
+- Deleting tech-demo app and starting to build a sample application which consumes the Ardtweeno API. Refs #26
+- Altered the output from the punchcard graph generator to display times in a 24 hour format HH. Fixes #25
+- Modified the Ardtweeno frontend Javascript to stop AJAX requests to the status API when navigating away from the status tab. Fixes #18
+- Added favicon.ico. Fixes #21
+- Added bootstrap styles to the punchcard view
+- Implemented punchcard graph generator accessible when clicking on a node in the topology graph. Refs #6
+- Implemented Topology graph generation internally and available from a tab menu on the gateway frontend. Fixes #5
+- Added skeleton implementation of topology view - Updated index view with a new AJAX menu tab linked to the topology view 
+- Added Raphael.js library which is used in the construction of the topology graph. Refs #5
+- Rakefile target test now cleans the tty0tty and then builds the binary before running tests. Fixes #19
+
+
+## Version 0.3.1
+- Fixed runtime dependency added twice in gemspec. - Fixes #17
+- Release 0.3.0 merged to origin/master
+
 ## Version 0.3.0
 - Incorrectly assert_true against method which does not return true or false - Refs #16
 - System now passes mock confdata into the options hash should the ENV['RACK_ENV'] == 'test' - Fixes #16

data/Gemfile

@@ -26,4 +26,3 @@ gem "serialport", ">= 1.1.0"
 # For the HTTP REST API
 gem "sinatra", ">= 1.3.3"
 gem "thin", ">= 1.5.0"
-gem "rufus-scheduler", ">= 2.0"

data/Gemfile.lock

@@ -1,68 +1,71 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ardtweeno (0.2.5)
+    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)
-      sinatra (>= 1.3.3)
       thin (>= 1.5.0)
       typhoeus (>= 0.6.3)
-    bson (1.9.0)
-    bson_ext (1.9.0)
-      bson (~> 1.9.0)
+    atomic (1.1.14)
+    bson (1.9.2)
+    bson_ext (1.9.2)
+      bson (~> 1.9.2)
     daemons (1.1.9)
     diff-lcs (1.2.4)
-    dotenv (0.8.0)
-    ethon (0.5.12)
+    dotenv (0.9.0)
+    ethon (0.6.1)
       ffi (>= 1.3.0)
       mime-types (~> 1.18)
     eventmachine (1.0.3)
-    ffi (1.9.0)
+    ffi (1.9.1)
     foreman (0.63.0)
       dotenv (>= 0.7)
       thor (>= 0.13.6)
-    json (1.8.0)
-    mime-types (1.23)
-    mini_portile (0.5.0)
-    mongo (1.9.0)
-      bson (~> 1.9.0)
+    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.0)
     rack (1.5.2)
-    rack-protection (1.5.0)
+    rack-protection (1.5.1)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (10.0.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
+    rake (10.1.0)
+    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)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    rufus-scheduler (2.0.19)
-      tzinfo (>= 0.3.23)
-    serialport (1.1.0)
-    sinatra (1.4.3)
+    rspec-mocks (2.14.4)
+    rufus-scheduler (3.0.2)
+      tzinfo
+    serialport (1.2.1)
+    sinatra (1.4.4)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     test-unit (2.5.5)
-    thin (1.5.1)
+    thin (1.6.0)
       daemons (>= 1.0.9)
-      eventmachine (>= 0.12.6)
-      rack (>= 1.0.0)
+      eventmachine (>= 1.0.0)
+      rack (>= 1.5.0)
     thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
     tilt (1.4.1)
-    typhoeus (0.6.3)
-      ethon (~> 0.5.11)
-    tzinfo (1.0.0)
+    typhoeus (0.6.5)
+      ethon (~> 0.6.1)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
@@ -78,7 +81,6 @@ DEPENDENCIES
   rack-test
   rake
   rspec
-  rufus-scheduler (>= 2.0)
   serialport (>= 1.1.0)
   sinatra (>= 1.3.3)
   test-unit

data/INSTALL

@@ -1,12 +1,16 @@
+####################################################################################################
+# @author       David Kirwan https://github.com/davidkirwan/ardtweeno
+# @description  Ardtweeno Gem Installation Instructions
+#
+# @date         02-07-2013
+####################################################################################################
+
 # Ardtweeno MVP - Installation instructions
 The Ardtweeno system can be installed from https://rubygems.org/gems/ardtweeno through the _gem_ utility, or by checking 
-out the codebase from the git repository on https://github.com/davidkirwan/ardtweeno and then building and installing the 
-gem using the _rake install_ command.
-
-System gem dependencies can be installed using the _bundler install_ command from the git repository root directory.
+out the code from the git repository on https://github.com/davidkirwan/ardtweeno. To install change directory to the
+_ardtweeno-gem_ directory then use the _bundle_ utility to install the dependencies. Use the _rake_ utility to build and 
+install the gem.
 
-Tests can be run with the _rake test_ command from the root of the git repository. The tests may require the tty0tty null
-serial modem to have been compiled prior to the tests being executed. This system is bundled with the gem in the following
-directory: _tests/tty0tty/pts_. Enter the directory and compile the library with the _make_.
+Tests can be run with the _rake test_ command from the _ardtweeno-gem_ folder.
 
-To launch the system, simply type _foreman start -f Procfile -p <port>_
+To launch the system, simply type _foreman start -f Procfile -p <port>_ from the _ardtweeno-gem_ folder.

data/README.md

@@ -1,22 +1,25 @@
 # Ardtweeno
-Ardtweeno is a distributed sensor mesh network gateway which bridges devices connected through a serial
-link to those on the internet over IP. The system is modular in nature with the interface to the 
-gateway from the serial link being accessible through a HTTP REST API. This allows many different devices 
-potentially at multiple sites to communicate with the central gateway over the internet or to a serial 
-device connected locally as would be the case with a directly connected XBee Coordinator.
+Ardtweeno is an application gateway which bridges a Serial Device and an Internet Protocol network. 
+The system is designed as a PaaS (platform as a service) for the Raspberry Pi ARM platform. All data 
+received on the serial interface is stored to a MongoDB database if one is available otherwise stores 
+the data in system RAM. The gateway exposes a HTTP REST API for configuration and data manipulation purposes 
+which can be queried in order to build statistics, graphs and other forms of data reporting.
 
-All data is logged to a local database to allow statistical analysis and graphs to be generated for 
-inclusion in hourly/daily reports which can be attached to the systems twitter feed.
-
-The core system is wrapped in a Ruby Sinatra webapp which exposes a HTTP REST API and allows interaction 
+The core system is wrapped in a Ruby Sinatra web application which exposes a HTTP REST API and allows interaction 
 with the gateway over RESTful HTTP calls on the IP network. This has been designed with a Raspberry Pi in 
-mind and has been tested to work correctly on the Raspbian distribution.
+mind and has been tested to work correctly on the Raspbian Wheezy distribution.
+
+The system has been designed to be as modular in nature as possible. It is for this reason the interface to 
+the gateway from the serial link is through a HTTP REST API. This allows many different devices at multiple 
+sites to communicate with the central gateway over a LAN/WAN or the internet, while also retrieving data
+from a serial device connected locally. 
+
+To enable the Ardtweeno gateway to speak to a specific serial device, a SerialParser implementation must be 
+developed. The only requirement from the gateway's point of view is that it must interact with it through the
+HTTP REST API.
 
 In future releases, I hope to make the service interactable so that it may respond to commands received 
-on twitter, or through web hooks and possibly an IRC bot. I plan to develop a fully featured Ruby
-on Rails web application to act as an end user front end to the system and display generated reports and
-graphs from data recieved on the mesh network, while also extending the feature set of the HTTP REST API
-and eventually offer the means to manage and upload updated firmwares to the mesh network nodes.
+on twitter, or through web hooks and possibly an IRC bot.
 
 This is a work in progress! The Wiki associated now contains the instructions for accessing the REST
 API and installation instructions. Any bugs encountered can be raised on the issue tracker.
@@ -24,8 +27,6 @@ API and installation instructions. Any bugs encountered can be raised on the iss
 If you would like to collaborate with me on this project please fork the repository and send any changes
 through a pull request! I gladly welcome constructive input!
 
-
-
 # COPYING / Licence
 This software is released under the Creative Commons Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0)
 for more information see the full details of this licence here: http://creativecommons.org/licenses/by-nc/3.0/
@@ -33,7 +34,6 @@ for more information see the full details of this licence here: http://creativec
 For information regarding commercial use of the Ardtweeno Gateway, please contact the author at:
 davidkirwanirl (_at_) gmail dot com or through Twitter at @kirwan\_david
 
-
 # DISCLAIMER
 All code is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

data/Rakefile

@@ -1,16 +1,18 @@
-require 'rubygems'
+####################################################################################################
+# @author       David Kirwan https://github.com/davidkirwan/ardtweeno
+# @description  Ardtweeno Gem Rakefile
+#
+# @date         02-07-2013
+####################################################################################################
 
 begin
   require 'bundler'
+  Bundler::GemHelper.install_tasks
 rescue Exception => e
-  puts 'bundler gem not found, please install bundler and try again.'
-  exit
+  raise 'bundler gem not found, please install bundler and try again.'
 end
 
 
-
-Bundler::GemHelper.install_tasks
-
 task :default => 'menu'
 
 task :menu do
@@ -22,8 +24,18 @@ MSG
 end
 
 desc "Run the unit testing suite on this gem."
-task :test do
-  
+task :test => :tty0tty do
   require "./test/test_helper.rb"
+end
+
+# Build the tty0tty binary before running tests
+task :tty0tty => :clean_tty0tty do
+  thePath = File.dirname(__FILE__) + "/test/debug/tty0tty-1.1/pts/"
+  sh "gcc -Wall -O2 -D_GNU_SOURCE #{thePath}tty0tty.c -o #{thePath}tty0tty"
+end
 
+# Clean the build before compiling
+task :clean_tty0tty do
+  thePath = File.dirname(__FILE__) + "/test/debug/tty0tty-1.1/pts/"
+  sh "rm -rf #{thePath}tty0tty #{thePath}*.o #{thePath}core"
 end