snmpjr 0.1.0-java → 0.1.2-java

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDA5MDUxNDEyZmM2NjFiMzEyZDQzMjliMjY5YTlkOTlmNzBiZTAzZg==
+    NDg0ZjZmMzlhOTM4ZjA5Zjk3NzVhOTljN2U3MTI1M2RkZTBkYjNjMg==
   data.tar.gz: !binary |-
-    NTQ4ZmE0YjZhYjllOTE4YmMzYjk1YjEwZGUwZTkxNzFjN2VjNjM5YQ==
+    NzhkMWE4OTk2Nzk5MDg3YWJiOTk2ZDY2OTUzMTgwYzVlOWVhYjNjMQ==
 SHA512:
   metadata.gz: !binary |-
-    MmQyYzA2NThlNWJkMGYyNDFkZTgzZWQ4ODJiZDI5MjZmYzFiODk0MmMxNDBi
-    ZWU1YWY2ZGU4NGUxZmMxMWM3MjEyNGE0ZGY2ODI1OTc5OWQ2NjJhZWJmYzEx
-    OGNhYWVmNTQ2MzFjY2IwNGFkNDRmNjk1ZThlNjYzMDNiMjM4M2M=
+    MmQ2ZGJmMzVlODRhNTJkZmIwN2VkMGIwYjA5MGE3Mzc0Nzc2OWRiOGVmOWYx
+    OTYwNjU4ZmMwMjE1YzJkYjQzNWRkMjU5ZTljNTc1ODNkYTkzOTA3YTBmOTA3
+    OTIyZDEzYTNkYTJmM2UwZTdlOTNmZWYxMTRhZDViZmE5NDUwZTc=
   data.tar.gz: !binary |-
-    ZWNjYTE1N2Y1MGVhM2FmOWIwZmQ2ZmI5NzA3ZWIxNzZjNDU3ZjVkN2ZjMTFk
-    MTg4ZjliMmVlOWEwNjY3OTE4NDdjOWViYTAyMzQxNGMwMWVkMjEwODA2ODIy
-    NzA2ZWNiNDI5NWE1MzE3YTI2NTFkYWQ1ODAyNTcyZGU1NWI5NGE=
+    Mjk1Y2VlZjg4NWZmNWFmZDM4MGNkZWY2NDNkZGQ0OWM4MjEwYjdjMzQ3YTY4
+    YjJlNjE4NzA5ZjQyYmJlNjRhNzQxMmFmYmMxY2YxMDFmMjA3MmI1NmE2NDAx
+    MzY4MTg0NGNjY2QwMDA1NzM1MWQyOTlkZTYwYjM0OTI3MDQ3MTg=

data/history.rdoc

@@ -1,3 +1,7 @@
+== 0.1.2 (13 October 2014)
+
+* Refactor the wiring
+
 == 0.1.1 (12 October 2014)
 
 * Fix travis auto deployment

data/lib/snmpjr/getter.rb

@@ -0,0 +1,36 @@
+require "snmpjr/pdu"
+require "snmpjr/session"
+
+class Snmpjr
+  class Getter
+
+    def initialize target
+      @target = target
+      @session = Snmpjr::Session.new
+    end
+
+    def get_multiple oids
+      @session.start
+      result = oids.map {|oid|
+        send_oid oid
+      }
+      @session.close
+      result
+    end
+
+    def get oid
+      @session.start
+      result = send_oid oid
+      @session.close
+      result
+    end
+
+    private
+
+    def send_oid oid
+      pdu = Snmpjr::Pdu.new.create oid
+      @session.send(pdu, @target)
+    end
+
+  end
+end

data/lib/snmpjr/session.rb

@@ -3,20 +3,29 @@ require 'snmpjr/wrappers/transport'
 class Snmpjr
   class Session
 
+    def initialize
+      @snmp = Snmpjr::Wrappers::Snmp.new(Snmpjr::Wrappers::Transport::DefaultUdpTransportMapping.new)
+    end
 
-    def send pdu, target
-      snmp = Snmpjr::Wrappers::Snmp.new(Snmpjr::Wrappers::Transport::DefaultUdpTransportMapping.new)
-      snmp.listen
+    def start
+      @snmp.listen
+    end
 
+    def send pdu, target
       begin
-        result = snmp.send(pdu, target)
-      rescue
-        raise "Failed to send SNMP package"
-      ensure
-        snmp.close
+        result = @snmp.send(pdu, target)
+        if result.response.nil?
+          "Request timed out"
+        else
+          result.response.variable_bindings.first.variable.to_s
+        end
+      rescue Exception => e
+        "Error: #{e.to_s}"
       end
+    end
 
-      result.response.variable_bindings.first.variable.to_s
+    def close
+      @snmp.close
     end
   end
 end

data/lib/snmpjr/version.rb

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

data/lib/snmpjr.rb

@@ -1,6 +1,5 @@
 require "snmpjr/version"
-require "snmpjr/pdu"
-require "snmpjr/session"
+require "snmpjr/getter"
 require "snmpjr/target"
 
 class Snmpjr
@@ -13,24 +12,16 @@ class Snmpjr
 
   def get oids
     target = Snmpjr::Target.new.create(:host => @host, :port => @port, :community => @community)
+    getter = Snmpjr::Getter.new(target)
 
     case oids.class.to_s
     when 'String'
-      get_oid(oids, target)
+      getter.get oids
     when 'Array'
-      oids.map{|oid|
-        get_oid(oid, target)
-      }
+      getter.get_multiple oids
     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/spec/integration/snmpjr_spec.rb

@@ -2,15 +2,36 @@ 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'
+    context 'when the host is reachable' do
+      subject { Snmpjr.new(:host => 'demo.snmplabs.com', :port => 161, :community => 'public') }
+
+      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
+
+      context "when an invalid oid is requested" do
+
+        let(:expected) { ['Error: Invalid first sub-identifier (must be 0, 1, or 2)', 'zeus.snmplabs.com'] }
+        it "returns an error" do
+          expect(subject.get ['6.5.4.3.2.1', '1.3.6.1.2.1.1.5.0']).to eq expected
+
+        end
+      end
     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
+    context 'when the host is unreachable' do
+      subject { Snmpjr.new(:host => 'example.com', :port => 161, :community => 'public') }
+
+      it "the request times out after 5 seconds" do
+        expect(subject.get '1.3.6.1.2.1.1.1.0').to eq 'Request timed out'
+      end
     end
+
   end
 end

data/spec/snmpjr/getter_spec.rb

@@ -0,0 +1,61 @@
+require production_code
+
+describe Snmpjr::Getter do
+  let(:target) { double :target }
+  let(:session) { double Snmpjr::Session }
+  let(:pdu) { double Snmpjr::Pdu }
+  let(:created_pdu_1) { double :created_pdu_1 }
+
+  subject { described_class.new(target) }
+
+  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(:start)
+    allow(session).to receive(:send).with(created_pdu_1, target).and_return 'Foo'
+    allow(session).to receive(:close)
+  end
+
+  describe "#get_multiple" 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
+      allow(session).to receive(:send).with(created_pdu_2, target).and_return 'Bar'
+    end
+
+    it 'starts an snmp session' do
+      subject.get_multiple ['1.2.3.4.5.6', '6.5.4.3.2.1']
+      expect(session).to have_received(:start)
+    end
+
+    it 'performs multiple gets for each oid' do
+      expect(subject.get_multiple ['1.2.3.4.5.6', '6.5.4.3.2.1']).to eq(['Foo', 'Bar'])
+      expect(session).to have_received(:send).with(created_pdu_1, target)
+      expect(session).to have_received(:send).with(created_pdu_2, target)
+    end
+
+    it 'closes the snmp session' do
+      subject.get_multiple ['1.2.3.4.5.6', '6.5.4.3.2.1']
+      expect(session).to have_received(:close)
+    end
+  end
+
+  describe "#get" do
+    it 'starts an snmp session' do
+      subject.get '1.2.3.4.5.6'
+      expect(session).to have_received(:start)
+    end
+
+    it 'performs a synchronous get' do
+      expect(subject.get '1.2.3.4.5.6').to eq 'Foo'
+      expect(session).to have_received(:send).with(created_pdu_1, target)
+    end
+
+    it 'closes the snmp session' do
+      subject.get '1.2.3.4.5.6'
+      expect(session).to have_received(:close)
+    end
+  end
+end

