marinetraffic 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ab07ecf1a910c6ae8f99a2939cbcae009072f44
-  data.tar.gz: 5b4a121d569831974c084de80b023b8434b0dafe
+  metadata.gz: d0009285cd9ec60abb0264806ae7e1efdd054828
+  data.tar.gz: d9a588dba5761380f20b6e3c59d09d926c992cf1
 SHA512:
-  metadata.gz: 31a763348e24afa158793877569edccbafa0c94b54c65066ae45886eb3cba187bf64249099f7d556d348a067cf9f95d892ecbe980ef3ae0c5771a225b13117cd
-  data.tar.gz: fe58b988362cc59f33d34428dfd1f737964f417f9b54be4fb1f209306bf19cb7b1eabe6665f87f71c4b84766d30de2cd52bca44af1710137e4447befd6eca05f
+  metadata.gz: 6aa89875c1c71a660b66b97b39e438b24fd77d0e081469861574e7f6c0a8c6b8508be6bd5ac90d9ac629de80ad0860f37784993341c16a3b664ca4a6209572e3
+  data.tar.gz: 729f6793faab79abe5e610748e2f23427290da7d5b47b6582e6997ac156e78d5311c892818312d9c9ed5220a0141ba2a20f4dd70dce6f352bafae4d27c053b4b

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/**/env.yml/

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.2.0
+  - 2.2.2

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/minitest_helper\.rb$})      { 'test' }
+end

data/README.md

@@ -23,7 +23,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Authentication
+
+You authenticate to the MarineTraffic API by providing your secret API key in the request.
+To use your API key, you need only set Marinetraffic.api_key equal to the key. The Ruby library will automatically send this key in each request.
+
+```ruby
+require "stripe"
+Marinetraffic.api_key = "2571121d07b9ce09c1abc34db75606a840a2c68c"
+```
+
+### Find vessels
+
+You can call vessel informations by the Vessel.find method. This method accepts a *MMSI Number* and an optional flag for *extended data* (false by default).
+
+```ruby
+vessel = Marinetraffic::Vessel.find("311026000", true)
+vessel.mmsi      # => "311026000"
+vessel.lat       # => "54.520730"
+vessel.lng       # => "10.421800"
+vessel.ship_name # => "NINA"
+```
 
 ## Development
 

data/lib/marinetraffic.rb

@@ -1,5 +1,9 @@
 require "marinetraffic/version"
+require "marinetraffic/vessel"
+require "marinetraffic/api"
 
 module Marinetraffic
-  # Your code goes here...
+  class << self
+    attr_accessor :api_key
+  end
 end

data/lib/marinetraffic/api.rb

@@ -0,0 +1,15 @@
+require 'faraday'
+require 'json'
+
+API_URL = "http://services.marinetraffic.com/api"
+
+module Marinetraffic
+  class API
+    def self.call(name, params = {})
+      params[:protocol] = :json
+      param_string = params.map{|attr| "#{attr.first}:#{attr.last}"}.join('/')
+      url = "#{API_URL}/#{name}/#{Marinetraffic.api_key}/#{param_string}"
+      response = Faraday.get(url)
+    end
+  end
+end

data/lib/marinetraffic/version.rb

@@ -1,3 +1,3 @@
 module Marinetraffic
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/marinetraffic/vessel.rb

@@ -0,0 +1,68 @@
+module Marinetraffic
+  class Vessel
+
+    attr_reader :mmsi, :lat, :lon, :speed, :course, :status, :timestamp
+    attr_reader :ship_type, :ship_name, :imo, :callsign, :flag, :current_port, :last_port, :last_port_time, :destination, :eta, :length, :draught, :grt, :dwt, :year_built
+
+    def initialize(attributes = {})
+      @mmsi = attributes["mmsi"]
+      @lat = attributes["lat"]
+      @lon = attributes["lon"]
+      @speed = attributes["speed"]
+      @course = attributes["course"]
+      @status = attributes["status"]
+      @timestamp = attributes["timestamp"]
+      @ship_type = attributes["ship_type"]
+      @ship_name = attributes["ship_name"]
+      @imo = attributes["imo"]
+      @callsign = attributes["callsign"]
+      @flag = attributes["flag"]
+      @current_port = attributes["current_port"]
+      @last_port = attributes["last_port"]
+      @last_port_time = attributes["last_port_time"]
+      @destination = attributes["destination"]
+      @eta = attributes["eta"]
+      @length = attributes["length"]
+      @draught = attributes["draught"]
+      @grt = attributes["grt"]
+      @dwt = attributes["dwt"]
+      @year_built = attributes["year_built"]
+    end
+
+    def self.find(mmsi, extended = false)
+      params = { mmsi: mmsi, timespan: 20 }
+      params[:msgtype] = :extended if extended
+      response = API.call(:exportvessel, params)
+      list = JSON.parse(response.body).first
+      attributes = map_attributes(list)
+      new(attributes)
+    end
+
+    def self.map_attributes(list)
+      attributes = {}
+      attributes["mmsi"] = list.shift
+      attributes["lat"] = list.shift
+      attributes["lon"] = list.shift
+      attributes["speed"] = list.shift
+      attributes["course"] = list.shift
+      attributes["status"] = list.shift
+      attributes["timestamp"] = list.shift
+      attributes["ship_type"] = list.shift
+      attributes["ship_name"] = 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["draught"] = list.shift
+      attributes["grt"] = list.shift
+      attributes["dwt"] = list.shift
+      attributes["year_built"] = list.shift
+      attributes
+    end
+  end
+end

data/marinetraffic.gemspec

@@ -19,6 +19,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "faraday"
+  spec.add_dependency "json"
+
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest", "~> 2.4.4"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marinetraffic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Fabio Kuhn
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'This is a API wrapper for MarineTraffic written in Ruby. You can find
   more information about the API of MarineTraffic on this page: https://www.marinetraffic.com/en/ais-api-services'
 email:
@@ -50,13 +148,16 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/marinetraffic.rb
+- lib/marinetraffic/api.rb
 - lib/marinetraffic/version.rb
+- lib/marinetraffic/vessel.rb
 - marinetraffic.gemspec
 homepage: https://github.com/mordaroso/marinetraffic.
 licenses: