vatsim_online_redux 1.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a78e86307bec08f8b4dd9dbb4fefbb7178201c182fd79a636fb08779d638efc
-  data.tar.gz: 6d4cb6b9b60b1214539bc3b34a84b19970199f9cb54721f097e4ca8e3e3924f3
+  metadata.gz: c66083b4e7cce58e2f54c7582452157ff5ef8ea741b77a07b18cccc5b21a0e21
+  data.tar.gz: 1513cda20bf54348b56821c50d18de0b9f389f58fe31f7875a3572f0a7bd9124
 SHA512:
-  metadata.gz: 8ecc57d54538a812f72ad152e9ef690b61ccf8be8c689997550d5c15d913c9b23e855b21ec746a0a0bc5732f92ba564b6f44d8110e55110564ee3c9a26f6717c
-  data.tar.gz: 83652fe1c4c98c5ca26a182e41b6e79583e4b0e5db8b95a57b51cf9759ecf3518db9cb172d0667018c3fcb4af6e11efd048c33accfbe3c66f971581f65b74ce9
+  metadata.gz: 6597071f1292ef8a6e2f0ae6b05e285fa7fde6df224f6d88868798d24014ee2e7b1e964a95bdb8c3eadae11215473882e6b4eb0af8af35e4f14b921368f09614
+  data.tar.gz: 15fb29033a50d6a5f71e48588551454c7d4fdd0f2a76c18dfae6e232f654f8cd048154038bf89628a516e89c7a2ceae39b687b8f86be75eabe9e6b8ad8a9be8e

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## Changelog
 
+### v. 2.1.1 - 16 Mar 2022
+
+* Fixing a bug with the time diff on the status and data files
+
+### v. 2.1.0 - 20 Apr 2021
+
+* Added the new vatsim_regex_callsign method
+* Updated refresh time for data from 3 minutes to 60 seconds
+
+### v. 2.0.1 - 30 Jan 2021
+
+* Updated the code to use the new VATSIM Json data feed
+
+### v. 1.0.1 - 30 Mar 2020
+
+* Small bugfix to the 1.0.0 release
+
+### v. 1.0.0 - 30 Mar 2020
+
+* Updating code to work better with Windows environments
+
 ### v. 0.9.1 - 31 Dec 2016
 
 * Maintenance release, updated dependencies

data/README.md

@@ -11,10 +11,7 @@ online ATC and/or pilots for given airports, areas or globally and to filter by
 returned as objects, exposing a rich set of attributes. Vatsim data is pulled
 on preset intervals and cached locally to avoid flooding the servers.
 
