aprs_is 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2628f0430c1aaaab4c4db1dc0e6b3501a3605e76b8cc8c9ebdb2a40529b0ae12
+  data.tar.gz: e9d66295e712e9d32684701e69c5d53f7a5dfd9fca484674aecd68e374a710c0
+SHA512:
+  metadata.gz: dcd936e78c5b5a03ec8b7eb09b231c4d34f38932d86bd8c613d880dfc9c4b30c9cabb3045eef27673f45ea6e50c93012673c2c8f369b592115fdeb33b06167ba
+  data.tar.gz: 88e0e29ea7793741a80a720939a9800f3936393121a4877702b3935dc962a94e8614bf0813a0d47f976a5972fa8e718eca6196d994c9333ab171f9865205e465

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+  - 2.6.6
+  - 2.7.0
+  - 2.7.2
+  - 2.5.7
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in aprs_is-client.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    aprs_is (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.2)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    shellany (0.0.1)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    terminal-notifier-guard (1.6.4)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aprs_is!
+  byebug
+  guard
+  guard-rspec
+  rake (~> 12.0)
+  rspec (~> 3.2)
+  simplecov
+  terminal-notifier-guard (~> 1.6.1)
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,46 @@
+notification :terminal_notifier, app_name: "AprsIs::Client" if `uname` =~ /Darwin/
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -0,0 +1,35 @@
+# AprsIs::Client
+[![Build Status](https://travis-ci.com/fuelxc/aprs_is.svg?branch=main)](https://travis-ci.com/fuelxc/aprs_is)
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aprs_is'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install aprs_is
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fuelxc/aprs_is.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aprs_is.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/aprs_is/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aprs_is"
+  spec.version       = AprsIs::VERSION
+  spec.authors       = ["Eric Harrison"]
+  spec.email         = ["eric@rubynooby.com"]
+
+  spec.summary       = %q{Gem that implements the APRS-IS specification}
+  spec.homepage      = "https://github.com/fuelxc/aprs_is"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fuelxc/aprs_is"
+  spec.metadata["changelog_uri"] = "https://github.com/fuelxc/aprs_is/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6.1'
+  spec.add_development_dependency 'simplecov'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aprs_is"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/aprs_is.rb

@@ -0,0 +1,7 @@
+require 'aprs_is/version'
+require 'aprs_is/passcode'
+require 'aprs_is/filter'
+require 'aprs_is/client'
+
+module AprsIs
+end

data/lib/aprs_is/client.rb

@@ -0,0 +1,63 @@
+require 'socket'
+
+module AprsIs
+  class Client
+    attr_reader :hostname, :port, :version
+
+    class Error < StandardError; end
+    
+    def initialize(hostname:, port:, version: "AprsIs::Client v#{VERSION}")
+      @hostname = hostname
+      @port = port
+      @version = version
+    end
+
+    def login(call_sign, filter = nil)
+      send_message(login_message(call_sign, filter))
+      return self
+    end
+
+    def apply_filter(filter)
+      send_message(filter_message(filter))
+    end
+
+    def read(&block)
+      while line = socket.gets
+        yield line
+      end
+    end
+
+    # :nocov:
+    def stream(&block)
+      loop do
+        read(&block)
+      end
+    end
+    # :nocov:
+
+    def send_message(message)
+      socket.puts message
+    end
+
+    private
+
+    def login_message(call_sign, filter = nil)
+      [
+        "user #{call_sign} pass #{passcode_for(call_sign)} vers #{version}",
+        filter&.to_s
+      ].compact.join(" ")
+    end
+
+    def filter_message(filter)
+      "filter #{filter}"
+    end
+
+    def passcode_for(call_sign)
+      @passcode = AprsIs::Passcode.new(call_sign)
+    end
+
+    def socket
+      @socket ||= TCPSocket.open(hostname, port)
+    end
+  end
+end

data/lib/aprs_is/filter.rb

@@ -0,0 +1,47 @@
+require 'aprs_is/filter/constants'
+
+module AprsIs
+  class Filter
+    class InvalidTypeError < StandardError; end;
+    class ValueArityError < StandardError; end;
+
+    attr_reader :filter_type, :values
+
+    def initialize(type:, values: )
+      @filter_type = type
+      @values = values || []
+
+      validate_filter_type
+      validate_arity
+    end
+
+    def to_s
+      values.unshift(prefix).compact.join("/")
+    end
+
+    private
+    def validate_arity
+      raise ValueArityError.new("Filter type '#{filter_type}' requires #{arity} values only #{values.length} given.") unless arity_matches?
+    end
+    
+    def validate_filter_type
+      raise InvalidTypeError.new("'#{filter_type}' is not a valid type.") unless type_exists?
+    end
+
+    def arity_matches?
+      (arity == -1 && values.length > 0) || [arity].flatten.include?(values.length)
+    end
+    
+    def type_exists?
+      Constants::FILTER_TYPE_MAP.has_key?(filter_type)
+    end
+
+    def arity
+      Constants::FILTER_TYPE_MAP[filter_type][:arity]
+    end
+
+    def prefix
+      Constants::FILTER_TYPE_MAP[filter_type][:prefix]
+    end
+  end
+end

data/lib/aprs_is/filter/constants.rb

@@ -0,0 +1,68 @@
+module AprsIs
+  class Filter
+    module Constants
+      FILTER_TYPE_MAP = {
+        range: {
+          prefix: 'r',
+          arity: 3
+        },
+        prefix: {
+          prefix: 'p',
+          arity: -1
+        },
+        callsign: {
+          prefix: 'b',
+          arity: -1
+        },
+        object: {
+          prefix: 'o',
+          arity: -1
+        },
+        strict: {
+          prefix: 'os',
+          arity: -1
+        },
+        type: {
+          prefix: 't',
+          arity: [1,3]
+        },
+        symbol: {
+          prefix: 's',
+          arity: 3
+        },
+        digipeater: {
+          prefix: 'd',
+          arity: -1
+        },
+        area: {
+          prefix: 'a',
+          arity: 4
+        },
+        entry: {
+          prefix: 'e',
+          arity: -1
+        },
+        group: {
+          prefix: 'g',
+          arity: -1
+        },
+        unproto: {
+          prefix: 'u',
+          arity: -1
+        },
+        q: {
+          prefix: 'q',
+          arity: (1..2)
+        },
+        me: {
+          prefix: 'm',
+          arity: 1
+        },
+        friend: {
+          prefix: 'f',
+          arity: 2
+        },
+      }.freeze
+    end
+  end
+end

data/lib/aprs_is/passcode.rb

@@ -0,0 +1,33 @@
+module AprsIs
+  class Passcode
+    attr_reader :call_sign
+
+    def initialize(call_sign)
+      @call_sign = call_sign
+    end
+
+    def to_s
+      generate.to_s
+    end
+
+    def generate
+      hash = 0x73e2
+      flag = true
+      call_sign_for_generation.split('').each do |c|
+        hash = if flag
+          (hash ^ (c.ord << 8))
+        else
+          (hash ^ c.ord)
+        end
+        flag = !flag
+      end
+      hash & 0x7fff
+    end
+
+    private
+
+    def call_sign_for_generation
+      call_sign.upcase.split('-').first
+    end
+  end
+end

data/lib/aprs_is/version.rb

@@ -0,0 +1,3 @@
+module AprsIs
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: aprs_is
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Harrison
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eric@rubynooby.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- aprs_is.gemspec
+- bin/console
+- bin/setup
+- lib/aprs_is.rb
+- lib/aprs_is/client.rb
+- lib/aprs_is/filter.rb
+- lib/aprs_is/filter/constants.rb
+- lib/aprs_is/passcode.rb
+- lib/aprs_is/version.rb
+homepage: https://github.com/fuelxc/aprs_is
+licenses: []
+metadata:
+  homepage_uri: https://github.com/fuelxc/aprs_is
+  source_code_uri: https://github.com/fuelxc/aprs_is
+  changelog_uri: https://github.com/fuelxc/aprs_is/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Gem that implements the APRS-IS specification
+test_files: []