atc-tools 1.0.0

data/lib/atc-tools/vrc.rb

@@ -0,0 +1,165 @@
+require 'rautomation'
+require 'atc-tools/flight_plan'
+require 'atc-tools/aircraft'
+
+module ATCTools
+  class NoAircraftSelectedError < StandardError; end
+  
+  # A class for interfacing with the Virtual Radar Client application.
+  # http://www1.metacraft.com/VRC/
+  #
+  # Methods with a bang (!) at the end manipulate the window and
+  # could affect the user.
+  class VRC
+    # VRC log path for exporting aircraft info.
+    attr_accessor :aclog_path
+    
+    # Params:
+    #   :aclog_path - Location of the VRC log dump for the aircraft info query.
+    def initialize(**kvargs)
+      @aclog_path = kvargs.fetch :aclog_path, File.expand_path('Documents/VRC/acinfo.txt', '~')
+      
+      @selected_aircraft = ''
+      
+      #Window handles.
+      @vrc_win         = RAutomation::Window.new title: /VRC.*Connected to server:/
+      @flight_plan_win = RAutomation::Window.new title: /Flight Plan - /
+      @terminal_win    = RAutomation::Window.new title: /\\cmd.exe/
+      
+      @command_win     = @vrc_win.text_fields[0]
+      @callsign_win    = @vrc_win.text_fields[1]
+    end
+    
+    # Title of the VRC flight plan window.
+    # This includes the pilot's callsign and real name.
+    def flight_plan_title
+      @flight_plan_win.title
+    end
+    
+    # Extracts the flight plan of the selected aircraft.
+    def selected_flight_plan!
+      raise ATCTools::NoAircraftSelectedError, "No aircraft selected." \
+        unless aircraft_selected?
+      
+      execute_command ".ss #{@selected_aircraft}"
+      
+      flight_plan = ATCTools::FlightPlan.new \
+        callsign:   @selected_aircraft,
+        aircraft:   ATCTools::Aircraft.new(
+                      @flight_plan_win.text_fields[1].value,
+                      info: selected_aircraft_info!
+                    ),
+        rules:      (RAutomation::Adapter::Win32::SelectList.new @flight_plan_win, index: 0)
+                      .value.upcase.to_sym,
+        depart:     ATCTools::Airport.new(@flight_plan_win.text_fields[2].value),
+        arrive:     ATCTools::Airport.new(@flight_plan_win.text_fields[3].value),
+        alternate:  ATCTools::Airport.new(@flight_plan_win.text_fields[4].value),
+        cruise:     @flight_plan_win.text_fields[5].value.to_i,
+        scratchpad: @flight_plan_win.text_fields[6].value.strip,
+        squawk:     @flight_plan_win.text_fields[7].value.strip,
+        route:      @flight_plan_win.text_fields[8].value.strip,
+        remarks:    @flight_plan_win.text_fields[9].value.strip
+    end
+    
+    # Extracts the callsign of the selected aircraft.
+    # Returns an empty string if no aircraft is selected.
+    def selected_aircraft
+      @selected_aircraft = @callsign_win.value.strip
+    end
+    
+    # True if an aircraft is selected.
+    def aircraft_selected?
+      selection_empty = selected_aircraft.empty?
+      @selected_aircraft = '' if selection_empty
+      not selection_empty
+    end
+    
+    # Extracts the aircraft info for the selected aircraft.
+    def selected_aircraft_info!
+      # --------------------------------------------------------------------------
+      # TODO: Prompt for an aircraft model as the input and use .typeinfo instead.
+      #       This way it can return info for cached aircraft.
+      # --------------------------------------------------------------------------
+      
+      raise ATCTools::NoAircraftSelectedError, "No aircraft selected." \
+        unless aircraft_selected?
+      
+      # ---------------------------
+      # TODO: 
+      # ---------------------------
+      
+      # Retrieve the aircraft info.
+      execute_command ".acinfo #{@selected_aircraft}"
+
+      # Dump the aircraft info to a log for processing.
+      execute_command ".log #{File.basename @aclog_path}"
+      
+      # Process aircraft info.
+      aclog = ''
+      result = ''
+      attempts = 0
+      
+      while attempts < 5
+        aclog_exists = File.exists? @aclog_path
+        break if aclog_exists
+        
+        attempts += 1
+        sleep 0.5
+      end
+      
+      if aclog_exists
+        aclog = File.open(@aclog_path).read
+        
+        # Only keep the last few lines.
+        # Reverse the lines so the latest one is first.
+        aclog = aclog.lines[-6..-1].reverse.join
+        
+        aclog.each_line do |line|
+          result = line.gsub /.*\s*(Aircraft info for \w*:\s*)/, '' if line.include? "Aircraft info for #{@selected_aircraft}"
+          break if result
+        end
+        
+        # ---------------
+        # TODO: Implement
+        # ---------------
+        result = "Aircraft type code '#{'xxx'}' not found in database." if result.empty?
+        
+        # File.delete @aclog_path
+      end
+      
+      result
+    end
+    
+    # Extract the text from the command line.
+    def command_line
+      @command_win.value
+    end
+    
+    # Execute a command in the VRC client.
+    # Preserves partially-entered commands in the text box.
+    def execute_command(cmd)
+      old_cmd = command_line
+      execute_command! cmd
+      @command_win.set old_cmd
+    end
+    
+    # Execute a command in the VRC client, overwriting any
+    # partially-entered command in the text box.
+    def execute_command!(cmd)
+      @command_win.set cmd
+      @command_win.send_keys :return
+    end
+    
+    # Activate the VRC window, bringing it to the foreground.
+    def activate_vrc_window!
+      @vrc_win.activate
+    end
+    
+    # Activate the terminal (command line) window, bringing
+    # it to the foreground.
+    def activate_terminal_window!
+      @terminal_win.activate
+    end
+    
+  end
+end

data/license.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Alex McLain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: atc-tools
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex McLain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rautomation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rdoc
+  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: pry
+  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: |-
+  A VATSIM flight plan validator for the VRC radar client.
+    NOTE: Only works with 32-bit Ruby installations due to the RAutomation gem.
+email: alex@alexmclain.com
+executables:
+- fpv
+extensions: []
+extra_rdoc_files: []
+files:
+- license.txt
+- bin/fpv
+- lib/atc-tools/aircraft.rb
+- lib/atc-tools/airport.rb
+- lib/atc-tools/flight_plan.rb
+- lib/atc-tools/script/flight_plan_validator.rb
+- lib/atc-tools/vrc.rb
+- lib/atc-tools.rb
+- doc/Aircraft.html
+- doc/Airport.html
+- doc/ATCTools/Aircraft.html
+- doc/ATCTools/Airport.html
+- doc/ATCTools/FlightPlan.html
+- doc/ATCTools/FlightPlanValidator.html
+- doc/ATCTools/HeadingDiscoveryError.html
+- doc/ATCTools/HeadingError.html
+- doc/ATCTools/NameDiscoveryError.html
+- doc/ATCTools/NoAircraftSelectedError.html
+- doc/ATCTools/VRC.html
+- doc/ATCTools.html
+- doc/created.rid
+- doc/FlightPlan.html
+- doc/HeadingError.html
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/search.js
+- doc/js/searcher.js
+- doc/js/search_index.js
+- doc/NameDiscoveryError.html
+- doc/rdoc.css
+- doc/table_of_contents.html
+homepage: https://bitbucket.org/amclain/atc-tools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A VATSIM flight plan validator for the VRC radar client.
+test_files: []