-[![Build Status](https://secure.travis-ci.org/tarakanbg/vatsim_online.png?branch=master)](http://travis-ci.org/tarakanbg/vatsim_online)
-[![Gemnasium](https://gemnasium.com/tarakanbg/vatsim_online.png?travis)](https://gemnasium.com/tarakanbg/vatsim_online)
-[![Gem Version](https://badge.fury.io/rb/vatsim_online.png)](http://badge.fury.io/rb/vatsim_online)
-[![Code Climate](https://codeclimate.com/github/tarakanbg/vatsim_online.png)](https://codeclimate.com/github/tarakanbg/vatsim_online)
+[![Gem Version](https://badge.fury.io/rb/vatsim_online_redux.png)](http://badge.fury.io/rb/vatsim_online_redux)
 
 ## Requirements
 
@@ -48,6 +45,11 @@ any string (or variable containing a string) representing a full or partial pilo
 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.
 
+* `vatsim_regex_callsign`, which can be applied to
+  any string (or variable containing a string) representing a regular expression or
+  a comma-separated list of regular expressions.
+  The provided regex 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)
@@ -103,6 +105,13 @@ callsign = "BAW, RYR"
 callsign.vatsim_callsign # => returns an array of all Speedbird and Ryanair flights as station objects
 ```
 
+### Filter by regex examples
+
+```ruby
+# Attaching the method directly to a string:
+'BAW\d{3}'.vatsim_regex_callsign # => returns an array of all Speedbird flights with a 3 digit flight number as station objects
+```
+
 
 ### Anatomy of method returns
 
@@ -142,7 +151,7 @@ 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.
+The `vatsim_callsign` and `vatsim_regex_callsign` methods return an **array** of all matching stations.
 
 ### Station attributes
 
@@ -320,7 +329,7 @@ end
 
 * Vatsim status and data files are cached locally to reduce the load on vatsim
 servers. Random server is chosen to retrieve the data each time. By default the
-status file is updated once every 4 hours and the data file once every 3 minutes
+status file is updated once every 4 hours and the data file once every minute
 regardless of the number of incoming requests.
 * The data is cached in your default TEMP directory (OS specific)
 * All the data retrieval and caching logic is encapsulated in a separate class
@@ -335,134 +344,6 @@ front or after the identifiers or the commas, i.e. you can use
 `"LO,LB".vatsim_online` or `"LO, LB".vatsim_online` or `"LO , LB".vatsim_online` with
 the same result.
 
-## Changelog
-
-### v. 0.9.1 - 31 Dec 2016
-
-* Maintenance release, updated dependencies
-
-### v. 0.9 - 20 June 2015
-
-* Fixed nil String bug, can select "ALL" (thanks to Pierre Ferran and Florian Rimoli)
-
-### v. 0.8.3 - 10 April 2014
-
-* Fix stale data bug, change data fallback logic
-
-### v. 0.8.2 - 5 October 2013
-
-* Handle undetermined position when drawing gcmap
-
-### v. 0.8.1 - 5 October 2013
-
-* Ignore prefile data
-
-### 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
-
-### v. 0.7.1 - 15 July 2013
-
-* more comprehensive ATC ratings list
-* dependencies updated
-
-### v. 0.7.0 - 26 February 2013
-
-* added Ruby 2.0 support
-
-### v. 0.6.2 - 4 January 2013
-
-* updated gem dependencies
-* refactored `Station` class for simplicity
-
-### v. 0.6.1 - 08 October 2012
-
-* Fixed pilot station duplication issue when using multiple ICAOs
-
-### v. 0.6.0 - 08 October 2012
-
-* The `vatsim_online` method now also supports a comma-separated list of full or
-partial ICAO codes like this: `"LO,LB".vatsim_online`. This allows you to pull the
-information for multiple airports or FIRs in a single request
-* The comma-seprated list is not sensitive to whitespace, meaning you can use
-`"LO,LB".vatsim_online` or `"LO, LB".vatsim_online` or `"LO , LB".vatsim_online` with
-the same result
-
-### v. 0.5.3 - 30 September 2012
-
-* fixed bug with exceptions on missing ATC remark
-
-### v. 0.5.2 - 29 September 2012
-
-* fixed permissions bug on UNIX systems
-
-### v. 0.5.1 - 23 September 2012
-
-* bugfixes
-
-### v. 0.5 - 23 September 2012
-
-* New option `:exclude => "ICAO"` allowing further request customization by
-excluding a matching subset of ATC stations from the listing. Read the documentation
-for detailed explanation and examples
-* New customized station attribute: `online_since`. Returns the station login time
-parsed as a Ruby Time object in UTC (zulu time). As opposed to the `logon` attribute
-which returns an unformatted, unparsed string such as `20120722091954`
-* The `rating` station attribute is now humanized not to return just an integer,
-but a readable version of the VATSIM rating, i.e. S1, S2, S3, C1, C3, I1, I3, etc...
-* Added the possibility of customizing the great circle maps by optionally passing
-parameters for width and height: `icao.vatsim_online(:gcmap_width => 400, :gcmap_height => 400)`.
-Read the documentation for detailed explanation and examples
-* New customized station attribute `atis_message`. It will return a humanized web safe
-version of the ATC atis without the voice server info and with lines split with
-`<br />` tags. As opposed to the original `atis` attribute, which returns raw atis,
-as reported from VATSIM, including voice server as first line
-
-### v. 0.4 - 27 August 2012
-
-* GCMapper integration: this library now plays nicely with [gcmapper](https://rubygems.org/gems/gcmapper).
-A new attribute is provided for the pilot stations: `.gcmap` which returns a great
-circle map image url, depicting the GC route of the aircraft, its origin and destination,
-its current position on the route, together with its current altitude and groundspeed.
-Look at the example in the README section above.
-* New station attributes: planned_altitude, transponder, heading, qnh_in, qnh_mb,
-flight_type, cid, latitude_humanized, longitude_humanized
-
-
-### v. 0.3 - 22 July 2012
-
-* The hash returned by the `vatsim_online` method now includes 2 new arrays:
-`arrivals` and `departures`. These two are returned separately for convenience,
-in case you want to loop through them separately. The `pilots` array return is
-unchanged and contains all arrivals and departures.
-* New station attributes: latitude, longitude
-* Improved UTF-8 conversion process
-
-### v. 0.2 - 21 July 2012
-
-* Station attribute `departure` is now renamed to `origin`
-* UTF-8 is now enforced for all local caching and file/string manipulations, the
-original Vatsim data is re-encoded
-* Station ATIS is now cleaned of invalid and obscure characters
-* Improved documentation
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Make sure all tests are passing!
-5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
-
 ## Credits
 
 Copyright © 2016 [Svilen Vassilev](http://svilen.rubystudio.net)
@@ -473,6 +354,6 @@ Copyright © 2020 [Alex Dent](https://github.com/aldent95)
 * [Florian Rimoli](https://github.com/Flox06)
 * [Pierre Ferran](https://github.com/pierr3)
 
-Released under the [MIT LICENSE](https://github.com/tarakanbg/vatsim_online/blob/master/LICENSE)
+Released under the [MIT LICENSE](https://github.com/tarakanbg/vatsim_online_redux/blob/master/LICENSE)
 
 Maps generated by the [Great Circle Mapper](http://www.gcmap.com/), copyright Karl L. Swartz

data/lib/vatsim_online/callsign_parser.rb

@@ -9,7 +9,7 @@ module VatsimTools
     attributes = %w{role callsign gcmap_width gcmap_height}
     attributes.each {|attribute| attr_accessor attribute.to_sym }
 
-    LOCAL_DATA = "#{Dir.tmpdir}/vatsim_online/vatsim_data.txt"
+    LOCAL_DATA = "#{Dir.tmpdir}/vatsim_online/vatsim_data.json"
 
     def initialize(callsign, args = nil)
       VatsimTools::DataDownloader.new
@@ -29,15 +29,21 @@ module VatsimTools
 
 
     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"
+      matching_stations = []
+      raw_data = File.read(LOCAL_DATA)
+      data = JSON.parse(raw_data)
+      pilots = data['pilots'].each {|p| p['role'] = 'pilot'}
+      controllers = data['controllers'].each {|p| p['role'] = 'controller'}
+      atis = data['atis'].each {|p| p['role'] = 'atis'}
+      stations = pilots + controllers + atis
+      stations.each do |station|
+        callsign = station['callsign']
+        @callsign.each do |cs|
+          matching_stations << station 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
+      matching_stations
     end
 
     def station_objects

data/lib/vatsim_online/callsign_regex_parser.rb

@@ -0,0 +1,60 @@
+module VatsimTools
+
+  class CallsignRegexParser
+
+    %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_online/vatsim_data.json"
+
+    def initialize(callsign, args = nil)
+      VatsimTools::DataDownloader.new
+      # args.class == Hash ? @role = determine_role(args) : @role = "all"
+      @callsign = callsign.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
+      matching_stations = []
+      raw_data = File.read(LOCAL_DATA)
+      data = JSON.parse(raw_data)
+      pilots = data['pilots'].each {|p| p['role'] = 'pilot'}
+      controllers = data['controllers'].each {|p| p['role'] = 'controller'}
+      atis = data['atis'].each {|p| p['role'] = 'atis'}
+      stations = pilots + controllers + atis
+      stations.each do |station|
+        callsign = station['callsign']
+        @callsign.each do |cs|
+          matching_stations << station if Regexp.new(cs) =~ callsign[0...cs.length] # && client == "ATC") unless @role == "pilot"
+          # stations << row if (origin[0...icao.length] == icao || destination[0...icao.length] == icao) unless @role == "atc"
+        end
+      end
+      matching_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

@@ -1,127 +1,131 @@
-module VatsimTools
-require 'tempfile'
-require 'time_diff'
-require 'tmpdir'
-require 'net/http'
-require 'fileutils'
-  class DataDownloader
-
-    STATUS_URL = "http://status.vatsim.net/status.txt"
-    TEMP_DIR = "#{Dir.tmpdir}/vatsim_online"
-    LOCAL_STATUS = "#{Dir.tmpdir}/vatsim_online/vatsim_status.txt"
-    LOCAL_STATUS_BAK = "#{Dir.tmpdir}/vatsim_online/vatsim_status_bak.txt"
-    LOCAL_DATA = "#{Dir.tmpdir}/vatsim_online/vatsim_data.txt"
-    LOCAL_DATA_BAK = "#{Dir.tmpdir}/vatsim_online/vatsim_data_bak.txt"
-
-    def initialize
-      FileUtils.mkdir(TEMP_DIR) unless File.exist? TEMP_DIR
-      data_file
-    end
-
-    def create_status_tempfile
-      uri = URI(STATUS_URL)
-      http = Net::HTTP.new(uri.host, uri.port)
-      request = Net::HTTP::Get.new(uri.path)
-      data = http.request(request).body.gsub("\n", '')
-      create_status_backup if File.exists?(LOCAL_STATUS)
-      File.write(LOCAL_STATUS, data)
-      File.chmod(0777, LOCAL_STATUS)
-      dummy_status if data.include? "<html><head>"
-    rescue Exception => e
-      dummy_status
-    end
-
-    def create_status_backup
-      source = LOCAL_STATUS
-      target = LOCAL_STATUS_BAK
-      FileUtils.cp_r source, target
-      File.chmod(0777, LOCAL_STATUS_BAK)
-    end
-
-    def read_status_tempfile
-      status = File.open(LOCAL_STATUS)
-      difference = Time.diff(status.ctime, Time.now)[:hour]
-      if difference > 3
-        data = create_status_tempfile
-      else
-        data = status.read
-      end
-      status.close
-      data
-    end
-
-    def status_file
-      File.exists?(LOCAL_STATUS) ? read_status_tempfile : create_status_tempfile
-      LOCAL_STATUS
-    end
-
-    def servers
-      urls = []
-      CSV.foreach(status_file, :col_sep =>'=') do |row|
-        urls << row[1] if row[0] == "url0"
-      end
-      urls
-    end
-
-    def create_local_data_file
-      uri = URI(servers.sample)
-      http = Net::HTTP.new(uri.host, uri.port)
-      request = Net::HTTP::Get.new(uri.path)
-      req_data = http.request(request).body
-      create_data_backup if File.exists?(LOCAL_DATA)
-      data = req_data.gsub(/["]/, '\s').encode!('UTF-16', 'UTF-8', :invalid => :replace, :replace => '').encode!('UTF-8', 'UTF-16')
-      data = data.slice(0..(data.index('!PREFILE:')))
-      File.open(LOCAL_DATA, "w+") {|f| f.write(data)}
-      File.chmod(0777, LOCAL_DATA)
-      gem_data_file if req_data.include? "<html><head>"
-      file = File.open(LOCAL_DATA)
-      gem_data_file if file.size == 0
-      file.close
-    rescue Exception => e
-      gem_data_file
-    end
-
-    def create_data_backup
-      source = LOCAL_DATA
-      target = LOCAL_DATA_BAK
-      FileUtils.cp_r source, target
-      File.chmod(0777, LOCAL_DATA_BAK)
-    end
-
-    def read_local_datafile
-      data = File.open(LOCAL_DATA)
-      difference = Time.diff(data.ctime, Time.now)[:minute]
-      if difference > 2
-        d = create_local_data_file
-      else
-        d = data.read
-      end
-      data.close
-      d
-    end
-
-    def data_file
-      File.exists?(LOCAL_DATA) ? read_local_datafile : create_local_data_file
-      LOCAL_DATA
-    end
-
-    def gem_data_file
-      source = LOCAL_DATA_BAK
-      target = LOCAL_DATA
-      FileUtils.cp_r source, target
-      File.chmod(0777, LOCAL_DATA)
-    end
-
-    def dummy_status
-      source = LOCAL_STATUS_BAK
-      target = LOCAL_STATUS
-      FileUtils.cp_r source, target
-      File.chmod(0777, LOCAL_STATUS)
-    end
-    def get_data(url)
-      uri = URI(url)
-      Net::HTTP.get(uri)
-    end
-  end
-
-end
+module VatsimTools
+require 'tempfile'
+require 'time_diff'
+require 'tmpdir'
+require 'net/http'
+require 'fileutils'
+  class DataDownloader
+
+    STATUS_URL = "https://status.vatsim.net/status.json"
+    TEMP_DIR = "#{Dir.tmpdir}/vatsim_online"
+    LOCAL_STATUS = "#{Dir.tmpdir}/vatsim_online/vatsim_status.json"
+    LOCAL_STATUS_BAK = "#{Dir.tmpdir}/vatsim_online/vatsim_status_bak.json"
+    LOCAL_DATA = "#{Dir.tmpdir}/vatsim_online/vatsim_data.json"
+    LOCAL_DATA_BAK = "#{Dir.tmpdir}/vatsim_online/vatsim_data_bak.json"
+
+    def initialize
+      FileUtils.mkdir(TEMP_DIR) unless File.exist? TEMP_DIR
+      data_file
+    end
+
+    def create_status_tempfile
+      uri = URI(STATUS_URL)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.path)
+      http.use_ssl = (uri.scheme == 'https')
+      data = http.request(request).body.gsub("\n", '')
+      create_status_backup if File.exists?(LOCAL_STATUS)
+      File.write(LOCAL_STATUS, data)
+      File.chmod(0777, LOCAL_STATUS)
+      dummy_status if data.include? "<html><head>"
+    rescue Exception => e
+      if e.class == WebMock::NetConnectNotAllowedError
+        raise e
+      end
+      dummy_status
+    end
+
+    def create_status_backup
+      source = LOCAL_STATUS
+      target = LOCAL_STATUS_BAK
+      FileUtils.cp_r source, target
+      File.chmod(0777, LOCAL_STATUS_BAK)
+    end
+
+    def read_status_tempfile
+      status = File.open(LOCAL_STATUS)
+      difference = Time.diff(status.mtime, Time.now)[:hour]
+      if difference > 3
+        data = create_status_tempfile
+      else
+        data = status.read
+      end
+      status.close
+      data
+    end
+
+    def status_file
+      File.exists?(LOCAL_STATUS) ? read_status_tempfile : create_status_tempfile
+      LOCAL_STATUS
+    end
+
+    def servers
+      raw_data = File.read(status_file)
+      data = JSON.parse(raw_data)
+      data['data']['v3']
+    end
+
+    def create_local_data_file
+      uri = URI(servers.sample)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.path)
+      http.use_ssl = (uri.scheme == 'https')
+      req_data = http.request(request).body
+      create_data_backup if File.exists?(LOCAL_DATA)
+      File.open(LOCAL_DATA, "w+") {|f| f.write(req_data.force_encoding('UTF-8'))}
+      File.chmod(0777, LOCAL_DATA)
+      gem_data_file if req_data.include? "<html><head>"
+      file = File.open(LOCAL_DATA)
+      gem_data_file if file.size == 0
+      file.close
+    rescue Exception => e
+      if e.class == WebMock::NetConnectNotAllowedError
+        raise e
+      end
+      gem_data_file
+    end
+
+    def create_data_backup
+      source = LOCAL_DATA
+      target = LOCAL_DATA_BAK
+      FileUtils.cp_r source, target
+      File.chmod(0777, LOCAL_DATA_BAK)
+    end
+
+    def read_local_datafile
+      data = File.open(LOCAL_DATA)
+      difference = Time.diff(data.mtime, Time.now)[:second] + (Time.diff(data.mtime, Time.now)[:minute] * 60)
+      if difference > 60
+        d = create_local_data_file
+      else
+        d = data.read
+      end
+      data.close
+      d
+    end
+
+    def data_file
+      File.exists?(LOCAL_DATA) ? read_local_datafile : create_local_data_file
+      LOCAL_DATA
+    end
+
+    def gem_data_file
+      source = LOCAL_DATA_BAK
+      target = LOCAL_DATA
+      FileUtils.cp_r source, target
+      File.chmod(0777, LOCAL_DATA)
+    end
+
+    def dummy_status
+      source = LOCAL_STATUS_BAK
+      target = LOCAL_STATUS
+      FileUtils.cp_r source, target
+      File.chmod(0777, LOCAL_STATUS)
+    end
+    def get_data(url)
+      uri = URI(url)
+      Net::HTTP.get(uri)
+    end
+  end
+
+end