SNMPDevice 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +36 -0
- data/Rakefile +1 -0
- data/SNMPDevice.gemspec +24 -0
- data/lib/SNMPDevice/configuration.rb +15 -0
- data/lib/SNMPDevice/device.rb +51 -0
- data/lib/SNMPDevice/version.rb +3 -0
- data/lib/SNMPDevice.rb +7 -0
- metadata +99 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b0a348531172447e34751b9a23c3160752c6d73b
|
4
|
+
data.tar.gz: 3e4bce513fffd6e23a80bc41ffaf2b22bc6647cd
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e635557861a7c774233cd4e13c02ede57d479010608264bc0dd30a0ca101b285f4a44ba75a086c4d89e9518842912f5b10b1a51bea9683f284d9cb7353ce7c4e
|
7
|
+
data.tar.gz: 7eddc4050694c6b49aeb45a89ffac1cde9b9d3594ec9d1734d88fa85d80a55494dea054fd6d2ec4adf35d044df037b4d15545fbc90d04ff063e8b0a3f61a981a
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Joshua Smock
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,36 @@
|
|
1
|
+
# SNMPDevice
|
2
|
+
|
3
|
+
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.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'SNMPDevice'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install SNMPDevice
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
require 'SNMPDevice/device'
|
22
|
+
include SNMPDevice
|
23
|
+
|
24
|
+
printer_a = Device.new('10.247.1.20')
|
25
|
+
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'}})
|
26
|
+
printer_a.toner_info # => [["name_of_toner","toner_level"], ["Yellow", "50"], ["Cyan", "100"], ["Magenta". "10"], ["Black", "0"]]
|
27
|
+
|
28
|
+
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.
|
29
|
+
|
30
|
+
## Contributing
|
31
|
+
|
32
|
+
1. Fork it
|
33
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
34
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
35
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
36
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/SNMPDevice.gemspec
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'SNMPDevice/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "SNMPDevice"
|
8
|
+
spec.version = SNMPDevice::VERSION
|
9
|
+
spec.authors = ["Joshua Smock"]
|
10
|
+
spec.email = ["contact@joshuasmock.com"]
|
11
|
+
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.}
|
12
|
+
spec.summary = %q{This gem allows for the generation of various network device information through SNMP. It is built to be manufacturer agnostic.}
|
13
|
+
spec.homepage = "https://github.com/joshuasmock/SNMPDevice"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
spec.add_dependency "snmp"
|
24
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
module SNMPDevice
|
2
|
+
class Configuration
|
3
|
+
def self.load(filename)
|
4
|
+
begin
|
5
|
+
YAML::load(File.open("#{filename}"))
|
6
|
+
rescue Errno::ENOENT
|
7
|
+
puts "Could not find file #{filename}. Please check that the file exists."
|
8
|
+
nil
|
9
|
+
rescue Psych::SyntaxError => e
|
10
|
+
puts "You had a syntax error in #{filename}: #{e}"
|
11
|
+
nil
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,51 @@
|
|
1
|
+
require 'snmp'
|
2
|
+
require 'SNMPDevice/configuration'
|
3
|
+
|
4
|
+
module SNMPDevice
|
5
|
+
class Device
|
6
|
+
attr_accessor :config
|
7
|
+
|
8
|
+
def initialize(ip_address, hash_or_filename = nil)
|
9
|
+
set_snmp_object(ip_address)
|
10
|
+
unless hash_or_filename.nil?
|
11
|
+
set_config(hash_or_filename)
|
12
|
+
end
|
13
|
+
end
|
14
|
+
def set_config(hash_or_filename)
|
15
|
+
@config = hash_or_filename.end_with?('.yml') ? SNMPDevice::Configuration.load(hash_or_filename) : hash_or_filename
|
16
|
+
end
|
17
|
+
|
18
|
+
private
|
19
|
+
attr_accessor :snmp_object
|
20
|
+
def method_missing(symbol, *args)
|
21
|
+
require_config
|
22
|
+
if symbol.id2name.end_with?('_info') and @config.has_key?(symbol.id2name.split('_info')[0])
|
23
|
+
snmp_lookup(symbol.id2name.split('_info')[0])
|
24
|
+
else
|
25
|
+
super
|
26
|
+
end
|
27
|
+
end
|
28
|
+
def set_snmp_object(ip_address)
|
29
|
+
@snmp_object = SNMP::Manager.new(:host => ip_address)
|
30
|
+
end
|
31
|
+
def snmp_lookup(name)
|
32
|
+
lookup_table = Array.new
|
33
|
+
output = [[]]
|
34
|
+
@config[name].each do |n|
|
35
|
+
lookup_table.push(SNMP::ObjectId.new(n[1]))
|
36
|
+
output[0].push(n[0])
|
37
|
+
end
|
38
|
+
@snmp_object.walk(lookup_table) do |row|
|
39
|
+
tmp_arr = Array.new
|
40
|
+
row.each do |r|
|
41
|
+
tmp_arr.push(r.value.to_s)
|
42
|
+
end
|
43
|
+
output.push(tmp_arr)
|
44
|
+
end
|
45
|
+
return output
|
46
|
+
end
|
47
|
+
def require_config
|
48
|
+
raise 'Config is not currently set' if @config.nil?
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
data/lib/SNMPDevice.rb
ADDED
metadata
ADDED
@@ -0,0 +1,99 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: SNMPDevice
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Joshua Smock
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2013-07-11 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.3'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: snmp
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: This gem allows for gathering of information via SNMP, using the SNMP
|
56
|
+
Library for Ruby, on network devices. It is manufacturer agnostic, and accepts a
|
57
|
+
configuration file or hash when creating a new `Device` instance.
|
58
|
+
email:
|
59
|
+
- contact@joshuasmock.com
|
60
|
+
executables: []
|
61
|
+
extensions: []
|
62
|
+
extra_rdoc_files: []
|
63
|
+
files:
|
64
|
+
- .gitignore
|
65
|
+
- Gemfile
|
66
|
+
- LICENSE.txt
|
67
|
+
- README.md
|
68
|
+
- Rakefile
|
69
|
+
- SNMPDevice.gemspec
|
70
|
+
- lib/SNMPDevice.rb
|
71
|
+
- lib/SNMPDevice/configuration.rb
|
72
|
+
- lib/SNMPDevice/device.rb
|
73
|
+
- lib/SNMPDevice/version.rb
|
74
|
+
homepage: https://github.com/joshuasmock/SNMPDevice
|
75
|
+
licenses:
|
76
|
+
- MIT
|
77
|
+
metadata: {}
|
78
|
+
post_install_message:
|
79
|
+
rdoc_options: []
|
80
|
+
require_paths:
|
81
|
+
- lib
|
82
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - '>='
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: '0'
|
87
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
|
+
requirements:
|
89
|
+
- - '>='
|
90
|
+
- !ruby/object:Gem::Version
|
91
|
+
version: '0'
|
92
|
+
requirements: []
|
93
|
+
rubyforge_project:
|
94
|
+
rubygems_version: 2.0.0
|
95
|
+
signing_key:
|
96
|
+
specification_version: 4
|
97
|
+
summary: This gem allows for the generation of various network device information
|
98
|
+
through SNMP. It is built to be manufacturer agnostic.
|
99
|
+
test_files: []
|