kismet-gpsxml 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78680bef3cc7620904daf46d7631c56d2cb54edf
-  data.tar.gz: 612f54b0375cfbf43dfa19499f356f7c2b58a344
+  metadata.gz: 082909a1892fe7eb5624537ecf61a7a6ffbc5447
+  data.tar.gz: 6a49b8666fb2c6e551f449c68790321095256c2b
 SHA512:
-  metadata.gz: 2a0d063ddaee9b21273c24b4bc42324909fa61faccc73dc6f2f751529f24841346297ead614c53251c6dab6e66330b1e5fe2a3841f33233455825d2b42f659c2
-  data.tar.gz: db04db1be38f2d66b65923f5f4704539534d7766fe638d472985f5fd8f3fe871070e6c2f7c15d558cdc599b9ebb317dc865db9a138f41e9ce7b8f0855919ab43
+  metadata.gz: 8813e43976f20d93e3174a10e666763ca7f9fd76cb77421b5943ae3911e0997e925eed742dcc93035bd2ca48716212c3b7fc81f5604d591a6f3743615938f1f6
+  data.tar.gz: f11f2600b63db3db5bb7ca7abc78efd1384e54a330f9bca28175c05f45f31a58baef1293781d96681793a332eff82eee0dad75a5150b737aaa2a4981b7577bad

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.2.10

data/Gemfile

@@ -3,9 +3,9 @@ source "http://rubygems.org"
 gem "nokogiri", "~> 1.6.3.0"
 
 group :development do
-  gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"
   gem "jeweler", "~> 2.0.1"
   gem "simplecov", ">= 0"
+  gem "minitest-spec-expect", "~> 2.0.0"
 end

data/{README.rdoc → README.md}

