kiss-tnc 1.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 394d48eb1bdb8bda7bc9283a58b8b7ec8d53585b
-  data.tar.gz: ce5f3281c95c4d13e740944a3b709715e527cbe6
+SHA256:
+  metadata.gz: '09b09122da0f586f8c540ad8327c90ac04b5461b1fc6a7ed82e4a19319f23330'
+  data.tar.gz: 1c126ad07648e80290e873ed49cf9bf9c6672d3ea9e2d181ff977a54d6208a46
 SHA512:
-  metadata.gz: 768bfa681b99bc095b97499cdf73b73490bd0abee0319710d13af7e57a81785ff09ef260a74476fd826748475ba0e9b538849666676509b970ddb4c9f4594b2a
-  data.tar.gz: 1bcf99dd124fdea56a27529e76a0cd706ecf42fed6f9ece186781143242be71a9b702506df4f9a116f84d589c6feebf9f14acca36b2455caf99e5b2c22c2cf1b
+  metadata.gz: 2b0df5c966c1e2082162902ec988dff74d455ebe831f774e4df32768e6ea91ece147168714fa36cd71014616f6eb384550391003a22092bace28ab6672c066f8
+  data.tar.gz: f6fa098359c055522eddbcabd135244e06a4d06e37b0682556e77fbd9b0c0d017bce82c25c6fad12f06c2be358647511b562be09db7ee354514720230a226764

data/.gitignore

@@ -5,3 +5,4 @@ html
 Gemfile.lock
 .idea/
 *.gem
+/public/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 2.1.0
+
+* Added a parent interface to KissAbstract called Kiss
+
+## 2.0.0
+
+* Moved abstraction over to abstractify library.
+* Added more parsing methods so entry points now take strings rather than KISS encoded data.
+* Added errors where appropriate, for example writing invalid frames now throw an IOError.
+* The write and read methods now take frames in the form of a map of strings, all encoding is now handled by the library.
+
 ## 1.0.3
 
 * Changed KissSerial so its methods can accept any arguments, used for abstraction purposes.
@@ -16,4 +27,4 @@
 
 ## 1.0.0
 
-* Initial release
+* Initial release

data/CONTRIBUTORS.md

@@ -1,4 +1,10 @@
+## Current Project Lead
+
 * Jeffrey Phillips Freeman (WI2ARD) - http://JeffreyFreeman.me
+
+## Contributors
+
+* Greg Albrecht W2GMD <oss@undef.net>
 * Martin Murray (KD8LVZ)
 * Paul McMillan - https://github.com/PaulMcMillan
 * Russ Innes

data/Rakefile

@@ -24,44 +24,43 @@ def dump_load_path
     end
 end
 
-gem 'json', '~> 1.8.3'
-
-gem 'bundler', '~> 1.7'
+# gem 'json', '~> 1.8.3'
+#
+# gem 'bundler', '~> 1.7'
 require 'bundler'
 
-gem 'rake', '~> 11.3.0'
+# gem 'rake', '~> 11.3.0'
 require 'rake/clean'
 require 'rake/testtask'
 
 
-require 'cucumber'
-require 'cucumber/rake/task'
-gem 'rdoc' # we need the installed RDoc gem, not the system one
-require 'rdoc/task'
+# require 'cucumber'
+# require 'cucumber/rake/task'
+# gem 'rdoc' # we need the installed RDoc gem, not the system one
+# require 'rdoc/task'
 
 include Rake::DSL
 
 Bundler::GemHelper.install_tasks
 
 
-Rake::TestTask.new do |t|
-    t.pattern = 'test/tc_*.rb'
-end
-
-
-CUKE_RESULTS = 'results.html'
-CLEAN << CUKE_RESULTS
-Cucumber::Rake::Task.new(:features) do |t|
-    t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
-    t.fork = false
-end
-
-Rake::RDocTask.new do |rd|
+# Rake::TestTask.new do |t|
+#     t.pattern = 'test/tc_*.rb'
+# end
 
-    rd.main = "README.rdoc"
-
-    rd.rdoc_files.include("README.rdoc", "lib/**/*.rb", "bin/**/*")
-end
 
