argos-ruby 1.1.0 → 1.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWZlNzc5MzczNTY4MTkyMDljZmMzYTQwYTBlODIwYThkMjg5MDZhZQ==
+    Mjc1YTlhYTAwYTA4ZGE4MmYyZGFkYmUwNGNhNDE3MDNkYTA4MDdjNQ==
   data.tar.gz: !binary |-
-    MzQ0MzQ0NjVhM2Y0NDMxMmZjYjEzODRlNDg4ZDQxNTc4MDM1YTgxMQ==
+    YjQzNDA1MDlkZjkyMWZlYTAwZWQ3NTVjODNhNjk5ZDI3MDZhOThiOA==
 SHA512:
   metadata.gz: !binary |-
-    N2U3OWFmOWU4NWEwNWEwZGI1YmE2OTNjODMyYjMyMTIwZDdmMTkwZGQyZGZl
-    ZWQ1MjNiN2VlMDQ3ZWRhZjU0YTE1ZmFjYzQyYTY2ZjViNDkyODNhMzMxMzEy
-    MWZkY2VjNDUxZjVhMzU0OWU5MTFhYTk1Nzc2MmIzZGIxZGIxZWM=
+    ZTcxM2NmZTdmYmU4MGZiOTRiYmM2MjM3NmE5NmJjMmFlOGNlYzVlNTgwYmEy
+    NDQ3OTBkZTViZDk2MTJlMDc4NjA4NWE3OTMzYmIzN2ZhZDYwMjIyN2QyZWIy
+    MjE2NThhY2RlZTM3Njg1MjkyMThlNDliYmVkYzgzZmMzZjU0MTQ=
   data.tar.gz: !binary |-
-    N2Q0ZTg0NWUwOWRkNWYwY2VlZDBjNzc3NWQ3ZmIxMGVhYzg2YjYyZDVlZjQ4
-    YmYzMGEwZjRjNTM2Y2ZiMmJiMjRmMmIwNThjYmNiYjZjZTlmNGVjNDA0MjBh
-    OTNmZTRjMTZhM2U2ZDk0Y2M5OTEzOWEzZmI2N2RlMGMxZjdmYmM=
+    NmMyNzcwMDE0MjA3NTFhZjNkYzcyNjQyMDJhYjcxZmY4OTI3ZWQ3NGJmZWRj
+    MTczZDQwODE0Njg2OTE2ZjIxOTlkODFjMjdkZGIwM2VhYzRmNzg0MDIyODNk
+    YzE1NDkzZDUzMDc5N2EzOTUwYjQzNWZmMjY4M2VmNmZmODA4NzE=

data/lib/argos/exception.rb

@@ -3,6 +3,8 @@ module Argos
   end
   class SoapException < Exception
   end
+  class NodataException < SoapException
+  end
   class SoapFault < SoapException
   end
 end

data/lib/argos/soap.rb

@@ -26,9 +26,16 @@ module Argos
     # response [Savon::Response]
     # operation [Savon::Operation]
     # xml [String] (Extracted, inner) XML
+    # filter FIXME
+    # platformId [String] Comma-separated list of platforms
+    # programNumber [String] Comma-separated list of programs
+    # nbDaysFromNow
+    # period
     attr_accessor :client, :request, :response, :operation, :xml, :filter,
       :platformId, :programNumber, :nbDaysFromNow, :period
-      
+    
+    # username [String]
+    # password [String]
     attr_writer :username, :password
     
     URI = "http://ws-argos.cls.fr/argosDws/services/DixService"
@@ -37,6 +44,7 @@ module Argos
     WSDL = "#{URI}?wsdl"       
     
     ARGOS_NS = "http://service.dataxmldistribution.argos.cls.fr/types"
+    
     SOAP_NS = "http://www.w3.org/2003/05/soap-envelope"
     
     NAMESPACES = {
@@ -147,6 +155,12 @@ module Argos
       }
       @response = o.call
       @request = o.build
