snmpjr 0.1.0-java

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDA5MDUxNDEyZmM2NjFiMzEyZDQzMjliMjY5YTlkOTlmNzBiZTAzZg==
+  data.tar.gz: !binary |-
+    NTQ4ZmE0YjZhYjllOTE4YmMzYjk1YjEwZGUwZTkxNzFjN2VjNjM5YQ==
+SHA512:
+  metadata.gz: !binary |-
+    MmQyYzA2NThlNWJkMGYyNDFkZTgzZWQ4ODJiZDI5MjZmYzFiODk0MmMxNDBi
+    ZWU1YWY2ZGU4NGUxZmMxMWM3MjEyNGE0ZGY2ODI1OTc5OWQ2NjJhZWJmYzEx
+    OGNhYWVmNTQ2MzFjY2IwNGFkNDRmNjk1ZThlNjYzMDNiMjM4M2M=
+  data.tar.gz: !binary |-
+    ZWNjYTE1N2Y1MGVhM2FmOWIwZmQ2ZmI5NzA3ZWIxNzZjNDU3ZjVkN2ZjMTFk
+    MTg4ZjliMmVlOWEwNjY3OTE4NDdjOWViYTAyMzQxNGMwMWVkMjEwODA2ODIy
+    NzA2ZWNiNDI5NWE1MzE3YTI2NTFkYWQ1ODAyNTcyZGU1NWI5NGE=

data/.gitignore