data/spec/snmpjr/session_spec.rb

@@ -1,26 +1,40 @@
 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(:transport_mapping) { double Snmpjr::Wrappers::Transport::DefaultUdpTransportMapping }
+  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(:listen)
+    allow(snmp_session).to receive(:send)
+    allow(snmp_session).to receive(:close)
+  end
+
+  describe "#start" do
+
+    it "opens a new SNMP4J session with Udp transport mapping" do
+      subject.start
+      expect(Snmpjr::Wrappers::Snmp).to have_received(:new).with(transport_mapping)
+    end
+
+    it "calls the listen method on the Snmp session" do
+      subject.start
+      expect(snmp_session).to have_received(:listen)
+    end
+
+  end
 
-    let(:snmp_session) { double Snmpjr::Wrappers::Snmp }
+  describe "#send" do
+    let(:result) { double :result }
+    let(:pdu) { double :pdu }
+    let(:target) { double :target }
 
     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
@@ -28,10 +42,31 @@ describe Snmpjr::Session do
       subject.send(pdu, target)
     end
 
-    it "closes the connection" do
-      expect(snmp_session).to receive(:close)
-      subject.send(pdu, target)
+    context 'the requests times out' do
+      before do
+        allow(result).to receive(:response).and_return nil
+      end
+
+      it 'returns a request timeout' do
+        expect(subject.send(pdu, target)).to eq "Request timed out"
+      end
     end
 
+    context 'an exception is raised' do
+      before do
+        allow(snmp_session).to receive(:send).and_raise(RuntimeError.new('Some error'))
+      end
+
+      it 'returns the error without blowing up' do
+        expect(subject.send(pdu, target)).to eq "Error: Some error"
+      end
+    end
+  end
+
+  describe "#close" do
+    it "closes the snmp session" do
+      subject.close
+      expect(snmp_session).to have_received(:close)
+    end
   end
 end

data/spec/snmpjr_spec.rb

@@ -6,17 +6,12 @@ describe Snmpjr 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 }
+      let(:getter) { double Snmpjr::Getter }
 
       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
+        allow(Snmpjr::Getter).to receive(:new).with(community_target).and_return getter
       end
 
       let(:agent_details) { { :host => '127.0.0.1', :port => 161, :community => 'some_community' } }
@@ -25,22 +20,15 @@ describe Snmpjr do
 
       context 'when passed a single oid' do
         it 'performs a synchronous get' do
+          expect(getter).to receive(:get).with('1.2.3.4.5.6')
           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
+        it 'performs a get multiple using the getter' do
+          expect(getter).to receive(:get_multiple).with(['1.2.3.4.5.6', '6.5.4.3.2.1'])
           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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snmpjr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: java
 authors:
 - Zen Kyprianou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-10-13 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.
@@ -30,6 +30,7 @@ files:
 - Rakefile
 - history.rdoc
 - lib/snmpjr.rb
+- lib/snmpjr/getter.rb
 - lib/snmpjr/pdu.rb
 - lib/snmpjr/session.rb
 - lib/snmpjr/target.rb
@@ -40,6 +41,7 @@ files:
 - lib/snmpjr/wrappers/transport.rb
 - snmpjr.gemspec
 - spec/integration/snmpjr_spec.rb
+- spec/snmpjr/getter_spec.rb
 - spec/snmpjr/pdu_spec.rb
 - spec/snmpjr/session_spec.rb
 - spec/snmpjr/target_spec.rb
@@ -71,6 +73,7 @@ specification_version: 4
 summary: Simple SNMP interface for JRuby
 test_files:
 - spec/integration/snmpjr_spec.rb
+- spec/snmpjr/getter_spec.rb
 - spec/snmpjr/pdu_spec.rb
 - spec/snmpjr/session_spec.rb
 - spec/snmpjr/target_spec.rb