vfr_utils 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad057bae66be0a8f641c375a0ed7f0c4e6413b37
+  data.tar.gz: 2592fd98b47284abb45bfee57bf003bc69c832fa
+SHA512:
+  metadata.gz: 7997372764a5dbb062fe6450860fb33fbfeceaeffea6ee34c8f9ef7d35b16edc9987109a92d981350e356847c67065dbf3b2e45480e2a6dac70c53bed6ecfd71
+  data.tar.gz: 2142d275478481899105ec253def50ffbb425c3650042a1776cfab9df6d61da356b91c725a9136ec4451da05e89cd3521be56c6a5c18fa96bfdb28be90b401ad

data/bin/vfr_utils

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/vfr_utils/cli'
+
+VfrUtils::CLI.run ARGV

data/lib/vfr_utils.rb

@@ -0,0 +1,23 @@
+require_relative 'vfr_utils/version'
+require_relative 'vfr_utils/configuration'
+require_relative 'vfr_utils/master_configuration'
+require_relative 'vfr_utils/cache'
+require_relative 'vfr_utils/base_service'
+require_relative 'vfr_utils/taf'
+require_relative 'vfr_utils/notam'
+require_relative 'vfr_utils/metar'
+
+module VfrUtils
+  class << self
+    attr_accessor :master_configuration
+  end
+
+  self.master_configuration ||= MasterConfiguration.new
+
+  class << self
+    def configure
+      self.master_configuration ||= MasterConfiguration.new
+      yield master_configuration
+    end
+  end
+end

data/lib/vfr_utils/base_service.rb

@@ -0,0 +1,38 @@
+require_relative '../vfr_utils'
+require 'faraday'
+require 'nokogiri'
+require 'date'
+
+module VfrUtils
+  class BaseService
+
+    class << self
+
+      def inherited(child_class)
+        def child_class.cache
+          unless @cache
+            config_key = self.name.split('::').last.downcase.to_sym
+            @cache = Cache.new(VfrUtils.master_configuration.send(config_key))
+          end
+          @cache
+        end
+      end
+
+      def get(icao_codes)
+        icao_codes = [*icao_codes]
+        icao_codes.map!(&:upcase)
+
+        ret = {}
+        icao_codes.each do |icao_code|
+          ret[icao_code] = get_one(icao_code)
+        end
+        ret
+      end
+
+      def get_one(icao_code)
+        raise "Implement me!"
+      end
+
+    end
+  end
+end

data/lib/vfr_utils/cache.rb

@@ -0,0 +1,33 @@
+module VfrUtils
+  class Cache
+
+    def initialize(config)
+      @config = config
+    end
+
+    def get(k, &blk)
+       return get_files(k, &blk) if config.cache_backend == :files
+       raise "Unsupported cache backend: #{config.cache_backend}"
+    end
+
+    private
+
+    def config
+      @config
+    end
+
+    def get_files(k)
+      cache_file_path = "#{config.cache_directory}/#{k}.tmp"
+      if File.exists?(cache_file_path)
+        if Time.now.to_i - File.ctime(cache_file_path).to_i > config.cache_lifetime
+          FileUtils.rm_rf(cache_file_path)
+        else
+          return Marshal.load(File.read(cache_file_path))
+        end
+      end
+      v = yield
+      File.write(cache_file_path, Marshal.dump(v))
+      v
+    end
+  end
+end

data/lib/vfr_utils/cli.rb

@@ -0,0 +1,49 @@
+require_relative '../vfr_utils'
+
+module VfrUtils
+  module CLI
+
+    ALLOWED_ACTIONS = [
+      'metar',
+      'taf',
+      'notam'
+    ]
+
+    def self.run(argv)
+      return usage if argv.empty?
+      action = argv[0].downcase
+      params = argv[1..-1]
+      return usage unless ALLOWED_ACTIONS.include? action
+      send(action.to_sym, params)
+      0
+    end
+
+    def self.usage
+      STDERR.puts "Version: #{VfrUtils::VERSION} Usage: vfr-utils <action> <params>"
+      STDERR.puts ""
+      STDERR.puts "Allowed actions:"
+      ALLOWED_ACTIONS.each { |action| STDERR.puts "  #{action} <space delimited list of ICAO codes>" }
+      STDERR.puts ""
+      1
+    end
+
+    def self.notam(icao_codes)
+      require_relative 'notam'
+      require_relative 'formatter/notam'
+      VfrUtils::Formatter::NOTAM.pretty_display(VfrUtils::NOTAM.get(icao_codes))
+    end
+
+    def self.metar(icao_codes)
+      require_relative 'metar'
+      require_relative 'formatter/weather'
+      VfrUtils::Formatter::Weather.pretty_display(VfrUtils::METAR.get(icao_codes))
+    end
+
+    def self.taf(icao_codes)
+      require_relative 'taf'
+      require_relative 'formatter/weather'
+      VfrUtils::Formatter::Weather.pretty_display(VfrUtils::TAF.get(icao_codes))
+    end
+
+  end
+end

data/lib/vfr_utils/configuration.rb

