tl1 0.1.0

data/lib/tl1/command.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+require 'strscan'
+
+module TL1
+  # A representation of a CLI interaction, including an input message format and
+  # an output message format.
+  class Command
+    attr_reader :input_format, :output_format
+
+    def initialize(input, output = nil)
+      @input_format = TL1::InputFormat.new(input)
+      @output_format = output && TL1::OutputFormat.new(output)
+    end
+
+    def input(**kwargs)
+      input_format.format(**kwargs) + ';'
+    end
+
+    def record_sources(output)
+      OutputScanner.new(output).records
+    end
+
+    def parse_output(output)
+      return output unless output_format
+
+      record_sources(output).map do |record_source|
+        output_format.parse(record_source)
+      end
+    end
+
+    # A helper class to extract records from output messages. Assumes records
+    # are double-quoted and separated by newlines.
+    class OutputScanner
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+
+      def records
+        records = []
+        scanner = StringScanner.new(message)
+        scan_begin(scanner)
+        loop do
+          record = scan_next_record(scanner)
+          break unless record
+          records << record
+        end
+        records
+      end
+
+      def scan_begin(scanner)
+        scanner.skip_until(/^M\s+\d+\s+COMPLD$/)
+      end
+
+      def scan_next_record(scanner)
+        scanner.skip(/\s*/)
+        char = scanner.getch
+        case char
+        when '>'
+          scan_begin(scanner)
+          scan_next_record(scanner)
+        when ';'
+          nil
+        when '"'
+          scan_record(scanner)
+        end
+      end
+
+      def scan_characters(scanner)
+        loop do
+          raise 'Unexpected end of message' if scanner.eos?
+          yield scanner.getch
+        end
+      end
+
+      def scan_record(scanner)
+        record = String.new
+
+        scan_characters(scanner) do |char|
+          case char
+          when '\\'
+            next_char = scanner.getch
+            if next_char == '"'
+              record << "\"#{scan_record_quoted_string(scanner)}"
+            else
+              record << char << next_char
+            end
+          when '"'
+            return record
+          else
+            record << char
+          end
+        end
+      end
+
+      def scan_record_quoted_string(scanner)
+        record = String.new
+
+        scan_characters(scanner) do |char|
+          case char
+          when '\\'
+            next_char = scanner.getch
+            return "#{record}\"" if next_char == '"'
+            record << char << next_char
+          else
+            record << char
+          end
+        end
+      end
+    end
+  end # class Command
+end # module TL1

data/lib/tl1/input_format.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module TL1
+  # A format for an input message.
+  class InputFormat
+    attr_reader :source
+
+    def initialize(source)
+      @source = source
+    end
+
+    def ast
+      @ast ||= AST.parse_message_format(source)
+    end
+
+    def as_json
+      ast.as_json
+    end
+
+    def format(**kwargs)
+      ast.format(**kwargs)
+    end
+  end # class OutputFormat
+end # module TL1

data/lib/tl1/output_format.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module TL1
+  # A format for records appearing in output messages.
+  class OutputFormat
+    attr_reader :source
+
+    def initialize(source)
+      @source = source
+    end
+
+    def ast
+      @ast ||= AST.parse_message_format(source)
+    end
+
+    def as_json
+      ast.as_json
+    end
+
+    def parse(record_source)
+      ast.parse(record_source)
+    end
+  end # class OutputFormat
+end # module TL1

