vatsim 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - rbx-18mode
+  - rbx-19mode
+

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -1,12 +1,13 @@
-# vatsim.rb
+# vatsim.rb [![Build Status](https://secure.travis-ci.org/tdawe/vatsim.png?branch=master)](http://travis-ci.org/tdawe/vatsim)
 vatsim.rb is a Ruby library for retrieving online status for Pilots and ATC connections on the [VATSIM] network.
 
 [VATSIM]: http://www.vatsim.net
 
 ## Installation
-    gem install vatsim 
+    gem install vatsim
 
 ## Documentation
 [http://rdoc.info/gems/vatsim][documentation]
 
 [documentation]: http://rdoc.info/gems/vatsim
+

data/lib/vatsim.rb

@@ -1,5 +1,9 @@
 require 'vatsim/data'
 require 'vatsim/client'
+require 'vatsim/pilot'
+require 'vatsim/atc'
 require 'vatsim/prefile'
+require 'vatsim/server'
+require 'vatsim/voice_server'
 require 'vatsim/version'
 

data/lib/vatsim/atc.rb

@@ -0,0 +1,7 @@
+module Vatsim
+  # Connected pilot
+  class ATC < Client
+    attr_reader :callsign, :cid, :realname, :clienttype, :frequency, :latitude, :longitude, :server, :protrevision, :rating, :facilitytype, :visualrange, :time_logon
+  end
+end
+

data/lib/vatsim/client.rb

@@ -1,7 +1,6 @@
 module Vatsim
   # Connected clients
   class Client
-    attr_reader :callsign, :cid, :realname, :clienttype, :frequency, :latitude, :longitude, :altitude, :groundspeed, :planned_aircraft, :planned_tascruise, :planned_depairport, :planned_altitude, :planned_destairport, :server, :protrevision, :rating, :transponder, :facilitytype, :visualrange, :planned_revision, :planned_flighttype, :planned_deptime, :planned_actdeptime, :planned_hrsenroute, :planned_minenroute, :planned_hrsfuel, :planned_minfuel, :planned_altairport, :planned_remarks, :planned_route, :planned_depairport_lat, :planned_depairport_lon, :planned_destairport_lat, :planned_destairport_lon, :atis_message, :time_last_atis_received, :time_logon, :heading, :QNH_iHg, :QNH_Mb
 
     # Initialize Client with colon delimited line from vatsim-data.txt format
     def initialize line

data/lib/vatsim/data.rb

@@ -6,87 +6,79 @@ module Vatsim
   # Stores parsed data from vatsim data format
   class Data
 
-    attr_reader :clients, :prefiles, :general
+    attr_reader :pilots, :atc, :prefiles, :general, :servers, :voice_servers
 
     STATUS_URL = "http://status.vatsim.net/status.txt"
     STATUS_DOWNLOAD_INTERVAL = 60*60*6 # 6 hours
     DATA_DOWNLOAD_INTERVAL = 60*2 # 2 minutes
+    STATUS_FILE_PATH = Dir::tmpdir + "/vatsim-status.txt"
+    DATA_FILE_PATH = Dir::tmpdir + "/vatsim-data.txt"
 
-    def initialize properties = nil
-      @clients = Array.new
+    def initialize
+      @pilots = Array.new
+      @atc = Array.new
       @prefiles = Array.new
+      @servers = Array.new
+      @voice_servers = Array.new
       @general = Hash.new
 
-      @status_file_path = Dir::tmpdir + "/vatsim-status.txt"
-      @data_file_path = Dir::tmpdir + "/vatsim-data.txt"
-      @refresh_files = true
-
-      if !properties.nil?
-        @status_file_path = properties["status_file_path"] if properties.has_key?("status_file_path")
-        @data_file_path = properties["data_file_path"] if properties.has_key?("data_file_path")
-        @refresh_files = properties["download_files"] if properties.has_key?("download_files")
-      end
-
       parse
     end
 
-    # Returns all connected Pilots
-    def pilots
-      pilots = Array.new
-      @clients.each { |client|
-        pilots << client if client.clienttype.eql? "PILOT"
-      }
-      return pilots
-    end
-
-    # Returns all connected ATC
-    def atc
-      atc = Array.new
-      @clients.each { |client|
-        atc << client if client.clienttype.eql? "ATC"
-      }
-      return atc
-    end
-
     private
 
     # Parse the vatsim data file and store output as necessary
     def parse
-      download_files if @refresh_files
+      download_files
 
       parsing_clients = false
       parsing_prefile = false
       parsing_general = false
-
-      File.open(@data_file_path, 'r:ascii-8bit').each { |line|
-
-        parsing_clients = false if line.start_with? ";"
-        parsing_prefile = false if line.start_with? ";"
-        parsing_general = false if line.start_with? ";"
-
-        if parsing_clients
-          @clients << Client.new(line)
+      parsing_servers = false
+      parsing_voice_servers = false
+
+      File.open(DATA_FILE_PATH, 'r:ascii-8bit').each { |line|
+
+        if line.start_with? ";"
+          parsing_clients = false
+          parsing_prefile = false
+          parsing_general = false
+          parsing_servers = false
+          parsing_voice_servers = false
+        elsif parsing_clients
+          clienttype = line.split(":")[3]
+          if clienttype.eql? "PILOT"
+            @pilots << Pilot.new(line)
+          elsif clienttype.eql? "ATC"
+            @atc << ATC.new(line)
+          end
         elsif parsing_prefile
           @prefiles << Prefile.new(line)
         elsif parsing_general
           line_split = line.split("=")
           @general[line_split[0].strip.downcase.gsub(" ", "_")] = line_split[1].strip
+        elsif parsing_servers
+          @servers << Server.new(line)
+        elsif parsing_voice_servers
+          @voice_servers << VoiceServer.new(line) if line.length > 2 # ignore last, empty line for voice server that contains 2 characters
         end
 
         parsing_clients = true if line.start_with? "!CLIENTS:"
         parsing_prefile = true if line.start_with? "!PREFILE:"
         parsing_general = true if line.start_with? "!GENERAL:"
+        parsing_servers = true if line.start_with? "!SERVERS:"
+        parsing_voice_servers = true if line.start_with? "!VOICE SERVERS:"
       }
     end
 
     # Initialize the system by downloading status and vatsim data files
     def download_files
-      if !File.exists?(@status_file_path) or File.mtime(@status_file_path) < Time.now - STATUS_DOWNLOAD_INTERVAL
-       download_to_file STATUS_URL, @status_file_path
+      if !File.exists?(STATUS_FILE_PATH) or File.mtime(STATUS_FILE_PATH) < Time.now - STATUS_DOWNLOAD_INTERVAL
+       download_to_file STATUS_URL, STATUS_FILE_PATH
       end
 
-      if !File.exists?(@data_file_path ) or File.mtime(@data_file_path ) < Time.now - DATA_DOWNLOAD_INTERVAL
-        download_to_file random_data_url, @data_file_path
+      if !File.exists?(DATA_FILE_PATH) or File.mtime(DATA_FILE_PATH) < Time.now - DATA_DOWNLOAD_INTERVAL
+        download_to_file random_data_url, DATA_FILE_PATH
       end
     end
 
@@ -107,7 +99,7 @@ module Vatsim
     # Return random vatsim data url from status file
     def random_data_url
       url0s = Array.new
-      file = File.open(@status_file_path)
+      file = File.open(STATUS_FILE_PATH)
       file.each {|line|
         if line.start_with? "url0"
           url0s << line.split("=").last

data/lib/vatsim/pilot.rb

@@ -0,0 +1,7 @@
+module Vatsim
+  # Connected pilot
+  class Pilot < Client
+    attr_reader :callsign, :cid, :realname, :clienttype, :latitude, :longitude, :altitude, :groundspeed, :planned_aircraft, :planned_tascruise, :planned_depairport, :planned_altitude, :planned_destairport, :server, :protrevision, :rating, :transponder, :planned_revision, :planned_flighttype, :planned_deptime, :planned_actdeptime, :planned_hrsenroute, :planned_minenroute, :planned_hrsfuel, :planned_minfuel, :planned_altairport, :planned_remarks, :planned_route, :planned_depairport_lat, :planned_depairport_lon, :planned_destairport_lat, :planned_destairport_lon, :time_logon, :heading, :QNH_iHg, :QNH_Mb
+  end
+end
+

data/lib/vatsim/prefile.rb

@@ -1,7 +1,7 @@
 module Vatsim
   # Prefiled clients
   class Prefile
-    attr_reader :callsign, :cid, :realname, :clienttype, :frequency, :latitude, :longitude, :altitude, :groundspeed, :planned_aircraft, :planned_tascruise, :planned_depairport, :planned_altitude, :planned_destairport, :server, :protrevision, :rating, :transponder, :facilitytype, :visualrange, :planned_revision, :planned_flighttype, :planned_deptime, :planned_actdeptime, :planned_hrsenroute, :planned_minenroute, :planned_hrsfuel, :planned_minfuel, :planned_altairport, :planned_remarks, :planned_route, :planned_depairport_lat, :planned_depairport_lon, :planned_destairport_lat, :planned_destairport_lon, :atis_message, :time_last_atis_received, :time_logon, :heading, :QNH_iHg, :QNH_Mb
+    attr_reader :callsign, :cid, :realname, :planned_aircraft, :planned_tascruise, :planned_depairport, :planned_altitude, :planned_destairport, :planned_revision, :planned_flighttype, :planned_deptime, :planned_actdeptime, :planned_hrsenroute, :planned_minenroute, :planned_hrsfuel, :planned_minfuel, :planned_altairport, :planned_remarks, :planned_route, :planned_depairport_lat, :planned_depairport_lon, :planned_destairport_lat, :planned_destairport_lon
 
     def initialize line
       attributes = [:callsign, :cid, :realname, :clienttype, :frequency, :latitude, :longitude, :altitude, :groundspeed, :planned_aircraft, :planned_tascruise, :planned_depairport, :planned_altitude, :planned_destairport, :server, :protrevision, :rating, :transponder, :facilitytype, :visualrange, :planned_revision, :planned_flighttype, :planned_deptime, :planned_actdeptime, :planned_hrsenroute, :planned_minenroute, :planned_hrsfuel, :planned_minfuel, :planned_altairport, :planned_remarks, :planned_route, :planned_depairport_lat, :planned_depairport_lon, :planned_destairport_lat, :planned_destairport_lon, :atis_message, :time_last_atis_received, :time_logon, :heading, :QNH_iHg, :QNH_Mb]

data/lib/vatsim/server.rb

@@ -0,0 +1,19 @@
+module Vatsim
+  # Server to which clients can connect
+  class Server
+
+    attr_reader :ident, :hostname_or_IP, :location, :name, :clients_connection_allowed
+
+    # Initialize Server with colon delimited line from vatsim-data.txt format
+    def initialize line
+      attributes = [:ident, :hostname_or_IP, :location, :name, :clients_connection_allowed]
+
+      line_split = line.split(":")
+
+      attributes.each_with_index.map { |attribute, index|
+        instance_variable_set("@#{attribute}", line_split[index]) if self.respond_to?(attribute)
+      }
+    end
+  end
+end
+

data/lib/vatsim/version.rb

@@ -1,4 +1,4 @@
 module Vatsim
-  VERSION = "0.0.3" # Current gem version
+  VERSION = "0.0.4" # Current gem version
 end
 

data/lib/vatsim/voice_server.rb

@@ -0,0 +1,19 @@
+module Vatsim
+  # Voice server that clients can use
+  class VoiceServer
+
+    attr_reader :hostname_or_IP, :location, :name, :clients_connection_allowed, :type_of_voice_server
+
+    # Initialize Server with colon delimited line from vatsim-data.txt format
+    def initialize line
+      attributes = [:hostname_or_IP, :location, :name, :clients_connection_allowed, :type_of_voice_server]
+
+      line_split = line.split(":")
+
+      attributes.each_with_index.map { |attribute, index|
+        instance_variable_set("@#{attribute}", line_split[index]) if self.respond_to?(attribute)
+      }
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -1,7 +1,16 @@
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+end
+
 require 'vatsim'
+require 'webmock/rspec'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 end
+

data/spec/vatsim_spec.rb

@@ -1,32 +1,150 @@
 require 'spec_helper'
 
 describe Vatsim::VERSION do
-	it "should return a non nil version" do
-		Vatsim::VERSION.should_not == nil
- 	end
+  it "should return a non nil version" do
+    Vatsim::VERSION.should_not == nil
+ end
 end
 
 describe Vatsim::Data do
-	it "should return correct number of clients, pilots, and atc" do
-		data = Vatsim::Data.new("download_files" => false, "data_file_path" => File.dirname(__FILE__) + "/vatsim-data.txt")
-    data.clients.length.should equal(502)
-		data.pilots.length.should equal(379)
-		data.atc.length.should equal(122)
-	end
-
-  it "should return correct number of prefiled" do
-		data = Vatsim::Data.new("download_files" => false, "data_file_path" => File.dirname(__FILE__) + "/vatsim-data.txt")
+
+  before do
+    WebMock.disable_net_connect!
+    File.delete(Vatsim::Data::STATUS_FILE_PATH) if File.exists?(Vatsim::Data::STATUS_FILE_PATH)
+    File.delete(Vatsim::Data::DATA_FILE_PATH) if File.exists?(Vatsim::Data::DATA_FILE_PATH)
+    stub_request(:get, "http://status.vatsim.net/status.txt").to_return(:body => File.new(File.dirname(__FILE__) + "/vatsim-status.txt"))
+    stub_request(:get, "http://www.net-flyer.net/DataFeed/vatsim-data.txt").to_return(:body => File.new(File.dirname(__FILE__) + "/vatsim-data.txt"))
+    stub_request(:get, "http://www.klain.net/sidata/vatsim-data.txt").to_return(:body => File.new(File.dirname(__FILE__) + "/vatsim-data.txt"))
+    stub_request(:get, "http://fsproshop.com/servinfo/vatsim-data.txt").to_return(:body => File.new(File.dirname(__FILE__) + "/vatsim-data.txt"))
+    stub_request(:get, "http://info.vroute.net/vatsim-data.txt").to_return(:body => File.new(File.dirname(__FILE__) + "/vatsim-data.txt"))
+    stub_request(:get, "http://data.vattastic.com/vatsim-data.txt").to_return(:body => File.new(File.dirname(__FILE__) + "/vatsim-data.txt"))
+  end
+
+  it "should return correct number of pilots, prefiles, servers, and atc" do
+    data = Vatsim::Data.new
+    data.pilots.length.should equal(379)
+    data.atc.length.should equal(122)
+    data.servers.length.should equal(8)
+    data.voice_servers.length.should equal(11)
     data.prefiles.length.should equal(6)
-	end
+  end
 
   it "should return correct values for general properties" do
-		data = Vatsim::Data.new("download_files" => false, "data_file_path" => File.dirname(__FILE__) + "/vatsim-data.txt")
+    data = Vatsim::Data.new
     data.general.length.should equal(5)
     data.general["version"].should == "8"
     data.general["reload"].should == "2"
     data.general["update"].should == "20120504011745"
     data.general["atis_allow_min"].should == "5"
     data.general["connected_clients"].should == "502"
-	end
+  end
+
+  it "should return correct values for a specific pilot" do
+    data = Vatsim::Data.new
+    pilot = data.pilots[19]
+    pilot.callsign.should == "ACA021"
+    pilot.cid.should == "1216364"
+    pilot.realname.should == "Sam Bouz CYUL"
+    pilot.clienttype.should == "PILOT"
+    pilot.latitude.should == "52.36574"
+    pilot.longitude.should == "38.94341"
+    pilot.altitude.should == "33799"
+    pilot.groundspeed.should == "486"
+    pilot.planned_aircraft.should == "H/A333"
+    pilot.planned_tascruise.should == "480"
+    pilot.planned_depairport.should == "UUEE"
+    pilot.planned_altitude.should == "FL340"
+    pilot.planned_destairport.should == "LTAC"
+    pilot.server.should == "EUROPE-CW2"
+    pilot.protrevision.should == "100"
+    pilot.rating.should == "1"
+    pilot.transponder.should == "3437"
+    pilot.planned_revision.should == "0"
+    pilot.planned_flighttype.should == "I"
+    pilot.planned_deptime.should == "0"
+    pilot.planned_actdeptime.should == "0"
+    pilot.planned_hrsenroute.should == "2"
+    pilot.planned_minenroute.should == "38"
+    pilot.planned_hrsfuel.should == "4"
+    pilot.planned_minfuel.should == "7"
+    pilot.planned_altairport.should == "LTBA"
+    pilot.planned_remarks.should == " /T/"
+    pilot.planned_route.should == "KS LUKOS 6E8 LO 6E18 DK CRDR6 FV R11 TS R808 UUOO R368 KUBOK UA279 GR UP29 SUMOL UW100 INB UM853 BUK UW71 ILHAN"
+    pilot.planned_depairport_lat.should == "0"
+    pilot.planned_depairport_lon.should == "0"
+    pilot.planned_destairport_lat.should == "0"
+    pilot.planned_destairport_lon.should == "0"
+    pilot.time_logon.should == "20120503235431"
+    pilot.heading.should == "169"
+    pilot.QNH_iHg.should == "29.7"
+    pilot.QNH_Mb.should == "1005"
+  end
+
+  it "should return correct values for a specific prefile" do
+    data = Vatsim::Data.new
+    prefile = data.prefiles[1]
+    prefile.callsign.should == "DAV10674"
+    prefile.cid.should == "1207105"
+    prefile.realname.should == "Randy Harrill KCMO"
+    prefile.planned_aircraft.should == "T/MD90/W"
+    prefile.planned_tascruise.should == "360"
+    prefile.planned_depairport.should == "KATL"
+    prefile.planned_altitude.should == "F290"
+    prefile.planned_destairport.should == "KMIA"
+    prefile.planned_revision.should == "0"
+    prefile.planned_flighttype.should == "I"
+    prefile.planned_deptime.should == "45"
+    prefile.planned_actdeptime.should == "45"
+    prefile.planned_hrsenroute.should == "1"
+    prefile.planned_minenroute.should == "50"
+    prefile.planned_hrsfuel.should == "2"
+    prefile.planned_minfuel.should == "50"
+    prefile.planned_altairport.should == "KPBI"
+    prefile.planned_remarks.should == "+VFPS+/V/ "
+    prefile.planned_route.should == "THRSR6 LUCKK SZW SSCOT1"
+    prefile.planned_depairport_lat.should == "0"
+    prefile.planned_depairport_lon.should == "0"
+    prefile.planned_destairport_lat.should == "0"
+    prefile.planned_destairport_lon.should == "0"
+  end
+
+  it "should return correct values for a specific ATC" do
+    data = Vatsim::Data.new
+    atc = data.atc[20]
+    atc.callsign.should == "CZEG_CTR"
+    atc.cid.should == "1096034"
+    atc.realname.should == "Brett Zubot"
+    atc.clienttype.should == "ATC"
+    atc.frequency.should == "132.850"
+    atc.latitude.should == "53.18500"
+    atc.longitude.should == "-113.86667"
+    atc.server.should == "USA-N"
+    atc.protrevision.should == "100"
+    atc.rating.should == "5"
+    atc.facilitytype.should == "6"
+    atc.visualrange.should == "600"
+    atc.time_logon.should == "20120504004825"
+  end
+
+  it "should return correct values for a specific server" do
+    data = Vatsim::Data.new
+    server = data.servers[6]
+    server.ident.should == "USA-N"
+    server.hostname_or_IP.should == "204.244.237.21"
+    server.location.should == "Vancouver, CANADA"
+    server.name.should == "USA North"
+    server.clients_connection_allowed.should == "1"
+  end
+
+  it "should return correct values for a specific voice server" do
+    data = Vatsim::Data.new
+    voice_server = data.voice_servers[4]
+    voice_server.hostname_or_IP.should == "voice.zhuartcc.net"
+    voice_server.location.should == "Sponsored by Houston ARTCC"
+    voice_server.name.should == "ZHU-ARTCC"
+    voice_server.clients_connection_allowed.should == "1"
+    voice_server.type_of_voice_server.should == "R"
+  end
+
 end
 

data/vatsim.gemspec

@@ -10,4 +10,8 @@ Gem::Specification.new do |s|
   s.files       	= `git ls-files`.split("\n")
   s.require_paths 	= ['lib']
   s.homepage    	= 'https://github.com/tdawe/vatsim'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vatsim
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,72 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-19 00:00:00.000000000 Z
-dependencies: []
+date: 2012-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby gem to retrieve Pilot/ATC online status
 email: trevor.dawe@gmail.com
 executables: []
@@ -19,13 +83,19 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
+- Gemfile
 - README.md
 - Rakefile
 - lib/vatsim.rb
+- lib/vatsim/atc.rb
 - lib/vatsim/client.rb
 - lib/vatsim/data.rb
+- lib/vatsim/pilot.rb
 - lib/vatsim/prefile.rb
+- lib/vatsim/server.rb
 - lib/vatsim/version.rb
+- lib/vatsim/voice_server.rb
 - spec/spec_helper.rb
 - spec/vatsim-data.txt
 - spec/vatsim-status.txt