kismet-gpsxml 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8234d01b84c6db59e1bfb433860be76d4f7d2f8
-  data.tar.gz: e7c8f45dd59b43f05f8dc6ea91b22ef8711a5540
+  metadata.gz: 795d35c2d0f134187651956ebcc02dac33b33f3c
+  data.tar.gz: 79cfb9f7bb72725ed648c586331857f959389018
 SHA512:
-  metadata.gz: 79e2c8ea84b57a3a86552bf263ff7a3bc95449544cd7b6c5ea7f1a62301538bbabf0cea52d8f2fe37b7bb472795155beeef4c2d8c71bd95abaaa7cbf9ad91549
-  data.tar.gz: ebada54bac827dc690e8c523e0bb52c49c3fdd8ee8a63d49524291b8694eb7c920e8af5e95642eedeb25bc7ffd0df28d2b2e2a611265579bcec316e7cda2961b
+  metadata.gz: 979750dcfbcf764301602085d894b86fa5bfe6b1b029a5d228a1cbdc79a939faa62af1dbb3099d9ccc4657059dc79ddb7d2ecad0a6bacaf26b0932800aafdaa1
+  data.tar.gz: 559e322a14e3ac870ac24e17f9043cddcd44757a3cd89dd0687519d96d334168d5101be77b400c735474889a9e7bc209d681b60568f77b43397e1b8e7bf78d00

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/bin/gpsxml-filter-bad-bssid

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'kismet-gpsxml'
+
+unless ARGV[0]
+  $stderr.puts "Usage: #{__FILE__} logfile.gpsxml > output.gpsxml"
+  exit 1
+end
+
+file = ARGV[0]
+
+reader = Kismet::GPSXML::Reader.from_io File.open(file)
+
+count = reader.write_interesting_nodes_to_file STDOUT
+
+$stderr.puts "\n#{count} gps-point written."

data/bin/gpsxml2csv

@@ -5,7 +5,9 @@ require 'kismet-gpsxml'
 DEFAULT_ROUNDING = 4
 
 unless ARGV[0]
-  $stderr.puts "Usage: #{__FILE__} logfile.gpsxml [rounding-level]\nDefault rounding-level is #{DEFAULT_ROUNDING} decimal places."
+  $stderr.puts "Usage: #{__FILE__} logfile.gpsxml [rounding-level]"
+  $stderr.puts "Default rounding-level is #{DEFAULT_ROUNDING} decimal places."
+  $stderr.puts "Set GPSXML_OUTPUT_XML if you want the output to be XML."
   exit 1
 end
 
@@ -15,8 +17,20 @@ rounding = ARGV[1] ? ARGV[1].to_i : DEFAULT_ROUNDING
 reader = Kismet::GPSXML::Reader.from_io File.open(file)
 reader.rounding = rounding
 
-points = reader.points
+bssids = reader.bssids_by_lat_long
 
-points.each do |point,set|
-  puts [point, set.size].join(",")
+unless ENV['GPSXML_OUTPUT_XML']
+  bssids.each do |point,set|
+    puts [point, set.size].join(",")
+  end
+else
+  puts '<points input="%s" >' % File.basename(file)
+  bssids.each do |point,set|
+    puts '<point coord="%s" count="%d">' % [point, set.size]
+    set.each do |bssid|
+      puts '<bssid>%s</bssid>' % bssid
+    end
+    puts '</point>'
+  end
+  puts "</points>"
 end

data/kismet-gpsxml.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: kismet-gpsxml 0.1.1 ruby lib
+# stub: kismet-gpsxml 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "kismet-gpsxml"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.date = "2014-09-14"
   s.description = "A quick solution to model Kismet-generated gpsxml log files and output to CSV"
   s.email = "colin.dean@metamesh.org"