data/lib/tl1/platforms/bti.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+# rubocop: disable Metrics/ModuleLength
+module TL1
+  module Platforms
+    module BTI
+      ACT_USER = Command.new('ACT-USER::<username>:::<password>')
+      CANC_USER = Command.new('CANC-USER::<username>')
+
+      RTRV_EQPT_ALL = Command.new(
+        'RTRV-EQPT',
+        '<aid>:<type>:ID=<id>,C1=<custom1>,C2=<custom2>,C3=<custom3>:pst,sst'
+      )
+
+      RTRV_INV_ALL = Command.new(
+        'RTRV-INV',
+        [
+          '<aid>,<aidtype>',
+          [
+            'NAME=<name>',
+            'PEC=<pec>',
+            'CLEI=<clei>',
+            'FNAME=<fname>',
+            'SER=<ser>',
+            'HWREV=<hwrev>',
+            'FW=<fw>',
+            'MFGDAT=<mfgdat>',
+            'MFGLOCN=<mfglocn>',
+            'TSTDAT=<tstdat>',
+            'TSTLOCN=<tstlocn>',
+            'WAVELENGTH=<wavelength>',
+            'WAVELENGTHMIN=<wavelengthmin>',
+            'WAVELENGTHMAX=<wavelengthmax>',
+            'WAVELENGTHSPACING=<wavelengthspacing>',
+            'REACH=<reach>',
+            'MINBR=<minbr>',
+            'MAXBR=<maxbr>',
+            'NOMBR=<nombr>',
+            'ENCODING=<encoding>',
+            'CONNTYPE=<conntype>',
+            'VENDORNAME=<vendorname>',
+            'VENDORPN=<vendorpn>',
+            'VENDOROUI=<vendoroui>',
+            'TXFAULTIMP=<txfaultimp>',
+            'TXDISABLEIMP=<txdisableimp>',
+            'LOSIMP=<losimp>',
+            'DDIAGIMP=<ddiagimp>',
+            'MEDIA=<media>',
+            'USI=<usi>',
+            'TEMPHT=<tempht>',
+            'TEMPHTS=<temphts>'
+          ].join(',')
+        ].join(':')
+      )
+
+      RTRV_ALM_ALL = Command.new(
+        'RTRV-ALM-ALL',
+        [
+          '<aid>,<aidtype>',
+          [
+            '<ntfcncde>',
+            '<condtype>',
+            '<srveff>',
+            '<ocrdat>',
+            '<ocrtim>',
+            '<locn>',
+            '<dirn>',
+            '<tmper>'
+          ].join(','),
+          '<conddescr>,<aiddet>,<obsdbhvr>,<exptdbhvr>',
+          '<dgntype>,<tblislt>'
+        ].join(':')
+      )
+
+      RTRV_CRS_WCH = Command.new(
+        'RTRV-CRS-WCH',
+        '<from_aid>,<to_aid>::SERVICENAME=<service_name>'
+      )
+
+      RTRV_CRS_XCVR = Command.new(
+        'RTRV-CRS-XCVR',
+        '<src_aid>,<dst_aid>:<ctype>'
+      )
+
+      RTRV_CONN_EQPT = Command.new(
+        'RTRV-CONN-EQPT',
+        '<fromAid>,<toAid>:<type>'
+      )
+
+      RTRV_WDM = Command.new(
+        'RTRV-WDM',
+        [
+          '<aid>',
+          '',
+          [
+            '<ID=<id>',
+            'C1=<custom1>',
+            'C2=<custom2>',
+            'C3=<custom3>',
+            'FIBER=<fiber>',
+            'SPANLEN=<spanlen>',
+            'SPANLOSSSPECMAX=<spanlossspecmax>',
+            'SPANLOSSRX-HT=<spanlossrx-ht>',
+            'NUMCHNLS=<numchnls>',
+            'AINSTMR=<ainstmr>',
+            'ACTAINSTMR=<actainstmr>'
+          ].join(','),
+          '<pst>,<sst>'
+        ].join(':')
+      )
+
+      RTRV_ROUTE_CONN = Command.new(
+        'RTRV-ROUTE-CONN',
+        [
+          '',
+          '<ipaddr>,<mask>,<nexthop>',
+          [
+            'COST=<cost>',
+            'ADMINDIST=<admindist>',
+            'TYPE=<type>',
+            'PROT=<prot>',
+            'AGE=<age>',
+            'PREFSTAT=<prefstat>'
+          ].join(',')
+        ].join(':')
+      )
+    end # module BTI
+  end # module Platforms
+end # module TL1

