tac_scribe 0.6.4 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '087aeace10f5f7dc57b4a6f2814a606d98d9e6030f4af727f873e746d70351f6'
-  data.tar.gz: cfbd311805fbf15c025b2801180aeb4027860edd15b70a53397ff81234e55631
+  metadata.gz: cfeef79d42016f48197681a709c54114ca0029a4c2d5b70381165d119c9e97a0
+  data.tar.gz: d2f58ecaf5a1a0727b48ee391ea86ab8f8f98e46c3b0fef74da59b01660eecd0
 SHA512:
-  metadata.gz: 9447952b465dfa483c680b25610749dbf43ba15d69dc15787c19800159c5ad0e791ac8e369bb89998986f6480d11715f2009c39b4ac5cbbabbd56e335950a3ee
-  data.tar.gz: ccfa91a7488c9f44ae6dd3a54a0a2d68b343d40107e19f5848316568d471bf328ed95602821904dff2b3f824729607ade040262845d6a5b4b5d06e5df8a71ffc
+  metadata.gz: f19f29ac7a9f69e0fc201f79a38cac946dc4f3f6b7e619ce216547dbfbc5fef7350983f40b621d8a9554fc75735627bd37aa9bc1e2a01550222e6c9cbcf6e331
+  data.tar.gz: 92283b057445b590b197b7f32f2343be77e0d45caf70ff9b6a4706bc9dfdf28ae70cd2edb722989b9990fd019d6e85834167cb7468d7baa146c0ec68fac5bae0

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.3
+ruby-2.7.0

data/CHANGELOG.md

@@ -4,28 +4,52 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.6.2]
+## [Unreleased]
+
+## [0.7.4] - 2020-08-10
+### Changed
+^ Fix typo that was causing all objects to be registered as airbases
+
+## [0.7.3] - 2020-08-10
+### Changed
+- Bug fixes after adding CinC support
+
+## [0.7.2] - 2020-08-10
+### Added
+- Support for "Commander-In-Chief" to get airbase information
+
+## [0.7.1] - 2020-08-10
+### Changed
+- Fixed issue where "name" fields were not being populated
+  if airfields were not being loaded first
+
+## [0.7.0] - 2020-07-5
+### Changed
+- Synced Lat/Lon calculations with DCS and fixed issue where
+  calculations were incorrect if only one value was updated
+
+## [0.6.2] - 2020-04-19
 ### Changed
 - Fixed typo causing app to fail
 
-## [0.6.1]
+## [0.6.1] - 2020-04-19
 ### Changed
 - Test build for gem issue
 
-## [0.6.0]
+## [0.6.0] - 2020-04-19
 ### Added
 - Calculates and stores speed of units
 
 ### Fixed
 - Made more robust against failures and more logging messages
 
-## [0.5.0]
+## [0.5.0] - 2020-03-17
 ### Changed
 - Added missing db column to migration file
 - Clear the cache on server restart
 - Add more info to logging
 
-## [0.4.0]
+## [0.4.0] - 2020-03-13
 ### Changed
 - Switch to periodic writing to the database
 

data/exe/tac_scribe

@@ -10,6 +10,8 @@ options = {
   tacview_port: 42_674,
   tacview_password: nil,
   tacview_client_name: 'TacScribe',
+  cinc_enabled: false,
+  cinc_port: 9000,
   db_host: 'localhost',
   db_port: 5432,
   db_name: 'tac_scribe',
@@ -43,6 +45,17 @@ OptionParser.new do |opts|
     options[:tacview_client_name] = v
   end
 
+  opts.separator "\nCommander-In-Chief Options"
+  opts.on('-b', '--enable-cinc',
+          'Is Cinc enabled? (Default: false)') do |_v|
+    options[:cinc_enabled] = true
+  end
+  opts.on('-m', '--cinc-port=port',
+          'Cinc server port (Default: 9001)') do |v|
+    options[:cinc_port] = v
+  end
+  
+
   opts.separator "\nDatabase Options"
   opts.on('-o', '--db-host=host',
           'Postgresql server hostname / IP (Default: localhost)') do |v|
@@ -92,6 +105,11 @@ end.parse!
   exit(1)
 end
 
+if(options[:populate_airfields] && options[:cinc_enabled])
+  puts "You cannot populate airfields AND enable Cinc at the same time"
+  exit(1)
+end
+
 TacScribe::Daemon.new(
   tacview_host: options[:tacview_host],
   tacview_port: options[:tacview_port],
@@ -105,5 +123,7 @@ TacScribe::Daemon.new(
   verbose_logging: options[:verbose],
   thread_count: options[:threads].to_i,
   populate_airfields: options[:populate_airfields],
-  whitelist: options[:whitelist]
+  whitelist: options[:whitelist],
+  cinc_enabled: options[:cinc_enabled],
+  cinc_port: options[:cinc_port]
 ).start_processing

data/lib/tac_scribe/cache.rb

@@ -23,11 +23,12 @@ module TacScribe
     end
 
     def write_object(object)
-      if reference_latitude != 0 || reference_longitude != 0
+      if (reference_latitude != 0 || reference_longitude != 0) && object[:type] != "Ground+Static+Aerodrome"
         localize_position(object)
       end
 
       id = object[:object_id]
+      id ||= object[:id].to_s
       object[:id] = id
 
       cache_object = @@cache[id]
@@ -38,18 +39,29 @@ module TacScribe
         object.delete(key)
       end
 
-      if object[:coalition]
+      # https://wiki.hoggitworld.com/view/DCS_singleton_coalition
+      # Tacview returns a string, CinC returns an integer so we
+      # only do the conversion if there is a string.
+      if object[:coalition] && object[:coalition].is_a?(String)
         object[:coalition] = case object[:coalition]
-                             when 'Allies'
-                               0
-                             when 'Enemies'
-                               1
-                             else
+                             when 'Enemies' # Enemies is Bluefor
                                2
+                             when 'Allies' # Allies is Redfor
+                               1
+                             else # Neutral
+                               0
                              end
       end
 
-      if cache_object
+      if object[:type] == "Ground+Static+Aerodrome"
+        object[:heading] = object[:wind_heading] ? object[:wind_heading] : 0
+        object[:speed] = object[:wind_speed] ? object[:wind_speec] : 0
+        object.delete(:wind_heading)
+        object.delete(:wind_speed)
+        object.delete(:category)
+        cache_object = object
+        # No-op
+      elsif cache_object
         object[:heading] = calculate_heading(cache_object, object)
         object[:speed] = calculate_speed(cache_object, object)
         cache_object.merge!(object)
@@ -102,13 +114,13 @@ module TacScribe
       longitude = if object.key?(:longitude)
                     object[:longitude]
                   else
-                    cache_object[:position].y
+                    cache_object[:position].x
                   end
 
       latitude = if object.key?(:latitude)
                    object[:latitude]
                  else
-                   cache_object[:position].x
+                   cache_object[:position].y
                  end
 
       # This "Point" class is not lat/long aware which is why we are

data/lib/tac_scribe/daemon.rb

@@ -3,6 +3,7 @@
 require 'json'
 require 'tacview_client'
 require 'set'
+require 'cinc'
 require_relative 'datastore'
 require_relative 'cache'
 require_relative 'event_queue'
@@ -15,7 +16,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:, whitelist: nil)
+                   populate_airfields:, whitelist: nil, cinc_enabled:, cinc_port:)
       Datastore.instance.configure do |config|
         config.host = db_host
         config.port = db_port
