ardtweeno 0.0.2 → 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63968507920512729a01dd5e5952ce70b427bf99
+  data.tar.gz: 00a74be7f57bded6c488096b3c49bc3b4ee8eb82
+SHA512:
+  metadata.gz: b781f4581fb7f475cfbb219f53ae547a8e618115c6e01bf922396d34143fdbfbc7955e9f3a0f6c3a9af42df5dc5e55f4eecb6855a854a7639ce24a474cc6a6d9
+  data.tar.gz: 54ecc4d3c96a512f42d04c89e92a594b87f8b337ca089781b9fe7390972d151080cb26187b1853c54f8f3a35776b1bcc61c949099026b17bfa307387cd0444ec

data/CHANGELOG

@@ -1,6 +1,184 @@
+## Version 0.2.5 Engineering Release 2 RC5
+- Updated gemspec in preparation for release of ER 2
+- Updated REST API to be more robust when printing news posts
+- Latest documentation build
+- Added documentation supporting the newly implemented watch list and push notifications 
+- Added EagleCAD schematics for Ardtweeno Nodes
+- Added latest project documentation and image assets
+
+## Version 0.2.4 Engineering Release 2 RC4
+- Removed debugging statements from REST API Sinatra app
+- Updated Gemfile with a new dependency Typhoeus 
+- Implemented push notification system 
+- Implemented testing scheme for the push notifications 
+- Implemented system for placing an Ardtweeno::Node in a watchlist 
+- Implemented testing scheme for watchlist 
+- Implemented test script to add a Node to a watchlist
+- Removed debug statements from rescue blocks
+
+## Version 0.2.3 Engineering Release 2 RC3
+- Slightly edited output from topology generator 
+- Removed some debug statements from punchcard generator code
+- Added image assets for documentation 
+- Updated project documentation to the latest versions
+- Removing debug statements
+- Implemented node punchcard graph generator
+- CHANGELOG updated to contain 0.2.2 featureset
+
+## Version 0.2.2 Engineering Release 2 RC2
+- Implemented tests to cover the post creation system
+- Implemented manual post update system 
+- Added code highlighting to code blocks in posts
+- Added skeleton page for manually adding posts 
+- Implemented skeleton API functionality for adding posts 
+- Updated CSS
+
+## Version 0.2.1 Engineering Release 2 RC2
+- Latest codebase for the Ardtweeno project
+- Updated Arduino FIO firmware sketch for node1 to light led on detection of movement
+- Added new firmware for node1 movement sensor platform
+- Resolved issue with params not being passed correctly between methods
+- Implemented multiple zone statistics graphs being produced by the tech-demo
+- Added skeleton framework for handling contact form submits
+- Implemented statistics graph displaying on front of tech-demo - Removed a lot of unneeded javascript
+- Updated node sensor graph view to now correctly display the name of the node being graphed - Added link to return to the previous view from the node sensor graph view - Added a number of javascript libraries which will possibly be used later
+- Sensor graphs produced through /data/:node now use the last 60 packet data
+- Updated the node.js serialparser script to buffer fragmented data input better
+- Updated Arduino FIO firmware
+
+## Version 0.2.0 Engineering Release 2 RC1
+- Updated tech demo to return 503 Service Unavailable should the gateway be unavailable
+- Deleted nodejs compiled modules 
+- Updated Ardtweeno RESTAPI to the latest codebase 
+- Updated project documentation sections: API Spec, Iteration Plan and Project Backlog to the latest versions 
+- Built latest version of the documentation 
+- Fixed issue with the Twitter section of the tech demo being unaccessible through the sidebar menu
+- Implemented graph view 
+- Implemented tech demo graphing code
+- Fleshed out node graphing skeleton code
+- Skeleton implementation of node graphs
+- Refactored tech-demo packets api call
+- Altered the api calls to the packets interface to retrieve the last 5 packets in the tech-demo
+- Updated project sections bibliography, iteration plan and backlog
+- Implemented dynamic generation of topology graph being loaded into the topology section of the tech-demo app 
+- Deleted proof of concept topology generator script
+
+## Version 0.1.13 Minimum Viable Product Engineering Release 1 RC13
+- Updated README.md to include screenshot of the Topology Generator
+- Implemented dynamic topology graph generator using data pulled from the Ardtweeno API
+- Skeleton implementation of /gateway/topology in the tech-demo application
+- Updated project documentation section iteration plan to latest version
+- Updated tech demo with sample Raphael.js code for constructing a network topology graph
+- Implemented tests for /api/:version/system/status API calls
+- Implemented query for nodes - Implemented query for packets - Modified layout of control panel
+
+## Version 0.1.12 Minimum Viable Product Engineering Release 1 RC12
+- Updated sample Arduino FIO sketch
+- Implemented simple query for the zones api
+- Updated documentation sections api specification and iteration plan
+- Implemented gateway control panel system
+- Implemented addition to the rest api to include system status
+- Implemented basic ajax calls in the gateway control panel
+- Extending tech demo with control panel interface to control the gateway
+- Added CSS styling for URLS in the links section of the Ardtweeno Tech Demo
+- Updated tech-demo style to ensure forkme ribbon is in the correct place
+- Updated image assets used in tech-demo
+- Implemented Skeleton Tech Demo web app for the Ardtweeno system
+
+## Version 0.1.11 Minimum Viable Product Engineering Release 1 RC11
+- Implemented basic system for writing packets to the MongoDB Database
+- Implemented skeleton code to handle the database connection and recover from connection errors
+- Fixed bug with sorting of the packets being returned by the retrieve_packets REST API function
+- Added latest information on API specification documentation
+- Updated documentation to latest revisions
+
+
+## Version 0.1.10 Minimum Viable Product Engineering Release 1 RC10
+- Added API implementation and tests for zones 
+- Added /api/v1/zones and /api/v1/zones/:zonename
+- Skeleton implementation of zones
+- Implemented /api/v1/system/config interface 
+- Implemented tests for the system/config hook 
+- Updated layout of the conf.yaml file to incorporate future zones data
+- Implemented testing suite for nodes filtering parameters
+- Implemented Ardtweeno::API functions to handle RESTAPI calls to filter nodes data
+
+
+## Version 0.1.9 Minimum Viable Product Engineering Release 1 RC9
+- Implemented /api/v1/nodes REST API target 
+- Implemented Ardtweeno::API functions to handle nodes lookup 
+- Implemented test suite to test newly added API nodes functions 
+- Resolved previously unknown bug with newly constructed nodes not being passed initial parameters correctly
+- Updated project documentation to latest revisions
+
+
+## Version 0.1.8 Minimum Viable Product Engineering Release 1 RC8
+- Implemented REST API tests for date, hour and minute API calls
+- Implemented tests for the seqNo API calls
+- Implemented API handling of seqno, date, minute and hour 
+- Implemented internal testing of seqno, date, minute and hour API features
+- Updated CHANGELOG file permissions to 644
+- Added latest version of the section-iteration-plan documentation file
+- Removed resources/rest-api from the repo as it has now been successfully integrated elsewhere in the system
+
+
+## Version 0.1.7 Minimum Viable Product Engineering Release 1 RC7
+- Refactored RESTAPI system to ensure it can be executed directly from the gem root directory using the foreman Procfile launcher
+- Updated Ardtweeno gemspec
+- Updated image assets - Updated section-iteration-plan to latest revision
+
+
+## Version 0.1.6 Minimum Viable Product Engineering Release 1 RC6
+- Added rack-test, test-unit and removed simplecov gem requirements from Gemfile 
+- Added empty bin folder to fix issues with gem build failing on Mac Ruby 1.8.7
+- Updated require statements in the serialparser.rb
+- Updated gemspec to remove the bin folder
+- Added timing measurement functions to the API lookup function
+- Updated documentation section-iteration-plan and section-api-specification
+- Updated RESTAPI to ensure the rufus-scheduler continues to operate after being moved over to the foreman system
+- Updated REST API routes to best practices, API calls are now formatted like: /api/{version}/{target} 
+- Updated the node.js serialparser implementation to work with the new REST API routes 
+- Fixed issues with the REST API tests failing
+- Updated presentation-assets - Updated section-iteration-plan documentation to latest revision
+- Updated INSTALL instructions to the latest revision
+
+
+## Version 0.1.5 Minimum Viable Product Engineering Release 1 RC5
+- Added bundler configuration file for the REST API 
+- Added foreman configuration file for launching the REST API 
+- Renamed resources/rest-api/ardtweeno.rb -> web.rb to allow execution on the heroku.com paas
+- Updated image assets being used in project poster 
+- Updated documentation section-iteration-plan to latest revision
+- Updated ardtweeno rest-api app scheduling to run serialisation every hour
+
+## Version 0.1.4 Minimum Viable Product Engineering Release 1 RC4
+- Implemented MVP functionality to write packets to ~/.ardtweeno/packetdb.yaml 
+- Updated Gemfile dependency list to latest revision
+
+## Version 0.1.3 Minimum Viable Product Engineering Release 1 RC3
+- Updated Rakefile with exception handling to fail gracefully should a system not have bundler installed
+- Added exception handling to packet storage calls
+- Implemented the basic function structure for flushing packet data to disk - Updated dependencies to include rufus-scheduler
+- Updated CHANGELOG to the latest revision
+
+## Version 0.1.2 Minimum Viable Product Engineering Release 1 RC2
+- Added section-mvp-installation 
+- Updated section-minimum-system-requirements 
+- Updated section-project-deliverables
+- Switched method of handling dependencies to Bundler, added support files to enable change 
+- Updated INSTALL instructions
+- Updated section-iteration-plan and section-api-specification to latest revisions
+
+## Version 0.1.1 Minimum Viable Product Engineering Release 1 RC1
+- Fixed issue with resultset transformation prioritisation, resultset sorting now performed last thing as intended
+- Updated README.md
+
+## Version 0.1.0
+- MVP featureset implemented
+
 ## Version 0.0.2
 - Fixed typo in gemspec description
 
 ## Version 0.0.1
