spectacular 1.0.0

data/.autotest

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib          = 'minitest/autorun'
+  at.find_directories = ARGV unless ARGV.empty?
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2012-03-25
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,15 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/spectacular
+lib/spectacular.rb
+lib/spectacular/device.rb
+lib/spectacular/history.rb
+lib/spectacular/index.html
+lib/spectacular/server.rb
+lib/spectacular/sized_list.rb
+test/helper.rb
+test/test_history.rb
+test/test_sized_list.rb

data/README.rdoc

@@ -0,0 +1,52 @@
+= spectacular
+
+* http://github.com/tenderlove/spectacular
+
+== DESCRIPTION:
+
+Spectacular is an SNMP client that displays traffic information in the
+browser.
+
+== FEATURES/PROBLEMS:
+
+* It updates every second
+* I don't know what the units are on the Y axis yet
+* X axis is time
+
+== SYNOPSIS:
+
+  $ gem install spectacular
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Aaron Patterson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :minitest
+Hoe.plugin :gemspec # `gem install hoe-gemspec`
+Hoe.plugin :git     # `gem install hoe-git`
+
+Hoe.spec 'spectacular' do
+  developer('Aaron Patterson', 'aaron@tenderlovemaking.com')
+  self.readme_file   = 'README.rdoc'
+  self.history_file  = 'CHANGELOG.rdoc'
+  self.extra_rdoc_files  = FileList['*.rdoc']
+  self.extra_deps << ['snmp', '~> 1.1.0']
+end
+
+# vim: syntax=ruby

data/bin/spectacular

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'spectacular/server'
+
+server = WEBrick::HTTPServer.new :Port => 8080, :OutputBufferSize => 256
+
+server.mount '/',            Spectacular::Server::Index
+server.mount '/events.json', Spectacular::Server::Events
+
+trap('INT') { server.shutdown }
+server.start

data/lib/spectacular.rb

@@ -0,0 +1,7 @@
+require 'spectacular/sized_list'
+require 'spectacular/history'
+require 'spectacular/device'
+
+module Spectacular
+  VERSION = '1.0.0'
+end

data/lib/spectacular/device.rb

@@ -0,0 +1,69 @@
+require 'spectacular/history'
+require 'snmp'
+require 'json'
+
+module Spectacular
+  class Device
+    attr_reader :host, :history
+
+    def initialize host, history = 10
+      @host    = host
+      @history = new_history history
+    end
+
+    def columns
+      ["ifIndex", "ifDescr", "ifInOctets", "ifOutOctets"]
+    end
+
+    def interfaces
+      manager = snmp_manager host
+      interfaces = []
+      manager.walk(['ifDescr']) do |row|
+        interfaces << row.first.value.to_s
+      end
+      interfaces
+    ensure
+      manager.close
+    end
+
+    def monitor interval = 1
+      manager = snmp_manager host
+
+      loop do
+        manager.walk(columns) do |row|
+          key = row[1].value.to_s
+
+          result = diff history.last(key), row
+
+          yield result unless result.empty?
+
+          history.add key, row.map(&:dup)
+        end
+        sleep interval
+      end
+
+    ensure
+      manager.close
+    end
+
+    private
+    def snmp_manager host
+      SNMP::Manager.new :Host => host
+    end
+
+    Klass = Struct.new :name, :value # :nodoc:
+
+    def diff from, to
+      return [] unless from && to
+
+      to.first(2) + from.zip(to).last(2).map { |left, right|
+        diff = right.value.to_i - left.value.to_i
+        Klass.new left.name, diff
+      }
+    end
+
+    def new_history size
+      History.new size
+    end
+  end
+end

data/lib/spectacular/history.rb

@@ -0,0 +1,32 @@
+require 'spectacular/sized_list'
+
+module Spectacular
+  class History
+    def initialize size = 10
+      @groups = Hash.new { |h,k|
+        h[k] = new_list size
+      }
+    end
+
+    def add k, v
+      @groups[k] << v
+    end
+
+    def last k, len = nil
+      if len
+        @groups[k].last len
+      else
+        @groups[k].last
+      end
+    end
+
+    def [] k
+      @groups[k].to_a
+    end
+
+    private
+    def new_list size
+      SizedList.new size
+    end
+  end
+end

data/lib/spectacular/index.html

@@ -0,0 +1,68 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <script type="text/javascript" src="https://www.google.com/jsapi"></script>
+
+    <script>
+      function options(interface) {
+        return { 'title': interface,
+          'width':1000,
+          'height':300,
+          'hAxis': { 'title': 'Time' },
+          'vAxis': { 'title': 'Data' } };
+      }
+
+      function listen() {
+        var charts     = document.getElementById('interfaces');
+        var dataTables = {}
+        var gCharts    = {}
+
+        if (!!window.EventSource) {
+          var source = new EventSource('/events.json');
+          source.addEventListener('interfaces', function(e) {
+            var data = JSON.parse(e.data);
+            data.forEach(function(name) {
+              var chart = document.createElement('div');
+              chart.setAttribute('id', name);
+              charts.appendChild(chart);
+
+              var gchart = new google.visualization.LineChart(chart);
+              var table = new google.visualization.DataTable();
+              table.addColumn('string', 'time');
+              table.addColumn('number', 'input');
+              table.addColumn('number', 'output');
+
+              gCharts[name]    = gchart;
+              dataTables[name] = table;
+            });
+          }, false);
+
+          source.addEventListener('update', function(e) {
+            var data  = JSON.parse(e.data);
+            var chart = gCharts[data.interface];
+            var table = dataTables[data.interface];
+
+            if(chart && table) {
+              var count = table.getNumberOfRows();
+              table.addRow(['', data.in_delta, data.out_delta]);
+              if(count > 60) {
+                table.removeRow(0);
+              }
+              chart.draw(table, options(data.interface));
+            }
+          }, false);
+          } else {
+          alert('your browser is not supported');
+        }
+      }
+
+      google.load('visualization', '1.0', {'packages':['corechart']});
+      google.load("jquery", "1.7.1");
+      google.setOnLoadCallback(listen);
+    </script>
+  </head>
+  <body>
+    <div id="interfaces">
+    </div>
+  </body>
+</html>

