argos-ruby 1.0.5 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDNkNTlmYzhjMjk2YzhlNGMzNjVjNDY3NDM5MjZjNzE4YzYwMzMxZA==
+    NWZlNzc5MzczNTY4MTkyMDljZmMzYTQwYTBlODIwYThkMjg5MDZhZQ==
   data.tar.gz: !binary |-
-    MzVlNThiZTM1NzUxMTQ1ODQwMDZiNjU2NGFjYzIwMDY4MDRjZTIyMA==
+    MzQ0MzQ0NjVhM2Y0NDMxMmZjYjEzODRlNDg4ZDQxNTc4MDM1YTgxMQ==
 SHA512:
   metadata.gz: !binary |-
-    Zjc1OWM3ZjE1MmI3ZDZiMzIyYThkMzYwODZhZTMxNjM3MWRiMTQ0MTY4YTFh
-    YzU1YTY0NzZjNmE1YmQxYTgwOGZlMWM5YTgwNTczZjJmNGIzODkxOGI0NmNl
-    ODk3ZTAwY2FhNGZkMTA1YjFkMDdlMGM4ZmY5MjY5ZjYyMmJlZjI=
+    N2U3OWFmOWU4NWEwNWEwZGI1YmE2OTNjODMyYjMyMTIwZDdmMTkwZGQyZGZl
+    ZWQ1MjNiN2VlMDQ3ZWRhZjU0YTE1ZmFjYzQyYTY2ZjViNDkyODNhMzMxMzEy
+    MWZkY2VjNDUxZjVhMzU0OWU5MTFhYTk1Nzc2MmIzZGIxZGIxZWM=
   data.tar.gz: !binary |-
-    NmY0NDdmM2NmYzc2ODdjNjQwZmQ1NzQ4N2M3YzBhYTg2YTMwZWVmMzg3MDNm
-    ODNlNDJlNTRiNTY3YzM2ZmI0YmM5NTFkODEzODJjMjk1MjRmN2ZhYWRlMDg3
-    OGE5M2M3MGE1MDFiYjY0MDM5NjYyYjg0ZTcxNTNiM2E2Zjk5NDE=
+    N2Q0ZTg0NWUwOWRkNWYwY2VlZDBjNzc3NWQ3ZmIxMGVhYzg2YjYyZDVlZjQ4
+    YmYzMGEwZjRjNTM2Y2ZiMmJiMjRmMmIwNThjYmNiYjZjZTlmNGVjNDA0MjBh
+    OTNmZTRjMTZhM2U2ZDk0Y2M5OTEzOWEzZmI2N2RlMGMxZjdmYmM=

data/.gitignore

@@ -18,3 +18,4 @@ todo.txt
 .yardoc
 _yardoc
 doc/
+*.pdf

data/Gemfile

@@ -4,7 +4,7 @@ gem "yajl-ruby", git: "git://github.com/brianmario/yajl-ruby.git"
 gem "uuidtools"
 gem "hashie", git:  "git://github.com/intridea/hashie.git"
 #gem "json-schema", git:  "git://github.com/hoxworth/json-schema.git"
-
+gem "savon", github: 'savonrb/savon'
 
 group :development, :test do
   gem "thin"

data/LICENSE

@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    argos-ruby  Copyright (C) 2013  Norwegian Polar Data
+    argos-ruby  Copyright (C) 2013  Norwegian Polar Institute
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

data/README.md

@@ -1,92 +1,57 @@
 # argos-ruby
 