@@ -1,4 +1,7 @@
-= kismet-gpsxml
+kismet-gpsxml
+=============
+
+[![Travis-CI status](http://img.shields.io/travis/pittmesh/kismet-gpsxml.svg)](https://travis-ci.org/pittmesh/kismet-gpsxml/)
 
 This gem enables users to model Kismet's gpsxml log format in Ruby.
 
@@ -6,7 +9,22 @@ It provides a series of helper executables for doing things such as extracting
 the bssid and points, and counting the number of bssids within a certain
 vicinity.
 
-== Contributing to kismet-gpsxml2csv
+Installing
+----------
+
+Simply do:
+
+    gem install kismet-gpsxml
+
+or throw this into your `Gemfile`:
+
+    gem "kismet-gpsxml", "~> 0.0.1"
+
+Note that kismet-gpsxml is not yet a 1.0.0 release and may change wildly between
+releases. It is wise to lock to a version.
+
+Contributing to kismet-gpsxml
+-----------------------------
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -16,7 +34,8 @@ vicinity.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+Copyright
+---------
 
 Copyright (c) 2014 Meta Mesh, LLC. See LICENSE.txt for further details.
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/bin/gpsxml2csv

@@ -1,26 +1,21 @@
 #!/usr/bin/env ruby
 
-require 'nokogiri'
-require 'set'
-ELEM = Nokogiri::XML::Reader::TYPE_ELEMENT
+require './lib/kismet-gpsxml'
 
-$stderr.puts "Usage: #{__FILE__} logfile.gpsxml [rounding-level]\nDefault rounding-level is 6 decimal places.";exit 1 unless ARGV[0]
+DEFAULT_ROUNDING = 4
 
-file = ARGV[0]
-rounding = ARGV[1] ? ARGV[1].to_i : 6
+unless ARGV[0]
+  $stderr.puts "Usage: #{__FILE__} logfile.gpsxml [rounding-level]\nDefault rounding-level is #{DEFAULT_ROUNDING} decimal places."
+  exit 1
+end
 
-reader = Nokogiri::XML::Reader.from_io File.open(file)
+file = ARGV[0]
+rounding = ARGV[1] ? ARGV[1].to_i : DEFAULT_ROUNDING
 
-points = {}
+reader = Kismet::GPSXML::Reader.from_io File.open(file)
+reader.rounding = rounding
 
-reader.each do |node|
-  next unless node.name == "gps-point" && node.node_type == ELEM
-  lat = node.attribute("lat").to_f.round(rounding)
-  long = node.attribute("lon").to_f.round(rounding)
-  key = [lat,long].join(",")
-  points[key] = Set.new if points[key].nil?
-  points[key].add node.attribute("bssid")
-end
+points = reader.points
 
 points.each do |point,set|
   puts [point, set.size].join(",")

data/kismet-gpsxml.gemspec

@@ -2,36 +2,37 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: kismet-gpsxml 0.0.1 ruby lib
+# stub: kismet-gpsxml 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "kismet-gpsxml"
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Colin Dean"]
-  s.date = "2014-08-05"
+  s.date = "2014-08-17"
   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.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "bin/gpsxml2csv",
     "kismet-gpsxml.gemspec",
-    "lib/kismet-gpsxml2csv.rb",
+    "lib/kismet-gpsxml.rb",
     "test/helper.rb",
-    "test/test_kismet-gpsxml2csv.rb"
+    "test/test.xml",
+    "test/test_kismet-gpsxml.rb"
   ]
   s.homepage = "http://github.com/pittmesh/kismet-gpsxml"
   s.licenses = ["MIT"]
@@ -43,26 +44,26 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<nokogiri>, ["~> 1.6.3.0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<minitest-spec-expect>, ["~> 2.0.0"])
     else
       s.add_dependency(%q<nokogiri>, ["~> 1.6.3.0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<minitest-spec-expect>, ["~> 2.0.0"])
     end
   else
     s.add_dependency(%q<nokogiri>, ["~> 1.6.3.0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<minitest-spec-expect>, ["~> 2.0.0"])
   end
 end
 

data/lib/kismet-gpsxml.rb

@@ -0,0 +1,51 @@
+require 'nokogiri'
+require 'set'
+
+module Kismet
+  module GPSXML
+  end
+end
+
+class Kismet::GPSXML::Reader
+
+  private_class_method :new
+
+  attr_reader :reader
+  attr_accessor :rounding
+
+  def self.from_io io
+    new Nokogiri::XML::Reader.from_io(io)
+  end
+
+  def initialize xml_reader
+    @reader = xml_reader
+    @rounding = 4
+  end
+
+  def points
+    points = {}
+    reader.each do |node|
+      next unless interesting_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].add bssid
+    end
+    points
+  end
+
+  private
+
+  def interesting_node? node
+    node.name == "gps-point" &&
+    node.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT &&
+    node.attribute("bssid") != "00:00:00:00:00:00"
+  end
+
+  def point_info node
+    {lat: node.attribute("lat").to_f.round(rounding),
+     lon: node.attribute("lon").to_f.round(rounding),
+     bssid: node.attribute("bssid")}
+  end
+end

data/test/helper.rb

@@ -8,7 +8,7 @@ end
 
 SimpleCov.configure do
   clean_filters
-  load_adapter 'test_frameworks'
+  load_profile 'test_frameworks'
 end
 
 ENV["COVERAGE"] && SimpleCov.start do
@@ -23,12 +23,14 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'test/unit'
-require 'shoulda'
+require 'minitest/spec'
+require 'minitest/spec/expect'
+require 'minitest/autorun'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'kismet-gpsxml2csv'
+require 'kismet-gpsxml'
 
-class Test::Unit::TestCase
+def test_xml_location
+  File.join [File.dirname(__FILE__), "test.xml"]
 end

data/test/test.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE gps-run SYSTEM "http://kismetwireless.net/kismet-gps-2.9.1.dtd">
+
+<gps-run gps-version="5" start-time="Sun Jun 29 16:27:04 2014">
+
+    <network-file>Kismet-20140629-16-27-04-1.netxml</network-file>
+
+    <gps-point bssid="54:BE:F7:99:89:78" source="54:BE:F7:99:89:78" time-sec="1404073624" time-usec="698754" lat="40.429444" lon="-79.970444" spd="0.185000" heading="309.760010" fix="3" alt="223.399994" signal_dbm="-79" noise_dbm="0"/>
+    <gps-point bssid="A0:21:B7:74:EF:0B" source="A0:21:B7:74:EF:0B" time-sec="1404073624" time-usec="705437" lat="40.429555" lon="-79.970555" spd="0.185000" heading="309.760010" fix="3" alt="223.399994" signal_dbm="-72" noise_dbm="0"/>
+    <gps-point bssid="74:BF:33:11:BB:AA" source="74:BF:33:11:BB:AA" time-sec="1404073624" time-usec="698754" lat="40.429499" lon="-79.970999" spd="0.185000" heading="309.760010" fix="3" alt="223.399994" signal_dbm="-79" noise_dbm="0"/>
+    <gps-point bssid="00:06:B1:22:51:F9" source="00:06:B1:22:51:F9" time-sec="1404073624" time-usec="734943" lat="40.430000" lon="-79.980000" spd="0.185000" heading="309.760010" fix="3" alt="223.399994" signal_dbm="-83" noise_dbm="0"/>
+    <gps-point bssid="00:00:00:00:00:00" source="00:00:00:00:00:00" time-sec="1404073624" time-usec="734943" lat="40.430000" lon="-79.980000" spd="0.185000" heading="309.760010" fix="3" alt="223.399994" signal_dbm="-83" noise_dbm="0"/>
+</gps-run>

data/test/test_kismet-gpsxml.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+describe Kismet::GPSXML::Reader do
+  subject { Kismet::GPSXML::Reader }
+
+  describe "Expected methods" do
+    it "responds to from_io" do
+      subject.must_respond_to :from_io
+    end
+
+    it "responds to points" do
+      subject.public_instance_methods.must_include :points
+      # subject.must_respond_to :points # this doesn't work on classes, just instances
+    end
+
+    it "cannot be initialized directly" do
+      expect{ subject.new StringIO.new }.to_raise NoMethodError
+    end
+  end
+
+  describe "IO operations" do
+    let(:text_xml_io) { File.open test_xml_location }
+
+    before do
+      text_xml_io.rewind
+      @reader = subject.from_io text_xml_io
+    end
+
+    it "retrieves points" do
+      @reader.points.wont_be_empty
+    end
+
+    it "retrieves the expected number of points" do
+      @reader.points.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.must_be_empty
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kismet-gpsxml
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Colin Dean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.6.3.0
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-expect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: A quick solution to model Kismet-generated gpsxml log files and output
   to CSV
 email: colin.dean@metamesh.org
@@ -102,20 +102,21 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - ".document"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/gpsxml2csv
 - kismet-gpsxml.gemspec
-- lib/kismet-gpsxml2csv.rb
+- lib/kismet-gpsxml.rb
 - test/helper.rb
-- test/test_kismet-gpsxml2csv.rb
+- test/test.xml
+- test/test_kismet-gpsxml.rb
 homepage: http://github.com/pittmesh/kismet-gpsxml
 licenses:
 - MIT

data/Gemfile.lock

@@ -1,81 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (4.1.4)
-      i18n (~> 0.6, >= 0.6.9)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.1)
-      tzinfo (~> 1.1)
-    addressable (2.3.6)
-    builder (3.2.2)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.1.5)
-    faraday (0.9.0)
-      multipart-post (>= 1.2, < 3)
-    git (1.2.8)
-    github_api (0.12.0)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.2)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.3)
-      oauth2
-    hashie (3.2.0)
-    highline (1.6.21)
-    i18n (0.6.11)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-    json (1.8.1)
-    jwt (1.0.0)
-    mini_portile (0.6.0)
-    minitest (5.4.0)
-    multi_json (1.10.1)
-    multi_xml (0.5.5)
-    multipart-post (2.0.0)
-    nokogiri (1.6.3.1)
-      mini_portile (= 0.6.0)
-    oauth2 (1.0.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.5.2)
-    rake (10.3.2)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    shoulda (3.5.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.2.1)
-    shoulda-matchers (2.6.2)
-      activesupport (>= 3.0.0)
-    simplecov (0.9.0)
-      docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    thread_safe (0.3.4)
-    tzinfo (1.2.1)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  jeweler (~> 2.0.1)
-  nokogiri (~> 1.6.3.0)
-  rdoc (~> 3.12)
-  shoulda
-  simplecov

data/test/test_kismet-gpsxml2csv.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestKismetGpsxml2csv < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end