apex-aprs 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dbd006d7d8e71ef14b082177848ada159139d92012d859b7ff2c0dfd23bd3d4
-  data.tar.gz: ffc8ec190f0f310a3842732adedf1be2bed6b01488efc8d90cbd213174f85707
+  metadata.gz: 50aaeb1837b3f6a1515f98e798727ec7ca74815b0b4c6c6e197710b11916bd04
+  data.tar.gz: 7a0aeaafac5d7dc07bd4d74afa2b1eaaf29fad3c64bf6eb8e160f244bd0a7bd7
 SHA512:
-  metadata.gz: 4b829cea663db7673ae6f53531031f63736f5445cb7c48899a94ee1d7ca3b9848194479858c88fcd23abba18b48229e46ba811e54523c00ea21efcfef133c8ef
-  data.tar.gz: 0a831f1f9dffa31f6f76b4b060be04e997cc315f7604b701bb8086e4873337aaeea8c62fb4c80409d2a351b0355156cb5187c7e01cfc03bcb5938bfe28b7cee4
+  metadata.gz: 4186b7b390dee0744b860b060150adb3fcbb05f9b59890eca04758ae46a60bdc1938351983a59893c27f09badcf458e7fefcd7261651afd1ef5b418311b12970
+  data.tar.gz: 3c772a99fe98e6049036c20465a6cf687dc04f17ca30ab1ea5fc895dcd47eda5ea82dd90328f0c4b2ebbeb77ca998a94d2e78db7caa6b97e0899cc6a86290e6e

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.0.4
+
+* Frames are now classes rather than a map
+* Added mechanism for comparing frames for equivalence.
+
+## 1.0.3
+
+* Implemented the IGateTcp class for handling internet gateways.
+
 ## 1.0.2
 
 * Updates to dependencies only.

data/README.md

