geoptima 0.0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+== 0.0.1 / 2012-02-29
+* First release based on initial use on customer data verification in February 2012

data/CONTRIBUTORS

@@ -0,0 +1,5 @@
+Maintainer:
+  Craig Taverner <craig at amanzi dot com>
+
+Contributors:
+* 

data/Gemfile

@@ -0,0 +1,15 @@
+source :gemcutter
+
+gemspec
+
+group 'test' do
+  gem "rake", ">= 0.8.7"
+  gem "rdoc", ">= 2.5.10"
+  gem "horo", ">= 1.0.2"
+  gem "rspec", ">= 2.0.0"
+  gem "test-unit"
+end
+
+#gem 'ruby-debug-base19' if RUBY_VERSION.include? "1.9"
+#gem 'ruby-debug-base' if RUBY_VERSION.include? "1.8"
+#gem "ruby-debug-ide"

data/README.rdoc

@@ -0,0 +1,68 @@
+== Welcome to geoptima.rb
+
+Geoptima is a suite of applications for measuring and locating mobile/cellular subscriber experience on GPS enabled smartphones. It is produced by AmanziTel AB in Helsingborg, Sweden, and supports many phone manufacturers, with free downloads from the various app stores, markets or marketplaces. This Ruby library is only capable of reading the JSON format files priduced by these phones and reformating them as CSV for further analysis in Excel. This is a simple and independent way of analysing the data, when compared to the full-featured analysis applications and servers available from AmanziTel. If you want to analyse a limited amount of data in excel, or with Ruby, then this GEM might be for you. If you want to analyse large amounts of data, from many subscribers, or over long periods of time then rather consider the NetView and Customer IQ applications from AmanziTel at www.amanzitel.com.
+
+For more information on Geoptima refer to:
+* {AmanziTel}[http://www.amanzitel.com] - for commercial applications and platforms supporting Geoptima
+* {Geoptima on Android}[https://market.android.com/details?id=com.AmanziTel.Geoptima] - on the android market
+* For Geoptima on other plaforms, use the phone to search the relevant app-store or market
+
+=== Documentation
+
+The current version includes the core geoptima.rb library as well as a few command-line apps for using the library.
+
+== show_geoptima.rb
+
+This script simply imports the JSON files on the command-line and then:
+* Prints out basic information about each file (subscriber information, start date and number of events)
+* Optionally prints out all events on the console for visual inspection (using the -p option)
+* Optionally prints out all events to files in CSV format with merging of event types and fields into a single header for further processing with Excel or OpenOffice (using the -x option)
+
+Which event types to include and various other options are available using the command-line. Run it with the -h option to get a full list of options. The current version should support:
+
+Usage: ./showGeoptimaEvents.rb <-dvxEh> <-L limit> <-E types> <-T min,max> file <files>
+  -d  debug mode (output more context during processing) (false)
+  -p  print mode (print out final results to console) 
+  -v  verbose mode (output extra information to console) 
+  -x  export IMEI specific CSV files for further processing 
+  -s  seperate the export files by event type 
+  -h  show this help
+  -L  limit verbose output to specific number of lines (10000)
+  -E  comma-seperated list of event types to show and export (default: all; current: )
+  -T  time range to limit results to (default: all; current: )
+
+Currently the script also locates events that are close enough in time to GPS events.
+
+== show_geoptima_sos.rb
+
+This is a simplified version of the above script with special support for finding the SOS events in Blackberry phones. Run with the JSON files on the command line and it will print out all SOS events, possibly located to close GPS events.
+
+=== Installation
+
+Two options:
+* As a RubyGem: jruby -S gem install geoptima
+* From source: git clone git@github.com:craigtaverner/geoptima.rb.git
+
+=== Some Examples
+
+.. to be done ..
+(or see the code in the command-line utilities described below for examples)
+
+=== Command-line utilities
+
+The examples directory includes a few sample Ruby scripts for various import/export tasks, as well as some sample Geoptima data to test on. Consider the following run:
+
+  git clone git@github.com:craigtaverner/geoptima.rb.git
+  cd geoptima.rb/examples
+  ./geoptima.rb -x craig.json
+
+This should produce a file called ####.txt containing a CSV version of the Geoptima events for importing into Excel or OpenOffice.Calc for further processing.
+
+=== Contributing
+
+Have you found a bug, need help or have a patch ?
+Just clone geoptima.rb and send me a pull request or email me.
+
+=== License
+
+MIT, see the LICENSE file http://github.com/craigtaverner/geoptima.rb/tree/master/LICENSE.

data/bin/show_geoptima

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+
+# useful if being run inside a source code checkout
+$: << 'lib'
+$: << '../lib'
+
+require 'date'
+require 'geoptima'
+
+$debug=false
+
+$event_names=[]
+$files = []
+$print_limit = 10000
+
+def cw(val)
+  val.nil? ? '' : "(#{val})"
+end
+
+while arg=ARGV.shift:
+  if arg =~ /^\-(\w+)/
+    $1.split(//).each do |aa|
+      case aa
+      when 'h'
+        $help=true
+      when 'd'
+        $debug=true
+      when 'p'
+        $print=true
+      when 'v'
+        $verbose=true
+      when 'x'
+        $export=true
+      when 's'
+        $seperate=true
+      when 'E'
+        $event_names += ARGV.shift.split(/[\,\;\:\.]+/)
+      when 'T'
+        $time_range = Range.new(*(ARGV.shift.split(/[\,]+/).map do |t|
+          DateTime.parse t
+        end))
+      when 'L'
+        $print_limit = ARGV.shift.to_i
+        $print_limit = 10 if($print_limit<1)
+      else
+        puts "Unrecognized option: -#{aa}"
+      end
+    end
+  else
+    if File.exist? arg
+      $files << arg
+    else
+      puts "No such file: #{arg}"
+    end
+  end
+end
+
+$help = true if($files.length < 1)
+if $help
+  puts <<EOHELP
+Usage: ./showGeoptimaEvents.rb <-dvxEh> <-L limit> <-E types> <-T min,max> file <files>
+  -d  debug mode (output more context during processing) #{cw $debug}
+  -p  print mode (print out final results to console) #{cw $print}
+  -v  verbose mode (output extra information to console) #{cw $verbose}
+  -x  export IMEI specific CSV files for further processing #{cw $export}
+  -s  seperate the export files by event type #{cw $seperate}
+  -h  show this help
+  -L  limit verbose output to specific number of lines #{cw $print_limit}
+  -E  comma-seperated list of event types to show and export (default: all; current: #{$event_names.join(',')})
+  -T  time range to limit results to (default: all; current: #{$time_range})
+EOHELP
+  exit 0
+end
+
+$verbose = $verbose || $debug
+$datasets = Geoptima::Dataset.make_datasets($files, :locate => true, :time_range => $time_range)
+
+class Export
+  attr_reader :files, :names, :headers
+  def initialize(imei,names,dataset)
+    @names = names
+    if $export
+      if $seperate
+        @files = names.inject({}) do |a,name|
+          a[name] = File.open("#{imei}_#{name}.csv",'w')
+          a
+        end
+      else
+        @files={nil => File.open("#{imei}.csv",'w')}
+      end
+    end
+    @headers = names.inject({}) do |a,name|
+      a[name] = dataset.header([name]).reject{|h| h === 'timeoffset'}
+      puts "Created header for name #{name}: #{a[name].join(',')}" if($debug)
+      a
+    end
+    @headers[nil] = @headers.values.flatten
+    files && files.each do |key,file|
+      file.puts "Time\tEvent\tLatitude\tLongitude\t#{header(key).join("\t")}\n"
+    end
+    if $debug || $verbose
+      @headers.each do |name,head|
+        puts "Header[#{name}]: #{head.join(',')}"
+      end
+    end
+  end
+  def header(name=nil)
+    @headers[name]
+  end
+  def puts_to(line,name)
+    name = nil unless($seperate)
+    files[name].puts(line) if($export && files[name])
+  end
+  def puts_to_all(line)
+    files && files.each do |key,file|
+      file.puts line
+    end
+  end
+  def close
+    files && files.each do |key,file|
+      file.close
+      @files[key] = nil
+    end
+  end
+end
+
+def if_le
+  $count ||= 0
+  if $print
+    if $count < $print_limit
+      yield
+    elsif $count == $print_limit
+      puts " ... "
+    end
+  end
+  $count += 1
+end
+
+puts "Found #{$datasets.length} IMEIs"
+$datasets.keys.sort.each do |imei|
+  dataset = $datasets[imei]
+  events = dataset.sorted
+  puts if($print)
+  puts "Found #{dataset}"
+  if events && ($print || $export)
+    names = $event_names
+    names = dataset.events_names if(names.length<1)
+    export = Export.new(imei,names,dataset)
+    events.each do |event|
+      names.each do |name|
+        if event.name === name
+          fields = export.header($seperate ? name : nil).map{|h| event[h]}
+          export.puts_to "#{event.time_key}\t#{event.name}\t#{event.latitude}\t#{event.longitude}\t#{fields.join("\t")}", name
+          if_le{puts "#{event.time_key}\t#{event.name}\t#{event.latitude}\t#{event.longitude}\t#{event.fields.inspect}"}
+        end
+      end
+    end
+    export.close
+  end
+end
+

data/examples/export_layer.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env jruby
+
+# useful if being run inside a source code checkout
+$: << 'lib'
+$: << '../lib'
+
+require 'rubygems'
+require 'neo4j/spatial'
+require 'neo4j/spatial/cmd'
+
+$zoom = 1.0
+$args = Neo4j::Spatial::Cmd.args
+
+if $list === 'layers'
+  layers = Neo4j::Spatial::Layer.list
+  puts "Have #{layers.length} existing layers in the database:"
+  layers.each {|l| puts "\t#{l} (#{l.type_name})"}
+  puts
+  exit 0
+end
+
+if $help || $args.length < 1
+  puts <<-eos
+
+usage: ./export_layer.rb <-D storage_path> <-F format> <-E dir> <-Z zoom> <-W width> <-H height> <-l> <-h> layer <layers>
+    -D  Use specified database location
+    -F  Use specified export format (png, shp)
+    -E  Use specified export directory path (default '.')
+    -Z  Zoom in by specified factor (eg. 3.0)
+    -W  Image width (default 600)
+    -H  Image height (default 400)
+    -l  List existing database layers first
+    -h  Display this help and exit
+  The layer(s) should be pre-existing layers (including dynamic layers) in the database.
+  Supported formats are 'shp' for ESRI Shapefile and 'png' for images.
+
+For example:
+  ./export_layer.rb -D db -E exports -F png croatia.osm highway highway-residential natural-water
+
+This will export four previously defined layers to png format files in the 'exports' directory.
+
+eos
+  exit
+end
+
+if $format.to_s.downcase === 'shp'
+  $exporter = Neo4j::Spatial::SHPExporter.new :dir => $export
+else
+  $exporter = Neo4j::Spatial::ImageExporter.new :dir => $export, :zoom => $zoom, :width => $width, :height => $height
+end
+
+puts "Exporting #{$args.length} layers to #{$exporter.format}"
+
+$args.each do |layer|
+  l = Neo4j::Spatial::Layer.find layer
+  puts "Exporting #{l} (#{l.type_name}) - #{l.index.layer_bounding_box}"
+  $exporter.export l.name
+  puts "Finished exporting #{l} (#{l.type_name}) of #{l.index.count} entries"
+end