vatsim_online 0.7.4.2 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccda7b2ddbfb35697808562a8201ac17466b26e9
-  data.tar.gz: 8e91f5a41cfe728dd263084536914510b0901654
+  metadata.gz: aaa2f18f60a9b48067065d398a31713df9fb5417
+  data.tar.gz: c074d77a202f76faf0d9626a7e42620e8d9e8c57
 SHA512:
-  metadata.gz: 55b2c7626b580ef8a215acbbf8f32af92ed99ef3f95c9c0568eeff2ced137650172109c9fd27186404bb4670bce2522e0d25eba371f3c8e701c105e3d4c60788
-  data.tar.gz: 14a4c16e851efe4145f24ebaf16872366317d24ad6d893e03443551d139239eee33ec6975b2d3dd52674fadbe74145044cd966d2c63b05ad581c57c148db8b6a
+  metadata.gz: 513e26e2992fcd07a6a9ba7997a92f7411275bc83217b375a503c89f2d6b04d2c21986682f7819da420cbe485ea21592436b8bfa0240bb11b945a8176854a464
+  data.tar.gz: d4edd8ed2ab1534a855fbbbaf90546918f6ee09be4d8dff76497c75a43da2916ec1edcd4279dc4611f9d505156259a0ed28b0bd62bf9cd25720dafc1996d0060

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Changelog
 
+### v. 0.8 - 5 October 2013
+
+* search by callsign implemented
+
+### v. 0.7.4 - 2 August 2013
+
+* fallback scenarios for offline data servers
+
 ### v. 0.7.2 - 15 July 2013
 
 * added gemspec license declaration

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby gem for selectively pulling, parsing and displaying 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
+online ATC and/or pilots for given airports, areas or globally and to filter by callsign. 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.
 
@@ -31,11 +31,20 @@ Or install it yourself as:
 
 ## Usage
 
-This gem provides one public method: `vatsim_online`, which can be applied to
+This gem provides two public methods:
+
+* `vatsim_online`, which can be applied to
 any string (or variable containing a string) representing a full or partial ICAO
 code or a comma-separated list of ICAO codes. The provided ICAO code or fragment
 will be used as a search criteria and matched against the current vatsim data.
 
+* `vatsim_callsign`, which can be applied to
+any string (or variable containing a string) representing a full or partial pilot or ATC
+callsign or a comma-separated list of callsigns. The provided callsign or fragment
+will be used as a search criteria and matched against the current vatsim data.
+
+### Filter by ICAO code examples
+
 For example if you want to retrieve all active stations (ATC positions and pilots)
 for Vienna airport (ICAO: LOWW), then you can use:
 
@@ -74,6 +83,21 @@ return the pilots that are flying **to or from** the given area or airport,
 not the current enroute stations. The discovery algorithm is based on **origin
 and destination**.
 
+### Filter by callsign examples
+
+```ruby
+# Attaching the method directly to a string:
+"BAW".vatsim_callsign # => returns an array of all Speedbird flights as station objects
+
+# Attaching the method to a variable containing a string:
+callsign = "BAW"
+callsign.vatsim_callsign # => returns an array of all Speedbird flights as station objects
+
+# Attaching the method to a list of callsigns:
+callsign = "BAW, RYR"
+callsign.vatsim_callsign # => returns an array of all Speedbird and Ryanair flights as station objects
+```
+
 
 ### Anatomy of method returns
 
@@ -113,6 +137,8 @@ p1.remarks #=> "/V/ RMK/CHARTS"
 want to loop through them separately. The `pilots` array contains all arrivals
 and departures.
 
+The `vatsim_callsign` method returns an **array** of all matching stations.
+
 ### Station attributes
 
 Here's a complete list of the station object attributes that can be accessed:
@@ -306,6 +332,14 @@ the same result.
 
 ## Changelog
 
+### v. 0.8 - 5 October 2013
+
+* search by callsign implemented
+
+### v. 0.7.4 - 2 August 2013
+
+* fallback scenarios for offline data servers
+
 ### v. 0.7.2 - 15 July 2013
 
 * added gemspec license declaration

data/lib/vatsim_online.rb

@@ -1,10 +1,14 @@
 %w{vatsim_online/version vatsim_online/station vatsim_online/data_downloader
-   vatsim_online/station_parser}.each { |lib| require lib }
+   vatsim_online/station_parser vatsim_online/callsign_parser}.each { |lib| require lib }
 
 class String
   def vatsim_online(args={})
     VatsimOnline.vatsim_online(self, args)
   end
+
+  def vatsim_callsign(args={})
+    VatsimOnline.vatsim_callsign(self, args)
+  end
 end
 
 module VatsimOnline
