snmp-open 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67cb5790febed285507e8f2872aa8dbb3f025a02
-  data.tar.gz: d1504724d8f8572a03624bca255d10757636d40f
+SHA256:
+  metadata.gz: 1362f32d8e43b509be4884b392c43689b9cba48c2e2d6f63c4912e645ba6fcc9
+  data.tar.gz: d751cce9e00204ae0b0d131120338ce3b7beaf1bbfb2e71f114c60f8c9bfdfa8
 SHA512:
-  metadata.gz: fff2fcd5e4c3a42d921112c4d0f36e96914b037aee168c73b2981796375597e82e7564352030cd0860043c40f24e61a7e44cd8fe3ae7b7f481b7c60e4d973631
-  data.tar.gz: 240aebb9fd9938b76a1d0bc37e56c77d70eb8cd5958a73f952b1766df793c8baabf43a437b0a0207c0c391ea5648018c7948c9ad92572f6b2cabb5555fb67492
+  metadata.gz: 51603c2ee2b8d5077be2dcc8f26b74ad174d09a31fe6b6879343d98b33bba5f30f6246cf2ac3999f3a3aa46fda3b5cf7f849310016de5725cbdd0574741af99c
+  data.tar.gz: 2670576c9373c22e74e5bc7a118317ffdefb33d685ef654236e1ec5f369f9ac772d619ff7cfba3e8532ba52a5fc3b0d52bc67439cbeb96d84a08d6cc36f40819

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.4, 2.5, 2.6, 2.7, jruby, truffleruby]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/CommentedKeyword:
+  Enabled: false

data/lib/snmp/open/command_reader.rb

@@ -30,8 +30,7 @@ module SNMP
                    else
                      Open3.capture3(cli(cmd, oid, options))
                    end
-        raise CommandTimeoutError, err.chomp if err =~ /^timeout/i
-        raise CommandError, err.chomp unless err.empty?
+        raise_capture_errors(err)
         out
       end
 
@@ -42,6 +41,7 @@ module SNMP
         [
           command,
           *options.map { |k, v| "#{k}#{v}" },
+          *oid_options(id),
           *@host_options.map { |k, v| "#{k}#{v}" },
           *@command_options.fetch(command, {}).map { |k, v| "#{k}#{v}" },
           *id
@@ -50,6 +50,19 @@ module SNMP
 
       private
 
+      def raise_capture_errors(err)
+        case err
+        when /^Cannot find module \(([^)]+)\)/
+          raise UnknownMIBError, "Unknown MIB: #{Regexp.last_match(1)}"
+        when /^(\S+): Unknown Object Identifier$/
+          raise UnknownOIDError, "Unknown OID: #{Regexp.last_match(1)}"
+        when /^timeout/i
+          raise CommandTimeoutError, err.chomp
+        when /./
+          raise CommandError, err.chomp
+        end
+      end
+
       def merge_options(options = {})
         options.each_pair.with_object({}) do |(key, value), opts|
           if Options::MAP.key?(key)
@@ -63,6 +76,15 @@ module SNMP
         end
       end
 
+      # if the request OID is all-numeric, force numeric OID in the output
+      def oid_options(id)
+        if id =~ /[^0-9.]/
+          []
+        else
+          ['-On']
+        end
+      end
+
       def normalize_command(command)
         case command
         when Symbol then "snmp#{command}"
@@ -100,5 +122,7 @@ module SNMP
 
     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/options.rb

@@ -24,12 +24,10 @@ module SNMP
         host: nil
       }.freeze
 
-      # On some systems, SNMP command outputs will include symbolic OID names,
-      # 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
+      # and/or value units. The parser doesn't support these, so disable them.
       REQUIRED_BY_PARSER = {
         '-Oe' => nil,
-        '-On' => nil,
         '-OU' => nil
       }.freeze
 

data/lib/snmp/open/parser.rb

@@ -14,6 +14,7 @@ module SNMP
     # convert SNMP command output into arrays
     class Parser
       include SNMP::Open::Parser::Constants
+      OID_RE = Regexp.union(/\S+-MIB::\S+/, /[0-9\.]+/)
 
       def initialize(oids)
         @oids = oids
@@ -21,12 +22,8 @@ module SNMP
 
       def parse(texts)
         columns = texts.map do |text|
-          tokenized =
-            text
-            .gsub(/^([0-9\.]+) = (Opaque|STRING): ((?!")[^\n]*)\n/,
-                  %(\\1 = \\2: "\\3"\n))
-            .gsub(Static::ANY_MESSAGE, Static::QUOTED_MESSAGES)
-            .shellsplit
+          clean = clean_input_text(text)
+          tokenized = clean.shellsplit
           parse_tokens(tokenized)
         end
 
@@ -47,6 +44,16 @@ module SNMP
         end
       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(Static::ANY_MESSAGE, Static::QUOTED_MESSAGES)
+      end
+
       def index_using_first_oid(value)
         base = @oids.first
 
@@ -69,12 +76,12 @@ module SNMP
 
         objects
       rescue StopIteration
-        return objects
+        objects
       end
 
       def parse_next_object(tokens)
         oid = tokens.next.sub(/\A\./, '')
-        raise "Parse error at #{oid}" unless oid =~ /\A[0-9.]+\z/
+        raise "Parse error at #{oid}" unless oid =~ OID_RE
         equals = tokens.next
         raise "Parse error after #{oid}" unless equals == '='
         type, value = parse_type(tokens)

data/lib/snmp/open/version.rb

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

data/snmp-open.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'snmp/open/version'
 
@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'snmp'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snmp-open
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ben Miller
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,16 +66,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - bmiller@rackspace.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -98,7 +99,7 @@ files:
 homepage: https://github.com/bjmllr/snmp-open
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,9 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Wrapper for command-line SNMP utilities
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-  - 2.3.4
-  - 2.2.7
-before_install: gem install bundler -v 1.13.6