snmpjr 0.2.1-java → 0.2.2-java

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTA2YTdhZGVkOWZhZjgzZDQxMjkwNWFjYjkzMTNiOTFiZWYyMDI2OQ==
+    MmUwNWVjOGJkMDViODU2YjZiNGU1NWRjMTg0NmIwZDhjYzgyMmRiOQ==
   data.tar.gz: !binary |-
-    ZGI1YTFkNjg4ODAxM2NkOGI3ZTlmZTVlOTE0NTk5ODQ2MGMzMGVmZg==
+    MzA2MDZlZmE0NjM1ZjIxMDRjYzMyZDQ0MmY1ZWMwYjhlMjQ3YjYxOA==
 SHA512:
   metadata.gz: !binary |-
-    MjFjOTJiYmNmMmNiYWI1ZWFjOTc4NGJiNDM1YjJlMjVkZTZhZDY3YzE1OTM0
-    YjZiZmZiMWEzZWUzYzBhMDJkYjk2M2VlODFkM2M3NGM1Y2MxNmY2Y2Y4N2Jm
-    ZjliZTNmNmFjN2Y2NmVkOGJhM2U3Mzk0ZGZlNTcyZjdjZGZhZjg=
+    MzFlMzlmMjNlY2I4MjlkNWYwN2QxMzZmNWU2NDk0OGUzZmJhZDczMTM3Zjg2
+    NGMyMjY3NTJmMDlkNmRhNzM4ZTc3NTZiMTkyZmI0YjQ5OWUxZjg3OGQ1ODY2
+    ZjIzNDhkZmZhNDEzYTZlZmIzNWMwMTBiNjI3NTE4NDI5Y2RmMzA=
   data.tar.gz: !binary |-
-    NzI2ZThiNWIxYmMwYjgwYjFjMzU0ODg1ZTgzNmYzMWRiYTk5OWRiMTEyY2M5
-    NTQ1NTM4YWJmYmZjNGZkYTE3NGY0YzJjY2RiNWE0OTBjYWNjNGYzNDQzZWNi
-    ZGY0YzMyMTExZGRmNGUzYzgxOGQ3NjUyMDlhMGVlYmE4Zjg3MTU=
+    MGFkYmI2NTk4ZTBiNjg4YTdiZjdkZTczMjQ5MjBhMjFjZjFlY2U2YTFlZjEx
+    YmYzNDNlM2ZlYjcyOGFmOTZmMTBhN2NhZWE0OTMyZjZhMDQ3NDYxMjY2MTg1
+    ZWM5ZjlhNjU0MjI2MDY2MmZlMDQxNmM4NTcyNzZkZGZjYzhhMWE=

data/.gitignore