@@ -30,7 +30,20 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+### Unit Tests
+
+To run all unit tests first make sure you have dependencies installed:
+
+```bash
+bundle install
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Syncleus/apex-aprs
+then run the tests with:
+
+```bash
+bundle exec rake test
+```
+
+## Contributing
 
+Bug reports and pull requests are welcome on Git at https://git.qoto.org/digipex/apex-aprs

data/apex-aprs.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
     spec.add_dependency 'kiss-tnc', '~> 1.0'
     spec.add_development_dependency 'bundler', '~> 2.2'
     spec.add_development_dependency 'rake', '~> 13.0'
-    spec.add_development_dependency 'rdoc', '~> 6.3'
+    spec.add_development_dependency 'test-unit', '~> 3.6'
+    #spec.add_development_dependency 'rdoc', '~> 6.3'
     spec.add_development_dependency 'aruba', '~> 2.0'
 end

data/lib/apex/app_info.rb

@@ -1,3 +1,3 @@
 module Apex
-    VERSION = "1.0.2"
+    VERSION = "1.0.4"
 end

data/lib/apex/aprs_kiss.rb

@@ -1,4 +1,5 @@
 require 'kiss/constants'
+require 'apex/frame'
 
 module Apex
     class AprsKiss
@@ -11,7 +12,6 @@ module Apex
 
         private
         def self.decode_frame(raw_frame)
-            frame = {}
             frame_len = raw_frame.length
 
             if frame_len > 16
@@ -22,12 +22,12 @@ module Apex
                         # 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]
-                                text_as_array = raw_frame[raw_slice + 3..-1].map { |b| b.chr }
-                                frame[:text] = text_as_array.join
-                                frame[:destination] = identity_as_string(extract_callsign(raw_frame))
-                                frame[:source] = identity_as_string(extract_callsign(raw_frame[7..-1]))
-                                frame[:path] = extract_path(i.to_i, raw_frame)
-                                return frame
+                                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 Frame.new(source, destination, path, payload)
                             end
                         end
                     end
@@ -94,13 +94,13 @@ module Apex
 
         private
         def self.encode_frame(frame)
-            enc_frame = encode_callsign(parse_identity_string(frame[:destination])) + encode_callsign(parse_identity_string(frame[:source]))
+            enc_frame = encode_callsign(parse_identity_string(frame.destination)) + encode_callsign(parse_identity_string(frame.source))
 
-            frame[:path].each do |path|
+            frame.path.each do |path|
                 enc_frame += encode_callsign(parse_identity_string(path))
             end
 
-            return enc_frame[0...-1] + [enc_frame[-1] | 0x01] + [Kiss::SLOT_TIME] + [0xf0] + frame[:text].chars.map { |c| c.ord }
+            return enc_frame[0...-1] + [enc_frame[-1] | 0x01] + [Kiss::SLOT_TIME] + [0xf0] + frame.payload.chars.map { |c| c.ord }
         end
 
         private
@@ -170,4 +170,4 @@ module Apex
             end
         end
     end
-end
+end

data/lib/apex/frame.rb

@@ -0,0 +1,124 @@
+module Apex
+  public
+  class UnpathedFrame
+    attr_accessor :source, :destination, :payload
+
+    protected
+    def initialize(source, destination, payload)
+      @source = source
+      @destination = destination
+      @payload = payload
+    end
+
+    public
+    def path_agnostic_eql?(other)
+      raise ArgumentError.new("The argument must be either an UnpathedFrame or a PathAgnosticFrame") if not ((other.instance_of? UnpathedFrame) || (other.instance_of? PathAgnosticFrame))
+
+      return self == other
+    end
+
+    public
+    def path_agnostic_equality?(other)
+      return false if (not other.respond_to? :source) ||
+                      (not other.respond_to? :destination) ||
+                      (not other.respond_to? :payload)
+
+      if (self.source.eql? other.source) && (self.destination.eql? other.destination) && (self.payload.eql? other.payload)
+         return true
+      else
+        return false
+      end
+    end
+
+    public
+    def path_agnostic_hash
+      return [self.source, self.destination, self.payload].hash
+    end
+
+    public
+    def ==(other)
+      return self.path_agnostic_equality? other
+    end
+
+    public
+    def eql?(other)
+      self.path_agnostic_eql? other
+    end
+
+    public
+    def hash
+      return self.path_agnostic_hash
+    end
+  end
+
+  public
+  class Frame < UnpathedFrame
+    attr_accessor :path
+
+    protected
+    def initialize(source, destination, path, payload)
+      super(source, destination, payload)
+
+      @path = path
+    end
+
+    public
+    def eql?(other)
+      raise ArgumentError.new("The argument can not be a UnpathedFrame or a PathAgnosticFrame") if ((other.instance_of? UnpathedFrame) || (other.instance_of? PathAgnosticFrame))
+      raise ArgumentError.new("The argument must be of type Frame (or a child class).") if not other.kind_of? Frame
+
+      return self == other
+    end
+
+    public
+    def ==(other)
+      return false if not super(other)
+
+      return false if not other.respond_to? :path
+
+      if self.path.eql? other.path
+         return true
+      else
+        return false
+      end
+    end
+
+    public
+    def hash
+      return [super, self.path].hash
+    end
+
+    public
+    def path_agnostic_identity
+      return PathAgnosticFrame.new(self)
+    end
+  end
+
+  private
+  class PathAgnosticFrame < Frame
+    protected
+    def initialize(frame)
+      super(frame.source, frame.destination, frame.path, frame.payload)
+    end
+
+    public
+    def eql?(other)
+      return self.path_agnostic_eql? other
+    end
+
+    public
+    def ==(other)
+      return self.path_agnostic_equality? other
+    end
+
+    public
+    def hash
+      return self.path_agnostic_hash
+    end
+
+    public
+    def path_agnostic_identity
+      return self
+    end
+  end
+end

data/lib/apex/igate_tcp.rb

@@ -0,0 +1,178 @@
+require 'apex/app_info'
+
+module Apex
+    class IGateTcp
+        DEFAULT_APRSIS_URL = 'http://srvr.aprs-is.net:8080'
+        DEFAULT_APRSIS_SERVER = 'rotate.aprs.net'
+        DEFAULT_APRSIS_FILTER_PORT = 14580
+
+        protected
+        def initialize(user, password=nil)
+            @user = user
+            password = IGateTcp.calculatePasscode(user) if password.nil?
+            @auth = ['user', user, 'pass', password, 'vers', "APEX #{VERSION}"].join(' ')
+            @aprsis_sock = nil
+            @data_buffer = ''
+            @packet_buffer = []
+            @lock = Mutex.new
+        end
+
+        private
+        def reset_buffer
+            @data_buffer = ''
+            @packet_buffer = []
+        end
+
+        private
+        def self.format_path(path_list)
+            path_list.join(',')
+        end
+
+        private
+        def self.encode_frame(frame)
+            formatted_frame = [frame.source, frame.destination].join('>')
+            if frame.path and frame.path.length > 0
+                formatted_frame = [formatted_frame, IGateTcp::format_path(frame.path)].join(',')
+            end
+            formatted_frame += ':'
+            formatted_frame += frame.payload
+            return formatted_frame
+        end
+
+        private
+        def self.decode_frame(frame)
+            decoded_source = nil
+            frame_so_far = ''
+            path = nil
+            frame.chars.each do |char|
+                if char == '>' and decoded_source.nil?
+                    decoded_source = frame_so_far
+                    frame_so_far = ''
+                elsif char == ':' and !path
+                    path = frame_so_far
+                    frame_so_far = ''
+                else
+                    frame_so_far = [frame_so_far, char].join
+                end
+            end
+
+            path = path.split(',')
+            decoded_destination = path.shift
+            decoded_path = path
+            decoded_payload = frame_so_far
+
+            return Frame.new(decoded_source, decoded_destination, decoded_path, decoded_payload)
+        end
+
+        private
+        def self.calculatePasscode(callsign_raw)
+          callsign = callsign_raw.upcase.split('-').first
+          hash = 0x73e2
+          flag = true
+
+          callsign.split('').each do |c|
+            hash = if flag
+                      (hash ^ (c.ord << 8))
+                    else
+                      (hash ^ c.ord)
+                    end
+            flag = !flag
+          end
+          hash & 0x7fff
+        end
+
+        public
+        def connect(server=nil, port=nil, aprs_filter=nil, *args, **kwargs)
+            @lock.synchronize do
+                unless @aprsis_sock
+                    reset_buffer
+
+                    unless server
+                        server = DEFAULT_APRSIS_SERVER
+                    end
+
+                    unless port
+                        port = DEFAULT_APRSIS_FILTER_PORT
+                    end
+
+                    if aprs_filter.nil?
+                        @full_auth = @auth
+                    else
+                        @full_auth = [@auth, 'filter', aprs_filter].join(' ')
+                    end
+
+                    @server = server
+                    @port = port
+                    @aprsis_sock = TCPSocket.open(@server, @port)
+                    @aprsis_sock.puts( @full_auth + "\r\n" )
+                end
+            end
+        end
+
+        public
+        def close(*args, **kwargs)
+            @lock.synchronize do
+                if @aprsis_sock
+                    @aprsis_sock.close
+                    reset_buffer
+                    @aprsis_sock = nil
+                end
+            end
+        end
+
+        public
+        def read(filter_logresp=true, *args, **kwargs)
+            @lock.synchronize do
+                # check if there is any data waiting
+                read_more = true
+                while read_more
+                    begin
+                         read_line = @aprsis_sock.read_nonblock(100)
+                         unless read_line.nil?
+                             @data_buffer << read_line
+                         end
+                    rescue IO::WaitReadable
+                         read_more = false
+                    end
+                end
+
+                # check for any complete packets and move them to the packet buffer
+                if @data_buffer.include? "\r\n"
+                    partial = true
+                    if @data_buffer.end_with? "\r\n"
+                        partial = false
+                    end
+
+                    packets = @data_buffer.split("\r\n")
+                    if partial
+                        @data_buffer = packets.pop.dup
+                    else
+                        @data_buffer = ''
+                    end
+
+                    packets.each do |packet|
+                        @packet_buffer << packet.dup
+                    end
+                end
+
+                # return the next packet that matches the filter
+                while @packet_buffer.length > 0
+                    packet = @packet_buffer.pop
+                    unless (filter_logresp and packet.start_with?('#'))
+                        return IGateTcp::decode_frame(packet)
+                    end
+                end
+
+                return nil
+            end
+        end
+
+        public
+        def write(frame, *args, **kwargs)
+            @lock.synchronize do
+                encoded_frame = IGateTcp::encode_frame(frame)
+                @aprsis_sock.puts( encoded_frame )
+            end
+        end
+    end
+end

data/lib/apex.rb

@@ -1 +1,2 @@
-require 'apex/aprs_kiss'
+require 'apex/aprs_kiss'
+require 'apex/igate_tcp'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apex-aprs
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Jeffrey Phillips Freeman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 2023-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abstraction
@@ -81,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -129,12 +129,14 @@ files:
 - lib/apex.rb
 - lib/apex/app_info.rb
 - lib/apex/aprs_kiss.rb
+- lib/apex/frame.rb
+- lib/apex/igate_tcp.rb
 homepage: https://github.com/Syncleus/apex-aprs
 licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.4.16
+signing_key:
 specification_version: 4
 summary: Library for APRS, Automatic Packet Reporting System, communications including
   the next-generation APEX extensions. Includes an APRS-IS client.