vatsim_online_redux 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b68e83fc9b674c716b6bc39a5c49ca70a9d111eb0222bc344d0dd60df8582e9
-  data.tar.gz: 22751c268f529366bd591a6b1d7ce6bd020390c521aacf6d1a72417ae90c59df
+  metadata.gz: d505183669064d084f065ca8c896f478f3a354c6dafaadb122247a6fe3046994
+  data.tar.gz: a5d677876441ce1dd4d9767f5b67e148d8d83debf31ed0305b772fe743b6b0ca
 SHA512:
-  metadata.gz: 2f7e76e654c1f4c87c58f33c84ac13b115e5811571b9f07fedb08804867d3a6ff591b993d56ae0d2d054b8ac8d9e0e7b7ffc8b854d7b682ce9941b15e79a43e9
-  data.tar.gz: f8a65ee499723d787f6c25c26ab9d4dcabc7d764c3c18441bd2a78bbec92ed385f9fd6718724193ef76901e62b28643a181c978e29b2c350cfbd08eb2e0f93e4
+  metadata.gz: 92484572574fd1601e71a1fd1459bc7b098a3fa9dfc256167e49d2c3f0994ad13e527f24aad2687c6896e186ef7b0ca24731843edb05617e1fd504cd04713bf4
+  data.tar.gz: 8e25ae33b56267319781102c633ebff20dffb3ec8e4207c7c8319f5866214b457f96ea538aa139e18b8d3918c301c3366f484d2ebe3ed22a8e5ee1ef80bcc17a

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 ## Changelog
 
+### 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.rb

@@ -1,5 +1,5 @@
 %w{vatsim_online/version vatsim_online/station vatsim_online/data_downloader
-   vatsim_online/station_parser vatsim_online/callsign_parser}.each { |lib| require lib }
+   vatsim_online/station_parser vatsim_online/callsign_parser vatsim_online/callsign_regex_parser}.each { |lib| require lib }
 
 class String
   def vatsim_online(args={})
@@ -9,6 +9,10 @@ class String
   def vatsim_callsign(args={})
     VatsimOnline.vatsim_callsign(self, args)
   end
+
+  def vatsim_regex_callsign(args={})
+    VatsimOnline.vatsim_regex_callsign(self, args)
+  end
 end
 
 module VatsimOnline
@@ -21,4 +25,8 @@ module VatsimOnline
     VatsimTools::CallsignParser.new(callsign,args).station_objects
   end
 
+  def self.vatsim_regex_callsign(callsign, args)
+    VatsimTools::CallsignRegexParser.new(callsign, args).station_objects
+  end
+
 end

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

@@ -94,8 +94,8 @@ require 'fileutils'
 
     def read_local_datafile
       data = File.open(LOCAL_DATA)
-      difference = Time.diff(data.ctime, Time.now)[:minute]
-      if difference > 2
+      difference = Time.diff(data.ctime, Time.now)[:second] + (Time.diff(data.ctime, Time.now)[:minute] * 60)
+      if difference > 60
         d = create_local_data_file
       else
         d = data.read

data/lib/vatsim_online/version.rb

@@ -1,3 +1,3 @@
 module VatsimOnline
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/spec/callsign_regex_parser_spec.rb

@@ -0,0 +1,43 @@
+require 'vatsim_online'
+require 'data_downloader_spec_helper'
+
+describe VatsimTools::CallsignRegexParser do
+
+  target = VatsimTools::CallsignRegexParser
+
+  before(:each) do
+    delete_local_files
+    stub_request(:get, 'https://status.vatsim.net/status.json').
+      to_return(body: File.read(File.join(File.dirname(__FILE__),  'support', 'vatsim_status.json')), status: :ok)
+    stub_request(:get, 'https://data.vatsim.net/v3/vatsim-data.json').
+      to_return(body: File.read(File.join(File.dirname(__FILE__), 'support', 'vatsim_data.json')), status: :ok)
+  end
+
+  describe "stations" do
+    it "should return an expected result" do
+      callsign = "EGAC.*_APP"
+      target.new(callsign).stations.first['callsign'].should eq("EGAC_APP")
+      target.new(callsign).stations.class.should eq(Array)
+    end   
+  end
+
+  describe "station_objects" do
+    it "should return an array of Station objects" do
+      callsign = "VFE.*"
+      target.new(callsign).station_objects.class.should eq(Array)
+      target.new(callsign).station_objects.size.should eq(2)
+      target.new(callsign).station_objects.first.class.should eq(VatsimTools::Station)
+      target.new(callsign).station_objects.first.callsign.should eq("VFE1625")
+    end
+
+    it "should return an array of Station objects" do
+      callsign = "\\w{3}21\\d{2}"
+      target.new(callsign).station_objects.class.should eq(Array)
+      target.new(callsign).station_objects.size.should eq(2)
+      target.new(callsign).station_objects.first.class.should eq(VatsimTools::Station)
+      target.new(callsign).station_objects.first.callsign.should eq("VFE2157")
+    end
+  end
+
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vatsim_online_redux
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Svilen Vassilev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -131,11 +131,13 @@ files:
 - Rakefile
 - lib/vatsim_online.rb
 - lib/vatsim_online/callsign_parser.rb
+- lib/vatsim_online/callsign_regex_parser.rb
 - lib/vatsim_online/data_downloader.rb
 - lib/vatsim_online/station.rb
 - lib/vatsim_online/station_parser.rb
 - lib/vatsim_online/version.rb
 - spec/callsign_parser_spec.rb
+- spec/callsign_regex_parser_spec.rb
 - spec/data_downloader_spec.rb
 - spec/data_downloader_spec_helper.rb
 - spec/spec_helper.rb
@@ -174,6 +176,7 @@ summary: Updated version of original gem by Svilen Vassilev. Selectively pulls a
   on preset intervals and cached locally to avoid flooding the servers.
 test_files:
 - spec/callsign_parser_spec.rb
+- spec/callsign_regex_parser_spec.rb
 - spec/data_downloader_spec.rb
 - spec/data_downloader_spec_helper.rb
 - spec/spec_helper.rb