data/lib/spectacular/server.rb

@@ -0,0 +1,53 @@
+require 'webrick'
+require 'spectacular'
+require 'json'
+
+module Spectacular
+  module Server
+    dir = File.dirname __FILE__
+    INDEX = File.read File.expand_path File.join dir, 'index.html'
+
+    class Index < WEBrick::HTTPServlet::AbstractServlet
+      def do_GET request, response
+        response.status = 200
+        response['Content-Type'] = 'text/html'
+        response.body = INDEX
+      end
+    end
+
+    class Events < WEBrick::HTTPServlet::AbstractServlet
+      def do_GET request, response
+        response.status = 200
+        response['Content-Type'] = 'text/event-stream'
+        rd, rw = IO.pipe
+
+        response.body = rd
+
+        Thread.new {
+          begin
+            ip = ENV['ROUTER'] || '10.0.1.1'
+            dev = Spectacular::Device.new ip
+
+            rw.write "event: interfaces\n"
+            rw.write "data: #{JSON.dump(dev.interfaces)}\n\n"
+            rw.flush
+
+            dev.monitor do |row|
+              data = {
+                :interface => row[1].value.to_s,
+                :in_delta  => row[2].value,
+                :out_delta => row[3].value,
+              }
+
+              rw.write "event: update\n"
+              rw.write "data: #{JSON.dump(data)}\n\n"
+              rw.flush
+            end
+          ensure
+            rw.close
+          end
+        }
+      end
+    end
+  end
+end

data/lib/spectacular/sized_list.rb

@@ -0,0 +1,32 @@
+module Spectacular
+  class SizedList
+    include Enumerable
+
+    def initialize size
+      @size = size
+      @list = []
+    end
+
+    def << item
+      x = @list << item
+      while @list.size > @size
+        @list.shift
+      end
+      x
+    end
+
+    def each &block
+      @list.each(&block)
+    end
+
+    def last n = nil
+      return @list.last unless n
+
+      @list.last n
+    end
+
+    def length
+      @list.length
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/autorun'
+require 'spectacular'
+
+module Spectacular
+  class TestCase < MiniTest::Unit::TestCase
+  end
+end

data/test/test_history.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+module Spectacular
+  class TestHistory < TestCase
+    def test_add
+      history = History.new
+      history.add "foo", "bar"
+      assert_equal "bar", history.last("foo")
+    end
+
+    def test_last_2
+      history = History.new
+      history.add "foo", "bar"
+      history.add "foo", "baz"
+      assert_equal ["bar", "baz"], history.last("foo", 2)
+    end
+
+    def test_all
+      history = History.new
+      history.add "foo", "bar"
+      history.add "foo", "baz"
+      assert_equal ['bar', 'baz'], history['foo']
+    end
+
+    def test_key_miss
+      history = History.new
+      history.add "foo", "bar"
+      history.add "foo", "baz"
+      assert_equal [], history['bar']
+      assert_nil history.last 'bar'
+      assert_equal [], history.last('bar', 2)
+    end
+  end
+end

data/test/test_sized_list.rb

@@ -0,0 +1,34 @@
+require 'helper'
+
+module Spectacular
+  class TestSizedList < TestCase
+    def test_first
+      list = SizedList.new 10
+      11.times { |i| list << i }
+      assert_equal 1, list.first
+    end
+
+    def test_last
+      list = SizedList.new 10
+      11.times { |i| list << i }
+      assert_equal 10, list.last
+    end
+
+    def test_length
+      list = SizedList.new 10
+      assert_equal 0, list.length
+      10.times { |i|
+        list << i
+        assert_equal(i + 1, list.length)
+      }
+      list << Object.new
+      assert_equal 10, list.length
+    end
+
+    def test_last_param
+      list = SizedList.new 10
+      10.times { |i| list << i }
+      assert_equal [7, 8, 9], list.last(3)
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: spectacular
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: snmp
+  requirement: &70259861651520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70259861651520
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70259861642360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: *70259861642360
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70259861641620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: *70259861641620
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &70259861640980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: *70259861640980
+description: ! 'Spectacular is an SNMP client that displays traffic information in
+  the
+
+  browser.'
+email:
+- aaron@tenderlovemaking.com
+executables:
+- spectacular
+extensions: []
+extra_rdoc_files:
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files:
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/spectacular
+- lib/spectacular.rb
+- lib/spectacular/device.rb
+- lib/spectacular/history.rb
+- lib/spectacular/index.html
+- lib/spectacular/server.rb
+- lib/spectacular/sized_list.rb
+- test/helper.rb
+- test/test_history.rb
+- test/test_sized_list.rb
+- .gemtest
+homepage: http://github.com/tenderlove/spectacular
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: spectacular
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Spectacular is an SNMP client that displays traffic information in the browser.
+test_files:
+- test/test_history.rb
+- test/test_sized_list.rb