nacofetch 1.0.0

data/README.md

@@ -0,0 +1 @@
+# This is my README

data/bin/nacofetch

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'nacofetch'

data/lib/nacofetch.rb

@@ -0,0 +1,207 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'cri'
+
+require 'nacofetch/naco_interface'
+require 'nacofetch/config'
+
+#initialize here
+
+@default_config_dir = File.expand_path("~/.naco")
+@config_file_name = "config.rb"
+
+begin
+  NacoConfig.from_file(File.expand_path('~/.naco/config.rb'))
+rescue
+  config_filename = File.expand_path(@config_file_name, @default_config_dir)
+  puts "No config file found... creating #{config_filename}"
+
+  # ensure directory exists
+  begin
+    Dir::mkdir(@default_config_dir)
+    puts "Creating #{@default_config_dir}"
+  rescue
+    puts "#{@default_config_dir} already exists"
+  end
+
+  File.new(File.expand_path(@config_file_name, @default_config_dir), "w") do |f|
+    # file closes on block termination
+    # write into f if I want to pre-configure the file.  For now it's just empty.
+  end
+end
+
+def print_cycles(cycles)
+  puts "\tCycle\tEffective\tEnding"
+  puts "-------------------------------------------"
+  cycles.each do |cycle|
+    puts  "\t#{cycle.number}\t#{cycle.effective.strftime("%b %d %Y")}\t#{cycle.ending.strftime("%b %d %Y")}"
+  end
+end
+
+def select_cycle(opts)
+  ni = NacoInterface.new
+  cycles = ni.cycles
+
+  cycle = nil
+
+  unless opts[:current] or opts[:pending] or opts[:cycle]
+    cycle = ni.current_cycle
+    if cycles.size > 1
+      puts "WARN: no cycle specified, and multiple cycles are available.  Defaulting to current cycle (#{cycle.number})"
+    end
+  end
+
+  if(opts[:current])
+    cycle = ni.current_cycle
+  end
+
+  if(opts[:pending])
+    cycle = ni.pending_cycle
+  end
+
+  if(opts[:cycle])
+    cycle = cycles.select { |c| c.number == opts[:cycle] }.first
+    if cycle.nil?
+      puts "ERROR: cycle #{opts[:cycle]} not found on dTPP.  Available cycles:\n\n"
+      print_cycles(cycles)
+      exit 0
+    end
+  end
+
+  if cycle.nil?
+    raise "Ended up here with a nil cycle, and I can't handle that"
+  end
+
+  status = cycle.status == "PENDING" ? "(effective #{cycle.effective.strftime("%b %d %Y")})" : "(expires #{cycle.ending.strftime("%b %d %Y")})"
+  puts "Desired cycle is #{cycle.number} #{status}"
+
+  cycle
+end
+
+
+super_cmd = Cri::Command.define do
+  name        'nacofetch'
+  usage       'nacofetch fetches and packages naco/faa plates from the dTPP'
+  summary     'naco digital terminal procedure fetch tool'
+  description 'coming soon'
+
+  run do |opts, args, cmd|
+    puts cmd.help
+  end
+end
+
+super_cmd.define_command do
+  name        'cycle'
+  summary     'list currently available dTPP cycles'
+
+  run do |opts, args|
+    print_cycles(NacoInterface.new.cycles)
+  end
+end
+
+
+super_cmd.define_command do
+  name        'metafile'
+  summary     'prefetch metafile for cycle'
+  usage       'metafile <-p|-c|-y cycle>'
+
+  flag  :h, :help, 'show help for this command' do |value, cmd|
+    puts cmd.help
+    exit 0
+  end
+
+  flag :c, :current, 'Fetch current cycle (default)'
+  flag :p, :pending, 'Fetch pending cycle if available, otherwise fall back to current cycle'
+  option :y, :cycle, 'Fetch given cycle (-y 1207 will fetch cycle 1207)', :argument => :required
+
+  run do |opts, args, cmd|
+    cycle = select_cycle(opts)
+
+    metafile = NacoInterface.new.metafile_for_cycle(cycle)
+
+    puts "Metafile fetched: #{metafile}"
+  end
+end
+
+
+super_cmd.define_command do
+  name        'airport'
+  summary     'fetch plates for one or more airports'
+
+  flag  :h, :help, 'show help for this command' do |value, cmd|
+    puts cmd.help
+    exit 0
+  end
+
+  flag :c, :current, 'Fetch current cycle (default)'
+  flag :p, :pending, 'Fetch pending cycle if available, otherwise fall back to current cycle'
+  option :y, :cycle, 'Fetch given cycle (-y 1207 will fetch cycle 1207)', :argument => :required
+
+  run do |opts, args|
+    ni = NacoInterface.new
+    cycle = select_cycle(opts)
+    metafile = ni.metafile_for_cycle(cycle)
+
+    puts "Fetching cycle #{cycle.number} plates for: " + args.map{|a| a.upcase}.join(", ")
+
+    args.each do |a|
+      ni.fetch_plates_for_airport(metafile,a)
+    end
+  end
+end
+
+super_cmd.define_command do
+  name        'state'
+  summary     'fetch plates for all airports in one or more states'
+
+  flag  :h, :help, 'show help for this command' do |value, cmd|
+    puts cmd.help
+    exit 0
+  end
+
+  flag :c, :current, 'Fetch current cycle (default)'
+  flag :p, :pending, 'Fetch pending cycle if available, otherwise fall back to current cycle'
+  option :y, :cycle, 'Fetch given cycle (-y 1207 will fetch cycle 1207)', :argument => :required
+
+  run do |opts, args|
+    ni = NacoInterface.new
+    cycle = select_cycle(opts)
+    metafile = ni.metafile_for_cycle(cycle)
+
+    puts "Fetching cycle #{cycle.number} plates for: " + args.map{|a| a.upcase}.join(", ")
+
+    args.each do |a|
+      ni.fetch_plates_for_state(metafile,a)
+    end
+  end
+end
+
+super_cmd.define_command do
+  name        'volume'
+  summary     'fetch plates for an entire NACO volume'
+
+  flag  :h, :help, 'show help for this command' do |value, cmd|
+    puts cmd.help
+    exit 0
+  end
+
+  flag :c, :current, 'Fetch current cycle (default)'
+  flag :p, :pending, 'Fetch pending cycle if available, otherwise fall back to current cycle'
+  option :y, :cycle, 'Fetch given cycle (-y 1207 will fetch cycle 1207)', :argument => :required
+
+  run do |opts, args|
+    ni = NacoInterface.new
+    cycle = select_cycle(opts)
+    metafile = ni.metafile_for_cycle(cycle)
+
+    puts "Fetching cycle #{cycle.number} plates for: " + args.map{|a| a.upcase}.join(", ")
+
+    args.each do |a|
+      ni.fetch_plates_for_volume(metafile,a)
+    end
+  end
+end
+
+super_cmd.add_command Cri::Command.new_basic_help
+super_cmd.run(ARGV)