+      
+      # Handle faults (before extracting data)
+      _envelope.xpath("soap:Body/soap:Fault", namespaces).each do | fault |
+        raise fault.to_s
+      end
+      
       @text = _extract_escaped_xml("csvResponse").call(response)
     end
     
@@ -159,10 +173,20 @@ module Argos
     # {"data":{"program":[{"programNumber":"9660","platform":[{ .. },{ .. }]}],"@version":"1.0"}}
     # Each platform Hash (.. above): {"platformId":"129990","lastLocationClass":"3","lastCollectDate":"2013-10-03T08:32:24.000Z","lastLocationDate":"2013-05-22T04:55:15.000Z","lastLatitude":"47.67801","lastLongitude":"-122.13419"}
     def getPlatformList
-      _call_xml_operation(:getPlatformList, { platformListRequest:
+      platformList = _call_xml_operation(:getPlatformList, { platformListRequest:
         # Cannot use #baseRequest here because that methods calls #programs which also calls #getPlatformList...
         { username: _username, password: _password },
       }, _extract_escaped_xml("platformListResponse"))
+      
+      # Raise error if no programs
+      if platformList["data"]["program"].nil?
+        raise platformList.to_json
+      end
+      # Force Array
+      if not platformList["data"]["program"].is_a? Array
+        platformList["data"]["program"] = [platformList["data"]["program"]]
+      end
+      platformList
     end
     
     # @return [Hash]
@@ -205,26 +229,36 @@ module Argos
       @text = _extract_escaped_xml("observationResponse").call(response)
     end
     
-    # @return [Array]
+    # Platforms: array of platformId integers
+    # @return [Array] of [Integer]
     def platforms(programNumber=nil)
       platforms = []
-      programs = getPlatformList["data"]["program"]
+
+      platformListPrograms = getPlatformList["data"]["program"]
+
       if programNumber.to_s =~ /\d+/
-        programs.select! {|p| p["programNumber"].to_i == programNumber.to_i }
+        platformListPrograms.select! {|p| p["programNumber"].to_i == programNumber.to_i }
       end
-      programs.each do |program|
+      platformListPrograms.each do |program|
         platforms  += program["platform"].map {|p| p["platformId"].to_i}
       end
       platforms
     end
     
+    # Period request
     def period(startDate, endDate)  
       { startDate: startDate, endDate: endDate }
     end
     
+    # Programs: Array of programNumber integers
     # @return [Array]
     def programs
-      getPlatformList["data"]["program"].map {|p| p["programNumber"].to_i }
+      platformList = getPlatformList
+      if platformList.key?("data") and platformList["data"].key?("program")
+        platformList["data"]["program"].map {|p| p["programNumber"].to_i }
+      else
+        raise platformList
+      end
     end
 
     # @return [String]
@@ -284,7 +318,7 @@ module Argos
 
       # Handle faults (before extracting data)
       _envelope.xpath("soap:Body/soap:Fault", namespaces).each do | fault |
-        raise fault.to_s
+        raise Exception, fault.to_s
       end
       
       # Extract data
@@ -297,8 +331,17 @@ module Argos
       # Handle errors
       ng = Nokogiri.XML(xml)
       ng.xpath("/data/errors/error").each do | error |
-        raise error.to_s
-        # FIXME Custom exception so that it mighht be trapped on raw responses...
+        if error.key?("code")
+          case error["code"]
+          when "4"
+            raise NodataException
+          end
+          #<error code="2">max response reached</error>
+          #<errors><error code="9">start date upper than end date</error></errors>
+
+      else
+          raise error
+        end
       end
       
       # Validation

data/lib/argos/soap_command.rb

@@ -3,7 +3,14 @@ require "net/http"
 require "csv"
 
 module Argos
-
+  
+  # argos-soap command
+  #
+  # On success, data is pumped to STDOUT, on faults/errors to STDERR
+  # Examples:
+  # $ argos-soap --operation getXml
+  # $ argos-soap -o getXml --startDate="2014-03-10T00:00:00Z" --endDate="2014-03-10T23:59:59.999Z" --log-level=1
+  # $ argos-soap -o getXml --startDate="`date --date=yesterday -I`T00:00:00Z" --endDate="`date --date=yesterday -I`T23:59:59.999Z" --username=**** --password=***** > /my/argos/xml/archive/`date -I --date=yesterday`.xml
   class SoapCommand
      
     CMD = "argos-soap"
@@ -16,8 +23,8 @@ module Argos
         cmd.run
         exit(true)
       rescue => e
-        puts e
-        puts e.backtrace.join("\n")
+        STDERR.write e
+        STDERR.write e.backtrace.join("\n")
         exit(false)
       end
     end
@@ -36,6 +43,8 @@ module Argos
         opts.on("--debug", "Debug (alias for --log-level=0") do
           @param[:level] = Logger::DEBUG
         end
+        
+        # --date shorthand for 1 day startDate endDate
 
         opts.on("--format=format", "-f=format", "{ json | xml | text | raw }") do |format|
           @param[:format] = format.to_sym
@@ -64,7 +73,7 @@ module Argos
         end
         
         opts.on("--endDate=dateTime", "Set period end") do |endDate|
-          @param[:period].merge({ endDate: endDate })
+          @param[:period] = (@param[:period]||{}).merge({ endDate: endDate })
         end
         
         opts.on("--operations", "List operations") do
@@ -107,7 +116,7 @@ module Argos
       option_parser.parse!
       
       if operation.nil?
-        puts option_parser.help
+        STDOUT.write option_parser.help
         exit(false)
       end
       
@@ -120,6 +129,7 @@ module Argos
     end
     
     def run
+      begin
         @soap = Argos::Soap.new(param)
         
         @result = nil
@@ -152,33 +162,42 @@ module Argos
         else
           raise ArgumentError, "Unspported operation: #{param[:operation]}"  
         end
-        output
+        STDOUT.write output
+        
+      rescue NodataException
+        log.debug output
+      rescue => e
+        STDERR.write output
+      end
 
     end
     
     protected
     
     def output
+      
       if debug?
         log.debug "#{CMD} param: #{param.to_json}"
         log.debug "$ curl -XPOST #{Argos::Soap::URI} -d'#{soap.request}' -H \"Content-Type: application/soap+xml\""
       end
+      
       if result.is_a? Savon::Response
         @result = result.raw
       end
       
-      case format.to_sym
+      output = case format.to_sym
       
       when :ruby
-        puts result
+        result
       when :json
-        puts result.to_json
+        result.to_json
       when :text
-        puts soap.text
+        soap.text
       when :raw
-        puts soap.raw
+        soap.raw
       when :xml
-        puts soap.xml
+        # Return XML with parameter and time in trailing comment
+        soap.xml+xml_trailer
       else
         raise ArgumentError, "Unknown format: #{format}"
       end
@@ -197,5 +216,9 @@ module Argos
       [:getCsv, :getStreamXml, :getKml, :getXml, :getXsd, :getPlatformList, :getObsCsv, :getObsXml] 
     end
     
+    def xml_trailer
+      "<!-- #{Argos.library_version} #{param.reject {|k,v| k =~ /^password$/}.to_json} now: #{Time.now.utc.xmlschema} -->"
+    end
+    
   end
 end

data/lib/argos.rb

@@ -12,7 +12,7 @@ require_relative "argos/ascii"
 require_relative "argos/ds"
 require_relative "argos/diag"
 require_relative "argos/soap"
-require_relative "argos/download"
+#require_relative "argos/download"
 
 # Argos library containg
 # * Parsers for Argos legacy ASCII files (DS/DAT and DIAG files)
@@ -25,7 +25,7 @@ require_relative "argos/download"
 # 
 # For information about Argos, see: http://www.argos-system.org
 module Argos
-  VERSION = "1.1.0"
+  VERSION = "1.1.2"
   
   def self.library_version
     "argos-ruby-#{VERSION}" 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: argos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Espen Egeland
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec