normelton-snmp4em 0.1.1 → 0.1.2

data/Rakefile

@@ -2,7 +2,7 @@ require "rubygems"
 require "rake"
 require "echoe"
 
-Echoe.new("snmp4em", "0.1.0") do |p|
+Echoe.new("snmp4em", "0.1.2") do |p|
   p.description              = "A high-performance SNMP engine built on EventMachine and Ruby-SNMP"
   p.url                      = "http://github.com/normelton/snmp4em"
   p.author                   = "Norman Elton"

data/lib/snmp4em.rb

@@ -1,113 +1,12 @@
-require "snmp"
-require "common.rb"
-require "handler.rb"
-require "snmp_request.rb"
-require "requests/snmp_get_request.rb"
-require "requests/snmp_getnext_request.rb"
-require "requests/snmp_walk_request.rb"
-require "requests/snmp_set_request.rb"
-
-require "pp"
-
-# The SNMP4EM library 
-
-module SNMP4EM
-  class SNMPv1
-    @pending_requests = []
-    @socket = nil
-    
-    class << self
-      attr_reader :pending_requests
-      attr_reader :socket
-      
-      def init_socket #:nodoc:
-        @socket = EM::open_datagram_socket("0.0.0.0", 0, Handler)
-      end
-    end
-    
-    attr_reader :host, :port, :community_ro, :community_rw, :timeout, :retries
-    
-    # Creates a new object to communicate with SNMPv1 agents. Optionally pass in the following parameters:
-    # *  _host_ - IP/hostname of remote agent (default: 127.0.0.1)
-    # *  _port_ - UDP port on remote agent (default: 161)
-    # *  _community_ - Community string to use (default: public)
-    # *  _community_ro_ - Read-only community string to use for get/getnext/walk operations (default: public)
-    # *  _community_rw_ - Read-write community string to use for set operations (default: public)
-    # *  _timeout_ - Number of seconds to wait before a request times out (default: 1)
-    # *  _retries_ - Number of retries before failing (default: 3)
-    
-    def initialize(args = {})
-      @host         = args[:host]         || "127.0.0.1"
-      @port         = args[:port]         || 161
-      @community_ro = args[:community_ro] || args[:community] || "public"
-      @community_rw = args[:community_rw] || args[:community] || "public"
-      @timeout      = args[:timeout]      || 1
-      @retries      = args[:retries]      || 3
-      
-      self.class.init_socket
-    end
-    
-    def send(message) #:nodoc:
-      self.class.socket.send_datagram message.encode, @host, @port
-    end
-
-    # Sends an SNMP-GET request to the remote agent for all OIDs specified in the _oids_ array. Returns a SnmpGetRequest object,
-    # which implements EM::Deferrable. From there, implement a callback/errback to fetch the result. On success, the result will be
-    # a hash, mapping requested OID values to results.
-    # 
-    # Optional arguments can be passed into _args_, including:
-    # *  _return_raw_ - Return objects and errors as their raw SNMP types, such as SNMP::Integer instead of native Ruby integers, SNMP::OctetString instead of native Ruby strings, etc. (default: false)
-
-    def get(oids, args = {})
-      request = SnmpGetRequest.new(self, oids, args)
-      self.class.pending_requests << request
-      return request
-    end
-
-    # Sends an SNMP-GETNEXT request to the remote agent for all OIDs specified in the _oids_ array. Returns a SnmpGetRequest object,
-    # which implements EM::Deferrable. From there, implement a callback/errback to fetch the result. On success, the result will be
-    # a hash, mapping requested OID values to two-element arrays consisting of [_next_oid_ , _next_value_]. Any values that produced an
-    # error will map to a symbol representing the error.
-    # 
-    # Optional arguments can be passed into _args_, including:
-    # *  _return_raw_ - Return objects and errors as their raw SNMP types, such as SNMP::Integer instead of native Ruby integers, SNMP::OctetString instead of native Ruby strings, etc. (default: false)
-
-    def getnext(oids, args = {})
-      request = SnmpGetNextRequest.new(self, oids, args)
-      self.class.pending_requests << request
-      return request
-    end
-
-    # Sends an SNMP-SET request to the remote agent for all OIDs specified in the _oids_ hash. The hash must map OID values to requested
-    # values. Values can either be specified as Ruby native strings/integers, or as SNMP-specific classes (SNMP::IpAddress, etc).
-    # Returns a SnmpSetRequest object, which implements EM::Deferrable. From there, implement a callback/errback to fetch the result.
-    # On success, the result will be a hash, mapping requested OID values to the returned value from the agent. Any values that were stored
-    # successfully will map to _true_, otherwise, the value will map to a symbol representing the error.
-    # 
-    # Optional arguments can be passed into _args_, including:
-    # *  _return_raw_ - Return error objects as SNMP::ResponseError instead of a symbol
-
-    def set(oids, args = {})
-      request = SnmpSetRequest.new(self, oids, args)
-      self.class.pending_requests << request
-      return request
-    end
-
-    # Sends a series of SNMP-GETNEXT requests to simulate an SNMP "walk" operation. Given an OID prefix, the library will keep requesting the
-    # next OID until that returned OID does not begin with the requested prefix. This gives the ability to retrieve entire portions of the
-    # SNMP tree in one "operation". Multiple OID prefixes can be passed into the _oids_ array, and will be fetched in parallel. The function returns
-    # a SnmpWalkRequest object, which implements EM::Deferrable. From there, implement a callback/errback to fetch the result. On success, the
-    # result will be a hash, mapping requested OID prefixes to the returned value. Successful walks will be mapped to an array of two-element arrays,
-    # each of which consists of [_oid_ , _value_]. Unsuccessful walks will be mapped to a symbol representing the error.
-
-    # Optional arguments can be passed into _args_, including:
-    # *  _return_raw_ - Return objects and errors as their raw SNMP types, such as SNMP::Integer instead of native Ruby integers, SNMP::OctetString instead of native Ruby strings, etc. (default: false)
-    # *  _max_results_ - Maximum number of results to be returned for any single OID prefix (default: nil = unlimited)
-
-    def walk(oids, args = {})
-      request = SnmpWalkRequest.new(self, oids, args)
-      self.class.pending_requests << request
-      return request
-    end
-  end
-end
+$:.unshift File.expand_path(File.dirname(File.expand_path(__FILE__)))
+
+require 'eventmachine'
+require 'snmp'
+require 'snmp4em/common'
+require 'snmp4em/handler'
+require 'snmp4em/snmp_v1'
+require 'snmp4em/snmp_request'
+require 'snmp4em/requests/snmp_get_request'
+require 'snmp4em/requests/snmp_getnext_request'
+require 'snmp4em/requests/snmp_set_request'
+require 'snmp4em/requests/snmp_walk_request'

