snmp_table_viewer 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9db3534a0e0d11c1747bd4f2edbc2d98990fd1ed
+  data.tar.gz: f0302013da02ee45a7712a22524029ed73bdf039
+SHA512:
+  metadata.gz: 5ba88ae246f5ef4c89703d4760fefb11f20185466e9225b4b18dfcf8d371e43d0d5cf5a690e461e90cbcbc34a433c2fdacd5b834a3b2219b6dcaaf9184eef829
+  data.tar.gz: 077a5ec639f89fd10ddb13a7958f8164487229d4a6f3a622732b2e10f41ac6b2d494bc4e241a6a0379663802270aff29e5ece6d36940eb497d026b3be8e8c486

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+        ruby:
+          mass_threshold: 20
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - app/**/*
+    - lib/**/*
+exclude_paths: # customize
+- .bundle/
+- doc/
+- spec/
+- tmp/
+

data/.gitignore

@@ -0,0 +1,27 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+todo.txt
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+gemfiles/*.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.3.1
+  - 2.4.0
+gemfile:
+  - Gemfile
+branches:
+  only:
+    - master
+    - staging
+    - /gh(?:\d)+(?:-.+)?/
+    - /dev_ver_\d+\.\d+/
+before_install: gem update bundler
+script: rake ci:travis

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## Version 0.0.4
+
+  * Rename gem to snmp_table_viewer
+
+## Version 0.0.3
+
+  * Fetcher.fetch is now a class mehtod called from_snmp
+
+## Version 0.0.1
+
+  * Gemification of a personal utility

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in osm.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', all_on_start: true, all_after_pass: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/([^/]+)/(.+)\.rb$}) { |m| "spec/#{m[1]}/#{m[2]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.rdoc

@@ -0,0 +1,39 @@
+==Copyright
+Copyright (c) 2017, Robert Gauld. All rights reserved.
+
+
+==License
+This code can be used under the BSD License (reproduced below).
+Commiters to the project give Robert Gauld the right to redistribute their commits
+under the BSD license. Should the project be re-licensed and the commiter can not be
+contacted either by the email address accompanying their commits or the project's community
+then Robert Gauld shall have the right to re-license their commits on their behalf.
+
+For the purposes of this project the community will be taken to include:
+
+- GitHub (make sure you can be contacted through the user name making the commit)
+- The Online Scout Manager forum
+
+
+===BSD License
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+- Neither the name of the OSM Extender nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,83 @@
+[![Gem Version](https://badge.fury.io/rb/snmp_table_viewer.svg)](http://badge.fury.io/rb/snmp_table_viewer)
+[![Dependency Status](https://gemnasium.com/robertgauld/snmp_table_viewer.png)](https://gemnasium.com/robertgauld/snmp_table_viewer)
+
+Master branch:
+[![Build Status](https://secure.travis-ci.org/robertgauld/snmp_table_viewer.png?branch=master)](http://travis-ci.org/robertgauld/snmp_table_viewer)
+[![Coveralls Status](https://coveralls.io/repos/robertgauld/snmp_table_viewer/badge.svg?branch=master)](https://coveralls.io/r/robertgauld/snmp_table_viewer)
+[![Code Climate](https://codeclimate.com/github/robertgauld/snmp_table_viewer.png?branch=master)](https://codeclimate.com/github/robertgauld/snmp_table_viewer)
+
+Staging branch:
+[![Build Status](https://secure.travis-ci.org/robertgauld/snmp_table_viewer.png?branch=staging)](http://travis-ci.org/robertgauld/snmp_table_viewer)
+[![Coveralls Status](https://coveralls.io/repos/robertgauld/snmp_table_viewer/badge.svg?branch=master)](https://coveralls.io/r/robertgauld/snmp_table_viewer)
+[![Code Climate](https://codeclimate.com/github/robertgauld/snmp_table_viewer.png?branch=staging)](https://codeclimate.com/github/robertgauld/snmp_table_viewer)
+
+
+## Build State
+This project uses continuous integration to help ensure that a quality product is delivered.
+Travis CI monitors two branches (versions) of the code - Master (which is what gets released)
+and Staging (which is what is currently being developed ready for moving to master).
+
+
+## Ruby Versions
+This gem supports the following versions of ruby, it may work on other versions but is not tested against them so don't rely on it.
+
+  * 2.3.0
+  * 2.3.1
+  * 2.4.0
+
+
+## SNMP Table Viewer
+
+Easily view SNMP tables. The data in the table can be easily converted and formatted in a number of ways.
+
+
+## Installation
+
+Add to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+gem 'snmp_table_viewer', '~> 0.0'
+```
+
+
+## Executable
+
+```
+Usage: snmp-table-viewer [options]
+    -h, -?, --help                   Prints this help.
+        --headings HEADINGS          Headings to use in the table (e.g. "A, Bc, D").
+        --headings-for TYPE          Use headings for this table type (ifTable).
+        --format FORMAT              How to format the output (table|csv|json|raw) (default table).
+        --converter CONVERTER        A converter to run on the data before formatting (iftable).
+
+SNMP common options:
+    -v, --version VERSION            SNMP version to use (1|2|3|) (default 3).
+        --host HOST                  The host to connect to.
+        --port PORT                  p PORT
+                                     SNMP port to connect to (default 161).
+        --base-oid OID               The oid at the start of the table. Can by dotted numbers or ifTable
+
+SNMP version 1 and 2 options:
+    -c, --comunity COMMUNITY         SNMP comunity (default "public").
+
+SNMP version 3 options:
+    -u, --user, --username USER      SNMP user.
+    -l, --security-level LEVEL       Security level to use (no_auth|auth_no_priv|auth_priv).
+    -a AUTH_PROTOCOL,                Authentication protocol to use (MD5|SHA) (default MD5).
+        --auth-protocol
+    -A AUTH_PASSWORD,                Authentication password to use.
+        --auth-password
+    -x PRIV_PROTOCOL,                Privacy protocol to use (DES|AES) (default DES).
+        --priv-protocol
+    -X PRIV_PASSWORD,                Privacy password to use.
+        --priv-password
+
+Table formatter options:
+        --[no-]transpose-table       Transpose the output table (swap rows and columns).
+```
+
+## Documentation & Versioning
+
+Documentation can be found on [rubydoc.info](http://rubydoc.info/github/robertgauld/snmp_table_viewer/master/frames)
+
+We follow the [Semantic Versioning](http://semver.org/) concept,

data/Rakefile

@@ -0,0 +1,16 @@
+require "rake"
+require "rubygems"
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+
+namespace :ci do
+  desc "Run the Travis CI tests"
+  task :travis do
+    Rake::Task[:spec].invoke
+  end
+end

data/bin/snmp-table-viewer

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative File.join('..', 'lib', 'snmp_table_viewer')
+
+def parse_command_line
+  options = {
+    SNMPTableViewer::Formatter::Table => {
+      transpose: false,
+    },
+    snmp: {
+      common: {
+        version: 'v3',
+        host: 'localhost',
+        port: 161,
+      },
+      'v1' => {
+        community: 'public',
+      },
+      'v2' => {
+        community: 'public',
+      },
+      'v3' => {
+        auth_protocol: :md5,
+        priv_protocol: :des,
+      },
+    },
+    base_oid: '',
+    headings:  [],
+    formatter: SNMPTableViewer::Formatter::Table,
+  }
+  headings_for = {
+      'ifTable' => ['Index', 'Descr', 'Type', 'Mtu', 'Speed', 'PhysAddress', 'AdminStatus', 'OperStatus', 'LastChange', 'InOctets', 'InUcastPkts', 'InNUcastkts', 'InDiscards', 'InErrors', 'InUnknownPrortos', 'OutOctets', 'OutUcastPkts', 'OutNUcastPkts', 'OutDiscards', 'OutErrors', 'OutQLen', 'Specific'],
+  }
+  formatters = {
+      'table' => SNMPTableViewer::Formatter::Table,
+      'csv' =>   SNMPTableViewer::Formatter::CSV,
+      'json' =>  SNMPTableViewer::Formatter::JSON,
+      'raw' =>   SNMPTableViewer::Formatter::Raw,
+  }
+  converters = {
+    'iftable' => SNMPTableViewer::Converter::IfTable,
+  }
+  base_oids = {
+    'iftable' => '1.3.6.1.2.1.2.2',
+  }
+  snmp_version = 'v3'
+
+  parser = OptionParser.new do |opts|
+    opts.banner = "Usage: snmp-table-viewer [options]"
+
+    opts.on('-h', '--help', '-?', 'Prints this help.') do
+      puts opts
+      exit
+    end
+
+    opts.on('--headings HEADINGS', Array, 'Headings to use in the table (e.g. "A, Bc, D").') do |v|
+      options[:headings] += v.map(&:strip)
+    end
+
+    opts.on('--headings-for TYPE', String, "Use headings for this table type (#{headings_for.keys.join('|')}).") do |v|
+      options[:headings] += headings_for[v] || []
+    end
+
+    opts.on('--format FORMAT', String, "How to format the output (#{formatters.keys.join('|')}) (default table).") do |v|
+      options[:formatter] = formatters[v.downcase]
+    end
+
+    opts.on('--converter CONVERTER', String, "A converter to run on the data before formatting (#{converters.keys.join('|')}).") do |v|
+      options[:converter] = converters[v.downcase]
+    end
+
+
+    opts.separator "\nSNMP common options:"
+
+    opts.on('-vVERSION', '--version VERSION', 'SNMP version to use (1|2|3|) (default 3).') do |version|
+      snmp_version = "v#{version}"
+      options[:snmp][:common][:version] = snmp_version
+    end
+
+    opts.on('--host HOST', 'The host to connect to.') do |v|
+      options[:snmp][:common][:host] = v
+    end
+
+    opts.on('p PORT', '--port PORT', Integer, 'SNMP port to connect to (default 161).') do |v|
+      options[:snmp][:common][:port] = v
+    end
+
+    opts.on('--base-oid OID', 'The oid at the start of the table. Can by dotted numbers or ifTable') do |v|
+      options[:base_oid] = base_oids[v.downcase] || v
+    end
+
+
+
+    opts.separator "\nSNMP version 1 and 2 options:"
+
+    opts.on('-c COMMUNITY', '--comunity COMMUNITY', 'SNMP comunity (default "public").') do |community|
+      options[:snmp][snmp_version][:community] = community
+    end
+
+
+    opts.separator "\nSNMP version 3 options:"
+
+    opts.on('-u USER', '--user USER', '--username USER', 'SNMP user.') do |user|
+      options[:snmp]['v3'][:username] = user
+    end
+    opts.on('-l LEVEL', '--security-level LEVEL', 'Security level to use (no_auth|auth_no_priv|auth_priv).') do |level|
+      options[:snmp]['v3'][:security_level] = level
+    end
+    opts.on('-a AUTH_PROTOCOL', '--auth-protocol AUTH_PROTOCOL', 'Authentication protocol to use (MD5|SHA) (default MD5).') do |value|
+      options[:snmp]['v3'][:auth_protocol] = value.downcase.to_sym
+    end
+    opts.on('-A AUTH_PASSWORD', '--auth-password AUTH_PASSWORD', 'Authentication password to use.', String) do |value|
+      options[:snmp]['v3'][:auth_password] = value
+    end
+    opts.on('-x PRIV_PROTOCOL', '--priv-protocol PRIV_PROTOCOL', 'Privacy protocol to use (DES|AES) (default DES).') do |value|
+      options[:snmp]['v3'][:priv_protocol] = value.downcase.to_sym
+    end
+    opts.on('-X PRIV_PASSWORD', '--priv-password PRIV_PASSWORD', 'Privacy password to use.', String) do |value|
+      options[:snmp]['v3'][:priv_password] = value
+    end
+
+
+    opts.separator "\nTable formatter options:"
+    opts.on('--[no-]transpose-table', 'Transpose the output table (swap rows and columns).') do |v|
+      options[SNMPTableViewer::Formatter::Table][:transpose] = v
+    end
+
+  end # create parser
+  
+  parser.parse!(ARGV)
+  options
+end
+
+
+
+
+options = parse_command_line
+snmp_options = options[:snmp][:common].clone
+snmp_options.merge!(options[:snmp][snmp_options[:version]])
+
+data = SNMPTableViewer::Fetcher.fetch(base_oid: options[:base_oid], **snmp_options)
+
+converter = options[:converter]
+data = converter.convert(data) unless converter.nil?
+
+formatter = options[:formatter]
+formatter_options = options[formatter] || {}
+formatter = formatter.new(data: data, headings: options[:headings])
+puts formatter.output(**formatter_options)