-task :default => [:test, :features]
+# CUKE_RESULTS = 'results.html'
+# CLEAN << CUKE_RESULTS
+# Cucumber::Rake::Task.new(:features) do |t|
+#     t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+#     t.fork = false
+# end
 
+# Rake::RDocTask.new do |rd|
+#
+#     rd.main = "README.rdoc"
+#
+#     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb", "bin/**/*")
+# end
+#
+# task :default => [:test, :features]

data/kiss-tnc.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
     spec.summary = %q{Library for KISS communication with TNCs.}
     spec.description = %q{Ruby library for KISS communication with Terminal Node Controllers.}
-    spec.homepage = 'https://github.com/Syncleus/aprs'
+    spec.homepage = 'https://git.qoto.org/digipex/kiss-tnc'
 
     # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
     # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -29,10 +29,12 @@ Gem::Specification.new do |spec|
     spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
     spec.require_paths = ['lib']
 
-    spec.add_dependency 'abstraction', '~> 0.0.4'
+    spec.add_dependency 'abstractify', '~> 1.1'
     spec.add_dependency 'serialport', '~> 1.3'
-    spec.add_development_dependency 'bundler', '~> 1.7'
-    spec.add_development_dependency 'rake', '~> 11.3'
-    spec.add_development_dependency 'rdoc', '~> 4.2'
-    spec.add_development_dependency 'aruba', '~> 0.14'
+    spec.add_development_dependency 'bundler', '~> 2.3'
+    spec.add_development_dependency 'rake', '~> 13.0'
+    spec.add_development_dependency 'rspec', '~> 3.12'
+    spec.add_development_dependency 'simplecov', '~> 0.22'
+    spec.add_development_dependency 'simplecov-console', '~> 0.9'
+    #spec.add_development_dependency 'rdoc', '~> 6.5'
 end

data/lib/kiss/app_info.rb

@@ -1,3 +1,3 @@
 module Kiss
-    VERSION = "1.0.3"
+    VERSION = "2.1.0"
 end

data/lib/kiss/kiss.rb

@@ -0,0 +1,9 @@
+require 'abstractify'
+
+module Kiss
+  class Kiss
+    include Abstractify::Abstract
+
+    abstract :write_interface, :read_interface, :connect, :close
+  end
+end

data/lib/kiss/kiss_abstract.rb

@@ -1,10 +1,13 @@
 require 'thread'
-require 'abstraction'
+require 'abstractify'
 require 'kiss/constants'
+require 'kiss/kiss'
 
 module Kiss
-    class KissAbstract
-        abstract
+    class KissAbstract < Kiss
+        include Abstractify::Abstract
+
+        abstract :write_interface, :read_interface, :connect, :close
 
         protected
         def initialize(strip_df_start=true)
@@ -52,9 +55,132 @@ module Kiss
             (port << 4) & command_code
         end
 
