tac_scribe 0.2.1-java → 0.3.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad06d7c2f742a8d35c641bf120a6f95391902ea57719669cc53cd80186a14493
-  data.tar.gz: e35b648c32b18fe4628ee4a3a46adb6a378f2639d2e85a9cd6743b5d57624f7d
+  metadata.gz: f53013c85197970f92c1b1d77608bbb6c0f6d7d70b09640a4d566282ecd2ecd0
+  data.tar.gz: e05a92c6f3da05c2f2925bb0ab18740ec31e3629906c56472e3fa94b5c1891c8
 SHA512:
-  metadata.gz: 9a0fb2a75b2d1c66ff44aca4bbcdb3bf905032c20f631230c4491cfc8c696de3059b947e89c245b30c624d6c89a37f20bb9f24a38e0acc876bfefb409b04a442
-  data.tar.gz: 3502da2ea575e6a40a87599c2a117ccdbf12417b59feef9dd92628c9f56c46a1b642795203437d7b81321eda4c4c64e67e23d5203cb8ec4cf1c63bf6529c5f97
+  metadata.gz: 54e42d58f65f1d4e49f1affc4211d8829d4b26a1dfc810c5656c37346e552fad692371c3e0738f7a7629d378d88e481aad570a1a8ab47e329cc2c91aac601f20
+  data.tar.gz: 71d84cd363227f4ffd2684e00c04ae97e714b74f25339f1cf004d5741c33bf770131d7fb51b2b346f112d575135549ef001c0cb6c71b914cf0a72310659c926b

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.3
+jruby

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2019-10-27
+### Changed
+- Changed the command-line name to match gem
+
+### Fixed
+- Sleep between connection attempts
+
+### Added
+- Unit type filtering
+
 ## [0.2.1] - 2019-10-13
 ### Changed
 - Added separate events in / events out for the queue logging

data/README.md

@@ -21,9 +21,32 @@ Or install it yourself as:
 
 ## Usage
 
-You can run the tool using the `start_scribe` command. Use the `--help`
+You can run the tool using the `tac_scribe` command. Use the `--help`
 option for information on required arguments
 
+### Whitelist
+
+If you want to restrict what units get written to the database (e.g. for
+performance reasons) then create a whitelist file and pass that in with
+the whitelist option. For example if you only care about air units
+and landing areas create a file like the following:
+
+`whitelist.txt`
+
+With the following content
+
+```
+Sea+Watercraft+AircraftCarrier
+Air+Rotorcraft
+Air+FixedWing
+Ground+Static+Aerodrome
+Navaid+Static+Bullseye
+```
+
+and add `-w whitelist.txt` to the command-line.
+
+The unit type is the type provided by Tacview and it must be an exact match
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then,

data/exe/{start_scribe → tac_scribe}

@@ -15,7 +15,8 @@ options = {
   db_name: 'tac_scribe',
   verbose_logging: false,
   threads: 1,
-  populate_airfields: false
+  populate_airfields: false,
+  whitelist: nil
 }
 
 OptionParser.new do |opts|
@@ -76,6 +77,10 @@ OptionParser.new do |opts|
           'Verbose logging') do |_v|
     options[:verbose] = true
   end
+  opts.on('-w', '--whitelist=whitelist',
+          'Whitelist filename') do |v|
+    options[:whitelist] = v
+  end
 end.parse!
 
 %i[db_user db_password].each do |parameter|
@@ -99,5 +104,6 @@ TacScribe::Daemon.new(
   db_password: options[:db_password],
   verbose_logging: options[:verbose],
   thread_count: options[:threads].to_i,
-  populate_airfields: options[:populate_airfields]
+  populate_airfields: options[:populate_airfields],
+  whitelist: options[:whitelist]
 ).start_processing

data/lib/tac_scribe/daemon.rb

@@ -2,6 +2,7 @@
 
 require 'json'
 require 'tacview_client'
+require 'set'
 require_relative 'datastore'
 require_relative 'event_queue'
 require_relative 'event_processor'
@@ -13,7 +14,7 @@ module TacScribe
     def initialize(db_host:, db_port:, db_name:, db_user:, db_password:,
                    tacview_host:, tacview_port:, tacview_password:,
                    tacview_client_name:, verbose_logging:, thread_count:,
-                   populate_airfields:)
+                   populate_airfields:, whitelist: nil)
       Datastore.instance.configure do |config|
         config.host = db_host
         config.port = db_port
@@ -28,6 +29,7 @@ module TacScribe
       @populate_airfields = populate_airfields
       @thread_count = thread_count
       @processing_threads = []