data/lib/nacofetch/config.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'mixlib/config'
+
+class NacoConfig
+  extend(Mixlib::Config)
+
+  configure do |c|
+    c[:config_dir] = File.expand_path('~/.naco')
+    c[:plate_storage_dir] = File.expand_path('plates', c[:config_dir])
+    c[:metafile_storage_dir] = File.expand_path('metafiles', c[:config_dir])
+    c[:cache_storage_dir] = File.expand_path('cache', c[:config_dir])
+  end
+end
+

data/lib/nacofetch/cycle.rb

@@ -0,0 +1,21 @@
+require 'nacofetch/date_util'
+
+class Cycle
+  attr_accessor :url, :number, :effective, :ending
+
+  def initialize(url, number, effective, ending)
+    @url = url
+    @number = number
+    @effective = effective
+    @ending = ending
+  end
+
+  def status
+    now = Time.new
+
+    return "PENDING" if now.before?@effective
+    return "CURRENT" if now.before?@ending and now.after?@effective
+           "EXPIRED" if now.after?@ending
+  end
+
+end

data/lib/nacofetch/date_util.rb

@@ -0,0 +1,22 @@
+require 'date'
+
+def string_to_time time_, format_
+  time = Date._strptime(time_, format_)
+  return Time.local(time[:year], time[:mon], time[:mday], time[:hour], time[:min], time[:sec], time[:sec_fraction], time[:zone])
+end
+
+module DateUtil
+
+  LEFT_SIDE_LATER  = 1
+  RIGHT_SIDE_LATER = -1
+
+  def before?(input_time)
+    (self <=> input_time) == RIGHT_SIDE_LATER
+  end
+
+  def after?(input_time)
+    (self <=> input_time) == LEFT_SIDE_LATER
+  end
+end
+
+Time.send :include , DateUtil

data/lib/nacofetch/naco_interface.rb

@@ -0,0 +1,142 @@
+
+require 'rubygems'
+require 'open-uri'
+require 'nokogiri'
+require 'httpclient'
+
+require 'nacofetch/config'
+require 'nacofetch/cycle'
+
+
+class NacoInterface
+  def initialize
+    @base_url = "http://aeronav.faa.gov"
+  end
+
+  def cycles
+    unless @cycles_var
+      url = "/index.asp?xml=aeronav/applications/d_tpp"
+      doc = Nokogiri::HTML(open(@base_url + url))
+      @cycles_var = []
+
+      tables = doc.xpath('//table[@title="Digital Terminal Procedures Publication"]')
+
+      tables.xpath('//td[@headers="header1"]').each do |cycle|
+        url = cycle.xpath('./a/@href').to_s()
+        @cycles_var << Cycle.new(
+            url.sub(/digital_tpp/, "digital_tpp_search"), # todo: there's gotta be a less hacky way to do this'
+            /ver=(\d+)/.match(url)[1],
+            string_to_time(/eff=(\d+-\d+-\d+)/.match(url)[1], '%m-%d-%Y'),
+            string_to_time(/end=(\d+-\d+-\d+)/.match(url)[1], '%m-%d-%Y')
+        )
+      end
+    end
+
+    @cycles_var
+  end
+
+  def current_cycle
+    self.cycles.select { |cycle| cycle.status == "CURRENT" }.first
+  end
+
+  def pending_cycle
+    self.cycles.select { |cycle| cycle.status == "PENDING" }.first
+  end
+
+  def metafile_for_cycle(cycle)
+    fetch_metafile(cycle) unless File.exists?(metafilename(cycle))
+    metafilename(cycle)
+  end
+
+  def fetch_plates_for_airport(metafile_url, ident)
+    xpath = "/digital_tpp/state_code/city_name/airport_name[@icao_ident = '#{ident}' or @apt_ident = '#{ident}']"
+    #xpath = "/digital_tpp/state_code[@ID = 'GA']"
+
+    fetch_plates_for_xpath(metafile_url, xpath)
+  end
+
+  def fetch_plates_for_state(metafile_url, statecode)
+    xpath = "/digital_tpp/state_code[@ID = '#{statecode}']"
+
+    fetch_plates_for_xpath(metafile_url, xpath)
+  end
+
+  def fetch_plates_for_volume(metafile_url, volumecode)
+    xpath = "/digital_tpp/state_code[city_name/@volume = '#{volumecode}']"
+
+    fetch_plates_for_xpath(metafile_url, xpath)
+  end
+
+  private
+
+  def fetch_plates_for_xpath(metafile_url, xpath)
+    doc = Nokogiri::XML(open(metafile_url))
+
+    cycle = doc.xpath('/digital_tpp/@cycle')
+    base_path = "#{@base_url}/d-tpp/#{cycle}/"
+
+    plate_dir = NacoConfig.plate_storage_dir
+
+    unless File.directory?plate_dir
+      Dir::mkdir(File.expand_path(plate_dir))
+    end
+
+
+    doc.xpath(xpath).each do |node|
+      node.xpath(".//record").each do |chart|
+        url = chart.xpath("pdf_name").inner_html
+        name = chart.xpath("chart_name").inner_html.gsub(/\//, "-")
+        type = chart.xpath("chart_code").inner_html
+
+        apt_ident = determine_ident(chart.xpath(".."))
+
+        full_url = base_path + url
+
+        unless File.directory?(File.expand_path(apt_ident, plate_dir))
+          Dir::mkdir(File.expand_path(apt_ident, plate_dir))
+        end
+
+        download(full_url, File.expand_path("#{apt_ident}/#{name}.pdf", plate_dir))
+      end
+    end
+  end
+
+  def determine_ident(apt_node)
+    icao_ident = apt_node.xpath("@icao_ident").inner_html
+
+    if icao_ident.empty?
+      return apt_node.xpath("@apt_ident").inner_html
+    end
+
+    icao_ident
+  end
+
+  def metafilename(cycle)
+    File.expand_path("#{cycle.number}-metafile.xml", NacoConfig.metafile_storage_dir)
+  end
+
+  def fetch_metafile(cycle)
+    url = "/d-tpp/#{cycle.number}/xml_data/d-TPP_Metafile.xml"
+    download(@base_url+url, metafilename(cycle))
+  end
+
+  def download(url, to_file)
+    client = HTTPClient.new(nil)
+
+    begin
+      Dir::mkdir(File.dirname(File.expand_path(to_file)))
+    rescue
+    end
+
+    file = File.new(to_file, "wb")
+    puts "Downloading #{url} to #{to_file}"
+    begin
+      file.write(client.get_content(url))
+    rescue
+      puts "ERROR: problem fetching #{url} (skipping)"
+    end
+  end
+
+end
+
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: nacofetch
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ian McMahon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mixlib-config
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: A tool to fetch and manage naco plates from the FAA aeronav digital terminal plates website
+email: imcmahon@prototechnical.com
+executables: 
+- nacofetch
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/nacofetch/config.rb
+- lib/nacofetch/cycle.rb
+- lib/nacofetch/date_util.rb
+- lib/nacofetch/naco_interface.rb
+- lib/nacofetch.rb
+- bin/nacofetch
+- README.md
+has_rdoc: true
+homepage: http://nacofetch.prototechnical.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: NacoFetch
+test_files: []
+