aprs_parser 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6e02373b6a371cd563cfa6244beb7b51a3cc913
+  data.tar.gz: 4feacf7e3f8e01ec731247e5858b5afa60836ab1
+SHA512:
+  metadata.gz: ec8d5e169e4c942561641457cd02a7472843f6f3b26db55f666a348be2588b66789b7ccf9e6cd0d5ecec0f93e43cabf3a01bec48463f52705b34179b7266dfdb
+  data.tar.gz: 1fce9d19e570d379ab3626313d165c87c9066bf2af914c851570ce4dad4c9ed9f0ddc19d458a40821570b4c513ac5e69831de3e7a6b08ebfd0aa0316f96d4289

data/.gitignore

@@ -0,0 +1,15 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  RunRailsCops: false
+  Exclude:
+      - 'bin/*'
+
+Metrics/LineLength:
+  Max: 112
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0.pre
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aprs_parser.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# AprsParser
+
+Ruby APRS parser based on [libfap](http://www.pakettiradio.net/libfap/).
+
+## libfap
+
+Libfap is a C port of the Ham::APRS::FAP Finnish APRS Parser perl module. As the original Perl code, libfap parses normal, mic-e and compressed location packets, NMEA location packets, objects, items, messages, telemetry and most weather packets. More information on HAM::APRS::FAP is available at http://search.cpan.org/dist/Ham-APRS-FAP/. More information on libfap is available at http://www.pakettiradio.net/libfap/.
+
+
+## Requirements
+
+Latest libfab installed (http://www.pakettiradio.net/libfap/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aprs_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aprs_parser
+
+## Usage
+
+```
+data = 'K4HG-8>APKRAM,TCPIP*,qAC,AE5PL-JF:/150653z4440.48N/12403.91WMiPhone'
+parsed = AprsParser.parse(data)
+parsed[:src_callsign]
+```
+
+The following fields are currently supported (pull requests are welcome):
+
+```layout error_code, type, orig_packet, orig_packet_len, header, body, body_len, src_callsign, dst_callsign, path, path_len, latitude, longitude, format, pos_resolution, pos_ambiguity, dao_datum_byte, altitude, course, speed, symbol_table, symbol_code, messaging, destination, message, message_ack, message_nack, message_id, comment, comment_len, object_or_item_name, alive, gps_fix_status, radio_range, phg, timestamp, nmea_checksum_ok```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/masone/aprs_parser-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  # t.libs.push "lib"
+  t.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
+  t.verbose = false
+end

data/aprs_parser.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aprs_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aprs_parser'
+  spec.version       = AprsParser::VERSION
+  spec.authors       = ['Christian Felder (masone)']
+  spec.email         = ['ema@rh-productions.ch']
+
+  spec.summary       = 'Ruby APRS parser'
+  spec.description   = 'Ruby APRS parser based on libfap'
+  spec.homepage      = 'https://github.com/masone/aprs_parser-ruby'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions    = ['ext/aprs_parser/extconf.rb']
+
+  spec.add_dependency 'ffi'
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rubocop'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'aprs_parser'
+
+# 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

data/bin/setup

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

data/ext/aprs_parser/extconf.rb

@@ -0,0 +1,5 @@
+require 'mkmf'
+
+abort 'missing libfap' unless find_header 'fap.h'
+
+create_makefile('aprs_parser/aprs_parser')

data/lib/aprs_parser/converters/double_pointer.rb

@@ -0,0 +1,18 @@
+module AprsParser
+  module Converters
+    class DoublePointer
+      extend FFI::DataConverter
+      native_type FFI::Type::POINTER
+
+      class << self
+        def from_native(value, _context)
+          value.get_double(0) unless value.null?
+        end
+
+        def reference_required?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/aprs_parser/converters/path.rb

@@ -0,0 +1,19 @@
+module AprsParser
+  module Converters
+    class AprsPath
+      extend FFI::DataConverter
+      native_type FFI::Type::POINTER
+
+      class << self
+        # The path field is represented by an array of at least two strings
+        def from_native(value, _context)
+          value.get_array_of_string(0) unless value.null?
+        end
+
+        def reference_required?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/aprs_parser/converters/short_pointer.rb

@@ -0,0 +1,18 @@
+module AprsParser
+  module Converters
+    class ShortPointer
+      extend FFI::DataConverter
+      native_type FFI::Type::POINTER
+
+      class << self
+        def from_native(value, _context)
+          value.get_short(0) unless value.null?
+        end
+
+        def reference_required?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/aprs_parser/converters/timestamp.rb

@@ -0,0 +1,18 @@
+module AprsParser
+  module Converters
+    class Timestamp
+      extend FFI::DataConverter
+      native_type FFI::Type::POINTER
+
+      class << self
+        def from_native(value, _context)
+          value.get_int(0) unless value.null?
+        end
+
+        def reference_required?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/aprs_parser/converters/uint_pointer.rb

@@ -0,0 +1,18 @@
+module AprsParser
+  module Converters
+    class UintPointer
+      extend FFI::DataConverter
+      native_type FFI::Type::POINTER
+
+      class << self
+        def from_native(value, _context)
+          value.get_uint(0) unless value.null?
+        end
+
+        def reference_required?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/aprs_parser/converters.rb

@@ -0,0 +1,5 @@
+require 'aprs_parser/converters/double_pointer'
+require 'aprs_parser/converters/uint_pointer'
+require 'aprs_parser/converters/short_pointer'
+require 'aprs_parser/converters/timestamp'
+require 'aprs_parser/converters/path'

data/lib/aprs_parser/enums/error_code.rb

@@ -0,0 +1,24 @@
+module AprsParser
+  module Enums
+    extend FFI::Library
+
+    ErrorCode = enum [
+      :fapPACKET_NO, :fapPACKET_SHORT, :fapPACKET_NOBODY, :fapSRCCALL_NOAX25,
+      :fapSRCCALL_BADCHARS, :fapDSTPATH_TOOMANY, :fapDSTCALL_NONE, :fapDSTCALL_NOAX25,
+      :fapDIGICALL_NOAX25, :fapDIGICALL_BADCHARS, :fapTIMESTAMP_INV_LOC, :fapTIMESTAMP_INV_OBJ,
+      :fapTIMESTAMP_INV_STA, :fapTIMESTAMP_INV_GPGGA, :fapTIMESTAMP_INV_GPGLL, :fapPACKET_INVALID,
+      :fapNMEA_INV_CVAL, :fapNMEA_LARGE_EW, :fapNMEA_LARGE_NS, :fapNMEA_INV_SIGN,
+      :fapNMEA_INV_CKSUM, :fapGPRMC_FEWFIELDS, :fapGPRMC_NOFIX, :fapGPRMC_INV_TIME,
+      :fapGPRMC_INV_DATE, :fapGPRMC_DATE_OUT, :fapGPGGA_FEWFIELDS, :fapGPGGA_NOFIX,
+      :fapGPGLL_FEWFIELDS, :fapGPGLL_NOFIX, :fapNMEA_UNSUPP, :fapOBJ_SHORT,
+      :fapOBJ_INV, :fapOBJ_DEC_ERR, :fapITEM_SHORT, :fapITEM_INV,
+      :fapITEM_DEC_ERR, :fapLOC_SHORT, :fapLOC_INV, :fapLOC_LARGE,
+      :fapLOC_AMB_INV, :fapMICE_SHORT, :fapMICE_INV, :fapMICE_INV_INFO,
+      :fapMICE_AMB_LARGE, :fapMICE_AMB_INV, :fapMICE_AMB_ODD, :fapCOMP_INV,
+      :fapCOMP_SHORT, :fapMSG_INV, :fapWX_UNSUPP, :fapUSER_UNSUPP,
+      :fapDX_INV_SRC, :fapDX_INF_FREQ, :fapDX_NO_DX, :fapTLM_INV,
+      :fapTLM_LARGE, :fapTLM_UNSUPP, :fapEXP_UNSUPP, :fapSYM_INV_TABLE,
+      :fapNOT_IMPLEMENTED, :fapNMEA_NOFIELDS, :fapNO_APRS
+    ]
+  end
+end

data/lib/aprs_parser/enums/packet_type.rb

@@ -0,0 +1,7 @@
+module AprsParser
+  module Enums
+    extend FFI::Library
+
+    PacketType = enum [:fapLOCATION, :fapOBJECT, :fapITEM, :fapMICE, :fapNMEA, :fapWX, :fapMESSAGE, :fapCAPABILITIES, :fapSTATUS, :fapTELEMETRY, :fapTELEMETRY_MESSAGE, :fapDX_SPOT, :fapEXPERIMENTAL]
+  end
+end

data/lib/aprs_parser/enums/pos_format.rb

@@ -0,0 +1,7 @@
+module AprsParser
+  module Enums
+    extend FFI::Library
+
+    PosFormat = enum [:fapPOS_COMPRESSED, :fapPOS_UNCOMPRESSED, :fapPOS_MICE, :fapPOS_NMEA]
+  end
+end

data/lib/aprs_parser/enums.rb

@@ -0,0 +1,3 @@
+require 'aprs_parser/enums/error_code'
+require 'aprs_parser/enums/packet_type'
+require 'aprs_parser/enums/pos_format'

data/lib/aprs_parser/structs/package.rb

@@ -0,0 +1,49 @@
+module AprsParser
+  module Structs
+    extend FFI::Library
+
+    enum :pos_format, [:fapPOS_COMPRESSED, :fapPOS_UNCOMPRESSED, :fapPOS_MICE, :fapPOS_NMEA]
+
+    class Package < FFI::Struct
+      extend AprsParser::TypeSafety
+
+      layout error_code: AprsParser::Enums::ErrorCode,
+             type: :pointer, # AprsParser::Enums::PacketType,
+             orig_packet: :string,
+             orig_packet_len: :uint,
+             header: :string,
+             body: :pointer,
+             body_len: :uint,
+             src_callsign: :string,
+             dst_callsign: :string,
+             path: AprsParser::Converters::AprsPath,
+             path_len: :uint,
+             latitude: AprsParser::Converters::DoublePointer,
+             longitude: AprsParser::Converters::DoublePointer,
+             format: :pointer, # AprsParser::Enums::PosFormat,
+             pos_resolution: AprsParser::Converters::DoublePointer,
+             pos_ambiguity: AprsParser::Converters::UintPointer,
+             dao_datum_byte: :char,
+             altitude: AprsParser::Converters::DoublePointer,
+             course: AprsParser::Converters::UintPointer,
+             speed: AprsParser::Converters::DoublePointer,
+             symbol_table: :char,
+             symbol_code: :char,
+             messaging: AprsParser::Converters::ShortPointer,
+             destination: :string,
+             message: :string,
+             message_ack: :string,
+             message_nack: :string,
+             message_id: :string,
+             comment: :string,
+             comment_len: :uint,
+             object_or_item_name: :string,
+             alive: AprsParser::Converters::ShortPointer,
+             gps_fix_status: AprsParser::Converters::ShortPointer,
+             radio_range: AprsParser::Converters::UintPointer,
+             phg: :string,
+             timestamp: AprsParser::Converters::Timestamp,
+             nmea_checksum_ok: AprsParser::Converters::ShortPointer
+    end
+  end
+end

data/lib/aprs_parser/structs/telemetry.rb

@@ -0,0 +1,15 @@
+module AprsParser
+  module Structs
+    class Telemetry < FFI::Struct
+      extend AprsParser::TypeSafety
+
+      layout :seq, :uint,
+             :val1, :double,
+             :val2, :double,
+             :val3, :double,
+             :val4, :double,
+             :val5, :double,
+             :bits, :char
+    end
+  end
+end

data/lib/aprs_parser/structs/wx_report.rb

@@ -0,0 +1,23 @@
+module AprsParser
+  module Structs
+    class WxReport < FFI::Struct
+      extend AprsParser::TypeSafety
+
+      layout :wind_gust, AprsParser::Converters::DoublePointer,
+             :wind_dir, AprsParser::Converters::UintPointer,
+             :wind_speed, AprsParser::Converters::DoublePointer,
+             :temp, AprsParser::Converters::DoublePointer,
+             :temp_in, AprsParser::Converters::DoublePointer,
+             :rain_1h, AprsParser::Converters::DoublePointer,
+             :rain_24h, AprsParser::Converters::DoublePointer,
+             :rain_midnight, AprsParser::Converters::DoublePointer,
+             :humidity, AprsParser::Converters::UintPointer,
+             :humidity_h, AprsParser::Converters::UintPointer,
+             :humidity_in, AprsParser::Converters::UintPointer,
+             :pressure, AprsParser::Converters::DoublePointer,
+             :luminosity, AprsParser::Converters::UintPointer,
+             :snow_24h, AprsParser::Converters::DoublePointer,
+             :soft, :string
+    end
+  end
+end

data/lib/aprs_parser/structs.rb

@@ -0,0 +1,3 @@
+require 'aprs_parser/structs/wx_report'
+require 'aprs_parser/structs/telemetry'
+require 'aprs_parser/structs/package'

data/lib/aprs_parser/type_safety.rb

@@ -0,0 +1,27 @@
+module AprsParser
+  # Checks all values coming in and makes sure
+  # they are of an instance of the correct {#type_class}.
+  module TypeSafety
+    # Convert given value to native value, with type checking.
+    #
+    # @note Calls super-implementation if type is safe.
+    #
+    # @param value
+    # @param ctx
+    # @raise [TypeError] if value is not of the same kind as {#type_class}.
+    def to_native(value, ctx)
+      if value.is_a?(type_class)
+        super
+      else
+        fail TypeError, "expected a kind of #{name}, was #{value.class}"
+      end
+    end
+
+    # Retrieve the type that all objects going into to_native must be of.
+    #
+    # @return self by default
+    def type_class
+      self
+    end
+  end
+end

data/lib/aprs_parser/version.rb

@@ -0,0 +1,3 @@
+module AprsParser
+  VERSION = '1.0.0.pre'
+end

data/lib/aprs_parser.rb

@@ -0,0 +1,24 @@
+require 'ffi'
+require 'aprs_parser/version'
+require 'aprs_parser/type_safety'
+require 'aprs_parser/converters'
+require 'aprs_parser/enums'
+require 'aprs_parser/structs'
+
+module AprsParser
+  extend FFI::Library
+  ffi_lib 'fap'
+
+  attach_function :fap_init, [], :void
+  attach_function :fap_cleanup, [], :void
+  attach_function :fap_parse, :fap_parseaprs, [:string, :uint, :bool], AprsParser::Structs::Package.ptr
+
+  def self.parse(message)
+    AprsParser.fap_init
+    begin
+      AprsParser.fap_parse(message, message.bytesize, false)
+    ensure
+      AprsParser.fap_cleanup
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: aprs_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- Christian Felder (masone)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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: minitest
+  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: rubocop
+  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: Ruby APRS parser based on libfap
+email:
+- ema@rh-productions.ch
+executables: []
+extensions:
+- ext/aprs_parser/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- aprs_parser.gemspec
+- bin/console
+- bin/setup
+- ext/aprs_parser/extconf.rb
+- lib/aprs_parser.rb
+- lib/aprs_parser/converters.rb
+- lib/aprs_parser/converters/double_pointer.rb
+- lib/aprs_parser/converters/path.rb
+- lib/aprs_parser/converters/short_pointer.rb
+- lib/aprs_parser/converters/timestamp.rb
+- lib/aprs_parser/converters/uint_pointer.rb
+- lib/aprs_parser/enums.rb
+- lib/aprs_parser/enums/error_code.rb
+- lib/aprs_parser/enums/packet_type.rb
+- lib/aprs_parser/enums/pos_format.rb
+- lib/aprs_parser/structs.rb
+- lib/aprs_parser/structs/package.rb
+- lib/aprs_parser/structs/telemetry.rb
+- lib/aprs_parser/structs/wx_report.rb
+- lib/aprs_parser/type_safety.rb
+- lib/aprs_parser/version.rb
+homepage: https://github.com/masone/aprs_parser-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby APRS parser
+test_files: []