-A Ruby library and command-line tool for parsing Argos tracking data files.
+A Ruby library and command-line tool accessing data from the [Argos](http://www.argos-system.org) tracking system.
 
-## Usage
-### DS/DIAG to JSON
+## argos-soap (webservice client)
 
-```argos-ruby``` converts Argos files to JSON. DS header data is repeated in each message
-```sh
-curl "https://raw.github.com/npolar/argos-ruby/master/spec/argos/_ds/fragment.ds" > /tmp/fragment.ds
-argos-ruby /tmp/fragment.ds 
-```
+  $ argos-soap --operations
 ```json
-[
-  {
-    "program": 9660,
-    "platform": 10783,
-    "lines": 3,
-    "sensors": 3,
-    "satellite": "K",
-    "lc": "3",
-    "positioned": "1999-12-30T17:58:26Z",
-    "latitude": 79.824,
-    "longitude": 22.363,
-    "altitude": 0.0,
-    "headers": 12,
-    "measured": "1999-12-30T17:56:30Z",
-    "identical": 2,
-    "sensor_data": [
-      "78",
-      "00",
-      "00"
-    ],
-    "technology": "argos",
-    "type": "ds",
-    "location": "file:///tmp/fragment.ds",
-    "source": "a9c02cf81978a9fafecac582309c7c8161e5a76c",
-    "parser": "argos-ruby-1.0.4",
-    "id": "2d833010d13714dfb771f73470417405b887e8f4",
-    "bundle": "bc30f5e5733087f730202bea53fa730092a192e3"
-  },
-  {
-    "program": 9660,
-    "platform": 10783,
-    "lines": 3,
-    "sensors": 3,
-    "satellite": "K",
-    "lc": "3",
-    "positioned": "1999-12-30T17:58:26Z",
-    "latitude": 79.824,
-    "longitude": 22.363,
-    "altitude": 0.0,
-    "headers": 12,
-    "measured": "1999-12-30T18:01:20Z",
-    "identical": 5,
-    "sensor_data": [
-      "78",
-      "00",
-      "00"
-    ],
-    "technology": "argos",
-    "type": "ds",
-    "location": "file:///tmp/fragment.ds",
-    "source": "a9c02cf81978a9fafecac582309c7c8161e5a76c",
-    "parser": "argos-ruby-1.0.4",
-    "id": "26af9092d01fbd49ff8cb9041e63df352886dba6",
-    "bundle": "bc30f5e5733087f730202bea53fa730092a192e3"
-  }
-]
-
+["getCsv","getStreamXml","getKml","getXml","getXsd","getPlatformList","getObsCsv","getObsXml"]
 ```
+**All programs**
+Data from all programs and all platforms are fetched by default
 
-## About
+$ argos-soap --operation=getXml > [getXml.xml](https://github.com/npolar/argos-ruby/blob/master/spec/argos/_soap/getXml.xml)
+
+$ argos-soap --operation=getXml --format=json > [getXml.json](https://github.com/npolar/argos-ruby/blob/master/spec/argos/_soap/getXml.json)
+
+$ argos-soap --operation=getKml > [getKml.xml](https://github.com/npolar/argos-ruby/blob/master/spec/argos/_soap/getKml.xml)
+
+$ argos-soap --operation=getCsv --format=text > [getCsv.csv](https://github.com/npolar/argos-ruby/blob/master/spec/argos/_soap/getCsv.csv)
+
+**Select program(s)**
+argos-soap --operation getXml --programNumber 9660
 
-[argos-ruby](https://github.com/npolar/argos-ruby) has been developed to parse [Argos](http://www.argos-system.org)
-satellite tracking data files collected by the [Norwegian Polar Institute]
-(http://npolar.no/en) since 1989.
+**Select platformId(s)**
+$ argos-soap --operation getXml --platformId 81308
 
-Be warned, the Argos file formats have changed over time. No promises are
+
+**Authentication**
+Either set your credentials on the command line
+  $ argos-soap --operation=getPlatformList --username=myusername --password=mypassword
+Or set environmental variables ARGOS_SOAP_USERNAME and ARGOS_SOAP_PASSWORD
+
+## Argos file parsing
+### DS/DIAG to JSON
+  $ # 
+
+## About
+
+[argos-ruby](https://github.com/npolar/argos-ruby) was developed to parse [Argos](http://www.argos-system.org)
+satellite tracking data text files collected by the [Norwegian Polar Institute]
+(http://npolar.no/en) since 1989. Be warned, the Argos text file formats have changed over time. No promises are
 made that the library will work outside of Norway :).
 
-Currently, the library parses Argos DS/DIAG files dating from August 1990
-and onwards.
+Currently, the library parses Argos DS/DIAG files dating from August 1990 and onwards.
 
 ## Install
 $ gem install argos-ruby
 
 ## Links
-* [http://api.npolar.no/tracking/?q=&filter-technology=argos](http://api.npolar.no/tracking/?q=&filter-technology=argos)
-* [Argos users manual v1.5](http://www.argos-system.org/files/pmedia/public/r363_9_argos_users_manual-v1.5.pdf) (PDF)
+
+* https://github.com/npolar/api.npolar.no/wiki/Tracking-API-JSON
+* [Argos User's Manual](http://www.argos-system.org/manual/)
+* [Argos Web Service Interface Specification v1.5](http://www.argos-system.org/manual/argos_webservices-1_4.pdf)
 * http://alaska.usgs.gov/science/biology/spatial/
-* http://gis-lab.info/programs/argos/argos-manual-eng.html
+* http://gis-lab.info/programs/argos/argos-manual-eng.html
+

data/argos-ruby.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Espen Egeland", "Conrad Helgeland"]
   s.email       = ["data*npolar.no"]
   s.homepage    = "http://github.com/npolar/argos-ruby"
-  s.summary     = %q{Argos satellite tracking data parsers}
-  s.description = %q{Parses Argos (http://www.argos-system.org/) DS/DAT and DIAG/DIA files.}
+  s.summary     = %q{Argos satellite tracking library and command-line tools}
+  s.description = %q{Argos (http://www.argos-system.org/) webservice client and Argos legacy file (DS/DAT and DIAG/DIA) parser.}
   s.license = "GPL-3.0"
   s.add_development_dependency "rspec"
   s.files         = `git ls-files`.split("\n")

data/bin/{argos-ruby → argos-ascii}

@@ -3,9 +3,10 @@
 
 # argos-ruby /path/argos/ --dest=/path/dest --level=info 2>> /path/argos-json.log 
 require_relative "../lib/argos"
+
 require "optparse"
-require "yaml"
 require "fileutils"
+require "csv"
 
 param = { format: "json",
   action: "parse",
@@ -66,7 +67,7 @@ log = Logger.new(STDERR)
 log.level = param[:level]
 
 
-if not Argos.argos? glob
+if not Argos::Ascii.argos? glob
   glob = glob.gsub(/\/$/, "")
   if glob != /\*/
     glob += "/**/*"
@@ -80,14 +81,14 @@ argosfiles = 0
 
 Dir[glob].reject {|f| File.directory? f}.select {|f|
   argosfiles = argosfiles + 1
-  if not Argos.argos? f  
+  if not Argos::Ascii.argos? f  
     log.warn "Not Argos: #{f}"
   end
   
-  Argos.argos? f  
+  Argos::Ascii.argos? f  
 }.map {|filename|
   log.debug "*"*80
-  argos = Argos.factory(Argos.type(filename))
+  argos = Argos::Ascii.factory(Argos::Ascii.type(filename))
   argos.filename = filename
   argos.filter = param[:filter]
   argos.bundle = bundle
@@ -95,7 +96,7 @@ Dir[glob].reject {|f| File.directory? f}.select {|f|
 
   case param[:action]
     when "source","metadata"
-      result << Argos.source(argos).merge(glob: glob, bundle: bundle)
+      result << Argos::Ascii.source(argos).merge(glob: glob, bundle: bundle)
       
     when "parse"
       
@@ -150,6 +151,14 @@ if param[:dest].nil?
       puts result.to_yaml
     when /(ruby|rb)/
       puts result
+    when "csv"
+      
+      data = result.map {|r| r.values }
+      csv = CSV.generate() do |csv|
+        csv << result[0].keys
+        data.each { |row| csv << row }
+      end
+      puts csv
   end
 end
 

data/bin/argos-soap

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# Ruby-based command line client for Argos' Soap webservice
+#
+# For more information:
+# $ ./bin/argos-soap --help
+# https://github.com/npolar/argos-ruby/blob/master/README.md
+
+require_relative "../lib/argos"
+require_relative "../lib/argos/soap_command"
+
+Argos::SoapCommand.run

data/lib/argos.rb

@@ -1,155 +1,33 @@
+require "bundler/setup"
 require "bigdecimal"
 require "date"
 require "time" # for iso8601
 require "digest/sha1"
 require "json"
 require "logger"
+require "cgi"
 
 require_relative "argos/exception"
+require_relative "argos/ascii"
 require_relative "argos/ds"
 require_relative "argos/diag"
-
-# Argos module
-# Contains parsers for Argos DS/DAT and DIAG files.
-# 
-# Code written by staff at the Norwegian Polar Data Centre
-# http://data.npolar.no - a service run by the [Norwegian Polar Institute](http://npolar.no)
+require_relative "argos/soap"
+require_relative "argos/download"
+
+# Argos library containg
+# * Parsers for Argos legacy ASCII files (DS/DAT and DIAG files)
+# * Soap web service client and Argos XML download tool
+#
+# https://github.com/npolar/argos-ruby
+#
+# Code written by staff at the [Norwegian Polar Data Centre](http://data.npolar.no),
+# [Norwegian Polar Institute](http://npolar.no)
 # 
 # For information about Argos, see: http://www.argos-system.org
 module Argos
-  VERSION = "1.0.5"
-  # Detect Argos type ("ds" or "diag" or nil)
-  #
-  # @param filename [String] Argos (DS or DIAG) file
-  # @return [String]
-  #"ds"|"diag"
-  def self.type filename
-
-    if File.file? filename
-      # Avoid invalid byte sequence in UTF-8 (ArgumentError)
-      firstline = File.open(filename, :encoding => "iso-8859-1") {|f| f.readline}
-    else
-      firstline = filename
-    end
-
-    case firstline
-      when Argos::Ds::START_REGEX, Argos::Ds::START_REGEX_LEGACY
-        "ds"
-      when Argos::Diag::START_REGEX
-        "diag"
-      when "", nil
-        raise ArgumentError, "Not a file or empty string: #{filename}"
-      else nil
-    end 
-  end
-
-  # Argos file?
-  #
-  # @param filename [String] Argos (DS or DIAG) file
-  # @return [Boolean]
-  def self.argos?(filename)
-    case type(filename)
-    when "ds", "diag"
-      true
-    else
-      false
-    end
-  end
-
-  # Factory for Argos::Ds / Argos::Diag
-  #
-  # @param type [String]: Argos (DS or DIAG) file type (or filename)
-  # @return [Argos::Ds Argos::Diag]
-  # @throws ArgumentError
-  def self.factory(type)
-
-    # Auto-detect file format if not "ds" or "diag"
-    if not ["ds","diag"].include? type
-      if argos? type
-        type = self.type(type)
-      end
-    end
-
-    case type
-    when "ds"
-      Ds.new
-    when "diag"
-      Diag.new
-    else
-      raise ArgumentError, "Unknown Argos type: #{type}"
-    end
-  end
-
-
+  VERSION = "1.1.0"
+  
   def self.library_version
     "argos-ruby-#{VERSION}" 
   end
-
-  # Source fingerprint of Argos file (sha1 hash, segment and document counts, etc.)
-  #
-  # @param  [Argos::Ds Argos::Diag] argos
-  # @return [Hash] Source hash
-  def self.source(argos)
-
-    argos.parse(argos.filename)
-
-    latitude_mean = longitude_mean = nil
-    if argos.latitudes.any?
-      latitude_mean = (argos.latitudes.inject{ |sum, latitude| sum + latitude } / argos.latitudes.size).round(3)
-    end
-    if argos.longitudes.any?
-      longitude_mean = (argos.longitudes.inject{ |sum, longitude| sum + longitude } / argos.latitudes.size).round(3)
-    end
-    
-    
-    source = {
-      id: argos.source,
-      technology: "argos",
-      collection: "tracking",
-      type: argos.type,
-      programs: argos.programs,
-      platforms: argos.platforms,
-      start: argos.start,
-      stop: argos.stop,
-      north: argos.latitudes.max,
-      east: argos.longitudes.max,
-      south: argos.latitudes.min,
-      west: argos.longitudes.min,
-      latitude_mean: latitude_mean,
-      longitude_mean: longitude_mean,
-      location: "file://"+argos.filename,
-      bytes: argos.filesize,
-      modified: argos.updated.utc.iso8601,
-      messages: argos.messages.size,
-      filter: argos.filtername.nil? ? argos.filter : argos.filtername,
-      size: argos.size,
-      parser: library_version
-    }
-    if argos.multiplicates.any?
-      source[:multiplicates] = argos.multiplicates.map {|a| a[:id]}
-    end
-    if argos.errors.any?
-      source[:errors] = argos.errors
-    end
-    source
-    
-  end
-
-
-  def latitudes
-    select {|a| a.key? :latitude and a[:latitude].is_a? Float }.map {|a| a[:latitude]}.sort
-  end
-
-  def longitudes
-    select {|a| a.key? :longitude and a[:longitude].is_a? Float }.map {|a| a[:longitude]}.sort
-  end
-
-  def platforms
-    map {|a| a[:platform]}.uniq.sort
-  end
-
-  def programs
-    map {|a| a[:program]}.uniq.sort
-  end
-  
 end

data/lib/argos/ascii.rb

@@ -0,0 +1,134 @@
+module Argos
+  module Ascii
+    
+    # Detect Argos ASCII filetype ("ds" or "diag" or nil)
+    #
+    # @param filename [String] Argos (DS or DIAG) file
+    # @return [String]
+    #"ds"|"diag"
+    def self.type filename
+  
+      if File.file? filename
+        # Avoid invalid byte sequence in UTF-8 (ArgumentError)
+        firstline = File.open(filename, :encoding => "iso-8859-1") {|f| f.readline}
+      else
+        firstline = filename
+      end
+  
+      case firstline
+        when Argos::Ds::START_REGEX, Argos::Ds::START_REGEX_LEGACY
+          "ds"
+        when Argos::Diag::START_REGEX
+          "diag"
+        when "", nil
+          raise ArgumentError, "Not a file or empty string: #{filename}"
+        else nil
+      end 
+    end
+  
+    # Argos ASCII file?
+    #
+    # @param filename [String] Argos (DS or DIAG) file
+    # @return [Boolean]
+    def self.argos?(filename)
+      case type(filename)
+      when "ds", "diag"
+        true
+      else
+        false
+      end
+    end
+  
+    # Factory for Argos::Ds / Argos::Diag
+    #
+    # @param type [String]: Argos (DS or DIAG) file type (or filename)
+    # @return [Argos::Ds Argos::Diag]
+    # @throws ArgumentError
+    def self.factory(type)
+  
+      # Auto-detect file format if not "ds" or "diag"
+      if not ["ds","diag"].include? type
+        if argos? type
+          type = self.type(type)
+        end
+      end
+  
+      case type
+      when "ds"
+        Ds.new
+      when "diag"
+        Diag.new
+      else
+        raise ArgumentError, "Unknown Argos type: #{type}"
+      end
+    end
+  
+    # Source fingerprint of Argos file (sha1 hash, segment and document counts, etc.)
+    #
+    # @param  [Argos::Ds Argos::Diag] argos
+    # @return [Hash] Source hash
+    def self.source(argos)
+  
+      argos.parse(argos.filename)
+  
+      latitude_mean = longitude_mean = nil
+      if argos.latitudes.any?
+        latitude_mean = (argos.latitudes.inject{ |sum, latitude| sum + latitude } / argos.latitudes.size).round(3)
+      end
+      if argos.longitudes.any?
+        longitude_mean = (argos.longitudes.inject{ |sum, longitude| sum + longitude } / argos.latitudes.size).round(3)
+      end
+      
+      
+      source = {
+        id: argos.source,
+        technology: "argos",
+        collection: "tracking",
+        type: argos.type,
+        programs: argos.programs,
+        platforms: argos.platforms,
+        start: argos.start,
+        stop: argos.stop,
+        north: argos.latitudes.max,
+        east: argos.longitudes.max,
+        south: argos.latitudes.min,
+        west: argos.longitudes.min,
+        latitude_mean: latitude_mean,
+        longitude_mean: longitude_mean,
+        file: "file://"+argos.filename,
+        bytes: argos.filesize,
+        modified: argos.updated.utc.iso8601,
+        messages: argos.messages.size,
+        filter: argos.filtername.nil? ? argos.filter : argos.filtername,
+        size: argos.size,
+        parser: Argos.library_version
+      }
+      if argos.multiplicates.any?
+        source[:multiplicates] = argos.multiplicates.map {|a| a[:id]}
+      end
+      if argos.errors.any?
+        source[:errors] = argos.errors
+      end
+      source
+      
+    end
+  
+  
+    def latitudes
+      select {|a| a.key? :latitude and a[:latitude].is_a? Float }.map {|a| a[:latitude]}.sort
+    end
+  
+    def longitudes
+      select {|a| a.key? :longitude and a[:longitude].is_a? Float }.map {|a| a[:longitude]}.sort
+    end
+  
+    def platforms
+      map {|a| a[:platform]}.uniq.sort
+    end
+  
+    def programs
+      map {|a| a[:program]}.uniq.sort
+    end
+    
+  end
+end