lib-tl1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed86149b9bbf7b03e4d43da718d078ce386f369b88227df5f347f964a7ec627d
+  data.tar.gz: 424eb73445bab78ebe64de2b466e77c539edd7e9c5306dc304e28a0bc6e245ea
+SHA512:
+  metadata.gz: 5b3cf4ac73a83227e8ed4d525e1040cdea438990f7e1631e54549fdc6a0ed731ba0a8ce74ddcf3e580bd7350406656713dcab62f28b9b7c82f5a3b498463c4b7
+  data.tar.gz: 5ef144f03c51d4acd862943c087701799c0fb0eb6f052f5214fa12f9f4fa0bf1c16caf910c95a03af589945137319be0382291411c476fd9a07e13bd5afe38ef

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 3.0
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 3.0.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+*.gem
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 15

data/.ruby-gemset

@@ -0,0 +1 @@
+lib-tl1

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at p.wojcieszonek@bosmanger.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lib-tl1.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.10"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Piotr Wojcieszonek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Lib::Tl1
+
+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/lib/tl1`. 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 'lib-tl1'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lib-tl1
+
+## 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 the created tag, 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/[USERNAME]/lib-tl1. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lib-tl1/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lib::Tl1 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lib-tl1/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "lib/tl1"
+
+# 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-tl1.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/lib/tl1/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lib-tl1"
+  spec.version       = Lib::Tl1::VERSION
+  spec.authors       = ["Piotr Wojcieszonek"]
+  spec.email         = ["piotr@wojcieszonek.pl"]
+
+  spec.summary       = "Set of classes to low level handle the TL1 protocol"
+  spec.homepage      = "https://github.com/pwojcieszonek/#{spec.name}"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/lib/tl1.rb

@@ -0,0 +1,8 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "tl1/version"
+require_relative "tl1/message"
+

data/lib/lib/tl1/message.rb

@@ -0,0 +1,39 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "message/acknowledgment"
+require_relative "message/autonomous"
+require_relative "message/input"
+require_relative "message/output"
+
+module Lib
+  module TL1
+    module Message
+      def parse(message)
+        case message
+        when /\r\n\n   (.{0,20}) (\d{2,4}-\d{1,2}-\d{1,2}) (\d{1,2}:\d{1,2}:\d{1,2})\r\nM  (\d{1,6}) (\w{4,6})(.*)\r\n;/mi #Output message
+          # $1 - SID, $2 - DATE, $3 - TIME, $4 - CTAG, $5 - COMPLETION CODE, $6 - MESSAGE TEXT BLOCK
+          Lib::TL1::Message::Output.new(sid: $1, date: $2, time: $3, ctag: $4, cc: $5, text_block: $6)
+
+        when /(.*):(.{0,20}):(.*):(\d{1,6}):(.*):(.*);/mi # Input message
+          # $1 - COMMAND VERB, $2 - TID, $3 - AID, $4 - CTAG, $5 - General Block, $6 - Message Payload
+          Lib::TL1::Message::Input.new(command: $1, tid: $2, aid: $3, ctag: $4, gb: $5, payload: $6)
+
+        when /(IP|PF|OK|NA|NG|RL):(\d{1,6});/mi # Acknowledgment message
+          # $1 - Status Code, $2 - CTAG
+          Lib::TL1::Message::Acknowledgment.new(ack_code: $1, ctag: $2)
+
+        when /\r\n\n   (.{1,20}) (\d{2,4}-\d{1,2}-\d{1,2}) (\d{1,2}:\d{1,2}:\d{1,2})\r\n(\*C|\*\*|\*\^|A\^) (.*)(\r\n   .*)\r\n;/mi # Autonomous message
+          # $1 - SID, $2 - DATE, $3 - TIME, $4 - Alarm Code, $5 ATAG, $6 - Verb, $7 - Message code
+          Lib::TL1::Message::Autonomous.new(sid: $1, date: $2, time: $3, alarm_code: $4, ctag: $5, command: $6, text_block: $7)
+
+        else
+          raise ArgumentError, "Can't parse Message. Unknown TL1 message type"
+        end
+      end
+      alias new parse
+    end
+  end
+end

data/lib/lib/tl1/message/acknowledgment.rb

@@ -0,0 +1,50 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "field"
+require "comparable"
+module Lib
+  module TL1
+    module Message
+      class Acknowledgment
+        include Comparable
+        attr_reader :ack_code, :ctag
+
+        def initialize(ack_code: nil, ctag: nil)
+          if block_given?
+            yield self
+          else
+            self.ack_code = ack_code
+            self.ctag = ctag
+          end
+        end
+
+        def <=>(other)
+          return nil unless instance_of? other.class
+
+          to_s <=> other.to_s
+        end
+
+        def to_s
+          "#{@ack_code} #{@ctag}\r\n"
+        end
+        alias to_str to_s
+
+        def ack_code=(ack_code)
+          @ack_code = ack_code.is_a?(Field::AcknowledgmentCode) ? ack_code : Field::AcknowledgmentCode.new(ack_code)
+        end
+        alias acknowledgment_code ack_code
+        alias acknowledgment_code= ack_code=
+
+        def ctag=(ctag)
+          @ctag = ctag.is_a?(Field::CorrelationTag) ? ctag : Field::CorrelationTag.new(ctag)
+        end
+        alias correlation_tag ctag
+        alias correlation_tag= ctag=
+
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/autonomous.rb

@@ -0,0 +1,78 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "field"
+require "comparable"
+
+module Lib
+  module TL1
+    module Message
+      class Autonomous
+        include Comparable
+        attr_reader :sid, :date, :time, :alarm_code, :ctag, :command
+
+        def initialize(sid: nil, date: nil, time: nil, alarm_code: nil, ctag: nil, command: nil, text_block: nil)
+          if block_given?
+            yield self
+          else
+            self.sid = sid
+            self.date = date
+            self.time = time
+            self.alarm_code = alarm_code
+            self.ctag = ctag
+            self.command = command
+            self.text_block = text_block
+          end
+        end
+
+        def <=>(other)
+          return nil unless instance_of? other.class
+
+          to_s <=> other.to_s
+        end
+
+        def to_s
+          "\r\n\n   #{sid} #{date} #{time}\r\n  #{alarm_code} #{ctag}\r\n   #{text_block}\r\n;"
+        end
+        alias to_str to_s
+
+        def sid=(sid)
+          @sid = sid.is_a?(Field::SystemIdentifier) ? sid : Field::SystemIdentifier.new(sid)
+        end
+        alias system_identifier sid
+        alias system_identifier= sid=
+
+        def date=(date)
+          @date = date.is_a?(Field::Date) ? date : Field::Date.new(date)
+        end
+
+        def time=(time)
+          @time = time.is_a?(Field::Time) ? time : Field::Time.new(time)
+        end
+
+        def alarm_code=(alarm_code)
+          @alarm_code = alarm_code.is_a?(Field::AlarmCode) ? alarm_code : Field::AlarmCode.new(alarm_code)
+        end
+
+        def ctag=(ctag)
+          @atag = ctag.is_a?(Field::CorrelationTag) ? ctag : Field::CorrelationTag.new(ctag)
+        end
+        alias correlation_tag ctag
+        alias correlation_tag= ctag=
+        alias atag ctag
+        alias atag= ctag=
+
+        def command=(command)
+          @verb = command.is_a?(Field::CommandVerb) ? command : Field::CommandVerb.new(command)
+        end
+
+        def text_block=(text_block)
+          @text_block = text_block.is_a?(Field::TextBlock) ? text_block : Field::TextBlock.new(text_block)
+        end
+
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field.rb

@@ -0,0 +1,18 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "field/access_identifier"
+require_relative "field/acknowledgment_code"
+require_relative "field/alarm_code"
+require_relative "field/command_verb"
+require_relative "field/completion_code"
+require_relative "field/correlation_tag"
+require_relative "field/date"
+require_relative "field/general_block"
+require_relative "field/payload"
+require_relative "field/system_identifier"
+require_relative "field/target_identifier"
+require_relative "field/text_block"
+require_relative "field/time"

data/lib/lib/tl1/message/field/access_identifier.rb

@@ -0,0 +1,17 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class AccessIdentifier < Base
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/acknowledgment_code.rb

@@ -0,0 +1,45 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class AcknowledgmentCode < Base
+          ACK_CODE = {
+            ip: "In Progress",
+            fp: "Printout Follows",
+            ok: "All Right",
+            na: "No Acknowledgment",
+            ng: "No Good",
+            rl: "Repeat Later"
+          }.freeze
+
+          def initialize(field)
+            unless ACK_CODE.key? field.to_s.downcase.to_sym
+              raise ArgumentError, "Unknown Acknowledgment Code - #{field}"
+            end
+
+            super field.to_s.downcase.to_sym
+          end
+
+          def to_s
+            @field.to_s.upcase
+          end
+
+          def to_sym
+            @field
+          end
+
+          def description
+            ACK_CODE[@field]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/alarm_code.rb

@@ -0,0 +1,42 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class AlarmCode < Base
+          ALARM_CODE = {
+            '*C': "Critical Alarm",
+            '**': "Major Alarm",
+            '*^': "Minor Alarm",
+            'A^': "Non-Alarm Message"
+          }.freeze
+
+          def initialize(field)
+            raise ArgumentError, "Unknown Alarm Code - #{field}" unless ALARM_CODE.key? field.to_s.upcase.to_sym
+
+            super field.to_s.upcase.to_sym
+          end
+
+          def to_s
+            @field.to_s.upcase
+          end
+
+          def description
+            ALARM_CODE[@field]
+          end
+
+          def to_sym
+            @field
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/base.rb

@@ -0,0 +1,35 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class Base
+
+          include Comparable
+          extend Forwardable
+
+          def_delegators :@field, :to_s, :nil?, :empty?
+          attr_reader :field
+
+          def initialize(field)
+            @field = field
+          end
+
+          def <=>(other)
+            return nil unless instance_of? other.class
+
+            field <=> other.field
+          end
+
+          alias to_str to_s
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/command_verb.rb

@@ -0,0 +1,24 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class CommandVerb < Base
+
+          def initialize(field)
+            raise ArgumentError, "Command can't be nil" if field.nil?
+
+            super field.to_s.upcase
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/completion_code.rb

@@ -0,0 +1,67 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class CompletionCode < Base
+          COMPLETION_CODE = {
+            compld: "Total successful execution of the input command.",
+            deny: "Total denial of the input command.",
+            prtl: 'Partial  successful  execution of  the input command. This response code is valid  when
+                    the ctag  in  the general block is FALSE represents successful queuing of the input command
+                    submitted for delayed activation..',
+            delay: "Successful queuing of the input command submitted for delayed activation.",
+            rtry: 'Output response of a input retrieve command that retrieves extensive amount of information
+                    from the NE and uses more time for processing'
+          }.freeze
+
+          def initialize(field)
+            unless COMPLETION_CODE.key? field.to_s.downcase.to_sym
+              raise ArgumentError, "Unknown Completion Code - #{field}"
+            end
+
+            super field.to_s.downcase.to_sym
+          end
+
+          def to_s
+            @field.to_s.upcase
+          end
+
+          def to_sym
+            @field
+          end
+
+          def description
+            COMPLETION_CODE[@field]
+          end
+
+          def compld?
+            @field == :compld
+          end
+
+          def deny?
+            @field == :deny
+          end
+
+          def prtl?
+            @field == :prtl
+          end
+
+          def delay?
+            @field == :delay
+          end
+
+          def rtry?
+            @field == :rtry
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/correlation_tag.rb

@@ -0,0 +1,31 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class CorrelationTag < Base
+
+          def initialize(field = nil)
+            field = rand(0..999_999) if field.nil?
+            unless (field.to_i < 999_999) && (field.to_i >= 0)
+              raise ArgumentError, "Wrong #{self.class.name} format - #{field}"
+            end
+
+            super field.to_i
+          end
+
+          def to_i
+            @field.to_i
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/date.rb

@@ -0,0 +1,25 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+require "date"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class Date < Base
+
+          def_delegators :@field, :year, :mon, :day, :month
+
+          def initialize(field = nil)
+            super(field.nil? ? nil : ::Date.parse(field))
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/general_block.rb

@@ -0,0 +1,17 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class GeneralBlock < Base
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/payload.rb

@@ -0,0 +1,17 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class Payload < Base
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/system_identifier.rb

@@ -0,0 +1,17 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class SystemIdentifier < Base
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/target_identifier.rb

@@ -0,0 +1,24 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class TargetIdentifier < Base
+          def initialize(field)
+            unless field =~ (/^[a-zA-Z0-9-]{0,20}$/) || field.nil?
+              raise ArgumentError, "Wrong Target Identifier format - #{field}"
+            end
+
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/text_block.rb

@@ -0,0 +1,38 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class TextBlock < Base
+          def initialize(field)
+            @commented = false
+            case field
+            when /"\r\n   (.*)"/mi
+              field = Regexp.last_match(1)
+            when %r{/\*\r\n   (.*)\*/}mi
+              @commented = true
+              field = Regexp.last_match(1)
+            when /\r\n   (.*)/mi
+              field = Regexp.last_match(1)
+            when (nil || "")
+              field = nil
+            else
+              raise ArgumentError, "Unknown TextBlock format #{field}"
+            end
+            super field
+          end
+
+          def commented?
+            @commented
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/field/time.rb

@@ -0,0 +1,27 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "base"
+require "time"
+
+module Lib
+  module TL1
+    module Message
+      module Field
+        class Time < Base
+          def_delegators :@field, :min, :sec, :hour, :strftime
+
+          def initialize(field)
+            super ::Time.parse(field)
+          end
+
+          def to_s
+            @field.strftime("%H:%M:%S")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/input.rb

@@ -0,0 +1,79 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "field"
+require "comparable"
+
+module Lib
+  module TL1
+    module Message
+      class Input
+        include Comparable
+        attr_reader :command, :tid, :aid, :gb, :payload, :ctag
+
+        def initialize(command: nil, tid: nil, aid: nil, ctag: nil, gb: nil, payload: nil)
+          if block_given?
+            yield self
+          else
+            self.command = command
+            self.tid = tid
+            self.aid = aid
+            self.ctag = ctag
+            self.gb = gb
+            self.payload = payload
+          end
+        end
+
+        def <=>(other)
+          return nil unless instance_of? other.class
+
+          to_s <=> other.to_s
+        end
+
+        def to_s
+          "#{command}:#{tid}:#{aid}:#{ctag}:#{gb}:#{payload};"
+        end
+        alias to_str to_s
+
+        def command=(command)
+          @command = command.is_a?(Field::CommandVerb) ? command : Field::CommandVerb.new(command)
+        end
+        alias command_verb command
+        alias command_verb= command=
+        alias verb command
+        alias verb= command=
+
+        def tid=(tid)
+          @tid = tid.is_a?(Field::TargetIdentifier) ? tid : Field::TargetIdentifier.new(tid)
+        end
+        alias target_identifier tid
+        alias target_identifier= tid=
+
+        def aid=(aid)
+          @aid = aid.is_a?(Field::AccessIdentifier) ? aid : Field::AccessIdentifier.new(aid)
+        end
+        alias access_identifier aid
+        alias access_identifier= aid=
+
+        def ctag=(ctag)
+          @ctag = ctag.is_a?(Field::CorrelationTag) ? ctag : Field::CorrelationTag.new(ctag)
+        end
+        alias correlation_tag ctag
+        alias correlation_tag= ctag=
+
+        def gb=(gb)
+          @gb = gb.is_a?(Field::GeneralBlock) ? gb : Field::GeneralBlock.new(gb)
+        end
+        alias general_block gb
+        alias general_block= gb=
+
+        def payload=(payload)
+          @payload = payload.is_a?(Field::Payload) ? payload : Field::Payload.new(payload)
+        end
+
+      end
+    end
+  end
+end

data/lib/lib/tl1/message/output.rb

@@ -0,0 +1,73 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+require_relative "field"
+require "comparable"
+
+module Lib
+  module TL1
+    module Message
+      class Output
+        include Comparable
+        attr_reader :sid, :date, :time, :cc, :text_block, :ctag
+
+        def initialize(sid: nil, date: nil, time: nil, ctag: nil, cc: nil, text_block: nil)
+          if block_given?
+            yield self
+          else
+            self.sid = sid
+            self.date = date
+            self.time = time
+            self.ctag = ctag
+            self.cc = cc
+            self.text_block = text_block
+          end
+        end
+
+        def <=>(other)
+          return nil unless instance_of? other.class
+
+          to_s <=> other.to_s
+        end
+
+        def to_s
+          "\r\n\n   #{sid} #{date} #{time}\r\nM  #{ctag} #{cc}\r\n   #{text_block}\r\n;"
+        end
+        alias to_str to_s
+
+        def sid=(sid)
+          @sid = sid.is_a?(Field::SystemIdentifier) ? sid : Field::SystemIdentifier.new(sid)
+        end
+        alias system_identifier sid
+        alias system_identifier= sid=
+
+        def date=(date)
+          @date = date.is_a?(Field::Date) ? date : Field::Date.new(date)
+        end
+
+        def time=(time)
+          @time = time.is_a?(Field::Time) ? time : Field::Time.new(time)
+        end
+
+        def cc=(cc)
+          @cc = cc.is_a?(Field::CompletionCode) ? cc : Field::CompletionCode.new(cc)
+        end
+        alias completion_code cc
+        alias completion_code= cc=
+
+        def text_block=(text_block)
+          @text_block = text_block.is_a?(Field::TextBlock) ? text_block : Field::TextBlock.new(text_block)
+        end
+
+        def ctag=(ctag)
+          @ctag = ctag.is_a?(Field::CorrelationTag) ? ctag : Field::CorrelationTag.new(ctag)
+        end
+        alias correlation_tag ctag
+        alias correlation_tag= ctag=
+
+      end
+    end
+  end
+end

data/lib/lib/tl1/version.rb

@@ -0,0 +1,10 @@
+# Author: Piotr Wojcieszonek
+# e-mail: piotr@wojcieszonek.pl
+# Copyright 03.08.2021 Piotr Wojcieszonek
+# frozen_string_literal: true
+
+module Lib
+  module Tl1
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: lib-tl1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Wojcieszonek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-16 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- piotr@wojcieszonek.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib-tl1.gemspec
+- lib/lib/tl1.rb
+- lib/lib/tl1/message.rb
+- lib/lib/tl1/message/acknowledgment.rb
+- lib/lib/tl1/message/autonomous.rb
+- lib/lib/tl1/message/field.rb
+- lib/lib/tl1/message/field/access_identifier.rb
+- lib/lib/tl1/message/field/acknowledgment_code.rb
+- lib/lib/tl1/message/field/alarm_code.rb
+- lib/lib/tl1/message/field/base.rb
+- lib/lib/tl1/message/field/command_verb.rb
+- lib/lib/tl1/message/field/completion_code.rb
+- lib/lib/tl1/message/field/correlation_tag.rb
+- lib/lib/tl1/message/field/date.rb
+- lib/lib/tl1/message/field/general_block.rb
+- lib/lib/tl1/message/field/payload.rb
+- lib/lib/tl1/message/field/system_identifier.rb
+- lib/lib/tl1/message/field/target_identifier.rb
+- lib/lib/tl1/message/field/text_block.rb
+- lib/lib/tl1/message/field/time.rb
+- lib/lib/tl1/message/input.rb
+- lib/lib/tl1/message/output.rb
+- lib/lib/tl1/version.rb
+homepage: https://github.com/pwojcieszonek/lib-tl1
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pwojcieszonek/lib-tl1
+  source_code_uri: https://github.com/pwojcieszonek/lib-tl1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Set of classes to low level handle the TL1 protocol
+test_files: []