marinetraffic 0.0.5 → 0.0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f01e7fa9707d497da72d9ef6e12eb34d535fba5
-  data.tar.gz: 6b0c19cc2e002b3df7d665490807ab82b63eb158
+  metadata.gz: dca7779891746440b8e9417d557e58ca35df826c
+  data.tar.gz: 385169c61fa198c1ea5b5665f6b1573100a18de8
 SHA512:
-  metadata.gz: 14fd7b860b44c1e8d3c50e19623e256be04c567577f8e6ec592ece9d2053c61a97f2f3256aed42a73f438fc9c2344f533ec11afe15ca5aa32c19331599589089
-  data.tar.gz: 745922760aec1ac8e7bbd79045125dbd031294e657a66aa9a85172182060b2ad074f6a5fc8ef7c14c5a20bbc57de78564be33d25ab86a748911b90a66817f4a9
+  metadata.gz: 58f77469499e90d3eed2ac155e78604b4821ee0492c02d8b6988896b2c82f85512c21e0ca6cd6ba0ba68b33bc77f0effe908a67d8f200ccd24a857cade8d94af
+  data.tar.gz: b0737a76b56f8dd098580efb557833b6721c47320ea333136c506449f86e18032a1545ecda3bd70406e9e367c844d0767bc73ab2c270901e66623de6390b5b5e

data/lib/marinetraffic.rb

@@ -1,9 +1,16 @@
 require "marinetraffic/version"
-require "marinetraffic/vessel"
 require "marinetraffic/api"
+require "marinetraffic/vessel"
+require "marinetraffic/subscription"
+
+require "marinetraffic/errors/marinetraffic_error"
+require "marinetraffic/errors/authentication_error"
+require "marinetraffic/errors/api_error"
 
 module Marinetraffic
+  @api_base = 'http://services.marinetraffic.com/api'
+
   class << self
-    attr_accessor :api_key
+    attr_accessor :api_key, :api_base
   end
 end

data/lib/marinetraffic/api.rb

@@ -1,26 +1,30 @@
 require 'faraday'
 require 'nokogiri'
 
-API_URL = "http://services.marinetraffic.com/api"
-
 module Marinetraffic
   class API
     def self.call(name, params = {})
+      api_key = params.delete(:api_key)
+
+      unless api_key ||= Marinetraffic.api_key
+        raise AuthenticationError.new('No API key provided. ' \
+          'Set your API key using "Marinetraffic.api_key = <API-KEY>" ' \
+          'or pass it as parameter to your request.')
+      end
+
       params[:protocol] = :xml
       param_string = params.map{|attr| "#{attr.first}:#{attr.last}"}.join('/')
-      url = "#{API_URL}/#{name}/#{Marinetraffic.api_key}/#{param_string}"
+      url = "#{Marinetraffic.api_base}/#{name}/#{api_key}/#{param_string}"
       response = Faraday.get(url)
       doc = Nokogiri::XML(response.body)
-      raise_exception(doc) if doc.xpath('//ERROR').any?
+      handle_api_error(response, doc) if doc.xpath('//ERROR').any?
       doc
     end
 
-    def self.raise_exception(doc)
-      message = doc.xpath("//ERROR")[0]['DESCRIPTION']
-      raise MarinetrafficException.new(message)
+    def self.handle_api_error(response, doc)
+      error = doc.xpath('//ERROR')[0]['DESCRIPTION']
+      code = doc.xpath('//ERROR')[0]['CODE']
+      raise APIError.new(error, response.status.to_s, response.body, response.headers, code)
     end
   end
-
-  class MarinetrafficException < Exception
-  end
 end

data/lib/marinetraffic/errors/api_error.rb

@@ -0,0 +1,4 @@
+module Marinetraffic
+  class APIError < MarinetrafficError
+  end
+end

data/lib/marinetraffic/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Marinetraffic
+  class AuthenticationError < MarinetrafficError
+  end
+end

data/lib/marinetraffic/errors/marinetraffic_error.rb

@@ -0,0 +1,22 @@
+module Marinetraffic
+  class MarinetrafficError < StandardError
+    attr_reader :message
+    attr_reader :error_code
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :http_headers
+
+    def initialize(message=nil, http_status=nil, http_body=nil, http_headers=nil, error_code=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @http_headers = http_headers || {}
+      @error_code = error_code
+    end
+
+    def to_s
+      code_string = @error_code.nil? ? "" : "(Error #{@error_code}) "
+      "#{code_string}#{@message}"
+    end
+  end
+end

data/lib/marinetraffic/subscription.rb

@@ -0,0 +1,31 @@
+module Marinetraffic
+  class Subscription
+    attr_accessor :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def find(mmsi, extended = false, options = {})
+      params = { api_key: api_key }.merge(options)
+      params[:msgtype] = :extended if extended
+      response = API.call(:exportvessels, params)
+      result = response.xpath("//row[@MMSI=#{mmsi}]")[0]
+
+      if result != nil
+        attributes = Marinetraffic::Vessel.map_attributes(result, extended)
+        Marinetraffic::Vessel.new(attributes)
+      end
+    end
+
+    def all(extended = false, options = {})
+      params = { timespan: 20, api_key: api_key }.merge(options)
+      params[:msgtype] = :extended if extended
+      response = API.call(:exportvessels, params)
+      result = response.xpath("//row").map do |row|
+        attributes = Marinetraffic::Vessel.map_attributes(row, extended)
+        Marinetraffic::Vessel.new(attributes)
+      end
+    end
+  end
+end

data/lib/marinetraffic/version.rb

@@ -1,3 +1,3 @@
 module Marinetraffic
-  VERSION = "0.0.5"
+  VERSION = "0.0.6.1"
 end

data/lib/marinetraffic/vessel.rb

@@ -115,7 +115,7 @@ module Marinetraffic
     # 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
+      case ship_type.to_s[0].to_i
       when 1
         'Reserved'
       when 2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marinetraffic
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6.1
 platform: ruby
 authors:
 - Fabio Kuhn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2015-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -156,6 +156,10 @@ files:
 - bin/setup
 - lib/marinetraffic.rb
 - lib/marinetraffic/api.rb
+- lib/marinetraffic/errors/api_error.rb
+- lib/marinetraffic/errors/authentication_error.rb
+- lib/marinetraffic/errors/marinetraffic_error.rb
+- lib/marinetraffic/subscription.rb
 - lib/marinetraffic/version.rb
 - lib/marinetraffic/vessel.rb
 - marinetraffic.gemspec