marinetraffic 0.0.3.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf8f591bf3cf4c71b55288c3cb2d567e27b8e1dd
-  data.tar.gz: cbfd304fcf37660ce6f48f860da6335cb4a1a31e
+  metadata.gz: 963b7256b9a67232841c756caff1c328b95f6bc6
+  data.tar.gz: d293a6882f22a6ea43a6e674f70d2d6995779944
 SHA512:
-  metadata.gz: 2d65378cd2ecf37618d7295d4fdcc29ceaa732577622389154d4e287720d2bff8f3b1fde67e2127350bf2935025340493c96a0062142e9f1c41ec0a8799081f8
-  data.tar.gz: d86c9878b2ed9a322aa317e2ba0808573a7d965ab2f2880789c3b193df7528c06bab1be02f2218b6ab1a79e34eae3285f41635989cc2548b85f4366ab7a077e9
+  metadata.gz: 1f896e46875f2b57af4fbb4c28fe4db5c898608294a1d3c92540efd2ae036fae80063a859653826fccd701574eddab9e95bfb03b1072d9e57129e074c59c5f19
+  data.tar.gz: 9ae87d9b8c14b520cc161a3ba2f9a801d16d969dae9b9f358128da12b6585781d51e95ff7adb1f19a489652e45284b7cabf90e7cb2bfbd445b903bb1f6ade7f1

data/lib/marinetraffic/api.rb

@@ -1,15 +1,26 @@
 require 'faraday'
-require 'json'
+require 'nokogiri'
 
 API_URL = "http://services.marinetraffic.com/api"
 
 module Marinetraffic
   class API
     def self.call(name, params = {})
-      params[:protocol] = :json
+      params[:protocol] = :xml
       param_string = params.map{|attr| "#{attr.first}:#{attr.last}"}.join('/')
       url = "#{API_URL}/#{name}/#{Marinetraffic.api_key}/#{param_string}"
       response = Faraday.get(url)
+      doc = Nokogiri::XML(response.body)
+      raise_exception(doc) if doc.xpath('//ERROR').any?
+      doc
     end
+
+    def self.raise_exception(doc)
+      message = doc.xpath("//ERROR")[0]['DESCRIPTION']
+      raise MarinetrafficException.new(message)
+    end
+  end
+
+  class MarinetrafficException < Exception
   end
-end
+end

data/lib/marinetraffic/version.rb

@@ -1,3 +1,3 @@
 module Marinetraffic
-  VERSION = "0.0.3.1"
+  VERSION = "0.0.4"
 end

data/lib/marinetraffic/vessel.rb

@@ -34,41 +34,103 @@ module Marinetraffic
       params = { mmsi: mmsi, timespan: 20 }.merge(options)
       params[:msgtype] = :extended if extended
       response = API.call(:exportvessel, params)
-      list = JSON.parse(response.body).first
-      attributes = map_attributes(list, extended)
+      attributes = map_attributes(response.xpath("//row")[0], extended)
       new(attributes)
     end
 
-    def self.map_attributes(list, extended)
+    def self.map_attributes(response, extended)
       attributes = {}
-      attributes["mmsi"] = list.shift
-      attributes["lat"] = list.shift
-      attributes["lon"] = list.shift
-      attributes["speed"] = list.shift
-      attributes["course"] = list.shift
+      attributes["mmsi"] = response['MMSI']
+      attributes["lat"] = response['LAT'].to_f
+      attributes["lon"] = response['LON'].to_f
+      attributes["speed"] = response['SPEED'].to_i
+      attributes["course"] = response['COURSE'].to_i
       if extended