@@ -13,4 +17,8 @@ module VatsimOnline
     VatsimTools::StationParser.new(icao,args).sorted_station_objects
   end
 
+  def self.vatsim_callsign(callsign, args)
+    VatsimTools::CallsignParser.new(callsign,args).station_objects
+  end
+
 end

data/lib/vatsim_online/callsign_parser.rb

@@ -0,0 +1,54 @@
+module VatsimTools
+
+  class CallsignParser
+
+    %w{tmpdir csv}.each { |lib| require lib }
+    require_relative "data_downloader"
+    require_relative "station"
+
+    attributes = %w{role callsign gcmap_width gcmap_height}
+    attributes.each {|attribute| attr_accessor attribute.to_sym }
+
+    LOCAL_DATA = "#{Dir.tmpdir}/vatsim_data.txt"
+
+    def initialize(callsign, args = nil)
+      VatsimTools::DataDownloader.new
+      # args.class == Hash ? @role = determine_role(args) : @role = "all"
+      @callsign = callsign.upcase.split(',').each {|s| s.strip!}
+      # @excluded = args[:exclude].upcase if args && args[:exclude]
+      @gcmap_width = args[:gcmap_width] if args && args[:gcmap_width]
+      @gcmap_height = args[:gcmap_height] if args && args[:gcmap_height]
+    end
+
+    # def determine_role(args)
+    #   args[:atc] == false ? role = "pilot" : role = "all"
+    #   args[:pilots] == false ? role = "atc" : role = role
+    #   role = "all" if args[:pilots] == false && args[:atc] == false
+    #   role
+    # end
+
+
+    def stations
+      stations = []
+      CSV.foreach(LOCAL_DATA, :col_sep =>':') do |row|
+        callsign, origin, destination, client = row[0].to_s, row[11].to_s, row[13].to_s, row[3].to_s
+        for cs in @callsign
+          stations << row if callsign[0...cs.length] == cs # && client == "ATC") unless @role == "pilot"
+          # stations << row if (origin[0...icao.length] == icao || destination[0...icao.length] == icao) unless @role == "atc"
+        end
+      end
+      stations
+    end
+
+    def station_objects
+      station_objects= []
+      args = {}
+      args[:gcmap_width] = @gcmap_width if @gcmap_width
+      args[:gcmap_height] = @gcmap_height if @gcmap_height
+      stations.each {|station| station_objects << VatsimTools::Station.new(station, args) }
+      station_objects
+    end
+
+  end
+
+end

data/lib/vatsim_online/data_downloader.rb

@@ -60,6 +60,7 @@ module VatsimTools
       File.open(LOCAL_DATA, "w+") {|f| f.write(data)}
       File.chmod(0777, LOCAL_DATA)
       gem_data_file if curl.include? "<html><head>"
+      gem_data_file if File.open(LOCAL_DATA).size == 0
     rescue Curl::Err::HostResolutionError
       gem_data_file
     rescue Curl::Err::TimeoutError

data/lib/vatsim_online/version.rb

@@ -1,3 +1,3 @@
 module VatsimOnline
-  VERSION = "0.7.4.2"
+  VERSION = "0.8"
 end

data/spec/callsign_parser_spec.rb

@@ -0,0 +1,29 @@
+require 'vatsim_online'
+require 'callsign_parser_spec_helper.rb'
+
+describe VatsimTools::CallsignParser do
+
+  target = VatsimTools::CallsignParser
+
+  describe "stations" do
+    it "should return an expected result" do
+      gem_data_file
+      callsign = "WMKK"
+      target.new(callsign).stations.first[0].should eq("WMKK_APP")
+      target.new(callsign).stations.class.should eq(Array)
+    end   
+  end
+
+  describe "station_objects" do
+    it "should return an array of Station objects" do
+      gem_data_file
+      callsign = "LO"
+      target.new(callsign).station_objects.class.should eq(Array)
+      target.new(callsign).station_objects.size.should eq(2)
+      target.new(callsign).station_objects.first.class.should eq(VatsimTools::Station)
+      target.new(callsign).station_objects.first.callsign.should eq("LOT282")
+    end
+  end
+
+  
+end

data/spec/callsign_parser_spec_helper.rb

