snmpjr 0.1.3-java → 0.1.4-java

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjVlOTJkNDZhYzNjZGY0Zjk2NDNiYWMzMGUzM2Q0Zjg5NDE0NDRlMA==
+    MmUwZDc1YTk1N2M5MzY5ZjAxODgwNTU3ZjgzMjVlZTE5MWM5MWU5Mg==
   data.tar.gz: !binary |-
-    YTQ4ODM1YTQ1NDE2NjlkZmMzMGU5OGE1OTEwMGNiNzYwMWU2NjIwZQ==
+    ZTRlZmVhNTg0ODEyNDBmYTc4ODE3ZjUwZTNmNDMzY2VmYjY1MDk0ZQ==
 SHA512:
   metadata.gz: !binary |-
-    NzZiMzk2ZDJjMWNmNWE2OTg1NjY2YTcwMDAxODE3NGViODJkNzMwMmY0YmJh
-    MmNhZTllMWQwM2M4OWVhYWRmMTkzMGM2NjcwNTk1ZjljNjYyMWNkMWZmMTIy
-    YWFmNjIzNzMwN2Q4M2UyNTYxNTZiZWE5Mjg4ZDg2MTAyYTUyZTE=
+    YjY5MjZhNWEwZTE4MGJhNTgzZmFhODcwMDRiNTY0MjAzOGE5ODExMDg5Y2Rl
+    ZjhlMGZiNjJkYzcxZTQ0OWE2Y2RjMWE5Y2Q1NjhiZDdiMmY1ZTE1YmQ1NjI1
+    OTAzYzViMDQ4ZjExNmE5MjY3NDVmZjhlNzRhNGUzZGEwMjZiMjI=
   data.tar.gz: !binary |-
-    Y2YyYmVhMzBmNTRmYzUzYjdkZGI3ZmI0MzIyMTQ1NjA1ODZmZjk3Y2NiNThl
-    ZWQ5YjEzZjVjMjY3MjMxZTQ0NjJjNWNiMzAwZDQ3Y2M2NTUwMmQwM2IzYmUz
-    ZWU5OWFjM2Y0NzEwMWUwNGU0NDc1NTA2OWRlMjQ3M2U1MzRlNzI=
+    MDNiMDE3MWM4NDUxMjIyZjZhZDBkZGQwZjViN2E5NWM4NGFjYWZkYWIyYWYy
+    MzgxNjU4MTgyODI1ODQ1YWQ2NWIwZDYwNjZiNGU4N2IwYjg4OTM2NWJlYzIw
+    M2EzNmU4MmI0MWZiZGU4OTIxY2E1YTc1MDQxMjA0MDQ2ZTU5NjU=

data/history.rdoc

@@ -1,3 +1,7 @@
+== 0.1.4 (14 October 2014)
+
+* Returns a Response object rather than strings
+
 == 0.1.3 (13 October 2014)
 
 * Tweak the wording of the timeouts to show that its an error

data/lib/snmpjr/response.rb

@@ -0,0 +1,26 @@
+class Snmpjr
+  class Response
+    attr_reader :error
+
+    def initialize response = {}
+      @error = response[:error] || ''
+      @value = response[:value] || ''
+    end
+
+    def error?
+      if @error.empty?
+        false
+      else
+        true
+      end
+    end
+
+    def to_s
+      @value
+    end
+
+    def ==(other)
+      @error == other.error && to_s == other.to_s
+    end
+  end
+end

data/lib/snmpjr/session.rb

@@ -1,4 +1,5 @@
 require 'snmpjr/wrappers/transport'
+require 'snmpjr/response'
 
 class Snmpjr
   class Session
@@ -15,12 +16,12 @@ class Snmpjr
       begin
         result = @snmp.send(pdu, target)
         if result.response.nil?
-          "Error: Request timed out"
+          Snmpjr::Response.new(:error => 'Request timed out')
         else
-          result.response.variable_bindings.first.variable.to_s
+          Snmpjr::Response.new(:value => result.response.variable_bindings.first.variable.to_s)
         end
-      rescue Exception => e
-        "Error: #{e.to_s}"
+      rescue Exception => error
+        Snmpjr::Response.new(:error => error.to_s)
       end
     end
 