+      @whitelist = Set.new(IO.read(whitelist).split) if whitelist
 
       @client = TacviewClient::Client.new(
         host: tacview_host,
@@ -51,7 +53,6 @@ module TacScribe
         start_processing_threads
         populate_airfields if @populate_airfields
         @client.connect
-        sleep 30
       # Rescuing reliably from Net::HTTP is a complete bear so rescue
       # StandardError. It ain't pretty but it is reliable. We will puts
       # the exception just in case
@@ -59,6 +60,7 @@ module TacScribe
       rescue StandardError => e
         puts e.message
         puts e.backtrace
+        sleep 30
         next
       end
     end
@@ -74,7 +76,8 @@ module TacScribe
       @thread_count.times do
         @processing_threads << Thread.new do
           EventProcessor.new(datastore: Datastore.instance,
-                             event_queue: @event_queue).start
+                             event_queue: @event_queue,
+                             whitelist: @whitelist).start
         end
       end
     end
@@ -83,15 +86,15 @@ module TacScribe
       json = File.read(File.join(File.dirname(__FILE__), '../../data/airfields.json'))
       airfields = JSON.parse(json)
       airfields.each_with_index do |airfield, i|
-        @event_queue.update_object({
-            object_id: (45_000_000 + i).to_s,
-            latitude: BigDecimal(airfield['lat'].to_s),
-            longitude: BigDecimal(airfield['lon'].to_s),
-            altitude: BigDecimal(airfield['alt'].to_s),
-            type: 'Ground+Static+Aerodrome',
-            name: airfield['name'],
-            coalition: 2
-        })
+        @event_queue.update_object(
+          object_id: (45_000_000 + i).to_s,
+          latitude: BigDecimal(airfield['lat'].to_s),
+          longitude: BigDecimal(airfield['lon'].to_s),
+          altitude: BigDecimal(airfield['alt'].to_s),
+          type: 'Ground+Static+Aerodrome',
+          name: airfield['name'],
+          coalition: 2
+        )
       end
     end
   end

data/lib/tac_scribe/event_processor.rb

@@ -2,14 +2,18 @@
 
 require 'tacview_client/base_processor'
 require 'time'
+require 'concurrent-ruby'
 require_relative 'datastore'
 
 module TacScribe
   # Processes the events emitted by the Ruby Tacview Client
   class EventProcessor
-    def initialize(datastore:, event_queue:)
+    @@ignored_units = Concurrent::Set.new
+
+    def initialize(datastore:, event_queue:, whitelist: nil)
       @datastore = datastore
       @event_queue = event_queue
+      @whitelist = whitelist
     end
 
     def start
@@ -52,6 +56,13 @@ module TacScribe
     # @option event [BigDecimal] :altitude The object altitude above sea level
     #   in meters to 1 decimal place.
     def update_object(event, time)
+      return if @@ignored_units.include?(event[:object_id])
+
+      if @whitelist && event[:type] && !@whitelist.include?(event[:type])
+        @@ignored_units << event[:object_id]
+        return
+      end
+
       if @event_queue.reference_latitude || @event_queue.reference_longitude
         localize_position(event)
       end
@@ -64,6 +75,8 @@ module TacScribe
     # @param object_id [String] A hexadecimal number representing the object
     #   ID
     def delete_object(object_id)
+      return if @@ignored_units.delete?(object_id)
+
       @datastore.delete_object(object_id)
     end
 

data/lib/tac_scribe/event_queue.rb

@@ -18,7 +18,7 @@ module TacScribe
 
       Thread.new do
         loop do
-          puts "#{Time.now.strftime("%FT%T")} - Queue Size: #{@events.size} \t Events Added: #{@event_write} \t Events Processed: #{@event_read}"
+          puts "#{Time.now.strftime('%FT%T')} - Queue Size: #{@events.size} \t Events Added: #{@event_write} \t Events Processed: #{@event_read}"
           @event_write = 0
           @event_read = 0
           sleep 1

data/lib/tac_scribe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TacScribe
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/tac_scribe.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   # The following gem is newish and not heavily updated so the chances
   # of an API breaking change are higher then normal. Therefore lock the
   # version
+  spec.add_dependency 'concurrent-ruby', '~>1.1.5'
   spec.add_dependency 'sequel-postgis-georuby', '0.1.2'
   spec.add_dependency 'tacview_client', '~>0.1'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tac_scribe
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: java
 authors:
 - Jeffrey Jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2019-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.22'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  name: concurrent-ruby
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -168,7 +182,7 @@ description: Write Tacview data to PostGIS database
 email:
 - jeff@jones.be
 executables:
-- start_scribe
+- tac_scribe
 extensions: []
 extra_rdoc_files: []
 files:
@@ -189,7 +203,7 @@ files:
 - data/airfields.json
 - db/001_create_unit_table.rb
 - db/README.md
-- exe/start_scribe
+- exe/tac_scribe
 - lib/tac_scribe.rb
 - lib/tac_scribe/daemon.rb
 - lib/tac_scribe/datastore.rb