-        protected
-        def write_setting(command, value)
-            write_interface([FEND] + [command] + escape_special_codes(value) + [FEND])
+        private
+        def self.extract_path(start, raw_frame)
+            full_path = []
+
+            (2...start).each do |i|
+                path = identity_as_string(extract_callsign(raw_frame[i * 7..-1]))
+                if path and path.length > 0
+                    if raw_frame[i * 7 + 6] & 0x80 != 0
+                        full_path << [path, '*'].join
+                    else
+                        full_path << path
+                    end
+                end
+            end
+            return full_path
+        end
+
+        private
+        def self.parse_identity_string(identity_string)
+            # If we are parsing a spent token then first lets get rid of the astresick suffix.
+            if identity_string[-1] == '*'
+                identity_string = identity_string[0..-1]
+            end
+
+            if identity_string.include? '-'
+                call_sign, ssid = identity_string.split('-')
+            else
+                call_sign = identity_string
+                ssid = 0
+            end
+
+            return {:callsign => call_sign, :ssid => ssid.to_i}
+        end
+
+        private
+        def self.identity_as_string(identity)
+            if identity[:ssid] and identity[:ssid] > 0
+                return [identity[:callsign], identity[:ssid].to_s].join('-')
+            else
+                return identity[:callsign]
+            end
+        end
+
+        private
+        def self.extract_callsign(raw_frame)
+            callsign_as_array = raw_frame[0...6].map { |x| (x >> 1).chr }
+            callsign = callsign_as_array.join.strip
+            ssid = (raw_frame[6] >> 1) & 0x0f
+            ssid = (ssid == nil or ssid == 0 ? nil : ssid)
+            return {:callsign => callsign, :ssid => ssid}
+        end
+
+        private
+        def self.encode_callsign(callsign)
+            call_sign = callsign[:callsign]
+
+            enc_ssid = (callsign[:ssid] << 1) | 0x60
+
+            if call_sign.include? '*'
+                call_sign.gsub!(/\*/, '')
+                enc_ssid |= 0x80
+            end
+
+            while call_sign.length < 6
+                call_sign = [call_sign, ' '].join
+            end
+
+            return call_sign.chars.map { |p| p.ord << 1 } + [enc_ssid]
+        end
+
+        private
+        def self.encode_frame(frame)
+            enc_frame = encode_callsign(parse_identity_string(frame[:destination].to_s)) + encode_callsign(parse_identity_string(frame[:source].to_s))
+
+            frame[:path].each do |hop|
+                enc_frame += encode_callsign(parse_identity_string(hop.to_s))
+            end
+
+            return enc_frame[0...-1] + [enc_frame[-1] | 0x01] + [SLOT_TIME] + [0xf0] + frame[:payload].chars.map { |c| c.ord }
+        end
+
+        private
+        def self.decode_frame(raw_frame)
+            frame_len = raw_frame.length
+
+            if frame_len > 16
+                (0...frame_len - 2).each do |raw_slice|
+                    # Is address field length correct?
+                    if raw_frame[raw_slice] & 0x01 != 0 and ((raw_slice + 1) % 7) == 0
+                        i = (raw_slice.to_f + 1.0) / 7.0
+                        # Less than 2 callsigns?
+                        if 1.0 < i and i < 11.0
+                            if raw_frame[raw_slice + 1] & 0x03 == 0x03 and [0xf0, 0xcf].include? raw_frame[raw_slice + 2]
+                                payload_as_array = raw_frame[raw_slice + 3..-1].map { |b| b.chr }
+                                payload = payload_as_array.join
+                                destination = identity_as_string(extract_callsign(raw_frame))
+                                source = identity_as_string(extract_callsign(raw_frame[7..-1]))
+                                path = extract_path(i.to_i, raw_frame)
+                                return {:source => source, :destination => destination, :path => path, :payload => payload}
+                            end
+                        end
+                    end
+                end
+            end
+            return nil
+        end
+
+        private
+        def self.valid_frame(raw_frame)
+            frame_len = raw_frame.length
+
+            if frame_len > 16
+                (0...frame_len - 2).each do |raw_slice|
+                    # Is address field length correct?
+                    if raw_frame[raw_slice] & 0x01 != 0 and ((raw_slice + 1) % 7) == 0
+                        i = (raw_slice.to_f + 1.0) / 7.0
+                        # Less than 2 callsigns?
+                        if 1.0 < i and i < 11.0
+                            if raw_frame[raw_slice + 1] & 0x03 == 0x03 and [0xf0, 0xcf].include? raw_frame[raw_slice + 2]
+                                return true
+                            end
+                        end
+                    end
+                end
+            end
+            return false
         end
 
         private
@@ -115,6 +241,34 @@ module Kiss
             end
         end
 
+        private
+        def read_bytes(*args, **kwargs)
+              if @frame_buffer.length == 0
+                  fill_buffer
+              end
+
+              if @frame_buffer.length > 0
+                  return_frame = @frame_buffer[0]
+                  @frame_buffer.shift
+                  return return_frame
+              else
+                  return nil
+              end
+        end
+
+        private
+        def write_bytes(frame_bytes, port=0, *args, **kwargs)
+              kiss_packet = [FEND] + [KissAbstract.command_byte_combine(port, DATA_FRAME)] +
+                  KissAbstract.escape_special_codes(frame_bytes) + [FEND]
+
+              write_interface(kiss_packet)
+        end
+
+        protected
+        def write_setting(command, value)
+            write_interface([FEND] + [command] + KissAbstract.escape_special_codes(value) + [FEND])
+        end
+
         public
         def connect(mode_init=nil, *args, **kwargs)
         end