data/lib/snmpjr/version.rb

@@ -1,3 +1,3 @@
 class Snmpjr
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/integration/snmpjr_spec.rb

@@ -1,4 +1,5 @@
 require 'snmpjr'
+require 'snmpjr/response'
 
 describe "snmpjr" do
 
@@ -7,20 +8,22 @@ 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 '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(:value => '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'] }
+      let(:expected) { [Snmpjr::Response.new(:value => 'SunOS zeus.snmplabs.com 4.1.3_U1 1 sun4m'),
+                        Snmpjr::Response.new(: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) { ['Error: Invalid first sub-identifier (must be 0, 1, or 2)', 'zeus.snmplabs.com'] }
+        let(:expected) { [Snmpjr::Response.new(:error => 'Invalid first sub-identifier (must be 0, 1, or 2)'),
+                          Snmpjr::Response.new(:value => '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
@@ -29,9 +32,8 @@ describe "snmpjr" 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 'Error: Request timed out'
+        expect(subject.get '1.3.6.1.2.1.1.1.0').to eq Snmpjr::Response.new(:error => 'Request timed out')
       end
     end
-
   end
 end

data/spec/snmpjr/response_spec.rb

@@ -0,0 +1,58 @@
+require production_code
+
+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')
+        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')
+        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')
+        expect(response.error).to eq 'Some error'
+      end
+
+      it 'sets the value to an empty string' do
+        response = described_class.new(:error => 'Some error')
+        expect(response.to_s).to eq ''
+      end
+    end
+  end
+
+  describe '#error?' do
+    it 'returns true if there is an error' do
+      response = described_class.new(: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')
+      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') }
+      it 'returns true' do
+        expect(described_class.new(:value => 'some value')).to eq other
+      end
+    end
+
+    context 'when the objects are not equal' do
+      let(:other) { Snmpjr::Response.new(:error => 'some value') }
+      it 'returns true' do
+        expect(described_class.new(:error => 'some error')).to_not eq other
+      end
+    end
+  end
+end

data/spec/snmpjr/session_spec.rb

@@ -47,8 +47,9 @@ describe Snmpjr::Session do
         allow(result).to receive(:response).and_return nil
       end
 
+      let(:expected_response) { Snmpjr::Response.new(:error => 'Request timed out') }
       it 'returns a request timeout' do
-        expect(subject.send(pdu, target)).to eq "Error: Request timed out"
+        expect(subject.send(pdu, target)).to eq expected_response
       end
     end
 
@@ -57,8 +58,9 @@ describe Snmpjr::Session do
         allow(snmp_session).to receive(:send).and_raise(RuntimeError.new('Some error'))
       end
 
+      let(:expected_response) { Snmpjr::Response.new(:error => 'Some error') }
       it 'returns the error without blowing up' do
-        expect(subject.send(pdu, target)).to eq "Error: Some error"
+        expect(subject.send(pdu, target)).to eq expected_response
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snmpjr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: java
 authors:
 - Zen Kyprianou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2014-10-14 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.
@@ -32,6 +32,7 @@ files:
 - lib/snmpjr.rb
 - lib/snmpjr/getter.rb
 - lib/snmpjr/pdu.rb
+- lib/snmpjr/response.rb
 - lib/snmpjr/session.rb
 - lib/snmpjr/target.rb
 - lib/snmpjr/version.rb
@@ -43,6 +44,7 @@ files:
 - spec/integration/snmpjr_spec.rb
 - spec/snmpjr/getter_spec.rb
 - spec/snmpjr/pdu_spec.rb
+- spec/snmpjr/response_spec.rb
 - spec/snmpjr/session_spec.rb
 - spec/snmpjr/target_spec.rb
 - spec/snmpjr_spec.rb
@@ -75,6 +77,7 @@ test_files:
 - spec/integration/snmpjr_spec.rb
 - spec/snmpjr/getter_spec.rb
 - spec/snmpjr/pdu_spec.rb
+- spec/snmpjr/response_spec.rb
 - spec/snmpjr/session_spec.rb
 - spec/snmpjr/target_spec.rb
 - spec/snmpjr_spec.rb