snmp-open 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42cc48b7cd27987ef9bf4a9ab604a7c819ff2dae
-  data.tar.gz: c3a38d4e43063ed42a0ce786628e3af6a915504b
+  metadata.gz: 9ae08ac661e97b5c47899d166a7bdcd6b71e0c55
+  data.tar.gz: b10aae94bb31fc05b38ec3d3ab9ce1d450c3b104
 SHA512:
-  metadata.gz: 423425fb07efe8265c9384d1f60ebe18ec12ea5a08f9e58551b6837e817fb84fb9604a63690398d23e21d2b537a23b2c00d958d3b2b00c0e3eb5aca5f23faaa8
-  data.tar.gz: 4af15c0e555126e1015936069aeac4c8aaf9ec3e8b067089f3e9092205609478a30bc566232d1c2c0f3c519b0283dcd4e8b881e4d199101c36ab7e1ccbcae3a7
+  metadata.gz: 998d8abcd4e3e7b5967affb6441f590201c7a0c15b24ebe7f56911fa17a103086a2c6392586baa4fb9fe26083985e9de8cbc174eb2524a4303602a11757301be
+  data.tar.gz: ecf925444abd22e218b7235985aa5d98357f9e6e34b759ac760d3bbc5c1e83c89c46c261132663ee479124932c5b8d07e3313c88edd812cccf18aed1a179ce31

data/bin/console

@@ -6,5 +6,5 @@ require 'snmp/open'
 # 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.
 
-require "pry"
+require 'pry'
 Pry.start

data/bin/get

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+require 'json'
+$LOAD_PATH << File.join(__dir__, '..', 'lib')
+require 'snmp/open'
+
+host = ARGV.fetch(0)
+oids = ARGV[1..-1]
+jj SNMP::Open.new(host: host).get(oids).to_a

data/bin/walk

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+require 'json'
+$LOAD_PATH << File.join(__dir__, '..', 'lib')
+require 'snmp/open'
+
+host = ARGV.fetch(0)
+oids = ARGV[1..-1]
+jj SNMP::Open.new(host: host).walk(oids).to_a

data/lib/snmp/open.rb

@@ -1,5 +1,5 @@
-require 'open3'
 require 'snmp/open/parser'
+require 'snmp/open/command_reader'
 
 # Simple Network Management Protocol
 module SNMP
@@ -19,92 +19,39 @@ module SNMP
 
   # Open3-based wrapper for SNMP CLI commands
   class Open
-    attr_reader :options
+    attr_reader :reader
 
-    # see snmpcmd(1) for explanation of options
-    OPTIONS = {
-      version: '-v',
-      auth_password: '-A',
-      auth_protocol: '-a',
-      community: '-c',
-      context: '-n',
-      numeric: '-On', # needed by parser, should always be enabled
-      priv_password: '-X', # not recommended, see snmp.conf(5)
-      priv_protocol: '-x',
-      sec_level: '-l',
-      sec_user: '-u',
-      retries: '-r',
-      timeout: '-t',
-      host: nil
-    }.freeze
-
-    # +options+ accepts options dealing with making connections to the host,
-    # including all of the options listed in the +OPTIONS+ constant hash. Other
-    # options can be given as strings (or any object with a suitable +to_s+
-    # method), e.g., these are equivalent:
-    #
-    #   SNMP::Open.new(host: hostname, timeout: 3, '-m' => miblist)
-    #   SNMP::Open.new(hostname => nil, '-t' => '3', '-m' => miblist)
-    #
+    # see CommandReader for a description of options
     def initialize(options = {})
-      host = options.delete(:host) ||
-             (raise ArgumentError, 'Host expected but not given')
-      @host_options = merge_options(options)
-                      .merge('-On' => nil, host => nil)
-      return if @host_options.key?(nil)
-    end
-
-    # Generate a CLI command string
-    def cli(command, id = nil, options = {})
-      command = case command
-                when Symbol then "snmp#{command}"
-                else             command.to_s
-                end
-
-      [
-        command,
-        *options.map { |k, v| "#{k}#{v}" },
-        *@host_options.map { |k, v| "#{k}#{v}" },
-        *id
-      ].join(' ')
+      @reader = options[:reader] || CommandReader.new(options)
     end
 
     # Perform an SNMP get using the "snmpget" command and parse the output
     def get(oids)
       return enum_for(:get, oids) unless block_given?
-      texts = oids.map { |oid| capture_command(:get, oid) }
-      Parser.new(oids).parse(texts).each { |arg, *| yield(arg) }
+      texts = oids.map { |oid| reader.capture(:get, oid) }
+      Parser.new(oids).parse(texts).first.each { |arg| yield(arg) }
     end
 
     # Perform an SNMP walk using the "snmpwalk" or "snmpbulkwalk" commands and
     # parse the output
     def walk(oids, **kwargs)