data/lib/{requests → snmp4em/requests}/snmp_get_request.rb

@@ -1,5 +1,3 @@
-require "snmp_request.rb"
-
 module SNMP4EM
   
   # Returned from SNMP4EM::SNMPv1.get(). This implements EM::Deferrable, so you can hang a callback()

data/lib/{requests → snmp4em/requests}/snmp_getnext_request.rb

@@ -1,5 +1,3 @@
-require "snmp_request.rb"
-
 module SNMP4EM
 
   # Returned from SNMP4EM::SNMPv1.getnext(). This implements EM::Deferrable, so you can hang a callback()

data/lib/{requests → snmp4em/requests}/snmp_set_request.rb

@@ -1,5 +1,3 @@
-require "snmp_request.rb"
-
 module SNMP4EM
 
   # Returned from SNMP4EM::SNMPv1.set(). This implements EM::Deferrable, so you can hang a callback()

data/lib/{requests → snmp4em/requests}/snmp_walk_request.rb

@@ -1,5 +1,3 @@
-require "snmp_request.rb"
-
 module SNMP4EM
 
   # Returned from SNMP4EM::SNMPv1.walk(). This implements EM::Deferrable, so you can hang a callback()

data/lib/snmp4em/snmp_v1.rb

@@ -0,0 +1,104 @@
+# The SNMP4EM library 
+
+module SNMP4EM
+  class SNMPv1
+    @pending_requests = []
+    @socket = nil
+    
+    class << self
+      attr_reader :pending_requests
+      attr_reader :socket
+      
+      def init_socket #:nodoc:
+        if @socket.nil?
+          @socket = EM::open_datagram_socket("0.0.0.0", 0, Handler)
+        end
+      end
+    end
+    
+    attr_reader :host, :port, :community_ro, :community_rw, :timeout, :retries
+    
+    # Creates a new object to communicate with SNMPv1 agents. Optionally pass in the following parameters:
+    # *  _host_ - IP/hostname of remote agent (default: 127.0.0.1)
+    # *  _port_ - UDP port on remote agent (default: 161)
+    # *  _community_ - Community string to use (default: public)
+    # *  _community_ro_ - Read-only community string to use for get/getnext/walk operations (default: public)
+    # *  _community_rw_ - Read-write community string to use for set operations (default: public)
+    # *  _timeout_ - Number of seconds to wait before a request times out (default: 1)
+    # *  _retries_ - Number of retries before failing (default: 3)
+    
+    def initialize(args = {})
+      @host         = args[:host]         || "127.0.0.1"
+      @port         = args[:port]         || 161
+      @community_ro = args[:community_ro] || args[:community] || "public"
+      @community_rw = args[:community_rw] || args[:community] || "public"
+      @timeout      = args[:timeout]      || 1
+      @retries      = args[:retries]      || 3
+      
+      self.class.init_socket
+    end
+    
+    def send(message) #:nodoc:
+      self.class.socket.send_datagram message.encode, @host, @port
+    end
+
+    # Sends an SNMP-GET request to the remote agent for all OIDs specified in the _oids_ array. Returns a SnmpGetRequest object,
+    # which implements EM::Deferrable. From there, implement a callback/errback to fetch the result. On success, the result will be
+    # a hash, mapping requested OID values to results.
+    # 
+    # Optional arguments can be passed into _args_, including:
+    # *  _return_raw_ - Return objects and errors as their raw SNMP types, such as SNMP::Integer instead of native Ruby integers, SNMP::OctetString instead of native Ruby strings, etc. (default: false)
+
+    def get(oids, args = {})
+      request = SnmpGetRequest.new(self, oids, args)
+      self.class.pending_requests << request
+      return request
+    end
+
+    # Sends an SNMP-GETNEXT request to the remote agent for all OIDs specified in the _oids_ array. Returns a SnmpGetRequest object,
+    # which implements EM::Deferrable. From there, implement a callback/errback to fetch the result. On success, the result will be
+    # a hash, mapping requested OID values to two-element arrays consisting of [_next_oid_ , _next_value_]. Any values that produced an
+    # error will map to a symbol representing the error.
+    # 
+    # Optional arguments can be passed into _args_, including:
+    # *  _return_raw_ - Return objects and errors as their raw SNMP types, such as SNMP::Integer instead of native Ruby integers, SNMP::OctetString instead of native Ruby strings, etc. (default: false)
+
+    def getnext(oids, args = {})
+      request = SnmpGetNextRequest.new(self, oids, args)
+      self.class.pending_requests << request
+      return request
+    end
+
+    # Sends an SNMP-SET request to the remote agent for all OIDs specified in the _oids_ hash. The hash must map OID values to requested
+    # values. Values can either be specified as Ruby native strings/integers, or as SNMP-specific classes (SNMP::IpAddress, etc).
+    # Returns a SnmpSetRequest object, which implements EM::Deferrable. From there, implement a callback/errback to fetch the result.
+    # On success, the result will be a hash, mapping requested OID values to the returned value from the agent. Any values that were stored
+    # successfully will map to _true_, otherwise, the value will map to a symbol representing the error.
+    # 
+    # Optional arguments can be passed into _args_, including:
+    # *  _return_raw_ - Return error objects as SNMP::ResponseError instead of a symbol
+
+    def set(oids, args = {})
+      request = SnmpSetRequest.new(self, oids, args)
+      self.class.pending_requests << request
+      return request
+    end
+
+    # Sends a series of SNMP-GETNEXT requests to simulate an SNMP "walk" operation. Given an OID prefix, the library will keep requesting the
+    # next OID until that returned OID does not begin with the requested prefix. This gives the ability to retrieve entire portions of the
+    # SNMP tree in one "operation". Multiple OID prefixes can be passed into the _oids_ array, and will be fetched in parallel. The function returns
+    # a SnmpWalkRequest object, which implements EM::Deferrable. From there, implement a callback/errback to fetch the result. On success, the
+    # result will be a hash, mapping requested OID prefixes to the returned value. Successful walks will be mapped to an array of two-element arrays,
+    # each of which consists of [_oid_ , _value_]. Unsuccessful walks will be mapped to a symbol representing the error.
+
+    # Optional arguments can be passed into _args_, including:
+    # *  _return_raw_ - Return objects and errors as their raw SNMP types, such as SNMP::Integer instead of native Ruby integers, SNMP::OctetString instead of native Ruby strings, etc. (default: false)
+    # *  _max_results_ - Maximum number of results to be returned for any single OID prefix (default: nil = unlimited)
+
+    def walk(oids, args = {})
+      request = SnmpWalkRequest.new(self, oids, args)
+      self.class.pending_requests << request
+      return request
+    end
+  end
+end

