snmp 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc05dcb597e677b4e3415d4ebbf8d3270a6ee0497811835161bc8a720e37bb1
-  data.tar.gz: 1cb457419b0226e161ae789803a2924d80d6b93b4099535eebacf938d141b134
+  metadata.gz: 4a21d910b05ecc503b318d54843dc706c80e8912bdab3da2635e6cfed4fa1b7b
+  data.tar.gz: 5223e07377fc2bda06ebff57fa09022f22856fa26f596ecced8557f1c1267422
 SHA512:
-  metadata.gz: '09a2f0ed024c6271556fe8afaded20ae06eef4b7c2857ee82e1dddd4196f280532060631b98f39bd24f2539c3e1a384bfd0b64cc45d5b80fba8ad567c7875528'
-  data.tar.gz: a030ed0e551eb4fe3d8c96a2b02c731ec225e20c47804ee95e50488986d943410ff00fefb26a12a70c808b4db0a5a4a263361f7ebf3406e97e8beefb801ad769
+  metadata.gz: 560062489338a74306f8d8504135bad6cc07198d1e01a940da3857b1fce54f5f50ab6fa017b674ff2ee552cd0f14ac0ebdf7b89dafa2968c3275edb5c8fa872b
+  data.tar.gz: 696b0ce5b8858e49355011f1a7c8298838ec4cc4fa4f65fed7cdabc12a00c2ddfa26e070f29990c867a51d31b8cb0eaee297a6d75612c2d3722c8363dc54949b

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Change Log
+
+## Changes for version 1.3.3:
+* Move web content to GitHub Pages https://github.com/ruby-snmp/ruby-snmp/pull/66
+* Modernize project structure: README, gemspec, Rakefile, and development dependencies https://github.com/ruby-snmp/ruby-snmp/pull/65
+  * This change includes: Ship license file in gem. https://github.com/ruby-snmp/ruby-snmp/pull/65
+* Migrate from Travis CI to GitHub Actions https://github.com/ruby-snmp/ruby-snmp/pull/64
+* Transfer repository from `hallidave/ruby-snmp` to `ruby-snmp/ruby-snmp` https://github.com/ruby-snmp/ruby-snmp/pull/63
+* Allow MIB dir to be specified when loading additional modules (Fixes: https://github.com/ruby-snmp/ruby-snmp/issues/55 )
+* Name lookup hash values were set to nil when overwriting (Fixes: https://github.com/ruby-snmp/ruby-snmp/issues/54 )
+
+## Changes for version 1.3.2:
+* Accept non-standard error status codes
+
+## Changes for version 1.3.1:
+* Cleaned up deprecation warnings
+* Fixed SNMP::Integer#<=> method for Ruby 2.3.0 and later
+* Removed artificial limit on number of non-repeaters for GetBulkRequest
+* SNMP::BER module no longer pollutes global namespace
+
+## Changes for version 1.2.0:
+* Removed support for Ruby 1.8
+* Changed license to MIT License
+
+## Changes for version 1.1.1:
+
+* Incorporate various small pull requests
+
+## Changes for version 1.1.0:
+
+* Added MIB support to ObjectId and Varbind, so that to_s can return symbolic information
+* Added to_str method to ObjectId to return a numeric OID string (old to_s behavior)
+* TrapListener can now support multiple community strings
+
+## Changes for version 1.0.4:
+
+* New option handling and added lower-case versions of all options
+* Added SNMP::VERSION constant
+* Experimental support for IPv6
+* Removed support for installation with setup.rb
+
+## Changes for version 1.0.3:
+
+* Minor changes to Manager class.  The :Transport option may now be an
+  object or a class.  Explicity call Timeout.timeout so that a timeout
+  method may be defined in subclasses.  Thanks to Eric Monti.
+
+## Changes for version 1.0.2:
+
+* Internal code changes to make this library compatible with both Ruby 1.8
+  and Ruby 1.9.  Note that an ord() method is now added to the Fixnum class
+  for Ruby 1.8.  See the ber.rb file for details.
+
+## Changes for version 1.0.1:
+
+* Made the host configurable for the TrapListener.  Previously defaulted
+  to 'localhost'.
+
+## Changes for version 1.0.0:
+
+* Added to_s method to TimeTicks.  Displays time in human-readable form
+  instead of just a number.  The to_i method can still be used to get the
+  number of ticks.

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2004-2014 David R. Halliday
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# SNMP Library for Ruby
+[<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License MIT" />](https://raw.githubusercontent.com/ruby-snmp/ruby-snmp/master/MIT-LICENSE)
+[<img src="https://badge.fury.io/rb/snmp.svg" alt="Gem Version" />](https://badge.fury.io/rb/snmp)
+
+## Summary
+
+This library implements SNMP (the Simple Network Management Protocol).  It is
+implemented in pure Ruby, so there are no dependencies on external libraries
+like [net-snmp](http://www.net-snmp.org/).  You can run this library anywhere
+that Ruby can run.
+
+This release supports the following:
+
+* The GetRequest, GetNextRequest, GetBulkRequest, SetRequest, Response
+  SNMPv1_Trap, SNMPv2_Trap, and Inform PDUs
+* All of the ASN.1 data types defined by SNMPv1 and SNMPv2c
+* Sending informs and v1 and v2 traps
+* Trap handling for informs and v1 and v2 traps
+* Symbolic OID values (ie. "ifTable" instead of "1.3.6.1.2.1.2.2") as parameters to the SNMP::Manager API
+* Includes symbol data files for all current IETF MIBs
+* Compatible with Ruby 1.9 and higher
+
+See the SNMP::Manager, SNMP::TrapListener, and SNMP::MIB classes and the
+examples below for more details.
+
+## Installation
+
+You can use [RubyGems](https://rubygems.org/) to
+install the latest version of the SNMP library.
+
+```sh
+gem install snmp
+```
+
+## Examples
+
+### Get Request
+
+Retrieve a system description.
+
+```ruby
+require 'snmp'
+
+SNMP::Manager.open(:host => 'localhost') do |manager|
+  response = manager.get(["sysDescr.0", "sysName.0"])
+  response.each_varbind do |vb|
+    puts "#{vb.name.to_s}  #{vb.value.to_s}  #{vb.value.asn1_type}"
+  end
+end
+```
+
+### Set Request
+
+Create a varbind for setting the system name.
+
+```ruby
+require 'snmp'
+include SNMP
+
+manager = Manager.new(:host => 'localhost')
+varbind = VarBind.new("1.3.6.1.2.1.1.5.0", OctetString.new("My System Name"))
+manager.set(varbind)
+manager.close
+```
+
+### Table Walk
+
+Walk the ifTable.
+
+```ruby
+require 'snmp'
+
+ifTable_columns = ["ifIndex", "ifDescr", "ifInOctets", "ifOutOctets"]
+SNMP::Manager.open(:host => 'localhost') do |manager|
+  manager.walk(ifTable_columns) do |row|
+    row.each { |vb| print "\t#{vb.value}" }
+    puts
+  end
+end
+```
+
+### Get-Next Request
+
+A more difficult way to walk the ifTable.
+ 
+```ruby
+require 'snmp'
+include SNMP
+
+Manager.open(:host => 'localhost') do |manager|
+  ifTable = ObjectId.new("1.3.6.1.2.1.2.2")
+  next_oid = ifTable
+  while next_oid.subtree_of?(ifTable)
+    response = manager.get_next(next_oid)
+    varbind = response.varbind_list.first
+    next_oid = varbind.name
+    puts varbind.to_s
+  end
+end
+```
+
+### Get-Bulk Request
+
+Get interface description and admin status for 10 rows of the ifTable.
+
+```ruby
+require 'snmp'
+include SNMP
+
+ifDescr_OID = ObjectId.new("1.3.6.1.2.1.2.2.1.2")
+  ifAdminStatus_OID = ObjectId.new("1.3.6.1.2.1.2.2.1.7")
+  MAX_ROWS = 10
+  Manager.open(:host => 'localhost') do |manager|
+  response = manager.get_bulk(0, MAX_ROWS, [ifDescr_OID, ifAdminStatus_OID])
+  list = response.varbind_list
+  until list.empty?
+    ifDescr = list.shift
+    ifAdminStatus = list.shift
+    puts "#{ifDescr.value}    #{ifAdminStatus.value}"
+  end
+end
+```
+
+### Trap Handling
+
+Log traps to STDOUT.
+
+```ruby
+require 'snmp'
+require 'logger'
+
+log = Logger.new(STDOUT)
+m = SNMP::TrapListener.new do |manager|
+  manager.on_trap_default do |trap|
+    log.info trap.inspect
+  end
+end
+m.join
+```
+
+## License
+
+This SNMP Library is released under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,58 +1,22 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/clean'
+# frozen_string_literal: true
 
-require 'rdoc/task'
-require 'rubygems/package_task'
+require "bundler/gem_tasks"
 
-task :default => [:test]
+# Avoid using `minitest/test_task` for Ruby 2.5 and earlier
+require "rake/testtask"
 
-# test target
-Rake::TestTask.new do |test|
-    test.libs  << "lib"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib"
 end
 
-# package target
-CLEAN.include 'pkg'
-CLEAN.include 'doc'
-CLEAN.include 'web/site'
-
-spec = Gem::Specification.load "snmp.gemspec"
-
-Gem::PackageTask.new(spec) do |package|
-    package.need_zip = false
-    package.need_tar = false
-end
+task default: :test
 
 # rdoc, clobber_rdoc, rerdoc targets
+require 'rdoc/task'
+
 Rake::RDocTask.new do |doc|
-    doc.rdoc_dir = "doc"
-    doc.main = "README.rdoc"
-    doc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
-    doc.title = "SNMP Library for Ruby"
+  doc.rdoc_dir = "doc"
+  doc.main = "README.md"
+  doc.rdoc_files.include("README.md", "lib/**/*.rb")
+  doc.title = "SNMP Library for Ruby"
 end 
-
-namespace :web do
-  desc "Generate website content"
-  task :gen => :rdoc do
-    ROOT_PATH = File.dirname(File.expand_path(__FILE__))
-    SRC_DIR = ROOT_PATH + "/web/content"
-    DEST_DIR = ROOT_PATH + "/web/site"
-
-    rm_rf DEST_DIR
-    mkdir_p DEST_DIR
-
-    Dir.glob(SRC_DIR + "/*").each do |name|
-      puts "#{name}...copying"
-      cp name, DEST_DIR + "/" + File.basename(name)
-    end
-
-    puts "Documentation...copying"
-    cp_r ROOT_PATH + "/doc", DEST_DIR + "/doc"
-  end
-
-  desc "Publish website to RubyForge"
-  task :publish => :gen do
-    sh "scp -r web/site/* davehal@rubyforge.org:/var/www/gforge-projects/snmplib"
-  end
-end

data/dump_yaml.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'snmp'
+require 'yaml'
+
+varbinds = []
+SNMP::Manager.open do |snmp|
+  snmp.walk("ifTable") do |vb|
+    varbinds << [vb.name.to_s, vb.value.to_s, vb.value.class.to_s]
+  end
+end
+
+puts varbinds.to_yaml
+

data/import.rb

@@ -0,0 +1,22 @@
+# use local implementation, not the installed gem (if any)
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/lib")
+
+require 'snmp/mib'
+
+if ARGV.size == 1
+  mib_path = ARGV[0]
+else
+  smilint_version = `smilint --version`
+  libsmi_version = smilint_version.split[1]
+  mib_path = "/usr/local/Cellar/libsmi/#{libsmi_version}/share/mibs/ietf"
+end
+
+Dir["#{mib_path}/*"].each do |file|
+  print file
+  if (File.basename(file) == 'DOT12-RPTR-MIB')
+    puts " (skipping)"
+  else
+    puts
+    SNMP::MIB::import_module(file)
+  end
+end

data/lib/snmp/manager.rb

@@ -205,7 +205,8 @@ module SNMP
       @transport = config.create_transport
       @max_bytes = config.max_recv_bytes
       @mib = MIB.new
-      load_modules(config.mib_modules, config.mib_dir)
+      @mib_dir = config.mib_dir
+      load_modules(config.mib_modules, @mib_dir)
       @ignore_oid_order = config.ignore_oid_order
       @config = config.applied_config
     end
@@ -233,10 +234,6 @@ module SNMP
       @transport.close
     end
 
-    def load_module(name)
-      @mib.load_module(name)
-    end
-
     ##
     # Sends a get request for the supplied list of ObjectId or VarBind
     # objects.
@@ -490,8 +487,12 @@ module SNMP
       @@request_id.force_next(request_id)
     end
 
-    def load_modules(module_list, mib_dir)
-      module_list.each { |m| @mib.load_module(m, mib_dir) }
+    def load_module(name, mib_dir = @mib_dir)
+      @mib.load_module(name, mib_dir)
+    end
+
+    def load_modules(module_list, mib_dir = @mib_dir)
+      module_list.each { |m| load_module(m, mib_dir) }
     end
 
     private
@@ -623,7 +624,8 @@ module SNMP
       @community = config.community
       @max_bytes = config.max_recv_bytes
       @mib = MIB.new
-      load_modules(config.mib_modules, config.mib_dir)
+      @mib_dir = config.mib_dir
+      load_modules(config.mib_modules, @mib_dir)
       @config = config.applied_config
 
       @handler_init = block
@@ -697,12 +699,16 @@ module SNMP
     alias kill exit
     alias terminate exit
 
-    private
+    def load_module(name, mib_dir = @mib_dir)
+      @mib.load_module(name, mib_dir)
+    end
 
-    def load_modules(module_list, mib_dir)
-      module_list.each { |m| @mib.load_module(m, mib_dir) }
+    def load_modules(module_list, mib_dir = @mib_dir)
+      module_list.each { |m| load_module(m, mib_dir) }
     end
 
+    private
+
     def process_traps(trap_listener)
       @handler_init.call(trap_listener) if @handler_init
       loop do

data/lib/snmp/mib.rb

@@ -164,6 +164,7 @@ module SNMP
       end
       @by_name.merge!(oid_hash) do |key, old, value|
         warn "warning: overwriting old MIB name '#{key}'"
+        value
       end
       @by_module_by_name[module_name] = {}
       @by_module_by_name[module_name].merge!(oid_hash)

data/lib/snmp/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SNMP
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

metadata

@@ -1,79 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: snmp
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Dave Halliday
-autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 description: A Ruby implementation of SNMP (the Simple Network Management Protocol).
-email: hallidave@gmail.com
+email:
+- hallidave@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
-- README.rdoc
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
 - Rakefile
 - data/ruby/snmp/mibs/ACCOUNTING-CONTROL-MIB.yaml
 - data/ruby/snmp/mibs/ADSL-LINE-EXT-MIB.yaml
@@ -345,6 +291,7 @@ files:
 - data/ruby/snmp/mibs/VPN-TC-STD-MIB.yaml
 - data/ruby/snmp/mibs/VRRP-MIB.yaml
 - data/ruby/snmp/mibs/WWW-MIB.yaml
+- dump_yaml.rb
 - examples/datetime.rb
 - examples/dump.rb
 - examples/get.rb
@@ -353,6 +300,7 @@ files:
 - examples/log_traps.rb
 - examples/set.rb
 - examples/walk.rb
+- import.rb
 - lib/snmp.rb
 - lib/snmp/agent.rb
 - lib/snmp/ber.rb
@@ -362,24 +310,16 @@ files:
 - lib/snmp/pdu.rb
 - lib/snmp/varbind.rb
 - lib/snmp/version.rb
-- test/if_table1.yaml
-- test/if_table6.yaml
-- test/test_ber.rb
-- test/test_manager.rb
-- test/test_mib.rb
-- test/test_pdu.rb
-- test/test_retry.rb
-- test/test_smi.rb
-- test/test_varbind.rb
-- test/test_walk.rb
-homepage: https://github.com/hallidave/ruby-snmp
+homepage: https://github.com/ruby-snmp/ruby-snmp
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/ruby-snmp/ruby-snmp
+  source_code_uri: https://github.com/ruby-snmp/ruby-snmp
+  changelog_uri: https://github.com/ruby-snmp/ruby-snmp/CHANGELOG.md
 rdoc_options:
 - "--main"
-- README.rdoc
+- README.md
 - "--title"
 - SNMP Library for Ruby
 require_paths:
@@ -395,8 +335,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Ruby implementation of SNMP (the Simple Network Management Protocol).
 test_files: []