data/lib/tl1/session.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+module TL1
+  # A wrapper around an IO-like object representing a connection to a
+  # TL1-capable network element.
+  class Session
+    # @param io [IO, Net::SSH::Telnet, Net::Telnet]
+    #   An established connection to a TL1 server.
+    #
+    #   The connection object must have a `#write` method, and one of two read
+    #   methods: `#expect` or `#waitfor`. If you are using Net::Telnet or
+    #   Net::SSH::Telnet, `#waitfor` will be used. Otherwise, you should make
+    #   sure that your connection object has an `#expect` method that behaves
+    #   like `IO#expect` from the standard library.
+    #
+    # @param timeout [Integer]
+    #   How long to wait for responses, by default.
+    def initialize(io, timeout = 10)
+      @timeout = timeout
+      @io =
+        if io.respond_to?(:expect)
+          io
+        elsif io.respond_to?(:waitfor)
+          WaitforWrapper.new(io)
+        else
+          raise UnsupportedIOError,
+                "the given IO doesn't respond to expect or waitfor"
+        end
+    end
+
+    # Execute a TL1::Command
+    #
+    # @param [TL1::Command]
+    # @return [TL1::AST::Node]
+    def cmd(command, **kwargs)
+      output = raw_cmd(command.input(**kwargs))
+      command.parse_output(output)
+    end
+
+    # Receive data until the given pattern is matched.
+    #
+    # @param pattern [Regexp]
+    # @param timeout [Integer]
+    def expect(pattern, timeout = nil)
+      timeout ||= @timeout
+      @io.expect(pattern, timeout)
+    end
+
+    # Send a string and receive a string back.
+    #
+    # @param message [String]
+    # @param timeout [Integer]
+    # @return [String]
+    def raw_cmd(message, timeout = nil)
+      write(message)
+      expect(COMPLD, timeout)
+    end
+
+    # Send a string.
+    #
+    # @param message [String]
+    # @return [Boolean]
+    def write(message)
+      @io.write(message)
+    end
+
+    # Wraps objects that support `#waitfor` but not `#expect`, such as
+    # Net::Telnet and Net::SSH::Telnet. It is used transparently by
+    # `TL1::Session#initialize` for those classes, so it shouldn't be necessary
+    # to use it directly. If you are defining a new class that responds to
+    # `#waitfor`, you can define your own `#expect` method instead of using
+    # this.
+    class WaitforWrapper
+      def initialize(io)
+        @io = io
+      end
+
+      def expect(pattern, timeout)
+        @io.waitfor('Match' => pattern, 'Timeout' => timeout)
+      end
+
+      def write(*args)
+        @io.write(*args)
+      end
+    end # class WaitforWrapper
+  end # class Session
+end # module TL1

data/lib/tl1/test_io.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module TL1
+  # A simple IO-like object that accepts a hash of string inputs and
+  # corresponding outputs, useful for testing.
+  class TestIO
+    def initialize(commands, first_output: '')
+      commands.each_pair do |input, output|
+        next if output =~ COMPLD
+        raise ArgumentError, "incomplete output for #{input}"
+      end
+
+      @commands = commands
+      @next_output = first_output
+    end
+
+    def expect(pattern, _timeout = nil)
+      unless pattern =~ @next_output
+        raise TimeoutError, 'pattern does not match the next output'
+      end
+
+      @next_output
+    end
+
+    def write(message)
+      @next_output = @commands.fetch(message)
+      true
+    end
+
+    class TimeoutError < RuntimeError; end
+  end # class TestIO
+end # module TL1

data/lib/tl1/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Tl1
+  VERSION = '0.1.0'
+end

data/tl1.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tl1/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tl1'
+  spec.version       = Tl1::VERSION
+  spec.authors       = ['Ben Miller']
+  spec.email         = ['bmiller@rackspace.com']
+
+  spec.summary       = 'Define, send, and receive TL1 messages'
+  spec.homepage      = 'https://github.com/bjmllr/tl1'
+  spec.license       = 'GPL-3.0'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: tl1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Miller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- bmiller@rackspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tl1.rb
+- lib/tl1/ast.rb
+- lib/tl1/command.rb
+- lib/tl1/input_format.rb
+- lib/tl1/output_format.rb
+- lib/tl1/platforms/bti.rb
+- lib/tl1/session.rb
+- lib/tl1/test_io.rb
+- lib/tl1/version.rb
+- tl1.gemspec
+homepage: https://github.com/bjmllr/tl1
+licenses:
+- GPL-3.0
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Define, send, and receive TL1 messages
+test_files: []