-        attributes["timestamp"] = list.shift
-        attributes["ship_name"] = list.shift
-        attributes["ship_type"] = list.shift
-        attributes["imo"] = list.shift
-        attributes["callsign"] = list.shift
-        attributes["flag"] = list.shift
-        attributes["current_port"] = list.shift
-        attributes["last_port"] = list.shift
-        attributes["last_port_time"] = list.shift
-        attributes["destination"] = list.shift
-        attributes["eta"] = list.shift
-        attributes["length"] = list.shift
-        attributes["width"] = list.shift
-        attributes["draught"] = list.shift
-        attributes["grt"] = list.shift
-        attributes["dwt"] = list.shift
-        attributes["year_built"] = list.shift
+        attributes["timestamp"] = response['TIMESTAMP']
+        attributes["ship_name"] = response['SHIPNAME']
+        attributes["ship_type"] = response['SHIPTYPE'].to_i
+        attributes["imo"] = response['IMO']
+        attributes["callsign"] = response['CALLSIGN']
+        attributes["flag"] = response['FLAG']
+        attributes["current_port"] = response['CURRENT_PORT']
+        attributes["last_port"] = response['LAST_PORT']
+        attributes["last_port_time"] = response['LAST_PORT_TIME']
+        attributes["destination"] = response['DESTINATION']
+        attributes["eta"] = response['ETA']
+        attributes["length"] = response['LENGTH'].to_i
+        attributes["width"] = response['WIDTH'].to_i
+        attributes["draught"] = response['DRAUGHT'].to_i
+        attributes["grt"] = response['GRT'].to_i
+        attributes["dwt"] = response['DWT'].to_i
+        attributes["year_built"] = response['YEAR_BUILT'].to_i
       else
-        attributes["status"] = list.shift
-        attributes["timestamp"] = list.shift
+        attributes["status"] = response['STATUS'].to_i
+        attributes["timestamp"] = response['TIMESTAMP']
       end
       attributes
     end
+
+    # http://help.marinetraffic.com/hc/en-us/articles/203990998-What-is-the-significance-of-the-AIS-Navigational-Status-Values-
+    def status_human
+      case status
+        when  0
+          'under way using engine'
+        when  1
+          'at anchor'
+        when  2
+          'not under command '
+        when  3
+          'restricted maneuverability'
+        when  4
+          'constrained by her draught'
+        when  5
+          'moored'
+        when  6
+          'aground '
+        when  7
+          'engaged in fishing'
+        when  8
+          'under way sailing'
+        when  9
+          'reserved for future amendment of navigational status for ships carrying DG, HS, or MP, or IMO hazard or pollutant category C, high-speed craft (HSC)'
+        when 10
+          'reserved for future amendment of navigational status for ships carrying dangerous goods (DG), harmful substances (HS) or marine pollutants (MP), or IMO hazard or pollutant category A, wing in ground (WIG)'
+        when 11
+          'power-driven vessel towing astern (regional use)'
+        when 12
+          'power-driven vessel pushing ahead or towing alongside (regional use)'
+        when 13
+          'reserved for future use'
+        when 14
+          'AIS-SART (active), MOB-AIS, EPIRB-AIS'
+        when 15
+          'undefined = default (also used by AIS-SART, MOB-AIS and EPIRB-AIS under test)'
+       end
+      end
+
+    # http://help.marinetraffic.com/hc/en-us/articles/205579997-What-is-the-significance-of-the-AIS-SHIPTYPE-number-
+    def ship_type_human
+      return if ship_type == nil
+      case ship_type / 10
+        when 1
+          'Reserved'
+        when 2
+          'Wing In Ground'
+        when 3
+          'Special Category'
+        when 4
+          'High-Speed Craft'
+        when 5
+          'Special Category'
+        when 6
+          'Passenger'
+        when 7
+          'Cargo'
+        when 8
+          'Tanker'
+        when 9
+          'Other'
+        end
+      end
   end
-end
+end

data/marinetraffic.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday"
-  spec.add_dependency "json"
+  spec.add_dependency "nokogiri"
 
   spec.add_development_dependency "bundler", ">= 1.7.9"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marinetraffic
 version: !ruby/object:Gem::Version
-  version: 0.0.3.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Fabio Kuhn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="