-      kwargs = { bulk: true, non_repeaters: 0, max_repetitions: 10 }
-               .merge(kwargs)
       return enum_for(:walk, oids, **kwargs) unless block_given?
+      bulk = kwargs.fetch(:bulk, true)
+      options = walk_options(bulk, **kwargs)
       cmd = bulk ? :bulkwalk : :walk
-      options = bulk ? { '-Cn' => non_repeaters, '-Cr' => max_repetitions } : {}
-      texts = oids.map { |oid| capture_command(cmd, oid, options) }
+      texts = oids.map { |oid| reader.capture(cmd, oid, options) }
       Parser.new(oids).parse(texts).each { |*args| yield(*args) }
     end
 
-    private
-
-    def capture_command(cmd, oid, options = {})
-      out, err = Open3.capture3(cli(cmd, oid, options))
-      raise err unless err.empty?
-      out
-    end
-
-    def merge_options(options = {})
-      options.each_pair.with_object({}) do |(key, value), opts|
-        if OPTIONS.key?(key)
-          opts[OPTIONS[key]] = value
-        elsif key.is_a?(String)
-          opts[key] = value
-        else
-          raise "Unknown option #{key}"
-        end
+    def walk_options(bulk, **kwargs)
+      if bulk
+        {
+          '-Cn' => kwargs.fetch(:non_repeaters, 0),
+          '-Cr' => kwargs.fetch(:max_repetitions, 10)
+        }
+      else
+        {}
       end
     end
   end # class Open

data/lib/snmp/open/command_reader.rb

@@ -0,0 +1,75 @@
+require 'open3'
+
+module SNMP
+  class Open
+    # Open3-based data source that executes an snmp* command and captures the
+    # output
+    class CommandReader
+      # see snmpcmd(1) for explanation of options
+      OPTIONS = {
+        version: '-v',
+        auth_password: '-A',
+        auth_protocol: '-a',
+        community: '-c',
+        context: '-n',
+        numeric: '-On', # needed by parser, should always be enabled
+        priv_password: '-X', # not recommended, see snmp.conf(5)
+        priv_protocol: '-x',
+        sec_level: '-l',
+        sec_user: '-u',
+        retries: '-r',
+        timeout: '-t',
+        host: nil
+      }.freeze
+
+      # +options+ accepts options dealing with making connections to the host,
+      # including all of the options listed in the +OPTIONS+ constant hash.
+      # Other options can be given as strings (or any object with a suitable
+      # +to_s+ method), e.g., these are equivalent:
+      #
+      #   SNMP::Open.new(host: hostname, timeout: 3, '-m' => miblist)
+      #   SNMP::Open.new(hostname => nil, '-t' => '3', '-m' => miblist)
+      #
+      def initialize(options)
+        host = options.delete(:host) ||
+               (raise ArgumentError, 'Host expected but not given')
+        @host_options = merge_options(options).merge('-On' => nil, host => nil)
+      end
+
+      def capture(cmd, oid, options = {})
+        out, err = Open3.capture3(cli(cmd, oid, options))
+        raise err unless err.empty?
+        out
+      end
+
+      # Generate a CLI command string
+      def cli(command, id = nil, options = {})
+        command = case command
+                  when Symbol then "snmp#{command}"
+                  else             command.to_s
+                  end
+
+        [
+          command,
+          *options.map { |k, v| "#{k}#{v}" },
+          *@host_options.map { |k, v| "#{k}#{v}" },
+          *id
+        ].join(' ')
+      end
+
+      private
+
+      def merge_options(options = {})
+        options.each_pair.with_object({}) do |(key, value), opts|
+          if OPTIONS.key?(key)
+            opts[OPTIONS[key]] = value
+          elsif key.is_a?(String)
+            opts[key] = value
+          else
+            raise "Unknown option #{key}"
+          end
+        end
+      end
+    end # class CommandReader
+  end # class Open
+end # module SNMP

data/lib/snmp/open/file_reader.rb

@@ -1,8 +1,8 @@
-require 'snmp/open/parser'
+require 'snmp/open/command_reader'
 
 module SNMP
   class Open
-    # Test double for SNMP::Open that reads from the filesystem instead of
+    # Test data source for SNMP::Open that reads from the filesystem instead of
     # running SNMP commands. Expects a 'walk' directory to be present if #walk
     # will be used, and a 'get' directory if #get will be used. Within each
     # directory, files named according to the numeric OIDs to be used are