@@ -34,13 +35,20 @@ module TacScribe
       @threads = {}
       @whitelist = Set.new(IO.read(whitelist).split) if whitelist
 
-      @client = TacviewClient::Client.new(
+      @tacview_client = TacviewClient::Client.new(
         host: tacview_host,
         port: tacview_port,
         password: tacview_password,
         processor: @event_queue,
         client_name: tacview_client_name
       )
+
+      if cinc_enabled
+        @cinc_client = Cinc::Client.new(
+          host: tacview_host,
+          port: cinc_port
+        )
+      end
     end
 
     # Starts processing and reconnects if the client was disconnected.
@@ -55,13 +63,14 @@ module TacScribe
         Datastore.instance.truncate_table
         Cache.instance.clear
         start_processing_threads
+        start_cinc_thread
         start_db_sync_thread
         start_reporting_thread
         populate_airfields if @populate_airfields
         @threads.each_pair do |key, _value|
           puts "#{key} thread started"
         end
-        @client.connect
+        @tacview_client.connect
         # If this code is executed it means we have been disconnected without
         # exceptions. We will still sleep to stop a retry storm. Just not as
         # long.
@@ -103,6 +112,30 @@ module TacScribe
       @threads[:processing] = event_processor_thread
     end
 
+    def start_cinc_thread
+      return unless @cinc_client
+      cinc_thread = Thread.new do
+        loop do
+          @cinc_client.connect
+          while true
+            @cinc_client.get_airbases.each do |airbase|
+              @event_queue.update_object Hash[airbase.map{ |k, v| [k.to_sym, v] }]
+            end
+            sleep 60
+          end
+          rescue StandardError => e
+            puts 'Exception in cinc thread'
+            puts e.message
+            puts e.backtrace
+            sleep 30
+            next
+        end
+      end
+
+      cinc_thread.name = 'Cinc Processor'
+      @threads[:cinc] = cinc_thread
+    end
+
     def start_db_sync_thread
       db_write_thread = Thread.new do
         loop do
@@ -154,7 +187,7 @@ module TacScribe
           altitude: BigDecimal(airfield['alt'].to_s),
           type: 'Ground+Static+Aerodrome',
           name: airfield['name'],
-          coalition: 2
+          coalition: 0 # Neutral
         )
       end
     end

data/lib/tac_scribe/event_processor.rb

@@ -68,6 +68,9 @@ module TacScribe
     def update_object(event, time)
       return if ignore_unit?(event)
 
+      # Hack to make sure the :name field is present so that it is included
+      # in the SQL
+      event[:name] = nil unless event.has_key?(:name)
       event[:game_time] = time
 
       self.events_processed += 1

data/lib/tac_scribe/version.rb

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

data/tac_scribe.gemspec

@@ -26,11 +26,11 @@ Gem::Specification.new do |spec|
 
   spec.metadata['yard.run'] = 'yri'
 
+  spec.platform = RUBY_PLATFORM == 'java' ? 'java' : 'ruby'
+
   if RUBY_PLATFORM == 'java'
-    spec.platform = 'java'
     spec.add_dependency 'activerecord-jdbcpostgresql-adapter'
   else
-    spec.platform = 'ruby'
     spec.add_dependency 'pg', '~>1.1'
   end
 
@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'haversine', '~>0.3'
   spec.add_dependency 'sequel-postgis-georuby', '0.1.2'
   spec.add_dependency 'tacview_client', '~>0.1'
+  spec.add_dependency 'cinc', '~>0.1'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
@@ -50,4 +51,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~>0.73'
   spec.add_development_dependency 'simplecov', '~>0.17'
   spec.add_development_dependency 'yard', '~>0.9'
+  spec.add_development_dependency 'pry-byebug', '~>3.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tac_scribe
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.4
 platform: ruby
 authors:
 - Jeffrey Jones
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: cinc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 description: Write Tacview data to PostGIS database
 email:
 - jeff@jones.be
@@ -248,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Write Tacview data to PostGIS database