-  s.executables = ["gpsxml2csv"]
+  s.executables = ["gpsxml-filter-bad-bssid", "gpsxml2csv"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "bin/gpsxml-filter-bad-bssid",
     "bin/gpsxml2csv",
     "kismet-gpsxml.gemspec",
     "lib/kismet-gpsxml.rb",

data/lib/kismet-gpsxml.rb

@@ -22,25 +22,73 @@ class Kismet::GPSXML::Reader
     @rounding = 4
   end
 
-  def points
+  def bssids_by_lat_long
     points = {}
     reader.each do |node|
-      next unless interesting_node? node
+      next unless interesting_gpsxml_node? node
       point = point_info node
       lat, lon, bssid = point.values
       key = [lat,lon].join(",")
-      points[key] = Set.new if points[key].nil?
+      points[key] = SortedSet.new if points[key].nil?
       points[key].add bssid
     end
     points
   end
 
+  # Returns the number of interesting_gpsxml_nodes it wrote
+  def write_interesting_nodes_to_file io
+    counter = 0
+    reader.each do |node|
+      unless undesirable_node? node
+        io.write node_to_string(node)
+        counter += 1 if interesting_gpsxml_node? node
+      end
+    end
+    counter
+  end
+
   private
 
-  def interesting_node? node
-    node.name == "gps-point" &&
+  def is_gpspoint? node
     node.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT &&
-    node.attribute("bssid") != "00:00:00:00:00:00"
+    node.name == "gps-point"
+  end
+
+  def interesting_gpsxml_node? node
+    is_gpspoint?(node) &&
+    !undesirable_node?(node)
+  end
+
+  def undesirable_node? node
+    is_gpspoint?(node) &&
+    (
+      node.attribute("bssid") == "00:00:00:00:00:00" ||
+      node.attribute("bssid") == "GP:SD:TR:AC:KL:OG"
+    )
+  end
+
+  def node_to_string node
+    case node.node_type
+    when Nokogiri::XML::Reader::TYPE_ELEMENT
+      open_node_with_attrs(node)
+    when Nokogiri::XML::Reader::TYPE_END_ELEMENT
+      close_node(node)
+    when Nokogiri::XML::Reader::TYPE_DOCUMENT_TYPE
+      node.outer_xml
+    when Nokogiri::XML::Reader::TYPE_TEXT
+      node.value
+    end
+  end
+
+  def close_node node
+    "</"+node.name+">"
+  end
+
+  def open_node_with_attrs node
+    name = node.name
+    attrs = node.attributes.collect{|k,v| '%s="%s"'%[k,v] }.join(' ')
+    closing = node.self_closing? ? '/' : ''
+    "<#{[name,attrs].join(' ')}#{closing}>"
   end
 
   def point_info node

data/test/helper.rb

@@ -34,3 +34,7 @@ require 'kismet-gpsxml'
 def test_xml_location
   File.join [File.dirname(__FILE__), "test.xml"]
 end
+
+def test_write_location extra=""
+  File.join [File.dirname(__FILE__), "test_output#{extra}.xml"]
+end

data/test/test_kismet-gpsxml.rb

@@ -9,7 +9,7 @@ describe Kismet::GPSXML::Reader do
     end
 
     it "responds to points" do
-      subject.public_instance_methods.must_include :points
+      subject.public_instance_methods.must_include :bssids_by_lat_long
       # subject.must_respond_to :points # this doesn't work on classes, just instances
     end
 
@@ -20,24 +20,50 @@ describe Kismet::GPSXML::Reader do
 
   describe "IO operations" do
     let(:text_xml_io) { File.open test_xml_location }
+    let(:text_write_io) { File.open test_write_location, 'w' }
+
 
     before do
       text_xml_io.rewind
       @reader = subject.from_io text_xml_io
     end
 
+    #after do
+     #puts "what %s" % passed?
+      #if passed?
+      #  if File.exists?(text_write_io) || File.exists?(test_write_location)
+      #    File.unlink test_write_location
+      #  end
+      #end
+    #end
+
+
     it "retrieves points" do
-      @reader.points.wont_be_empty
+      @reader.bssids_by_lat_long.wont_be_empty
     end
 
     it "retrieves the expected number of points" do
-      @reader.points.size.must_equal 4 # one should be filtered out
+      @reader.bssids_by_lat_long.size.must_equal 4 # one should be filtered out
     end
 
     it "filters bssid = 00:00:00:00:00:00" do
-      points_with_bad_bssid = @reader.points.select{|position,bssid| bssid == '00:00:00:00:00:00'}
+      points_with_bad_bssid = @reader.bssids_by_lat_long.select{|position,bssid| bssid == '00:00:00:00:00:00'}
       points_with_bad_bssid.must_be_empty
     end
 
+    it "writes the expected number of points" do
+      count = @reader.write_interesting_nodes_to_file text_write_io
+      text_write_io.close
+      count.must_equal 4
+    end
+
+    it "writes the expected number of points, then doesn't filter more" do
+      count1 = @reader.write_interesting_nodes_to_file text_write_io
+      text_write_io.close
+      @reader2 = subject.from_io File.open(test_write_location)
+      count2 = @reader2.write_interesting_nodes_to_file File.open(test_write_location("-second"), 'w')
+
+      count1.must_equal count2
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kismet-gpsxml
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Colin Dean
@@ -98,6 +98,7 @@ description: A quick solution to model Kismet-generated gpsxml log files and out
   to CSV
 email: colin.dean@metamesh.org
 executables:
+- gpsxml-filter-bad-bssid
 - gpsxml2csv
 extensions: []
 extra_rdoc_files:
@@ -111,6 +112,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/gpsxml-filter-bad-bssid
 - bin/gpsxml2csv
 - kismet-gpsxml.gemspec
 - lib/kismet-gpsxml.rb