snmp-open 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1362f32d8e43b509be4884b392c43689b9cba48c2e2d6f63c4912e645ba6fcc9
-  data.tar.gz: d751cce9e00204ae0b0d131120338ce3b7beaf1bbfb2e71f114c60f8c9bfdfa8
+  metadata.gz: 0c647ac12c0055f8f71908c27d5460e3b220d2c265751987d7a08ac1b1179efa
+  data.tar.gz: 74dfcf665582e2d23f093a6e67b83e9def03c1b8939d9772b7a645e884f95dbe
 SHA512:
-  metadata.gz: 51603c2ee2b8d5077be2dcc8f26b74ad174d09a31fe6b6879343d98b33bba5f30f6246cf2ac3999f3a3aa46fda3b5cf7f849310016de5725cbdd0574741af99c
-  data.tar.gz: 2670576c9373c22e74e5bc7a118317ffdefb33d685ef654236e1ec5f369f9ac772d619ff7cfba3e8532ba52a5fc3b0d52bc67439cbeb96d84a08d6cc36f40819
+  metadata.gz: d8bd115d0a86d384dc860191bbb045e4903ab739ef1581041b6e030134345a60a3481a4f75554ddaf527587db8e72d0b544949590638606fabe0ea2ada23a77d
+  data.tar.gz: d505743d70310b076a783e1cdad8ab95a1a5776c6e8f5caf467c827791216896d76db3baf5fc9c4ca25519de6bf6336a7c6e27c3bff308e8eb65235c68ecf597

data/.github/workflows/ruby.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: [2.4, 2.5, 2.6, 2.7, jruby, truffleruby]
+        ruby: [2.4, 2.5, 2.6, 2.7, jruby]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,2 +1,62 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
 Style/CommentedKeyword:
   Enabled: false
+
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/snmp/open/parser/value_parser.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/snmp/open/parser.rb'
+
+Style/AccessModifierDeclarations: {Enabled: false}
+Style/IfUnlessModifier: {Enabled: false}
+Style/FrozenStringLiteralComment: {Enabled: false}
+
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true

data/Gemfile

@@ -5,4 +5,5 @@ group :guard do
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-rubocop'
+  gem 'rubocop', '~>1.0'
 end

data/lib/snmp/open/command_reader.rb

@@ -121,8 +121,11 @@ module SNMP
     end # class CommandReader
 
     class CommandError < RuntimeError; end
+
     class CommandTimeoutError < CommandError; end
+
     class UnknownMIBError < CommandError; end
+
     class UnknownOIDError < CommandError; end
   end # class Open
 end # module SNMP

data/lib/snmp/open/file_reader.rb

@@ -32,12 +32,12 @@ module SNMP
         mkdir(@directory, cmd.to_s) if @make_directories
         outfile = File.join(@directory, cmd.to_s, oid)
         File.read(outfile)
-      rescue Errno::ENOENT => err
+      rescue Errno::ENOENT => e
         if @warnings
           warning = @warnings.call(@command_generator, cmd, oid, outfile)
           warn warning
         end
-        raise err
+        raise e
       end
 
       def mkdir(base, cmd)

data/lib/snmp/open/options.rb

@@ -12,8 +12,10 @@ module SNMP
           'snmpbulkwalk' => '-Cc',
           'snmpwalk' => '-Cc'
         },
+        no_mib_name: '-Os',
         no_units: '-OU',
         non_symbolic: '-Oe',
+        non_symbolic_table_indexes: '-Ob',
         numeric: '-On',
         priv_password: '-X', # not recommended, see snmp.conf(5)
         priv_protocol: '-x',
@@ -24,9 +26,11 @@ module SNMP
         host: nil
       }.freeze
 
-      # On some systems, SNMP command outputs will include symbolic values
-      # and/or value units. The parser doesn't support these, so disable them.
+      # On some systems, SNMP command outputs will include symbolic values,
+      # table indexes, and/or value units. The parser doesn't support these, so
+      # disable them.
       REQUIRED_BY_PARSER = {
+        '-Ob' => nil,
         '-Oe' => nil,
         '-OU' => nil
       }.freeze