-- Placeholder framework in place 
+- Placeholder gem in place
 

data/COPYING

@@ -1,6 +1,7 @@
-This software is released under the creative commons attribution-sharealike 3.0 unported (cc by-sa 3.0) licence.
-for more information see: http://creativecommons.org/licenses/by-sa/3.0/
+This software is released under the Attribution-NonCommercial 3.0 Unported (CC BY-NC 3.0) licence.
+for more information see: http://creativecommons.org/licenses/by-nc/3.0/
 
 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.
+FITNESS FOR A PARTICULAR PURPOSE.
+

data/Gemfile

@@ -0,0 +1,29 @@
+source "http://rubygems.org"
+
+# The Ardtweeno Application Gateway
+gem "ardtweeno"
+
+# Utility
+gem "rake"
+gem "nokogiri"
+gem "rack", ">= 1.1"
+gem "foreman"
+gem "json"
+gem "typhoeus", ">= 0.6.3"
+
+# For the Database
+gem "mongo", ">= 1.6.2"
+gem "bson_ext", ">= 1.6.2"
+
+# For Testing
+gem "rack-test"
+gem "test-unit"
+gem "rspec", :require => "spec"
+
+# For the SerialParser 
+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

@@ -0,0 +1,76 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ardtweeno (0.2.1)
+      bundler (>= 1.2.3)
+    bson (1.8.5)
+    bson_ext (1.8.5)
+      bson (~> 1.8.5)
+    daemons (1.1.9)
+    diff-lcs (1.2.4)
+    dotenv (0.7.0)
+    ethon (0.5.12)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
+    eventmachine (1.0.3)
+    ffi (1.8.1)
+    foreman (0.63.0)
+      dotenv (>= 0.7)
+      thor (>= 0.13.6)
+    json (1.7.7)
+    mime-types (1.23)
+    mongo (1.8.5)
+      bson (~> 1.8.5)
+    nokogiri (1.5.9)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      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)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rufus-scheduler (2.0.18)
+      tzinfo (>= 0.3.23)
+    serialport (1.1.0)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    test-unit (2.5.4)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.18.1)
+    tilt (1.3.7)
+    typhoeus (0.6.3)
+      ethon (~> 0.5.11)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ardtweeno
+  bson_ext (>= 1.6.2)
+  foreman
+  json
+  mongo (>= 1.6.2)
+  nokogiri
+  rack (>= 1.1)
+  rack-test
+  rake
+  rspec
+  rufus-scheduler (>= 2.0)
+  serialport (>= 1.1.0)
+  sinatra (>= 1.3.3)
+  test-unit
+  thin (>= 1.5.0)
+  typhoeus (>= 0.6.3)

