vatsim_online 0.3 → 0.4

data/README.md

@@ -6,11 +6,9 @@ online ATC and/or pilots for given airports, areas or globally. Stations are
 returned as objects, exposing a rich set of attributes. Vatsim data is pulled
 on preset intervals and cached locally to avoid flooding the servers.
 
-### Badges of (dis)honour
-
-* Testing (Travis CI): [![Build Status](https://secure.travis-ci.org/tarakanbg/vatsim_online.png?branch=master)](http://travis-ci.org/tarakanbg/vatsim_online)
-* Code Analysis (CodeClimate): [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tarakanbg/vatsim_online)
-* Dependencies: (Gemnasium) [![Gemnasium](https://gemnasium.com/tarakanbg/vatsim_online.png?travis)](https://gemnasium.com/tarakanbg/vatsim_online)
+[![Build Status](https://secure.travis-ci.org/tarakanbg/vatsim_online.png?branch=master)](http://travis-ci.org/tarakanbg/vatsim_online)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tarakanbg/vatsim_online)
+[![Gemnasium](https://gemnasium.com/tarakanbg/vatsim_online.png?travis)](https://gemnasium.com/tarakanbg/vatsim_online)
 
 ## Requirements
 
@@ -108,23 +106,42 @@ and departures.
 
 Here's a complete list of the station object attributes that can be accessed:
 
-* callsign
-* name
-* role
-* frequency
-* altitude
-* groundspeed
-* aircraft
-* origin
-* destination
-* rating
-* facility
-* remarks
-* route
-* atis
-* logon
-* latitude
-* longitude
+* `cid` (VATSIM ID)
+* `callsign`
+* `name`
+* `role`
+* `frequency`
+* `altitude`
+* `planned_altitude` (or FL)
+* `heading`
+* `groundspeed`
+* `transponder`
+* `aircraft`
+* `origin`
+* `destination`
+* `route`
+* `rating`
+* `facility`
+* `remarks`
+* `atis`
+* `logon` (login time)
+* `latitude`
+* `longitude`
+* `latitude_humanized` (e.g. N44.09780)
+* `longitude_humanized` (e.g. W58.41483)
+* `qnh_in` (set QNH in inches Hg)
+* `qnh_mb` (set QNH in milibars/hectopascals)
+* `flight_type` (`I` for IFR, `V` for VFR, etc)
+* `gcmap` (returns a great circle map image url)
+
+### Great circle map visualization
+
+The `.gcmap` method, available for all pilot stations, returns a great
+circle map image url, depicting the GC route of the aircraft, its origin and destination,
+its current position on the route, together with its current altitude and groundspeed.
+Example picture below.
+
+![GC Map](http://www.gcmap.com/map?P=kdfw-N44.09780+W58.41483-egll,+%22AAL026%5cn37112+ft%5cn516+kts%22%2b%40N44.09780+W58.41483&MS=wls&MR=540&MX=720x360&PM=*)
 
 ### Customizing the request
 
@@ -195,8 +212,10 @@ end
     = pilot.origin
     = pilot.destination
     = pilot.route
+    = pilot.flight_type
     = pilot.altitude
     = pilot.groundspeed
+    = pilot.heading
     = pilot.remarks
 
 - for arrival in @arrivals
@@ -226,6 +245,17 @@ current algorithm does not evaluate enroute flights.
 
 ## Changelog
 
+### v. 0.4 - 27 August 2012
+
+* GCMapper integration: this library now plays nicely with [gcmapper](https://rubygems.org/gems/gcmapper).
+A new attribute is provided for the pilot stations: `.gcmap` which returns a great
+circle map image url, depicting the GC route of the aircraft, its origin and destination,
+its current position on the route, together with its current altitude and groundspeed.
+Look at the example in the README section above.
+* New station attributes: planned_altitude, transponder, heading, qnh_in, qnh_mb,
+flight_type, cid, latitude_humanized, longitude_humanized
+
+
 ### v. 0.3 - 22 July 2012
 
 * The hash returned by the `vatsim_online` method now includes 2 new arrays:
@@ -251,3 +281,16 @@ original Vatsim data is re-encoded
 4. Make sure all tests are passing!
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
+
+## Credits
+
+Copyright © 2012 [Svilen Vassilev](http://about.me/svilen)
+
+*If you find my work useful or time-saving, you can endorse it or buy me a beer:*
+
+[![endorse](http://api.coderwall.com/svilenv/endorse.png)](http://coderwall.com/svilenv)
+[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5FR7AQA4PLD8A)
+
+Released under the [MIT LICENSE](https://github.com/tarakanbg/airdata/blob/master/LICENSE)
+
+Maps generated by the [Great Circle Mapper](http://www.gcmap.com/), copyright Karl L. Swartz

data/lib/vatsim_online/station.rb

@@ -1,17 +1,23 @@
 # encoding: utf-8
 module VatsimTools
   class Station
+    require "gcmapper"
+
     attributes = %w{callsign name role frequency altitude groundspeed aircraft
-      origin destination rating facility remarks route atis logon latitude longitude}
+      origin destination rating facility remarks route atis logon latitude longitude
+      planned_altitude transponder heading qnh_in qnh_mb flight_type cid gcmap
+      latitude_humanized longitude_humanized}
     attributes.each {|attribute| attr_accessor attribute.to_sym }
 
 
     def initialize(station)
       @callsign = station[0]
+      @cid = station[1]
       @name = station[2]
       @role = station[3]
       @frequency = station[4]
       @altitude = station[7]
+      @planned_altitude = station[12]
       @groundspeed = station[8]
       @aircraft = station[9]
       @origin = station[11]
@@ -23,7 +29,37 @@ module VatsimTools
       @atis = atis_cleaner(station[35]) if station[35]
       @logon = station[37]
       @latitude = station[5]
+      @latitude_humanized = latitude_parser(station[5].to_f)
       @longitude = station[6]
+      @longitude_humanized = longitude_parser(station[6].to_f)
+      @transponder = station[17]
+      @heading = station[38]
+      @qnh_in = station[39]
+      @qnh_mb = station[40]
+      @flight_type = station[21]
+      @gcmap = gcmap_generator
+    end
+
+  private
+
+    def gcmap_generator
+      return "No map for ATC stations" if @role != "PILOT"
+      route = @origin
+      route += "-" + @latitude_humanized + "+" + @longitude_humanized
+      route += "-" + @destination
+      route += "%2C+\"" + @callsign + "%5Cn" + @altitude + "+ft%5Cn" + @groundspeed + "+kts"
+      route += "\"%2B%40" + @latitude_humanized + "+" + @longitude_humanized
+      route.gcmap
+    end
+
+    def latitude_parser(lat)
+      lat > 0 ? hemisphere = "N" : hemisphere = "S"
+      hemisphere + lat.abs.to_s
+    end
+
+    def longitude_parser(lon)
+      lon > 0 ? hemisphere = "E" : hemisphere = "W"
+      hemisphere + lon.abs.to_s
     end
 
     def atis_cleaner(raw_atis)

data/lib/vatsim_online/version.rb

@@ -1,3 +1,3 @@
 module VatsimOnline
-  VERSION = "0.3"
+  VERSION = "0.4"
 end

data/spec/vatsim_online_spec.rb

@@ -49,8 +49,42 @@ describe VatsimTools::Station do
       new_object.facility.should eq("5")
       new_object.logon.should eq("20120722092836")
       new_object.latitude.should eq("2.93968")
+      new_object.latitude_humanized.should eq("N2.93968")
       new_object.longitude.should eq("101.39812")
+      new_object.longitude_humanized.should eq("E101.39812")
     end
   end
 
+  describe "pilot object" do
+    it "should contain all attributes" do
+      gem_data_file
+      icao = "EGLL"
+      station = VatsimTools::StationParser.new(icao).stations.first
+      new_object = VatsimTools::Station.new(station)
+      new_object.callsign.should eq("AAL026")
+      new_object.name.should eq("Manuel Santillan MMCU")
+      new_object.role.should eq("PILOT")
+      new_object.latitude.should eq("44.09780")
+      new_object.latitude_humanized.should eq("N44.0978")
+      new_object.longitude.should eq("-58.41483")
+      new_object.longitude_humanized.should eq("W58.41483")
+      new_object.planned_altitude.should eq("370")
+      new_object.transponder.should eq("4122")
+      new_object.heading.should eq("73")
+      new_object.qnh_in.should eq("30.12")
+      new_object.qnh_mb.should eq("1019")
+      new_object.flight_type.should eq("I")
+      new_object.cid.should eq("1210329")
+    end
+
+    it "should generate gcmap link" do
+      gem_data_file
+      icao = "EGLL"
+      station = VatsimTools::StationParser.new(icao).stations.first
+      new_object = VatsimTools::Station.new(station)
+      new_object.gcmap.should eq("http://www.gcmap.com/map?P=KDFW-N44.0978+W58.41483-EGLL%2C+\"AAL026%5Cn37210+ft%5Cn543+kts\"%2B%40N44.0978+W58.41483%0d%0a&MS=wls&MR=120&MX=720x360&PM=b:disc7%2b\"%25U%25+%28N\"")
+    end
+
+  end
+
 end

data/vatsim_online.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "guard-rspec"
   gem.add_dependency "curb", "~> 0.8.1"
   gem.add_dependency "time_diff", "~> 0.2.2"
+  gem.add_dependency "gcmapper", "~> 0.3"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vatsim_online
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-22 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -123,6 +123,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: gcmapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: Selectively pulls and parses Vatsim online stations data. Essentially
   it's a 'who's online' library, capable of displaying online ATC and/or pilots for
   given airports, areas or globally. Stations are returned as objects, exposing a