netdot-restclient 1.4 → 2.0.0

data/lib/netdot/restclient/version.rb

@@ -1,10 +1,11 @@
+# Netdot
 module Netdot
+  # RestClient
   class RestClient
-    VERSION = "1.4"
+    VERSION = '2.0.0'
 
     def version
       VERSION
     end
-
   end
 end

data/netdot-restclient.gemspec

@@ -4,25 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'netdot/restclient/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "netdot-restclient"
+  spec.name          = 'netdot-restclient'
   spec.version       = Netdot::RestClient::VERSION
-  spec.authors       = ["Carlos Vicente"]
-  spec.email         = ["cvicente@gmail.com"]
-  spec.summary       = %q{RESTful API client for Netdot}
-  spec.description   = %q{Talk to Netdot via REST with Ruby}
-  spec.homepage      = ""
-  spec.license       = "Apache-2.0"
+  spec.authors       = ['Carlos Vicente']
+  spec.email         = ['cvicente@gmail.com']
+  spec.summary       = 'RESTful API client for Netdot'
+  spec.description   = 'Talk to Netdot via REST with Ruby'
+  spec.homepage      = ''
+  spec.license       = 'Apache-2.0'
 
   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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.6"
-
-  spec.add_dependency "httpclient"
-  spec.add_dependency "xml-simple"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.6'
 
+  spec.add_dependency 'httpclient'
+  spec.add_dependency 'xml-simple'
 end

data/sample/sample.rb

@@ -0,0 +1,43 @@
+#
+# Example: Create, find, and delete Host and Ipblock resources.
+#
+require 'netdot'
+require 'netaddr'
+
+# Connect
+netdot_restclient = Netdot::RestClient.new(server: 'http://localhost/netdot',
+                                           username: 'admin',
+                                           password: 'admin')
+
+# Create a Netdot::Host object
+netdot_host = Netdot::Host.new(connection: netdot_restclient)
+
+# Create a Netdot::Ipblock object
+netdot_ipblock = Netdot::Ipblock.new(connection: netdot_restclient)
+
+# Ask Netdot to allocate a new CIDR block
+cidr = netdot_ipblock.allocate('10.0.0.0/24', 24, 'example-net')
+
+# Use NetAddr gem to allocate an address in the CIDR block
+netaddr_cidr = NetAddr::CIDR.create(cidr)
+
+# Use the first address
+address = netaddr_cidr.nth(1)
+
+# Create a new host (DNS A record)
+netdot_host.create('example-host', address)
+
+# Find the new host
+_found = netdot_host.find_by_name('example-host')
+
+# Delete the new Host
+netdot_host.delete('example-host')
+
+# Delete the new Ipblock, and all its children
+ipblocks = netdot_ipblock.find_by_descr('example-net')
+ipblocks.each do |ipblock|
+  address = ipblock[1]['address']
+  netdot_ipblock.delete(address, true)
+end unless ipblocks.nil?
+
+0

data/spec/host_spec.rb

@@ -1,46 +1,45 @@
 require 'spec_helper'
 
 describe Netdot::Host do
-
   before :all do
     @netdot = connect
-    @host = Netdot::Host.new(:connection => @netdot) if @host.nil?
-    subnet = Netdot::Subnet.new(:connection => @netdot)
-    subnet_id = subnet.allocate('10.0.0.0/8', 24, 'test')
-    @cidr = NetAddr::CIDR.create(subnet_id)
+    @host = Netdot::Host.new(connection: @netdot) if @host.nil?
+    pblock = Netdot::Ipblock.new(connection: @netdot)
+    cidr = pblock.allocate('10.0.0.0/8', 24, 'rspec-Ipblock-host')
+    @cidr = NetAddr::CIDR.create(cidr)
   end
 
   context 'when creating a new Host instance' do
     it 'creates a new instance' do
-      expect {
-        host = Netdot::Host.new(:connection => @netdot)
-      }.not_to raise_error
+      expect do
+        Netdot::Host.new(connection: @netdot)
+      end.not_to raise_error
     end
 
     it 'raises an exception for invalid arguments' do
-      expect {
-        host = Netdot::Host.new
-      }.to raise_error(ArgumentError)
+      expect do
+        Netdot::Host.new
+      end.to raise_error(ArgumentError)
     end
   end
 
-  context 'creating a new host' do
+  context 'when creating a new host' do
     it 'creates a new host allocation' do
-      h = @host.create('test0-01-yyy', @cidr.nth(1))
+      h = @host.create('rspec-test0-01-yyy', @cidr.nth(1))
       expect(h.key? 'name').to be_truthy
-      expect(h['name']).to match('test0-01-yyy')
+      expect(h['name']).to match('rspec-test0-01-yyy')
     end
 
     it 'updates an existing allocation' do