@@ -125,29 +279,26 @@ module Kiss
 
         public
         def read(*args, **kwargs)
-            @lock.synchronize do
-                if @frame_buffer.length == 0
-                    fill_buffer
-                end
-
-                if @frame_buffer.length > 0
-                    return_frame = @frame_buffer[0]
-                    @frame_buffer.shift
-                    return return_frame
-                else
-                    return nil
-                end
-            end
+          @lock.synchronize do
+              frame = self.read_bytes(*args, **kwargs)
+              if frame and frame.length > 0
+                  return KissAbstract.decode_frame(frame)
+              else
+                  return nil
+              end
+          end
         end
 
         public
-        def write(frame_bytes, port=0, *args, **kwargs)
-            @lock.synchronize do
-                kiss_packet = [FEND] + [KissAbstract.command_byte_combine(port, DATA_FRAME)] +
-                    KissAbstract.escape_special_codes(frame_bytes) + [FEND]
-
-                write_interface(kiss_packet)
-            end
+        def write(frame, port=0, *args, **kwargs)
+          @lock.synchronize do
+              encoded_frame = KissAbstract.encode_frame(frame)
+              if KissAbstract.valid_frame(encoded_frame)
+                self.write_bytes(encoded_frame, *args, **kwargs)
+              else
+                raise IOError.new("frame was able to be encoded but was determined not to be valid")
+              end
+          end
         end
     end
-end
+end

data/lib/kiss/kiss_serial.rb

@@ -77,10 +77,10 @@ module Kiss
             end
 
             if @serial == nil or @serial.closed?
-                raise 'Attempting to close before the class has been started.'
+                raise IOError.new('Attempting to close before the class has been started.')
             else
                 @serial.close
             end
         end
     end
-end
+end

data/lib/kiss.rb

@@ -1,3 +1,5 @@
 require 'kiss/app_info'
 require 'kiss/kiss_serial'
-require 'kiss/constants'
+require 'kiss/constants'
+require 'kiss/kiss_abstract'
+require 'kiss/kiss'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kiss-tnc
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Jeffrey Phillips Freeman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: abstraction
+  name: abstractify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: serialport
   requirement: !ruby/object:Gem::Requirement
@@ -44,56 +44,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Ruby library for KISS communication with Terminal Node Controllers.
 email:
 - jeffrey.freeman@syncleus.com
@@ -102,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - CONTRIBUTORS.md
 - Gemfile
@@ -113,16 +128,15 @@ files:
 - lib/kiss.rb
 - lib/kiss/app_info.rb
 - lib/kiss/constants.rb
+- lib/kiss/kiss.rb
 - lib/kiss/kiss_abstract.rb
 - lib/kiss/kiss_serial.rb
-- lib/kiss/test.rb
-- lib/kiss/test/kiss_mock.rb
-homepage: https://github.com/Syncleus/aprs
+homepage: https://git.qoto.org/digipex/kiss-tnc
 licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,9 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.17
+signing_key:
 specification_version: 4
 summary: Library for KISS communication with TNCs.
 test_files: []

data/lib/kiss/test/kiss_mock.rb

@@ -1,41 +0,0 @@
-require 'kiss/kiss_abstract'
-
-module Kiss
-    class KissMock < KissAbstract
-
-        def initialize(strip_df_start=true)
-            super(strip_df_start)
-            @read_from_interface = []
-            @sent_to_interface = []
-        end
-
-        protected
-        def read_interface
-            if @read_from_interface.length == 0
-                return nil
-            end
-            return @read_from_interface.shift
-        end
-
-        protected
-        def write_interface(data)
-            @sent_to_interface << data
-        end
-
-        public
-        def clear_interface
-            @read_from_interface = []
-            @sent_to_interface = []
-        end
-
-        public
-        def add_read_from_interface(raw_frame)
-            @read_from_interface << raw_frame
-        end
-
-        public
-        def get_sent_to_interface
-            return @sent_to_interface
-        end
-    end
-end

data/lib/kiss/test.rb

@@ -1 +0,0 @@
-require 'kiss/test/kiss_mock'