data/lib/snmp/open/parser/value_parser.rb

@@ -23,9 +23,11 @@ module SNMP
         class Bits < ValueParser
           def parse(tokens)
             return @parse if @parse
+
             bytes = []
             loop do
               break unless tokens.peek =~ /\A[0-9A-Za-z]{1,2}\z/
+
               bytes << tokens.next.to_i(16)
             end
             @parse = [@type, bytes]
@@ -50,9 +52,11 @@ module SNMP
         class HexString < ValueParser
           def parse(tokens)
             return @parse if @parse
+
             bytes = []
             loop do
               break unless tokens.peek =~ /\A[0-9A-Za-z]{2}\z/
+
               bytes << tokens.next
             end
             string = bytes.map { |b| b.to_i(16).chr }.join
@@ -72,6 +76,7 @@ module SNMP
         class Timeticks < ValueParser
           def parse(tokens)
             return @parse if @parse
+
             ticks = tokens.next.tr('()', '').to_i
 
             # consume tokens through one like 23:59:59.99
@@ -106,16 +111,16 @@ module SNMP
 
         KNOWN_TOKENS = {
           NOSUCHINSTANCE_STR => NoSuchInstance,
-          NOSUCHOBJECT_STR =>  NoSuchObject,
+          NOSUCHOBJECT_STR => NoSuchObject,
           NOMOREVARIABLES_STR => Stop
         }.freeze
 
         KNOWN_TYPES = {
           nil => Default,
           'BITS' => Bits,
-          'INTEGER'   => ValueParser::Integer,
-          'Gauge32'   => ValueParser::Integer,
-          'Gauge64'   => ValueParser::Integer,
+          'INTEGER' => ValueParser::Integer,
+          'Gauge32' => ValueParser::Integer,
+          'Gauge64' => ValueParser::Integer,
           'Counter32' => ValueParser::Integer,
           'Counter64' => ValueParser::Integer,
           'Hex-STRING' => HexString,

data/lib/snmp/open/parser.rb

@@ -14,7 +14,37 @@ module SNMP
     # convert SNMP command output into arrays
     class Parser
       include SNMP::Open::Parser::Constants
-      OID_RE = Regexp.union(/\S+-MIB::\S+/, /[0-9\.]+/)
+      OID_RE = Regexp.union(/\S+-MIB::\S+/, /[0-9.]+/)
+
+      EMPTY_STRING_RE =
+        /^(#{OID_RE})     # capture group 1: OID
+          \s+=\s+
+          (Opaque|STRING) # capture group 2: Type
+          :\s*\n          # value is always empty string
+        /x.freeze
+
+      STRING_RE =
+        /^(#{OID_RE})         # capture group 1: OID
+          \s+=\s+
+          (Opaque|STRING):\s+ # capture group 2: Type
+
+          (                   # capture group 3: Value
+
+           (?!")              # this pattern is for finding strings in need of
+                              # quoting, so reject any strings that are already
+                              # quoted
+
+           [^\n]*             # first line of value
+
+           (\n                # newline before each additional line of value
+            (?!
+             #{OID_RE}        # additional lines of value are identified by not
+             \s+=\s+          # starting with "<OID> ="
+            )
+            [^\n]+            # additional lines of value
+           )*
+          )\n
+        /x.freeze
 
       def initialize(oids)
         @oids = oids
@@ -33,37 +63,34 @@ module SNMP
       private
 
       def align(columns)
-        indexes = columns.first.map { |value| index_using_first_oid(value) }
+        indexes = indexes_from_columns(columns)
+        bases = bases_from_columns(columns)
         hash = columns.flat_map { |row| row.map { |v| [v.oid, v] } }.to_h
 
         indexes.map do |index|
-          @oids.map do |base|
+          bases.map do |base, _|
             oid = [base, *index].join('.')
             hash.fetch(oid) { Value.new(oid, 'absent', nil) }
           end
         end
       end
 
+      def bases_from_columns(columns)
+        @oids
+          .zip(columns.map { |c| c&.first&.oid })
+          .map { |base, oid| base && oid && split_oid(base, oid) }
+      end
+
       def clean_input_text(text)
         text
           .gsub(/\r\n|\n\r|\r/, "\n")
-          .gsub(/^(#{OID_RE})\s*=\s*(Opaque|STRING):\s*\n/,
-                %(\\1 = \\2: ""\n))
-          .gsub(/^(#{OID_RE}) = (Opaque|STRING): ((?!")[^\n]*)\n/,
-                %(\\1 = \\2: "\\3"\n))
+          .gsub(EMPTY_STRING_RE, %(\\1 = \\2: ""\n))
+          .gsub(STRING_RE, %(\\1 = \\2: "\\3"\n))
           .gsub(Static::ANY_MESSAGE, Static::QUOTED_MESSAGES)
       end
 
-      def index_using_first_oid(value)
-        base = @oids.first
-
-        if base == value.oid
-          nil
-        elsif value.oid.start_with?(base)
-          value.oid.gsub(/\A#{base}\.?/, '')
-        else
-          raise "Received ID doesn't start with the given ID"
-        end
+      def indexes_from_columns(columns)
+        columns.first.map { |value| split_oid(@oids.first, value.oid)[1] }
       end
 
       def parse_tokens(tokens)
@@ -82,8 +109,10 @@ module SNMP
       def parse_next_object(tokens)
         oid = tokens.next.sub(/\A\./, '')
         raise "Parse error at #{oid}" unless oid =~ OID_RE
+
         equals = tokens.next
         raise "Parse error after #{oid}" unless equals == '='
+
         type, value = parse_type(tokens)
         Value.new(oid, type, value)
       end
@@ -94,6 +123,21 @@ module SNMP
         ValueParser.find(type, token).parse(tokens)
       end
 
+      # split a complete OID into a base and index, given an expected base
+      # raises if the base isn't present
+      def split_oid(base, oid)
+        if base == oid
+          [base, nil]
+        elsif oid.start_with?(base)
+          [base, oid.sub(/\A#{base}\.?/, '')]
+        elsif base.include?('::') && !oid.include?('::')
+          alternate_base = base.sub(/\A[^:]+::/, '')
+          split_oid(alternate_base, oid)
+        else
+          raise "Received ID doesn't start with the given ID"
+        end
+      end
+
       def table(columns)
         if columns.size == 1 && columns.all? { |column| column.size == 1 }
           columns

data/lib/snmp/open/version.rb

@@ -1,5 +1,5 @@
 module SNMP
   class Open
-    VERSION = '0.6.0'.freeze
+    VERSION = '0.7.1'.freeze
   end
 end

data/lib/snmp/open.rb

@@ -27,16 +27,18 @@ module SNMP
     end
 
     # Perform an SNMP get using the "snmpget" command and parse the output
-    def get(oids)
+    def get(oids, &block)
       return enum_for(:get, oids) unless block_given?
+
       texts = oids.map { |oid| reader.capture(:get, oid) }
-      Parser.new(oids).parse(texts).fetch(0, []).each { |arg| yield(arg) }
+      Parser.new(oids).parse(texts).fetch(0, []).each(&block)
     end
 
     # Perform an SNMP walk using the "snmpwalk" or "snmpbulkwalk" commands and
     # parse the output
     def walk(oids, **kwargs)
       return enum_for(:walk, oids, **kwargs) unless block_given?
+
       bulk = kwargs.fetch(:bulk, true)
       options = walk_options(bulk, **kwargs)
       cmd = bulk ? :bulkwalk : :walk

data/snmp-open.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2.4'
+
   spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snmp-open
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Ben Miller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,16 +105,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project:
+rubygems_version: 2.7.6.2
 signing_key:
 specification_version: 4
 summary: Wrapper for command-line SNMP utilities