ax25 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a5425ad5492e2b1b282d0ee3cdfc6479606520a310c68b63ea47abab2a5ef4c
+  data.tar.gz: fe8798a01726d2348495e00ef368265b5b3445019a9cd88e5bc5d4f57a9acf6d
+SHA512:
+  metadata.gz: e5847280eeb768b603c8abdf89a2c697a87053e72e6d67774b5c20c6b0a9bb5574ad83142a7b944c98cc6e9e49ef7efbbfb2f9df0fe9b56b1ffd7e06ef970709
+  data.tar.gz: 7c21ed23b09b4e1d355b754e237dd1c4ac3d51d6258dc2ac236727b00e08b822493d75da4346fe4ffef450fd3856d66af3a8dec8ffb9b62cd62c42c873ce4608

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+results.html
+pkg
+html
+Gemfile.lock
+.idea/
+*.gem
+/public/
+/vendor/

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1
+
+* Initial release

data/CONTRIBUTORS.md

@@ -0,0 +1,19 @@
+## 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
+* John Hogenmiller (KB3DFZ) - https://github.com/ytjohn
+* Phil Gagnon N1HHG
+* Ben Benesh - https://github.com/bbene
+* Joe Goforth
+* Rick Eason
+* Jay Nugent
+* Pete Loveall (AE5PL)
+* darksidelemm - https://github.com/darksidelemm
+* agmuino - https://github.com/agmuino

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,49 @@
+# AX.25
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ax25`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ax25'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ax25
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+### Unit Tests
+
+To run all unit tests first make sure you have dependencies installed:
+
+```bash
+bundle install
+```
+
+then run the tests with:
+
+```bash
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on Git at https://git.qoto.org/digipex/ax25

data/Rakefile

@@ -0,0 +1,66 @@
+def dump_load_path
+    puts $LOAD_PATH.join("\n")
+    found = nil
+    $LOAD_PATH.each do |path|
+        if File.exists?(File.join(path, "rspec"))
+            puts "Found rspec in #{path}"
+            if File.exists?(File.join(path, "rspec", "core"))
+                puts "Found core"
+                if File.exists?(File.join(path, "rspec", "core", "rake_task"))
+                    puts "Found rake_task"
+                    found = path
+                else
+                    puts "!! no rake_task"
+                end
+            else
+                puts "!!! no core"
+            end
+        end
+    end
+    if found.nil?
+        puts "Didn't find rspec/core/rake_task anywhere"
+    else
+        puts "Found in #{path}"
+    end
+end
+
+# gem 'json', '~> 2.5'
+#
+# gem 'bundler', '~> 2.2'
+# require 'bundler'
+#
+# gem 'rake', '~> 13.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'
+
+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|
+#
+#     rd.main = "README.rdoc"
+#
+#     rd.rdoc_files.include("README.rdoc", "lib/**/*.rb", "bin/**/*")
+# end
+#
+# task :default => [:test, :features]

data/ax25.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ax25/app_info'
+
+Gem::Specification.new do |spec|
+    spec.name = 'ax25'
+    spec.version = Ax25::VERSION
+    spec.licenses = ['Apache-2.0']
+    spec.authors = ['Jeffrey Phillips Freeman']
+    spec.email = ['the@jeffreyfreeman.me']
+
+    spec.summary = %q{A library implementing a complete implementation of the AX.25 v2.2 protocol.}
+    spec.description = %q{A library implementing a complete implementation of the AX.25 v2.2 protocol.}
+    spec.homepage = 'https://git.qoto.org/digipex/ax25'
+
+    # 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.
+    if spec.respond_to?(:metadata)
+        spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    else
+        raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+    end
+
+    spec.files = `git ls-files -z`.split("\x0").reject do |f|
+        f.match(%r{^(test|spec|features)/})
+    end
+    spec.bindir = 'bin'
+    spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    spec.require_paths = ['lib']
+
+    spec.add_dependency 'abstractify', '~> 1.1'
+    spec.add_dependency 'json', '~> 2.5'
+    spec.add_dependency 'kiss-tnc', '~> 3.0'
+    spec.add_development_dependency 'bundler', '~> 2.2'
+    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.3'
+    spec.add_development_dependency 'aruba', '~> 2.0'
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ax25/app_info.rb

@@ -0,0 +1,3 @@
+module Ax25
+    VERSION = "0.0.1"
+end

data/lib/ax25/encoder/aprs_kiss.rb

@@ -0,0 +1,59 @@
+require 'ax25/frame'
+require 'kiss'
+require 'ax25/encoder/encoder'
+
+module Ax25
+    class AprsKiss
+        include Encoder
+
+        ##
+        # Creates a new AprsKiss encoder
+        #
+        # @param data_stream [Kiss::Kiss] The underlying data stream frames are
+        #     written to.
+        protected
+        def initialize(data_stream)
+            raise ArgumentError.new("data_stream can not be nil") if data_stream.nil?
+            raise ArgumentError.new("data_stream must be a Kiss class: #{data_stream.to_s}") unless data_stream.kind_of? Kiss::Kiss
+
+            @data_stream = data_stream
+        end
+
+        public
+        def connect(*args, **kwargs)
+            @data_stream.connect(*args, **kwargs)
+        end
+
+        public
+        def close(*args, **kwargs)
+            @data_stream.close(*args, **kwargs)
+        end
+
+        public
+        def read(*args, **kwargs)
+          frame_map = @data_stream.read
+          return nil if frame_map.nil?
+
+          source = Ax25::ImmutableEntity.from_raw(frame_map[:source])
+          destination = Ax25::ImmutableEntity.from_raw(frame_map[:destination])
+
+          path = Ax25::ImmutablePath.from_raw(frame_map[:path])
+
+          return Ax25::ImmutableFrame.new(source, destination, path, frame_map[:payload])
+        end
+
+        public
+        def write(frame, *args, **kwargs)
+          raise ArgumentError.new("frame argument can not be nil") if frame.nil?
+
+          frame_map = {
+            :source => frame.source.to_s,
+            :destination => frame.destination.to_s,
+            :path => frame.path.to_string_array,
+            :payload => frame.payload
+          }
+
+          @data_stream.write(frame_map)
+        end
+    end
+end

data/lib/ax25/encoder/encoder.rb

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

data/lib/ax25/encoder/igate_tcp.rb

@@ -0,0 +1,184 @@
+require 'ax25/app_info'
+require 'socket'
+
+module Ax25
+    class IGateTcp
+        include Encoder
+
+        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', "ax25 #{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.encode_frame(frame)
+            formatted_frame = [frame.source, frame.destination].join('>')
+            if frame.path and frame.path.length > 0
+                formatted_frame = [formatted_frame, frame.path.to_s].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_source = Ax25::ImmutableEntity.from_raw(decoded_source, strict_callsign: false, strict_ssid: false)
+            decoded_destination = Ax25::ImmutableEntity.from_raw(path.shift, strict_callsign: false, strict_ssid: false)
+            decoded_path = Ax25::ImmutablePath.from_raw(path, strict_callsign: false, strict_ssid: false)
+            decoded_payload = frame_so_far
+
+            return Ax25::ImmutableFrame.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, aprsis_socket_override: nil, **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
+                    if aprsis_socket_override.nil?
+                      @aprsis_sock = TCPSocket.open(@server, @port)
+                    else
+                      @aprsis_sock = aprsis_socket_override
+                    end
+                    @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
+                         ## Lets not read in more than one frame at a time so we dont get stuck in a loop
+                         read_more = false if @data_buffer.include? "\r\n"
+                    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