data/snmp4em.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{snmp4em}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Norman Elton"]
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description = %q{A high-performance SNMP engine built on EventMachine and Ruby-SNMP}
   s.email = %q{normelton@gmail.com}
   s.extra_rdoc_files = ["README"]
-  s.files = ["lib/common.rb", "lib/handler.rb", "lib/requests/snmp_get_request.rb", "lib/requests/snmp_getnext_request.rb", "lib/requests/snmp_set_request.rb", "lib/requests/snmp_walk_request.rb", "lib/snmp4em.rb", "lib/snmp_request.rb", "Rakefile", "README", "snmp4em.gemspec", "Manifest"]
+  s.files = ["lib/snmp4em/common.rb", "lib/snmp4em/handler.rb", "lib/snmp4em/requests/snmp_get_request.rb", "lib/snmp4em/requests/snmp_getnext_request.rb", "lib/snmp4em/requests/snmp_set_request.rb", "lib/snmp4em/requests/snmp_walk_request.rb", "lib/snmp4em/snmp_request.rb", "lib/snmp4em/snmp_v1.rb", "lib/snmp4em.rb", "Manifest", "Rakefile", "README", "snmp4em.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/normelton/snmp4em}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Snmp4em", "--main", "README"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: normelton-snmp4em
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Norman Elton
@@ -22,18 +22,19 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
-- lib/common.rb
-- lib/handler.rb
-- lib/requests/snmp_get_request.rb
-- lib/requests/snmp_getnext_request.rb
-- lib/requests/snmp_set_request.rb
-- lib/requests/snmp_walk_request.rb
+- lib/snmp4em/common.rb
+- lib/snmp4em/handler.rb
+- lib/snmp4em/requests/snmp_get_request.rb
+- lib/snmp4em/requests/snmp_getnext_request.rb
+- lib/snmp4em/requests/snmp_set_request.rb
+- lib/snmp4em/requests/snmp_walk_request.rb
+- lib/snmp4em/snmp_request.rb
+- lib/snmp4em/snmp_v1.rb
 - lib/snmp4em.rb
-- lib/snmp_request.rb
+- Manifest
 - Rakefile
 - README
 - snmp4em.gemspec
-- Manifest
 has_rdoc: true
 homepage: http://github.com/normelton/snmp4em
 post_install_message: