SNMPDevice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0a348531172447e34751b9a23c3160752c6d73b
+  data.tar.gz: 3e4bce513fffd6e23a80bc41ffaf2b22bc6647cd
+SHA512:
+  metadata.gz: e635557861a7c774233cd4e13c02ede57d479010608264bc0dd30a0ca101b285f4a44ba75a086c4d89e9518842912f5b10b1a51bea9683f284d9cb7353ce7c4e
+  data.tar.gz: 7eddc4050694c6b49aeb45a89ffac1cde9b9d3594ec9d1734d88fa85d80a55494dea054fd6d2ec4adf35d044df037b4d15545fbc90d04ff063e8b0a3f61a981a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joshua Smock
+
+MIT License
+
+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,36 @@
+# SNMPDevice
+
+This gem allows for gathering of information via SNMP, using the SNMP Library for Ruby, on any network device that allows SNMP requests. It is manufacturer agnostic, and accepts a configuration file or hash when creating a new `Device` instance. See Usage for more information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'SNMPDevice'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install SNMPDevice
+
+## Usage
+
+	require 'SNMPDevice/device'
+	include SNMPDevice
+	 
+	printer_a = Device.new('10.247.1.20')
+	printer_a.load_config({'toner' => {:name_of_toner => '1.2.3.4.5.6.7.351.2', :toner_level => '1.2.3.4.5.6.7.351.3'}})
+	printer_a.toner_info # => [["name_of_toner","toner_level"], ["Yellow", "50"], ["Cyan", "100"], ["Magenta". "10"], ["Black", "0"]]
+
+Depending on the values in the hash or YAML config, you can call something like `paper_info` or `toner_info`. It uses Ruby's `method_missing` function to define names dynamically depending on the configuration values. The results of a function such as `toner_info` can then be used as needed in other ways, such as turning to `JSON` and outputting to Javascript to create a web application capable of monitoring various devices. 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/SNMPDevice.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'SNMPDevice/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "SNMPDevice"
+  spec.version       = SNMPDevice::VERSION
+  spec.authors       = ["Joshua Smock"]
+  spec.email         = ["contact@joshuasmock.com"]
+  spec.description   = %q{This gem allows for gathering of information via SNMP, using the SNMP Library for Ruby, on network devices. It is manufacturer agnostic, and accepts a configuration file or hash when creating a new `Device` instance.}
+  spec.summary       = %q{This gem allows for the generation of various network device information through SNMP. It is built to be manufacturer agnostic.}
+  spec.homepage      = "https://github.com/joshuasmock/SNMPDevice"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "snmp"
+end

data/lib/SNMPDevice/configuration.rb

@@ -0,0 +1,15 @@
+module SNMPDevice
+	class Configuration
+		def self.load(filename)
+			begin
+				YAML::load(File.open("#{filename}"))
+			rescue Errno::ENOENT
+				puts "Could not find file #{filename}. Please check that the file exists."
+				nil
+			rescue Psych::SyntaxError => e
+				puts "You had a syntax error in #{filename}: #{e}"
+				nil
+			end
+		end
+	end
+end

data/lib/SNMPDevice/device.rb

@@ -0,0 +1,51 @@
+require 'snmp'
+require 'SNMPDevice/configuration'
+
+module SNMPDevice
+	class Device
+		attr_accessor :config
+
+		def initialize(ip_address, hash_or_filename = nil)
+			set_snmp_object(ip_address)
+			unless hash_or_filename.nil?
+				set_config(hash_or_filename)
+			end
+		end
+		def set_config(hash_or_filename)
+			@config = hash_or_filename.end_with?('.yml') ? SNMPDevice::Configuration.load(hash_or_filename) : hash_or_filename
+		end
+
+		private
+		attr_accessor :snmp_object
+		def method_missing(symbol, *args)
+			require_config
+			if symbol.id2name.end_with?('_info') and @config.has_key?(symbol.id2name.split('_info')[0])
+				snmp_lookup(symbol.id2name.split('_info')[0])
+			else
+				super
+			end
+		end
+		def set_snmp_object(ip_address)
+			@snmp_object = SNMP::Manager.new(:host => ip_address)
+		end
+		def snmp_lookup(name)
+			lookup_table = Array.new
+			output = [[]]
+			@config[name].each do |n| 
+				lookup_table.push(SNMP::ObjectId.new(n[1])) 
+				output[0].push(n[0])
+			end
+			@snmp_object.walk(lookup_table) do |row|
+				tmp_arr = Array.new
+				row.each do |r|
+					tmp_arr.push(r.value.to_s)
+				end
+				output.push(tmp_arr)
+			end
+			return output
+		end
+		def require_config
+			raise 'Config is not currently set' if @config.nil?
+		end
+	end
+end

data/lib/SNMPDevice/version.rb

@@ -0,0 +1,3 @@
+module SNMPDevice
+  VERSION = "0.1.0"
+end

data/lib/SNMPDevice.rb

@@ -0,0 +1,7 @@
+# 3rd party libraries
+require 'snmp'
+
+# internal classes
+require 'SNMPDevice/version'
+require 'SNMPDevice/configuration'
+require 'SNMPDevice/device'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: SNMPDevice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Smock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: snmp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem allows for gathering of information via SNMP, using the SNMP
+  Library for Ruby, on network devices. It is manufacturer agnostic, and accepts a
+  configuration file or hash when creating a new `Device` instance.
+email:
+- contact@joshuasmock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SNMPDevice.gemspec
+- lib/SNMPDevice.rb
+- lib/SNMPDevice/configuration.rb
+- lib/SNMPDevice/device.rb
+- lib/SNMPDevice/version.rb
+homepage: https://github.com/joshuasmock/SNMPDevice
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: This gem allows for the generation of various network device information
+  through SNMP. It is built to be manufacturer agnostic.
+test_files: []