@@ -0,0 +1,29 @@
+require 'tmpdir'
+
+module VfrUtils
+  class Configuration
+    DEFAULTS = {
+      cache_lifetime: 900, # 900 secs = 15 minutes
+      cache_directory: "#{Dir.tmpdir}/vfr-utils",
+      cache_backend: :files,
+      redis_url: nil,
+    }
+    attr_accessor :cache_lifetime
+    attr_accessor :cache_directory
+    attr_accessor :cache_backend
+    attr_accessor :redis_url
+
+    def initialize(defaults=DEFAULTS)
+      @cache_lifetime = defaults[:cache_lifetime] || DEFAULTS[:cache_lifetime]
+      @cache_directory = defaults[:cache_directory] || DEFAULTS[:cache_directory]
+      @cache_backend = defaults[:cache_backend] || DEFAULTS[:cache_backend]
+      @redis_url = defaults[:redis_url] || DEFAULTS[:redis_url]
+      apply
+    end
+
+    def apply
+      FileUtils.mkdir_p @cache_directory if @cache_backend == :files
+    end
+
+  end
+end

data/lib/vfr_utils/formatter/notam.rb

@@ -0,0 +1,25 @@
+require 'pp'
+
+module VfrUtils
+  module Formatter
+    module NOTAM
+      def self.pretty_display(notams)
+        notams.each_pair do |icao_code, notams_for_aerodrome|
+          puts "=================================================="
+          puts "=====================  #{icao_code}  ====================="
+          notams_for_aerodrome.each do |notam_data|
+            puts "=================================================="
+            puts "Signature: #{notam_data[:signature]}" if notam_data[:signature]
+            puts "Valid from: #{notam_data[:valid_from].strftime("%F %H:%M (%A)")}" if notam_data[:valid_from]
+            puts "Valid to:   #{notam_data[:valid_to].strftime("%F %H:%M (%A)")}" if notam_data[:valid_to]
+            puts ""
+            puts notam_data[:message]
+            puts ""
+            puts "Created at #{notam_data[:created_at].strftime("%F %H:%M")} by #{notam_data[:source]}" if notam_data[:created_at]
+            puts "" if notam_data[:created_at]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vfr_utils/formatter/weather.rb

@@ -0,0 +1,17 @@
+require 'pp'
+
+module VfrUtils
+  module Formatter
+    module Weather
+      def self.pretty_display(data)
+        data.each_pair do |icao_code, data_for_aerodrome|
+          puts ""
+          #puts "=================================================="
+          puts "=====================  #{icao_code}  ====================="
+          puts data_for_aerodrome[:data]
+          puts "=================================================="
+        end
+      end
+    end
+  end
+end

data/lib/vfr_utils/master_configuration.rb

@@ -0,0 +1,30 @@
+module VfrUtils
+  class MasterConfiguration
+
+    def initialize(defaults={})
+      @defaults = defaults
+      @modules = {}
+    end
+
+    def method_missing(method_name, *args, &blk)
+      unless @modules[method_name]
+        @modules[method_name] = Configuration.new @defaults
+        self.class.class_exec do
+          define_method(method_name) { @modules[method_name] }
+        end
+        send(method_name, *args, &blk)
+      end
+    end
+
+    def global(values)
+      @defaults.merge! values
+      @modules.each_value do |m|
+        values.each_pair do |k,v|
+          key = "#{k}=".to_sym
+          m.send(key, v)
+        end
+      end
+    end
+
+  end
+end

data/lib/vfr_utils/metar.rb

@@ -0,0 +1,47 @@
+require_relative '../vfr_utils'
+require 'faraday'
+require 'nokogiri'
+require 'date'
+
+module VfrUtils
+  class METAR < BaseService
+
+    URL='http://aviationweather.gov/metar/data'
+
+    class << self
+
+      def get_one(icao_code)
+        return cache.get("metar_#{icao_code}") do
+          html = fetch_from_web(icao_code)
+          parse(html)
+        end
+      end
+
+      private
+
+      def fetch_from_web(icao_code)
+        request_params = {
+          ids: icao_code,
+          format: 'raw',
+          hours: 0,
+          taf: 'off',
+          layout: 'off',
+          date: 0
+        }
+        response = Faraday.get URL, request_params
+        response.body
+      end
+
+      def parse(html)
+        html_doc = Nokogiri::HTML(html)
+        begin
+          data = html_doc.xpath("//div[@id='awc_main_content']//p").first.next_sibling.next_sibling.next_sibling.text
+        rescue
+          data = nil
+        end
+        { data: data }
+      end
+
+    end
+  end
+end

data/lib/vfr_utils/notam.rb

@@ -0,0 +1,88 @@
+require_relative '../vfr_utils'
+require 'faraday'
+require 'nokogiri'
+require 'date'
+
+module VfrUtils
+  class NOTAM < BaseService
+
+    URL='https://www.notams.faa.gov/dinsQueryWeb/queryRetrievalMapAction.do'
+
+    class << self
+
+      def get_one(icao_code)
+        ret = []
+        return cache.get("notam_#{icao_code}") do
+          html = fetch_from_web(icao_code)
+          html_doc = Nokogiri::HTML(html)
+          html_doc.xpath("//td[@class='textBlack12']/pre").map(&:text).each do |raw_notam|
+            ret << parse(raw_notam)
+          end
+          ret
+        end
+      end
+
+      private
+
+      def fetch_from_web(icao_code)
+        request_params = {
+          reportType: 'Raw',
+          retrieveLocId: icao_code,
+          actionType: 'notamRetrievalByICAOs',
+          submit: 'View NOTAMs'
+        }
+        response = Faraday.post URL, request_params
+        response.body
+      end
+
+      def parse(raw_notam)
+        ret = {
+          raw: raw_notam,
+          header: nil,
+          signature: nil,
+          icao_code: nil,
+          valid_from: nil,
+          valid_to: nil,
+          created_at: nil,
+          source: nil,
+          message: nil
+        }
+
+        lines = raw_notam.split("\n")
+        ret[:header] = lines[0]
+        ret[:created_at] = lines[-2].split(':', 2).last.strip # "17 Nov 2016 10:03:00"
+        ret[:created_at] = DateTime.parse(ret[:created_at])
+        ret[:source] = lines[-1].split(':', 2).last.strip
+        body = lines[1..-3].join(' ').gsub("\n", ' ')
+
+        if matches = body.match(/\AQ\)\s+(?<signature>.+)\s+A\)\s+(?<icao_code>.+)\s+B\)\s+(?<valid_from>.+)\s+C\)\s+(?<valid_to>.+)\s+E\)\s+(?<message>.+)\s*\z/)
+          ret[:signature] = matches[:signature]
+          ret[:icao_code] = matches[:icao_code]
+          ret[:valid_from] = parse_validity_time(matches[:valid_from])
+          ret[:valid_to] = parse_validity_time(matches[:valid_to])
+          ret[:message] = matches[:message]
+        else
+          body = ret[:header]+body
+          if matches = body.match(/\D(?<valid_from>\d{10})-(?<valid_to>\d{10}([A-Z]{3-5})?|PERM)/)
+            ret[:valid_from] = parse_validity_time(matches[:valid_from])
+            ret[:valid_to] = parse_validity_time(matches[:valid_to])
+            body.gsub!(matches[0], '')
+          end
+          ret[:message] = body
+        end
+        ret
+      end
+
+      def parse_validity_time(text)
+        return DateTime.new(2100) if text == 'PERM'
+        year = text[0..1].to_i+2000
+        month = text[2..3].to_i
+        day = text[4..5].to_i
+        hour = text[6..7].to_i
+        minute = text[8..9].to_i
+        zone = text[10..15]
+        DateTime.parse("#{year}-#{month}-#{day} #{hour}:#{minute}:00#{zone}")
+      end
+    end
+  end
+end

data/lib/vfr_utils/taf.rb

@@ -0,0 +1,46 @@
+require_relative '../vfr_utils'
+require 'faraday'
+require 'nokogiri'
+require 'date'
+
+module VfrUtils
+  class TAF < BaseService
+
+    URL='http://aviationweather.gov/taf/data'
+
+    class << self
+
+      def get_one(icao_code)
+        return cache.get("taf_#{icao_code}") do
+          html = fetch_from_web(icao_code)
+          parse(html)
+        end
+      end
+
+      private
+
+      def fetch_from_web(icao_code)
+        # http://aviationweather.gov/taf/data?ids=EPWR&format=raw&metars=off&layout=off
+        request_params = {
+          ids: icao_code,
+          format: 'raw',
+          metars: 'off',
+          layout: 'off',
+        }
+        response = Faraday.get URL, request_params
+        response.body
+      end
+
+      def parse(html)
+        html_doc = Nokogiri::HTML(html)
+        begin
+          data = html_doc.xpath("//code").first.inner_html.gsub('<br>', "\n")
+        rescue
+          data = nil
+        end
+        { data: data }
+      end
+
+    end
+  end
+end

data/lib/vfr_utils/version.rb

@@ -0,0 +1,3 @@
+module VfrUtils
+  VERSION='0.0.3'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: vfr_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Bartek Wilczek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: This gem provides set of classes and a CLI for obtaining information
+  like NOTAM, METAR and TAF
+email:
+- bwilczek@gmail.com
+executables:
+- vfr_utils
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/vfr_utils
+- lib/vfr_utils.rb
+- lib/vfr_utils/base_service.rb
+- lib/vfr_utils/cache.rb
+- lib/vfr_utils/cli.rb
+- lib/vfr_utils/configuration.rb
+- lib/vfr_utils/formatter/notam.rb
+- lib/vfr_utils/formatter/weather.rb
+- lib/vfr_utils/master_configuration.rb
+- lib/vfr_utils/metar.rb
+- lib/vfr_utils/notam.rb
+- lib/vfr_utils/taf.rb
+- lib/vfr_utils/version.rb
+homepage: https://github.com/bwilczek/vfr-utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Basic toolkit for obtaining aeronautical data
+test_files: []