data/INSTALL

@@ -0,0 +1,12 @@
+# 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.
+
+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_.
+
+To launch the system, simply type _foreman start -f Procfile -p <port>_

data/Procfile

@@ -0,0 +1 @@
+web:	bundle exec thin start -p $PORT

data/README.md

@@ -1,10 +1,34 @@
 # Ardtweeno
-Ardtweeno is a simple parser system for gathering data from a serial interface which can then be used to generate graphs, statistics
-and reports from this data suitible for sharing over HTTP through a Ruby on Rails gateway application.
+Ardtweeno is a distributed sensor mesh network gateway which bridges devices connected through an XBee Mesh
+Network link to those on the internet over IP. The system is modular in nature with the interface to the 
+gateway from the mesh network accessible through a HTTP REST API. This allows many different mesh networks 
+potentially at multiple sites to communicate with the centeral gateway over the internet or to a serial 
+device connected locally as would be the case with a directly connected XBee Coordinator.
+
+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 webbapp 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.
+
+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.
+
+This is a work in progress! The Wiki associated will soon contain the instructions for accessing the REST
+API and installation instructions shortly. Any bugs encountered can be raised on the issue tracker.
+
+
 
 # COPYING / Licence
 This software is released under the creative commons attribution-sharealike 3.0 unported (cc by-sa 3.0) licence.
 for more information see: http://creativecommons.org/licenses/by-sa/3.0/
+For information regarding commercial use of the Ardtweeno Gateway, please contact the author at:
+davidkirwanirl (_at_) gmail dot com
+
 
 # DISCLAIMER
 All code is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 

data/Rakefile

@@ -1,4 +1,14 @@
-require 'bundler'
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue Exception => e
+  puts 'bundler gem not found, please install bundler and try again.'
+  exit
+end
+
+
+
 Bundler::GemHelper.install_tasks
 
 task :default => 'menu'
@@ -7,16 +17,13 @@ task :menu do
   puts welcomeMsg = <<-MSG
 rake build    # Build ardtweeno-x.x.x.gem into the pkg directory
 rake install  # Build and install ardtweeno-x.x.x.gem into system gems
-rake release  # Create tag vx.x.x and build and push ardtweeno-x.x.x.gem to http://rubygems.org/
 rake test     # Run the unit testing suite on this gem.
 MSG
 end
 
 desc "Run the unit testing suite on this gem."
 task :test do
-  $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/lib')
-  require 'ardtweeno.rb'
-  Dir.glob("./test/*_test.rb").each do |file|
-   require file
-  end
+  
+  require "./test/test_helper.rb"
+
 end