-      h = @host.update('test0-01-zzz', @cidr.nth(1))
+      h = @host.update('rspec-test0-01-zzz', @cidr.nth(1))
       expect(h.key? 'name').to be_truthy
-      expect(h['name']).to match('test0-01-zzz')
+      expect(h['name']).to match('rspec-test0-01-zzz')
     end
   end
 
-  context 'finding existing hosts' do
+  context 'when finding existing hosts' do
     it 'finds a host by name' do
-      h = @host.find_by_name('test0-01-zzz')
+      h = @host.find_by_name('rspec-test0-01-zzz')
       expect(h).to be_instance_of(Hash)
     end
 
@@ -50,11 +49,11 @@ describe Netdot::Host do
     end
   end
 
-  context 'deleting a host' do
+  context 'when deleting a host' do
     it 'deletes a host' do
-      expect {
-        @host.delete('test-01-zzz')
-      }.not_to raise_error
+      expect do
+        @host.delete('rspec-test-01-zzz')
+      end.not_to raise_error
     end
   end
 end

data/spec/ipblock_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Netdot::Ipblock do
+  before :all do
+    @netdot = connect
+    @ipblock = Netdot::Ipblock.new(connection: @netdot) if @ipblock.nil?
+    @host = Netdot::Host.new(connection: @netdot) if @host.nil?
+  end
+
+  context 'when creating a new Ipblock instance' do
+    it 'creates a new instance' do
+      expect do
+        Ipblock = Netdot::Ipblock.new(connection: @netdot)
+      end.not_to raise_error
+    end
+
+    it 'raises an exception for invalid arguments' do
+      expect do
+        Ipblock = Netdot::Ipblock.new
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'when creating a new Ipblock' do
+    it 'allocates a new Ipblock' do
+      cidr = @ipblock.allocate('10.0.0.0/8', 24, 'rspec-Ipblock-one')
+      expect(cidr).to match('10.0.*.0/24')
+    end
+
+    it 'raises an exception if the prefix is not /24' do
+      expect do
+        @ipblock.allocate('10.0.0.0/8', 26)
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'when finding an Ipblock by description' do
+    it 'finds an Ipblock' do
+      expect(@ipblock.find_by_descr('rspec-Ipblock-one')).not_to be_nil
+    end
+
+    it 'raises an exception for an improperly formatted name' do
+      expect do
+        @ipblock.find_by_descr('rspec-Ipblock-one&Foo=bar')
+      end.to raise_error
+    end
+
+    it 'return nil for an empty string' do
+      expect(@ipblock.find_by_descr('')).to be_nil
+    end
+
+    it 'return nil if not found' do
+      expect(@ipblock.find_by_descr('rspec-Ipblock-bogus')).to be_nil
+    end
+  end
+
+  context 'when finding an Ipblock by CIDR' do
+    it 'finds an Ipblock' do
+      cidr = @ipblock.allocate('10.0.0.0/8', 24, 'rspec-Ipblock-two')
+      ipblock = @ipblock.find_by_addr(cidr)
+      expect(ipblock).not_to be_nil
+    end
+
+    it 'return nil if not found' do
+      expect(@ipblock.find_by_addr('1.2.3.4/32')).to be_nil
+    end
+  end
+
+  context 'when finding an Ipblock by address' do
+    it 'finds an Ipblock' do
+      cidr = @ipblock.allocate('10.0.0.0/8', 24, 'rspec-Ipblock-three')
+      (address, _prefix) = cidr.split('/')
+      ipblock = @ipblock.find_by_addr(address)
+      expect(ipblock).not_to be_nil
+    end
+
+    it 'return nil if not found' do
+      expect(@ipblock.find_by_addr('1.2.3.4')).to be_nil
+    end
+  end
+
+  context 'when deleting an Ipblock' do
+    it 'deletes an Ipblock' do
+      cidr = @ipblock.allocate('10.0.0.0/8', 24, 'rspec-Ipblock-four')
+      expect(@ipblock.delete(cidr)).to be_truthy
+    end
+
+    it 'deletes an Ipblock, and its children' do
+      cidr = @ipblock.allocate('10.0.0.0/8', 24, 'rspec-Ipblock-five')
+      netaddr_cidr = NetAddr::CIDR.create(cidr)
+      @host.create('rspec-test0-01-yyy', netaddr_cidr.nth(1))
+      expect(@ipblock.delete(cidr, true)).to be_truthy
+    end
+  end
+
+  context 'when cleaning up' do
+    %w( host one two three four five ).each do |s|
+      description = format('rspec-Ipblock-%s', s)
+      it "finds and deletes Ipblock '#{description}'" do
+        ipblocks = @ipblock.find_by_descr(description)
+        ipblocks.each do |ipblock|
+          address = ipblock[1]['address']
+          @ipblock.delete(address, true)
+        end unless ipblocks.nil?
+      end
+    end
+  end
+end