@@ -1,3 +1,4 @@
+tags
 *.DS_Store
 log/*
 *.swo

data/.semver

@@ -1,6 +1,6 @@
 ---
 :major: 0
 :minor: 2
-:patch: 1
+:patch: 2
 :special: ''
 :metadata: ''

data/README.md

@@ -9,7 +9,8 @@ Please note the gem is still in early develpment. Do not use as of yet!
 
 ## Features
 
-* Simple Synchronous SNMP v2c Get requests
+* Simple Synchronous SNMP V2 Get requests
+* Synchronous SNMP V2 Walk
 
 ## Requirements
 
@@ -36,8 +37,8 @@ Or install it yourself as:
 
 ```ruby
 # Initialize Snmpjr with host, port and a community
+# Optional Params. (port, retries, timeout)
 snmp = Snmpjr.new(host: '127.0.0.1', port: 161, community: 'public')
-Optional Params. (retries, timeout)
 
 # Call get on any single Oid
 snmp.get '1.3.6.1.2.1.1.1.0'
@@ -47,14 +48,14 @@ snmp.get '1.3.6.1.2.1.1.1.0'
 snmp.get ['1.3.6.1.2.1.1.1.0', '1.3.6.1.2.1.1.3.0']
 => [Snmpjr::Response.new(value: 'First result'), Snmpjr::Response.new(value: 'Second result')]
 
-Response objects respond to error?
+# Response objects respond to error?
 
 # Call walk on an Oid
 snmp.walk '1.3.6.1.2.1.1.1'
-=> [Snmpjr::Response.new(value: 'First response')..Snmpjr::Response.new(value: 'First response')]
+=> [Snmpjr::Response.new(value: 'First response')..Snmpjr::Response.new(value: 'Last response')]
 ```
 
-Snmpjr will catch and raise any exceptions that happen in Java land as RuntimeErrors preserving the message.
+Snmpjr will catch and raise any exceptions that happen in Java land and raise them as RuntimeErrors while preserving the message.
 
 When you request an Array of Oids these will be pulled sequentially
 

data/history.rdoc

@@ -1,3 +1,7 @@
+== v0.2.2 (03 November 2014)
+
+* Add the Oid as part of the response object
+
 == v0.2.1 (27 October 2014)
 
 * Try to fix the tag

data/lib/snmpjr/response.rb

@@ -1,10 +1,11 @@
 class Snmpjr
   class Response
-    attr_reader :error
+    attr_reader :error, :oid
 
     def initialize response = {}
       @error = response[:error] || ''
       @value = response[:value] || ''
+      @oid = response[:oid] || ''
     end
 
     def error?
@@ -20,7 +21,8 @@ class Snmpjr
     end
 
     def ==(other)
-      @error == other.error && to_s == other.to_s
+      return false unless other.instance_of?(self.class)
+      @error == other.error && to_s == other.to_s && @oid == other.oid
     end
   end
 end

data/lib/snmpjr/session.rb

@@ -37,9 +37,9 @@ class Snmpjr
 
     def construct_response variable_binding
       if variable_binding.is_exception
-        Snmpjr::Response.new(error: variable_binding.variable.to_s)
+        Snmpjr::Response.new(oid: variable_binding.oid.to_s, error: variable_binding.variable.to_s)
       else
-        Snmpjr::Response.new(value: variable_binding.variable.to_s)
+        Snmpjr::Response.new(oid: variable_binding.oid.to_s, value: variable_binding.variable.to_s)
       end
     end
 

data/lib/snmpjr/version.rb

@@ -1,3 +1,3 @@
 class Snmpjr
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/snmpjr/walker.rb

@@ -29,7 +29,7 @@ class Snmpjr
 
     def extract_variable_bindings variable_bindings
       variable_bindings.flat_map {|vb|
-        Snmpjr::Response.new(value: vb.variable.to_s)
+        Snmpjr::Response.new(oid: vb.oid.to_s, value: vb.variable.to_s)
       }
     end
 

data/spec/integration/snmpjr_get_spec.rb

@@ -9,19 +9,19 @@ describe "snmpjr" 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 Snmpjr::Response.new(value: 'SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m')
+        expect(subject.get '1.3.6.1.2.1.1.1.0').to eq Snmpjr::Response.new(oid: '1.3.6.1.2.1.1.1.0', value: 'SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m')
       end
 
-      let(:expected) { [Snmpjr::Response.new(value: 'SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m'),
-                        Snmpjr::Response.new(value: 'zeus.snmplabs.com')] }
+      let(:expected) { [Snmpjr::Response.new(oid: '1.3.6.1.2.1.1.1.0', value: 'SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m'),
+                        Snmpjr::Response.new(oid: '1.3.6.1.2.1.1.5.0', value: '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) { [Snmpjr::Response.new(error: 'noSuchInstance'),
-                          Snmpjr::Response.new(value: 'zeus.snmplabs.com')] }
+        let(:expected) { [Snmpjr::Response.new(oid: '1.3.6.1.2.1.1.5', error: 'noSuchInstance'),
+                          Snmpjr::Response.new(oid: '1.3.6.1.2.1.1.5.0', value: 'zeus.snmplabs.com')] }
 
         it 'returns an error' do
           expect(subject.get ['1.3.6.1.2.1.1.5', '1.3.6.1.2.1.1.5.0']).to eq expected

data/spec/snmpjr/response_spec.rb

@@ -5,53 +5,80 @@ describe Snmpjr::Response do
   describe '.new' do
     context 'when initialized with a value' do
       it 'assigns that value' do
-        response = described_class.new(value: 'Some value')
+        response = described_class.new(oid: 'some oid', value: 'Some value')
         expect(response.to_s).to eq 'Some value'
       end
 
       it 'sets the error to an empty string' do
-        response = described_class.new(value: 'Some value')
+        response = described_class.new(oid: 'some oid', value: 'Some value')
         expect(response.error).to eq ''
       end
     end
 
     context 'when initialized with an error' do
       it 'assigns that error' do
-        response = described_class.new(error: 'Some error')
+        response = described_class.new(oid: 'some oid', error: 'Some error')
         expect(response.error).to eq 'Some error'
       end
 
       it 'sets the value to an empty string' do
-        response = described_class.new(error: 'Some error')
+        response = described_class.new(oid: 'some oid', error: 'Some error')
         expect(response.to_s).to eq ''
       end
     end
   end
 
+  describe '#oid' do
+    it 'returns the oid' do
+      response = described_class.new(oid: 'some oid', error: 'Some error')
+      expect(response.oid).to eq 'some oid'
+    end
+  end
+
   describe '#error?' do
     it 'returns true if there is an error' do
-      response = described_class.new(error: 'Some error')
+      response = described_class.new(oid: 'some oid', error: 'Some error')
       expect(response.error?).to be_truthy
     end
 
     it 'returns false if there isnt an error' do
-      response = described_class.new(value: 'Some value')
+      response = described_class.new(oid: 'some oid', value: 'Some value')
       expect(response.error?).to be_falsey
     end
   end
 
   describe '#==' do
     context 'when the objects are equal' do
-      let(:other) { Snmpjr::Response.new(value: 'some value') }
+      let(:other) { Snmpjr::Response.new(oid: 'some oid', value: 'some value') }
       it 'returns true' do
-        expect(described_class.new(value: 'some value')).to eq other
+        expect(described_class.new(oid: 'some oid', value: 'some value')).to eq other
       end
     end
 
     context 'when the objects are not equal' do
-      let(:other) { Snmpjr::Response.new(error: 'some value') }
+      let(:other) { Snmpjr::Response.new(oid: 'some oid', error: 'some value') }
+      it 'returns true' do
+        expect(described_class.new(oid: 'some oid', error: 'some error')).to_not eq other
+      end
+    end
+
+    context 'when the oids are different' do
+      let(:other) { Snmpjr::Response.new(oid: 'some oid', error: 'some error') }
       it 'returns true' do
-        expect(described_class.new(error: 'some error')).to_not eq other
+        expect(described_class.new(oid: 'another oid', error: 'some error')).to_not eq other
+      end
+    end
+
+    context 'when the objects are not of the same class' do
+      let(:other) { double :response }
+      before do
+        allow(other).to receive(:error).and_return ''
+        allow(other).to receive(:to_s).and_return 'some value'
+        allow(other).to receive(:oid).and_return 'some oid'
+      end
+
+      it 'returns false' do
+        expect(described_class.new(oid: 'some oid', value: 'some value')).to_not eq other
       end
     end
   end

data/spec/snmpjr/session_spec.rb

@@ -24,7 +24,6 @@ describe Snmpjr::Session do
       subject.start
       expect(snmp_session).to have_received(:listen)
     end
-
   end
 
   describe '#send' do
@@ -38,8 +37,10 @@ describe Snmpjr::Session do
     before do
       allow(snmp_session).to receive(:send).and_return response
       allow(vb1).to receive_message_chain('variable.to_s')
+      allow(vb1).to receive_message_chain('oid.to_s')
       allow(vb1).to receive(:is_exception)
       allow(vb2).to receive_message_chain('variable.to_s')
+      allow(vb2).to receive_message_chain('oid.to_s')
       allow(vb2).to receive(:is_exception)
       allow(response).to receive_message_chain('response.variable_bindings').and_return(results)
     end

data/spec/snmpjr/walker_spec.rb

@@ -86,8 +86,8 @@ describe Snmpjr::Walker do
     end
 
     it 'performs a synchronous walk' do
-      expect(subject.walk oid).to match_array [Snmpjr::Response.new(value: vb1.variable.to_s),
-                                                         Snmpjr::Response.new(value: vb2.variable.to_s)]
+      expect(subject.walk oid).to match_array [Snmpjr::Response.new(oid: vb1.oid.to_s, value: vb1.variable.to_s),
+                                               Snmpjr::Response.new(oid: vb2.oid.to_s, value: vb2.variable.to_s)]
     end
 
     it 'closes the snmp session' do

data/spec/snmpjr_spec.rb

@@ -19,7 +19,6 @@ describe Snmpjr do
       allow(Snmpjr::Getter).to receive(:new).with(target: community_target, max_oids_per_request: 20).and_return getter
     end
 
-
     subject { described_class.new(agent_details.merge({max_oids_per_request: 20})) }
 
     context 'when passed a single oid' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snmpjr
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: java
 authors:
 - Zen Kyprianou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-n-bake