traffic_control 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in traffic_control.gemspec
+gemspec

data/README.textile

@@ -0,0 +1,43 @@
+h1. Traffic Control
+
+Helps you monitor your Airport Extreme traffic.
+
+h2. Features
+
+Spits out some basic snmp info including:
+* Number of wireless clients
+* Number of dhcp clients
+* Uptime
+
+Get network client information including:
+* Mac Address
+* IP Address
+* Time associated
+* Wireless strength
+
+h2. Example
+
+bc.. airport = TrafficControl::Airport.new "airport.local", "public"
+
+puts "There are around #{airport.settings["wirelessNumber"]} folk#{"s" unless airport.settings["wirelessNumber"] == 1} on your wifi"
+puts airport.clients.inspect
+
+airport.clients.each do |client, attributes|
+  puts "Details for client with MAC address #{client}:"
+  attributes.each do |name, details|
+    puts "#{name}:   #{details}"
+  end
+  puts "--\n"
+end
+
+
+h2. Requirements
+
+* SNMPwalk
+* Possibly the Airport MIB (see below)
+
+h3. Installing the Airport MIB
+
+bc. cd /usr/share/snmp/mibs
+sudo curl -L -O http://supportdownload.apple.com/download.info.apple.com/Apple_Support_Area/Apple_Software_Updates/Mac_OS_X/downloads/061-0652.20030619.5ibjt/airport-extreme.mib
+cd ~

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/traffic_control/airport.rb

@@ -0,0 +1,47 @@
+# Inspired by Andre LaBranche's work at http://dreness.com/bits/tech/airport
+# Send him love at dre at mac dot com
+
+module TrafficControl
+  class Airport
+    attr_accessor :host, :settings, :clients
+
+    def initialize(host, community = "public")
+      @host = host
+      @community = community
+      @settings = {}
+      @clients = []
+    end
+    
+    def load_data!
+      client_data = {}
+      
+      snmp_results = snmp_parser(snmp_output(@host, @community))
+      snmp_results.each do |setting|
+        if setting[1] == "0"
+          self.settings[setting[0]] = setting[2]
+        else
+          client_data[setting[1]] ||= []
+          client_data[setting.delete(setting[1])] << setting
+        end      
+      end
+
+      client_data.each { |key, value| self.clients << TrafficControl::Client.new(Hash[value])  }
+    end
+
+    def snmp_output(host, community)
+      snmpcmd = "#{SNMPBIN} -m AIRPORT-BASESTATION-3-MIB -Osq -v 2c "
+      snmpcmd += "-c \"#{community}\" \"#{host}\" "
+      snmpcmd += "SNMPv2-SMI::enterprises.apple.airport"
+      
+      `#{snmpcmd}`
+    end
+    
+    def snmp_parser(output)
+      output.
+        chomp
+        .split("\n")
+        .collect{ |v| v.split(/\.(.+)/).collect{ |t| t.split(" ") }.flatten }
+    end
+    
+  end
+end

data/lib/traffic_control/client.rb

@@ -0,0 +1,10 @@
+module TrafficControl
+  class Client
+    attr_accessor :mac, :ip, :client_id, :lease_time
+    
+    def initialize(attributes)
+      @mac, @ip, @client_id, @lease_time = attributes["dhcpPhysAddress"], attributes["dhcpIpAddress"], attributes["dhcpClientID"], attributes["dhcpLeaseTime"]
+    end
+    
+  end
+end

data/lib/traffic_control/version.rb

@@ -0,0 +1,3 @@
+module TrafficControl
+  VERSION = "0.0.1"
+end

data/lib/traffic_control.rb

@@ -0,0 +1,8 @@
+require "traffic_control/version"
+require "traffic_control/airport"
+require "traffic_control/client"
+
+module TrafficControl
+  SNMPBIN = File.dirname(__FILE__) + "../bin/snmpwalk"
+  SNMPBIN = "/usr/bin/snmpwalk"
+end

data/spec/models/airport_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+describe TrafficControl::Airport do
+  subject { TrafficControl::Airport.new "airport.local" }
+  
+  context "loading data" do
+  
+    it "should grab teh snmpwalk results and parse them, and create a bunch of clients" do
+      subject.stub! :snmp_parser => [["foo", "name", "bar"]], :snmp_output => nil
+      subject.load_data!
+    
+      subject.clients.should be_an(Array)
+      subject.clients.first.should be_a_kind_of TrafficControl::Client
+    end
+  
+    it "should parse the results of an snmpwalk output" do
+      mock_output = "foo.0 bar
+        foo.0 
+        foo.\"bar\" \"bar\""
+        
+      subject.snmp_parser(mock_output).should == [
+        ["foo", "0", "bar"],
+        ["foo", "0"],
+        ["foo", "\"bar\"", "\"bar\""],
+      ]
+    end
+  end
+end

data/spec/models/client_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe TrafficControl::Client do
+
+  it "should create a client given a hash of data" do
+    client = TrafficControl::Client.new({
+      "dhcpPhysAddress" => "foo",
+      "dhcpIpAddress" => "bar",
+      "dhcpClientID" => "\"\"",
+      "dhcpLeaseTime" => "1961"
+    })
+
+    client.mac.should == "foo"
+    client.ip.should == "bar"
+    client.client_id.should == "\"\""
+    client.lease_time.should == "1961"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift '../lib'
+
+require "rspec"
+require "traffic_control"

data/traffic_control.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "traffic_control/version"
+
+Gem::Specification.new do |s|
+  s.name        = "traffic_control"
+  s.version     = TrafficControl::VERSION
+  s.authors     = ["Nathan S"]
+  s.email       = ["nathan@inspire9.com"]
+  s.homepage    = "http://github.com/nathanscott/traffic_control"
+  s.summary     = "Helps you monitor your Airport Extreme traffic."
+  s.description = "It really helps you monitor your Airport Extreme traffic."
+
+  s.rubyforge_project = "traffic_control"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: traffic_control
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nathan S
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It really helps you monitor your Airport Extreme traffic.
+email:
+- nathan@inspire9.com
+executables:
+- snmpwalk
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.textile
+- Rakefile
+- bin/snmpwalk
+- lib/traffic_control.rb
+- lib/traffic_control/airport.rb
+- lib/traffic_control/client.rb
+- lib/traffic_control/version.rb
+- spec/models/airport_spec.rb
+- spec/models/client_spec.rb
+- spec/spec_helper.rb
+- traffic_control.gemspec
+homepage: http://github.com/nathanscott/traffic_control
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3384502027841592073
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3384502027841592073
+requirements: []
+rubyforge_project: traffic_control
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Helps you monitor your Airport Extreme traffic.
+test_files:
+- spec/models/airport_spec.rb
+- spec/models/client_spec.rb
+- spec/spec_helper.rb