@@ -12,37 +12,19 @@ module SNMP
     # Produces warnings describing an snmpbulkwalk or snmpget command that could
     # be used to generate a needed file, if the file is unavailable. Controlled
     # by the `warnings` option.
-
     class FileReader
       def initialize(directory, options = {})
         @directory = directory
         @warnings = options.delete(:warnings)
-        @command_generator = SNMP::Open.new(options.merge(host: '$OPTIONS'))
-      end
-
-      def get(oids)
-        return enum_for(:get, oids) unless block_given?
-        texts = oids.map { |o| File.read(File.join(@directory, 'get', o)) }
-        Parser.new(oids).parse(texts).each { |arg, *| yield(arg) }
-      rescue Errno::ENOENT => err
-        if @warnings
-          oids.each do |oid|
-            warn "#{@command_generator.cli(:get, oid)} > get/#{oid}"
-          end
-        end
-        raise err
+        @command_generator =
+          SNMP::Open::CommandReader.new(options.merge(host: '$OPTIONS'))
       end
 
-      def walk(oids, *rest)
-        return enum_for(:walk, oids, *rest) unless block_given?
-        texts = oids.map { |o| File.read(File.join(@directory, 'walk', o)) }
-        Parser.new(oids).parse(texts).each { |*args| yield(*args) }
+      def capture(cmd, oid, _options = {})
+        outfile = File.join(cmd.to_s, oid)
+        File.read(File.join(@directory, outfile))
       rescue Errno::ENOENT => err
-        if @warnings
-          oids.each do |oid|
-            warn "#{@command_generator.cli(:bulkwalk, oid)} > walk/#{oid}"
-          end
-        end
+        warn "#{@command_generator.cli(cmd, oid)} > #{outfile}" if @warnings
         raise err
       end
     end # class FileReader

data/lib/snmp/open/parser.rb

@@ -13,6 +13,8 @@ module SNMP
     class Parser
       NOSUCHOBJECT_STR =
         'No Such Object available on this agent at this OID'.freeze
+      NOSUCHINSTANCE_STR =
+        'No Such Instance currently exists at this OID'.freeze
 
       def initialize(oids)
         @oids = oids
@@ -21,7 +23,10 @@ module SNMP
       def parse(texts)
         columns = texts.map do |text|
           tokenized =
-            text.gsub(NOSUCHOBJECT_STR, %("#{NOSUCHOBJECT_STR}")).shellsplit
+            text
+            .gsub(NOSUCHOBJECT_STR, %("#{NOSUCHOBJECT_STR}"))
+            .gsub(NOSUCHINSTANCE_STR, %("#{NOSUCHINSTANCE_STR}"))
+            .shellsplit
           parse_tokens(tokenized)
         end
 
@@ -80,12 +85,14 @@ module SNMP
         next_token = tokens.next
         type = next_token.match(/\A([A-Z]+):\z/) { |md| md[1] }
         type, value = parse_value(tokens, next_token, type)
-        [type, convert_value(type, value)]
+        [type, Conversions.convert_value(type, value)]
       end
 
       def parse_value(tokens, token, type)
         if token == NOSUCHOBJECT_STR
           ['No Such Object', nil]
+        elsif token == NOSUCHINSTANCE_STR
+          ['No Such Instance', nil]
         elsif !type
           ['STRING', token]
         else
@@ -109,22 +116,25 @@ module SNMP
         @oids.zip(columns).map do |oid, column|
           indexes.map do |index|
             id = (oid == index ? index : "#{oid}.#{index}")
-            column.find { |o| o.oid == id } || absent_value(id)
+            column.find { |o| o.oid == id } || Conversions.absent_value(id)
           end
         end
       end
 
-      def convert_value(type, value)
-        case type
-        when 'INTEGER'
-          value.to_i
-        else
-          value
+      # functions to generate value objects
+      module Conversions
+        module_function def convert_value(type, value)
+          case type
+          when 'INTEGER'
+            value.to_i
+          else
+            value
+          end
         end
-      end
 
-      def absent_value(id)
-        Value.new(id, 'absent', nil)
+        module_function def absent_value(id)
+          Value.new(id, 'absent', nil)
+        end
       end
     end # class Parser
   end # class Open

data/lib/snmp/open/version.rb

@@ -1,5 +1,5 @@
 module Snmp
   module Open
-    VERSION = '0.1.3'.freeze
+    VERSION = '0.1.4'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snmp-open
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ben Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,8 +83,11 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/get
 - bin/setup
+- bin/walk
 - lib/snmp/open.rb
+- lib/snmp/open/command_reader.rb
 - lib/snmp/open/file_reader.rb
 - lib/snmp/open/parser.rb
 - lib/snmp/open/version.rb