@@ -0,0 +1,7 @@
+def gem_data_file
+  path = File.realpath("spec/vatsim_data.txt")
+  gem_data = File.open(path, :encoding => 'iso-8859-15').read
+  data = Tempfile.new('vatsim_data', :encoding => 'iso-8859-15')
+  data.write(gem_data.gsub(/["]/, '\s').force_encoding('iso-8859-15'))
+  File.rename data.path, "#{Dir.tmpdir}/vatsim_data.txt"
+end

data/spec/vatsim_data.txt

@@ -511,11 +511,5 @@ UK:109.169.48.148:London, UK:UK:1:
 USA-E:173.45.78.10:Ohio, USA:USA East:1:
 USA-N:204.244.237.21:Vancouver, CANADA:USA North:1:
 USA-W:64.151.108.52:San Francisco, USA:West USA:1:
-;
-;
-!PREFILE:
-BAW248:1216383:Raimo Ingland EETN:::::::H/B77W/Q:490:SBGL:FL310:EGLL:::::::0:I:1050:1050:11:10:12:40:EGKK:+VFPS+/V/TROPICALSIM/SBGL UK2000/EGLL PSS/77W AIRAC/1207 SEL/EKLQ RMK/CHARTS RMK/TCAS RMK/STEP CLIMB UP TO FL370 OPR/BAVIRTUAL:ESMAP UZ1 KIGOK UZ1 TROVA UN866 MSS UN866 DEKON UN866 APASO UN866 GOMER UN981 BIMBO DCT AGADO UN866 QPR UN472 JSY UN472 REVTU UP87 DOMUT:0:0:0:0:::::::
-THY17:1216592:Can Acar:::::::H/B77W/S:490:LTBA:32000:CYYZ:::::::0:I:1030:1030:10:0:12:15:CYYR:+VFPS+/V/REG/TCJJN SEL/GLDM DOF/120722 OPR/THY RMK/ADSB TCAS EQUIPPED DAT/SV NAV/RNAV1 RNP5 RNVD1A1 RALT/EINN CYYR:N0490F320 IBLAL UP727 BGS UL622 NARKA UL867 TEPNI UL624 LABUK UY444 ELMEK UL602 TABAT/N0480F340 UL602 KEMAD DCT RAVLO UY70 OTBED UL26 PENIL UL70 BAGSO DCT RESNO/M083F340 DOLIP 52N015W/M08F360 52N020W 53N030W 53N040W 52N050W CRONO DOTTY STEAM/N0480F380 N230E YRI DCT POLTY/0942:0:0:0:0:::::::
-VOZ894:1007572:James Kittelty - YMML:::::::B738/Q:441:YSSY:F380:YMML:::::::0:I:1100:1100:1:20:3:0:YMAV:+VFPS+/V/REG/VHYIG SEL/MRCP OPR/VOZ VIRTUAL PER/C NAV/RNP10 GPSRNAV RMK/ADSB TCAS EQUIPPED:DCT SY H65 RAZZI Q29 ML DCT:0:0:0:0:::::::
-;
+
 ;   END

data/spec/vatsim_online_spec.rb

@@ -32,6 +32,25 @@ describe VatsimOnline do
     end
   end
 
+  describe "vatsim_callsign" do
+    it "should work :)" do
+      gem_data_file
+      "AMZ1105".vatsim_callsign.class.should eq(Array)
+      "AMZ1105".vatsim_callsign.size.should eq(1)
+      "AMZ1105".vatsim_callsign.first.callsign.should eq("AMZ1105")      
+      "BAW".vatsim_callsign.size.should eq(15)
+      "BAW".vatsim_callsign.last.callsign.should eq("BAW9DV")      
+      "BAW, AMZ1105".vatsim_callsign.size.should eq(16)
+      "BAW, QFA".vatsim_callsign.size.should eq(21)
+      
+    end
+
+    it "should be case insensitive" do
+      gem_data_file
+      "amz1105".vatsim_callsign.first.callsign.should eq("AMZ1105")
+    end
+  end
+
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vatsim_online
 version: !ruby/object:Gem::Version
-  version: 0.7.4.2
+  version: '0.8'
 platform: ruby
 authors:
 - Svilen Vassilev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -157,12 +157,15 @@ files:
 - README.md
 - Rakefile
 - lib/vatsim_online.rb
+- lib/vatsim_online/callsign_parser.rb
 - lib/vatsim_online/data_downloader.rb
 - lib/vatsim_online/station.rb
 - lib/vatsim_online/station_parser.rb
 - lib/vatsim_online/vatsim_data.txt
 - lib/vatsim_online/vatsim_status.txt
 - lib/vatsim_online/version.rb
+- spec/callsign_parser_spec.rb
+- spec/callsign_parser_spec_helper.rb
 - spec/data_downloader_spec.rb
 - spec/data_downloader_spec_helper.rb
 - spec/spec_helper.rb
@@ -201,6 +204,8 @@ summary: Selectively pulls and parses Vatsim online stations data. Essentially i
   of attributes. Vatsim data is pulled on preset intervals and cached locally to avoid
   flooding the servers.
 test_files:
+- spec/callsign_parser_spec.rb
+- spec/callsign_parser_spec_helper.rb
 - spec/data_downloader_spec.rb
 - spec/data_downloader_spec_helper.rb
 - spec/spec_helper.rb