data/spec/restclient_spec.rb

@@ -1,32 +1,30 @@
 require 'spec_helper'
 
 describe Netdot::RestClient do
-
   before :all do
     @netdot = connect
   end
 
   context 'when connecting' do
-
     it 'raises an exception for incomplete arguments' do
       args = {
         username:  'admin',
         server:    'http://localhost/netdot'
       }
-      expect {
+      expect do
         Netdot::RestClient.new(args)
-      }.to raise_error(ArgumentError)
+      end.to raise_error(ArgumentError)
     end
 
     it 'raises an exception for an invalid password' do
-     args = {
+      args = {
         server:    ENV['SERVER'] || 'http://localhost/netdot',
         username:  ENV['USERNAME'] || 'admin',
         password:  'this-is-not-the-password'
       }
-      expect {
+      expect do
         Netdot::RestClient.new(args)
-      }.to raise_error
+      end.to raise_error
     end
 
     # The following two assume that local server has SSL
@@ -35,18 +33,18 @@ describe Netdot::RestClient do
       args = {
         server:    ENV['SERVER'] || 'https://localhost/netdot',
         username:  ENV['USERNAME'] || 'admin',
-        password:  ENV['PASSWORD'] || 'admin' 
+        password:  ENV['PASSWORD'] || 'admin'
       }
-      expect {
+      expect do
         Netdot::RestClient.new(args)
-      }.to raise_error
+      end.to raise_error
     end
 
     it 'does not raise an exception if SSL verification is disabled' do
       args = {
         server:     ENV['SERVER'] || 'https://localhost/netdot',
         username:   ENV['USERNAME'] || 'admin',
-        password:   ENV['PASSWORD'] || 'admin', 
+        password:   ENV['PASSWORD'] || 'admin',
         ssl_verify: false
       }
 
@@ -55,25 +53,23 @@ describe Netdot::RestClient do
     end
 
     it 'connects to the API' do
-      n = connect 
+      n = connect
       expect(n).to be_an_instance_of(Netdot::RestClient)
     end
-
   end
 
   context 'when getting' do
-
     it 'invalid resource raises exception' do
-      expect { 
-        resp = @netdot.get('foobar')
-      }.to raise_error
+      expect do
+        @netdot.get('foobar')
+      end.to raise_error
     end
 
     it 'valid resource as hash' do
       resp = @netdot.get('Entity/1')
       expect(resp).to be_an_instance_of(Hash)
     end
-    
+
     it 'record by id' do
       resp = @netdot.get('Entity/1')
       expect(resp['name']).to eq('Unknown')
@@ -83,46 +79,41 @@ describe Netdot::RestClient do
       resp = @netdot.get('Entity?name=Unknown')
       expect(resp['Entity']['1']['name']).to eq('Unknown')
     end
-
   end
 
   context 'when posting' do
-
     it 'fails to update invalid record' do
-      expect {
-        resp = @netdot.post('Foobar/1', {'key' => 'value'} )
-      }.to raise_error
+      expect do
+        @netdot.post('Foobar/1', 'key' => 'value')
+      end.to raise_error
     end
 
     it 'creates new record' do
-      resp = @netdot.post('Person', 
-                          { 'firstname' => 'Joe', 
-                            'lastname' => 'Plumber',
-                            'username' => 'joetubes'
-                          })
-      expect(resp['firstname']).to eq ('Joe')
-      expect(resp['lastname']).to eq ('Plumber')
-
+      resp = @netdot.post('Person',
+                          'firstname' => 'Joe',
+                          'lastname' => 'Plumber',
+                          'username' => 'joetubes'
+                         )
+      expect(resp['firstname']).to eq('Joe')
+      expect(resp['lastname']).to eq('Plumber')
     end
 
     it 'fails to create duplicate record' do
-      expect {
-        resp = @netdot.post('Person', 
-                            { 'firstname' => 'Joe', 
-                              'lastname' => 'Plumber',
-                              'username' => 'joetubes'
-                            })
-      }.to raise_error
+      expect do
+        @netdot.post('Person',
+                     'firstname' => 'Joe',
+                     'lastname' => 'Plumber',
+                     'username' => 'joetubes'
+                    )
+      end.to raise_error
     end
-
   end
 
   context 'when deleting' do
-    
     it 'fails to delete invalid record' do
-      expect {
-        resp = @netdot.delete('FooBar/1234')
-      }.to raise_error
+      expect do
+        @netdot.delete('FooBar/1234')
+      end.to raise_error
     end
 
     it 'deletes exiting record' do
@@ -131,8 +122,5 @@ describe Netdot::RestClient do
       resp = @netdot.delete("Person/#{person_id}")
       expect(resp).to be_truthy
     end
-
   end
-
 end
-