@@ -0,0 +1,17 @@
+log/*
+*.swo
+*.swp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create jruby-1.7.16@snmpjr

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- jruby-1.7.0
+- jruby-1.7.16
+deploy:
+  provider: rubygems
+  api_key:
+    secure: C9X1OQ07eVDPqOEcKQOOo+Li18J5VQ6uwsua6fNb7Mvzm5RVYKdaYMjan6gSJNkprxk5yDt/LQSZBBSSluO0yqxzyFFFBqzswPPKsYys5HVW45rFLFDs83e2YtgACEnXfNozuWoy0i3jgpN/P+eqrBlNFfuHpm4di7IBmeZimDY=
+  gem: snmpjr
+  on:
+    tags: true
+    repo: zenonas/snmpjr
+    all_branches: true

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rake_rack'
+  gem 'pry'
+  gem 'rspec'
+  gem 'rake'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Zen Kyprianou
+
+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,56 @@
+# Snmpjr
+
+[![Build Status](https://travis-ci.org/zenonas/snmpjr.svg?branch=master)](https://travis-ci.org/zenonas/snmpjr)
+Snmpjr aims to provide a clean and simple interface to use SNMP in your ruby code. It will wrap the popular SNMP4J library in Java.
+
+Please note the gem is still in early develpment. Do not use as of yet!
+
+## Features
+
+* Simple Synchronous SNMP v2c Get requests
+
+## Requirements
+
+* Java 1.6+
+* JRuby 1.7+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snmpjr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snmpjr
+
+## Usage
+
+```ruby
+# Initialize Snmpjr with host, port and a community
+snmp = Snmpjr.new(:host => '127.0.0.1', :port => 161, :community => 'public')
+
+# Call get on any single Oid
+snmp.get '1.3.6.1.2.1.1.1.0'
+=> 'The result'
+
+# Call get on an array of Oids'
+snmp.get ['1.3.6.1.2.1.1.1.0', '1.3.6.1.2.1.1.3.0']
+=> ['First result', 'Second result']
+```
+
+When you request an Array of Oids these will be pulled sequentially
+
+## Contributing
+
+1. Fork it ( https://github.com/zenonas/snmpjr/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/clean'
+require 'rake_rack'
+
+@external_dependencies = %w[jruby java]
+
+task :default => [
+  :clean,
+  :"rake_rack:check_external_dependencies",
+  :"rake_rack:code_quality:all",
+  :"rake_rack:rspec",
+  :"rake_rack:coverage:check_specs",
+  :"rake_rack:ok",
+]

data/history.rdoc

@@ -0,0 +1,7 @@
+== 0.1.1 (12 October 2014)
+
+* Fix travis auto deployment
+
+== 0.1.0 (12 October 2014)
+
+* Simple Synchronous SNMP get requests for SNMP v2c

data/lib/snmpjr/pdu.rb

@@ -0,0 +1,17 @@
+class Snmpjr
+  class Pdu
+    module Constants
+      GET = -96
+    end
+
+    def create oid
+      pdu = Snmpjr::Wrappers::PDU.new
+      oid = Snmpjr::Wrappers::SMI::OID.new oid
+      variable_binding = Snmpjr::Wrappers::SMI::VariableBinding.new oid
+      pdu.add variable_binding
+      pdu.type = Snmpjr::Pdu::Constants::GET
+      pdu
+    end
+
+  end
+end

data/lib/snmpjr/session.rb

@@ -0,0 +1,22 @@
+require 'snmpjr/wrappers/transport'
+
+class Snmpjr
+  class Session
+
+
+    def send pdu, target
+      snmp = Snmpjr::Wrappers::Snmp.new(Snmpjr::Wrappers::Transport::DefaultUdpTransportMapping.new)
+      snmp.listen
+
+      begin
+        result = snmp.send(pdu, target)
+      rescue
+        raise "Failed to send SNMP package"
+      ensure
+        snmp.close
+      end
+
+      result.response.variable_bindings.first.variable.to_s
+    end
+  end
+end

data/lib/snmpjr/target.rb

@@ -0,0 +1,15 @@
+require 'snmpjr/wrappers/smi'
+
+class Snmpjr
+  class Target
+
+    def create options = {}
+      target = Snmpjr::Wrappers::CommunityTarget.new
+      target.community = Snmpjr::Wrappers::SMI::OctetString.new(options.fetch(:community))
+      target.address = Snmpjr::Wrappers::SMI::GenericAddress.parse("udp:#{options.fetch(:host)}/#{options.fetch(:port)}")
+      target.version = 1
+      target.timeout = 5000
+      target
+    end
+  end
+end

data/lib/snmpjr/version.rb

@@ -0,0 +1,3 @@
+class Snmpjr
+  VERSION = "0.1.0"
+end

data/lib/snmpjr/wrappers/smi.rb

@@ -0,0 +1,9 @@
+require 'snmpjr/wrappers/snmp4j'
+
+class Snmpjr
+  module Wrappers
+    module SMI
+      include_package 'org.snmp4j.smi'
+    end
+  end
+end

data/lib/snmpjr/wrappers/snmp4j.rb

@@ -0,0 +1,12 @@
+class Snmpjr
+  module Wrappers
+    begin
+      require 'java'
+      require 'snmpjr/wrappers/snmp4j-2.3.1.jar'
+    rescue
+      raise "Snmpjr requires JRuby"
+    end
+
+    include_package 'org.snmp4j'
+  end
+end

data/lib/snmpjr/wrappers/transport.rb

@@ -0,0 +1,9 @@
+require 'snmpjr/wrappers/snmp4j'
+
+class Snmpjr
+  module Wrappers
+    module Transport
+      include_package 'org.snmp4j.transport'
+    end
+  end
+end

data/lib/snmpjr.rb

@@ -0,0 +1,36 @@
+require "snmpjr/version"
+require "snmpjr/pdu"
+require "snmpjr/session"
+require "snmpjr/target"
+
+class Snmpjr
+
+  def initialize options = {}
+    @host = options.fetch(:host)
+    @port = options.fetch(:port) || 161
+    @community = options.fetch(:community)
+  end
+
+  def get oids
+    target = Snmpjr::Target.new.create(:host => @host, :port => @port, :community => @community)
+
+    case oids.class.to_s
+    when 'String'
+      get_oid(oids, target)
+    when 'Array'
+      oids.map{|oid|
+        get_oid(oid, target)
+      }
+    else
+      raise ArgumentError.new 'You can request a single Oid using a String, or multiple using an Array'
+    end
+  end
+
+  private
+
+  def get_oid oid, target
+    pdu = Snmpjr::Pdu.new.create oid
+    Snmpjr::Session.new.send(pdu, target)
+  end
+
+end

data/snmpjr.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snmpjr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snmpjr"
+  spec.version       = Snmpjr::VERSION
+  spec.authors       = ["Zen Kyprianou"]
+  spec.email         = ["zen@kyprianou.eu"]
+  spec.summary       = %q{Simple SNMP interface for JRuby}
+  spec.description   = %q{Snmpjr aims to provide a clean and simple interface to use SNMP in your ruby code. It will wrap the popular SNMP4J library in Java.
+}
+  spec.homepage      = "https://github.com/zenonas/snmpjr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.platform      = "java"
+end

data/spec/integration/snmpjr_spec.rb

@@ -0,0 +1,16 @@
+require 'snmpjr'
+
+describe "snmpjr" do
+
+  subject { Snmpjr.new(:host => 'demo.snmplabs.com', :port => 161, :community => 'public') }
+  describe 'GET' do
+    it "can perform a simple synchronous get request on an snmp agent" do
+      expect(subject.get '1.3.6.1.2.1.1.1.0').to eq 'SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m'
+    end
+
+    let(:expected) { ['SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m', 'zeus.snmplabs.com'] }
+    it "can perform a series of gets if passed an array of oids" do
+      expect(subject.get ['1.3.6.1.2.1.1.1.0', '1.3.6.1.2.1.1.5.0']).to eq expected
+    end
+  end
+end

data/spec/snmpjr/pdu_spec.rb

@@ -0,0 +1,29 @@
+require production_code
+
+describe Snmpjr::Pdu do
+  describe "#create" do
+
+    let(:pdu) { double Snmpjr::Wrappers::PDU }
+    let(:oid) { double Snmpjr::Wrappers::SMI::OID }
+    let(:variable_binding) { double Snmpjr::Wrappers::SMI::VariableBinding }
+
+    before do
+      allow(Snmpjr::Wrappers::PDU).to receive(:new).and_return pdu
+      allow(Snmpjr::Wrappers::SMI::OID).to receive(:new).and_return oid
+      allow(Snmpjr::Wrappers::SMI::VariableBinding).to receive(:new).and_return variable_binding
+      allow(pdu).to receive(:type=)
+      allow(pdu).to receive(:add)
+    end
+    it "creates a GET Pdu" do
+      expect(pdu).to receive(:type=).with(Snmpjr::Pdu::Constants::GET)
+      subject.create '1.2.3.4'
+    end
+
+    it "adds an SMI variable binding containing an oid to the pdu" do
+      expect(Snmpjr::Wrappers::SMI::OID).to receive(:new).with('1.2.3.4')
+      expect(Snmpjr::Wrappers::SMI::VariableBinding).to receive(:new).with(oid)
+      expect(pdu).to receive(:add).with variable_binding
+      subject.create '1.2.3.4'
+    end
+  end
+end

data/spec/snmpjr/session_spec.rb

@@ -0,0 +1,37 @@
+require production_code
+
+describe Snmpjr::Session do
+  describe "#send" do
+    let(:transport_mapping) { double Snmpjr::Wrappers::Transport::DefaultUdpTransportMapping }
+
+    let(:target) { double :target }
+    let(:pdu) { double :pdu }
+    let(:result) { double :result }
+
+    let(:snmp_session) { double Snmpjr::Wrappers::Snmp }
+
+    before do
+      allow(Snmpjr::Wrappers::Transport::DefaultUdpTransportMapping).to receive(:new).and_return transport_mapping
+      allow(Snmpjr::Wrappers::Snmp).to receive(:new).and_return snmp_session
+      allow(snmp_session).to receive(:send).and_return result
+      allow(result).to receive_message_chain('response.variable_bindings.first.variable.to_s')
+      allow(snmp_session).to receive(:listen)
+      allow(snmp_session).to receive(:close)
+    end
+    it "opens a new SNMP4J session with Udp transport mapping" do
+      expect(Snmpjr::Wrappers::Snmp).to receive(:new).with(transport_mapping)
+      subject.send(pdu, target)
+    end
+
+    it "sends the pdu to the target" do
+      expect(snmp_session).to receive(:send).with(pdu, target)
+      subject.send(pdu, target)
+    end
+
+    it "closes the connection" do
+      expect(snmp_session).to receive(:close)
+      subject.send(pdu, target)
+    end
+
+  end
+end

data/spec/snmpjr/target_spec.rb

@@ -0,0 +1,38 @@
+require production_code
+
+describe Snmpjr::Target do
+
+  describe "#create" do
+    let(:options) { { :host => '127.0.0.1', :port => 161, :community => 'some_community' } }
+
+    it "creates an octet string for the community string" do
+      expect(Snmpjr::Wrappers::SMI::OctetString).to receive(:new).with(options[:community])
+      subject.create(options)
+    end
+
+    it "creates an smi address based on the ip and port name" do
+      expect(Snmpjr::Wrappers::SMI::GenericAddress).to receive(:parse).with("udp:127.0.0.1/161")
+      subject.create(options)
+    end
+
+    let(:community_target) { double Snmpjr::Wrappers::CommunityTarget }
+
+    before do
+      allow(Snmpjr::Wrappers::CommunityTarget).to receive(:new).and_return community_target
+      allow(community_target).to receive(:version=)
+      allow(community_target).to receive(:timeout=)
+      allow(community_target).to receive(:community=)
+      allow(community_target).to receive(:address=)
+    end
+
+    it "sets the snmp version to v2c and the timeout to 5000ms" do
+      expect(community_target).to receive(:version=).with(1)
+      expect(community_target).to receive(:timeout=).with(5000)
+      subject.create(options)
+    end
+
+    it "returns the SNMP4J community target" do
+      expect(subject.create(options).class).to eq community_target.class
+    end
+  end
+end

data/spec/snmpjr_spec.rb

@@ -0,0 +1,56 @@
+require production_code
+
+describe Snmpjr do
+  describe "#get" do
+    context "when the call is synchronous" do
+
+      let(:target) { double Snmpjr::Target }
+      let(:community_target) { double :community_target }
+      let(:session) { double Snmpjr::Session }
+      let(:pdu) { double Snmpjr::Pdu }
+      let(:created_pdu_1) { double :created_pdu_1 }
+
+      before do
+        allow(Snmpjr::Pdu).to receive(:new).and_return pdu
+        allow(pdu).to receive(:create).with('1.2.3.4.5.6').and_return created_pdu_1
+        allow(Snmpjr::Session).to receive(:new).and_return session
+        allow(session).to receive(:send)
+        allow(Snmpjr::Target).to receive(:new).and_return target
+        allow(target).to receive(:create).with(agent_details).and_return community_target
+      end
+
+      let(:agent_details) { { :host => '127.0.0.1', :port => 161, :community => 'some_community' } }
+
+      subject { described_class.new(agent_details) }
+
+      context 'when passed a single oid' do
+        it 'performs a synchronous get' do
+          subject.get '1.2.3.4.5.6'
+          expect(session).to have_received(:send).with(created_pdu_1, community_target)
+        end
+      end
+
+      context 'when passed multiple oids' do
+        let(:created_pdu_2) { double :created_pdu_2 }
+
+        before do
+          allow(pdu).to receive(:create).with('6.5.4.3.2.1').and_return created_pdu_2
+        end
+
+        it 'performs multiple gets for each oid' do
+          subject.get ['1.2.3.4.5.6', '6.5.4.3.2.1']
+          expect(session).to have_received(:send).with(created_pdu_1, community_target)
+          expect(session).to have_received(:send).with(created_pdu_2, community_target)
+        end
+      end
+
+      context 'when an invalid argument was passed in' do
+        it 'raises an ArgumentError' do
+          expect {
+            subject.get({'oid_value' => '1.3.4.5.6'})
+          }.to raise_error ArgumentError
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+require 'pry'
+
+SimpleCov.coverage_dir 'log/coverage/rspec'
+SimpleCov.add_filter "spec"
+SimpleCov.add_filter "vendor"
+SimpleCov.start
+
+def production_code
+  spec = caller[0][/spec.+\.rb/]
+  './' + spec.gsub('_spec','').gsub(/spec/, 'lib')
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: snmpjr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: java
+authors:
+- Zen Kyprianou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-12 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Snmpjr aims to provide a clean and simple interface to use SNMP in
+  your ruby code. It will wrap the popular SNMP4J library in Java.
+
+'
+email:
+- zen@kyprianou.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- history.rdoc
+- lib/snmpjr.rb
+- lib/snmpjr/pdu.rb
+- lib/snmpjr/session.rb
+- lib/snmpjr/target.rb
+- lib/snmpjr/version.rb
+- lib/snmpjr/wrappers/smi.rb
+- lib/snmpjr/wrappers/snmp4j-2.3.1.jar
+- lib/snmpjr/wrappers/snmp4j.rb
+- lib/snmpjr/wrappers/transport.rb
+- snmpjr.gemspec
+- spec/integration/snmpjr_spec.rb
+- spec/snmpjr/pdu_spec.rb
+- spec/snmpjr/session_spec.rb
+- spec/snmpjr/target_spec.rb
+- spec/snmpjr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zenonas/snmpjr
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Simple SNMP interface for JRuby
+test_files:
+- spec/integration/snmpjr_spec.rb
+- spec/snmpjr/pdu_spec.rb
+- spec/snmpjr/session_spec.rb
+- spec/snmpjr/target_spec.rb
+- spec/snmpjr_spec.rb
+- spec/spec_helper.rb