netdot-restclient 1.3 → 1.4

data/lib/netdot.rb

@@ -0,0 +1,22 @@
+require 'logger'
+
+module Netdot
+
+  class << self
+    attr_accessor :logger
+  end
+
+  class NullLogger < Logger
+    def initialize(*args)
+    end
+
+    def add(*args, &block)
+    end
+  end
+
+  Netdot.logger = NullLogger.new
+end
+
+require 'netdot/restclient'
+require 'netdot/host'
+require 'netdot/subnet'

data/lib/netdot/host.rb

@@ -0,0 +1,76 @@
+module Netdot
+  class Host
+    attr_accessor :connection
+
+    def initialize(argv = {})
+      [:connection].each do |k|
+        raise ArgumentError, "Missing required argument '#{k}'" unless argv[k]
+      end
+
+      argv.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+    ##############################################################
+    # Find RR and Ipblock records with flexible arguments
+    # Handle exceptions
+    def find(param, value)
+      begin
+        host = @connection.get("/host?#{param.to_s}=#{value}");
+      rescue Exception => e
+        # Not Found is ok, otherwise re-raise
+        raise unless (e.message =~ /404/)
+      end
+      # Return what we got
+      host
+    end
+
+    ##############################################################
+    # Find RR and Ipblock records associated with given name
+    def find_by_name(name)
+      find(:name, name)
+    end
+
+    ##############################################################
+    # Find RR and Ipblock records associated with this IP
+    def find_by_ip(ip)
+      find(:address, ip)
+    end
+
+    ##############################################################
+    # Create A record for given name and IP
+    # Will also create PTR record if .arpa zone exists
+    def create(name, ip)
+      Netdot.logger.debug("Creating new DNS records with name:#{name} and ip:#{ip}")
+      @connection.post('host', {'name' => name, 'address' => ip})
+    end
+
+    ##############################################################
+    # Update A record for given name and IP
+    # Will also create PTR record if .arpa zone exists
+    def update(name, ip)
+      Netdot.logger.debug("Updating DNS records with name:#{name} and ip:#{ip}")
+      delete(name)
+      #delete_by_ip(ip)
+      create(name, ip)
+    end
+
+    ##############################################################
+    # Delete A record for given name
+    def delete(name)
+      host = find_by_name(name)
+      return unless host
+
+      # remove any associated IP addresses
+      Netdot.logger.debug("Removing IP records for #{name}")
+      host['Ipblock'].keys.each do |id|
+        begin
+          @connection.delete("host?ipid=#{id}")
+        rescue Exception => e
+          # Not Found is ok, otherwise re-raise
+          raise unless (e.message =~ /404/)
+        end
+      end
+    end
+
+  end
+end

data/lib/netdot/restclient/version.rb

@@ -1,6 +1,6 @@
 module Netdot
   class RestClient
-    VERSION = "1.3"
+    VERSION = "1.4"
 
     def version
       VERSION

data/lib/netdot/subnet.rb

@@ -0,0 +1,107 @@
+module Netdot
+  class Subnet
+    attr_accessor :connection
+
+    def initialize(argv = {})
+      [:connection].each do |k|
+        raise ArgumentError, "Missing required argument '#{k}'" unless argv[k]
+      end
+
+      argv.each { |k,v| instance_variable_set("@#{k}", v) }
+    end
+
+    # Get next available subnet in given container
+    #
+    # Arguments:
+    #    IP container block (string)
+    #    CIDR subnet size (optional integer)
+    #    description (optional string)
+    # Returns:
+    #    New subnet ID when successful
+    #
+    def allocate(container, prefix=24, description=nil)
+
+      # Netdot currently only supports /24 prefixes
+      raise ArgumentError, "Prefix size #{prefix} is not currently supported (must be 24)" unless prefix==24
+
+      # Search for container and get its ID
+      cont_id = get_ipblock_id(container)
+
+      # Get container's children blocks
+      begin
+        resp = @connection.get("Ipblock?parent=#{cont_id}")
+      rescue Exception => e
+        # Not Found is ok, otherwise re-raise
+        raise unless (e.message =~ /404/)
+      end
+
+      # store existing subnets in hash (if any)
+      subnets = Hash.new
+      if ( resp )
+        resp.values.each do |b|
+          b.each do |k,v|
+            address = v['address']
+            subnets[address] = 1
+          end
+        end
+      end
+
+      # Iterate over all possible subnets
+      # This assumes that subnets are /24
+      spref = container.split('/')[0]
+      spref.gsub!(/(\d+\.\d+)\..*/, '\1')
+
+      (1..255).each do |n|
+        saddr = spref.dup
+        saddr = spref + ".#{n}.0"
+        if !subnets.empty? && subnets.key?(saddr)
+          next # subnet exists
+        end
+
+        # Create subnet
+        args = { 'address' => saddr, 'prefix' => prefix.to_s, 'status' => 'Subnet' }
+        args['description'] = description unless description.nil?
+        resp = @connection.post("Ipblock", args)
+        return resp['address'] + '/' + resp['prefix']
+      end
+
+      raise "Could not allocate subnet in #{container}"
+    end
+
+    ######################################################################
+    # Delete subnet and all its records
+    #
+    # Arguments:
+    #    subnet address (CIDR)
+    # Returns:
+    #    True if successful
+    #
+    def delete(subnet)
+      resp = @connection.get("host?subnet=#{subnet}")
+
+      if ! resp.empty?
+        resp['Ipblock'].keys.each do |id|
+          @connection.delete("Ipblock/#{id}")
+        end
+      end
+
+      sid = get_ipblock_id(subnet)
+      @connection.delete("Ipblock/#{sid}")
+    end
+
+    private
+    ######################################################################
+    # Get Ipblock ID given its address in CIDR format
+    #
+    # Arguments:
+    #    subnet address (CIDR)
+    # Returns:
+    #    ID (number)
+    #
+    def get_ipblock_id(cidr)
+      (address, prefix) = cidr.split('/')
+      resp = @connection.get("Ipblock?address=#{address}&prefix=#{prefix}")
+      resp['Ipblock'].keys[0]
+    end
+  end
+end

data/spec/host_spec.rb

@@ -0,0 +1,60 @@
+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)
+  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
+    end
+
+    it 'raises an exception for invalid arguments' do
+      expect {
+        host = Netdot::Host.new
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'creating a new host' do
+    it 'creates a new host allocation' do
+      h = @host.create('test0-01-yyy', @cidr.nth(1))
+      expect(h.key? 'name').to be_truthy
+      expect(h['name']).to match('test0-01-yyy')
+    end
+
+    it 'updates an existing allocation' do
+      h = @host.update('test0-01-zzz', @cidr.nth(1))
+      expect(h.key? 'name').to be_truthy
+      expect(h['name']).to match('test0-01-zzz')
+    end
+  end
+
+  context 'finding existing hosts' do
+    it 'finds a host by name' do
+      h = @host.find_by_name('test0-01-zzz')
+      expect(h).to be_instance_of(Hash)
+    end
+
+    it 'finds a host by ip' do
+      h = @host.find_by_ip(@cidr.nth(1))
+      expect(h).to be_instance_of(Hash)
+    end
+  end
+
+  context 'deleting a host' do
+    it 'deletes a host' do
+      expect {
+        @host.delete('test-01-zzz')
+      }.not_to raise_error
+    end
+  end
+end

data/spec/restclient_spec.rb

@@ -1,37 +1,64 @@
-require 'netdot/restclient'
+require 'spec_helper'
 
 describe Netdot::RestClient do
+
   before :all do
-    args = {
-      username:  'admin',
-      server:    'http://localhost/netdot'
-    }
-    expect {
-      Netdot::RestClient.new(args)
-    }.to raise_error(ArgumentError)
-    
-    args[:password] = 'this-is-not-the-password'
-    expect {
-      Netdot::RestClient.new(args)
-    }.to raise_error
+    @netdot = connect
+  end
+
+  context 'when connecting' do
+
+    it 'raises an exception for incomplete arguments' do
+      args = {
+        username:  'admin',
+        server:    'http://localhost/netdot'
+      }
+      expect {
+        Netdot::RestClient.new(args)
+      }.to raise_error(ArgumentError)
+    end
 
-    args[:password] = 'admin'
+    it 'raises an exception for an invalid password' do
+     args = {
+        server:    ENV['SERVER'] || 'http://localhost/netdot',
+        username:  ENV['USERNAME'] || 'admin',
+        password:  'this-is-not-the-password'
+      }
+      expect {
+        Netdot::RestClient.new(args)
+      }.to raise_error
+    end
 
     # The following two assume that local server has SSL
     # enabled with a self-signed cert
-    args[:server] = 'https://localhost/netdot'
-    expect {
-      Netdot::RestClient.new(args)
-    }.to raise_error
-
-    args[:ssl_verify] = false
-    @netdot = Netdot::RestClient.new(args)
-    expect(@netdot).to be_an_instance_of(Netdot::RestClient)
-
-    args[:server] = 'http://localhost/netdot'
-    @netdot = Netdot::RestClient.new(args)
-    expect(@netdot).to be_an_instance_of(Netdot::RestClient)
-    
+    it 'raises an exception if SSL verification fails' do
+      args = {
+        server:    ENV['SERVER'] || 'https://localhost/netdot',
+        username:  ENV['USERNAME'] || 'admin',
+        password:  ENV['PASSWORD'] || 'admin' 
+      }
+      expect {
+        Netdot::RestClient.new(args)
+      }.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', 
+        ssl_verify: false
+      }
+
+      netdot = Netdot::RestClient.new(args)
+      expect(netdot).to be_an_instance_of(Netdot::RestClient)
+    end
+
+    it 'connects to the API' do
+      n = connect 
+      expect(n).to be_an_instance_of(Netdot::RestClient)
+    end
+
   end
 
   context 'when getting' do
@@ -44,7 +71,7 @@ describe Netdot::RestClient do
 
     it 'valid resource as hash' do
       resp = @netdot.get('Entity/1')
-      resp.should be_an_instance_of(Hash)
+      expect(resp).to be_an_instance_of(Hash)
     end
     
     it 'record by id' do
@@ -57,18 +84,17 @@ describe Netdot::RestClient do
       expect(resp['Entity']['1']['name']).to eq('Unknown')
     end
 
-    
   end
 
-   context 'when posting' do
+  context 'when posting' do
 
-     it 'fails to update invalid record' do
+    it 'fails to update invalid record' do
       expect {
         resp = @netdot.post('Foobar/1', {'key' => 'value'} )
       }.to raise_error
-     end
+    end
 
-     it 'creates new record' do
+    it 'creates new record' do
       resp = @netdot.post('Person', 
                           { 'firstname' => 'Joe', 
                             'lastname' => 'Plumber',
@@ -77,9 +103,9 @@ describe Netdot::RestClient do
       expect(resp['firstname']).to eq ('Joe')
       expect(resp['lastname']).to eq ('Plumber')
 
-     end
+    end
 
-     it 'fails to create duplicate record' do
+    it 'fails to create duplicate record' do
       expect {
         resp = @netdot.post('Person', 
                             { 'firstname' => 'Joe', 
@@ -87,7 +113,7 @@ describe Netdot::RestClient do
                               'username' => 'joetubes'
                             })
       }.to raise_error
-     end
+    end
 
   end
 
@@ -103,7 +129,7 @@ describe Netdot::RestClient do
       resp = @netdot.get('Person?lastname=Plumber')
       person_id =  resp['Person'].keys[0]
       resp = @netdot.delete("Person/#{person_id}")
-      expect(resp).to be_true
+      expect(resp).to be_truthy
     end
 
   end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'netdot'
+require 'netaddr'
+
+@netdot = nil
+
+def connect
+  args = {
+    server:     ENV['SERVER'] || 'http://localhost/netdot',
+    username:   ENV['USERNAME'] || 'admin',
+    password:   ENV['PASSWORD'] || 'admin',
+    ssl_verify: false
+  }
+  @netdot = Netdot::RestClient.new(args) if @netdot.nil?
+  return @netdot
+end

data/spec/subnet_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Netdot::Subnet do
+
+  before :all do
+    @netdot = connect
+    @subnet = Netdot::Subnet.new(:connection => @netdot) if @subnet.nil?
+  end
+
+  context 'when creating a new Subnet instance' do
+    it 'creates a new instance' do
+      expect {
+        subnet = Netdot::Subnet.new(:connection => @netdot)
+      }.not_to raise_error
+    end
+
+    it 'raises an exception for invalid arguments' do
+      expect {
+        subnet = Netdot::Subnet.new
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'creating a new subnet' do
+    it 'allocates a new subnet' do
+      subnet_id = @subnet.allocate('10.0.0.0/8', 24, 'test')
+      expect(subnet_id).to match('10.0.*.0/24') 
+    end
+
+    it 'throws an exception if the prefix is not /24' do
+      expect {
+        subnet_id = @subnet.allocate('10.0.0.0/8', 26)
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'deleting a subnet' do
+    let(:subnet_id) do
+      @subnet.allocate('10.0.0.0/8', 24)
+    end
+
+    it 'deletes a subnet' do
+      expect(@subnet.delete(subnet_id)).to be_truthy
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netdot-restclient
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,11 +103,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/netdot.rb
+- lib/netdot/host.rb
 - lib/netdot/restclient.rb
 - lib/netdot/restclient/version.rb
+- lib/netdot/subnet.rb
 - netdot-restclient.gemspec
 - sample/host.rb
+- spec/host_spec.rb
 - spec/restclient_spec.rb
+- spec/spec_helper.rb
+- spec/subnet_spec.rb
 homepage: ''
 licenses:
 - Apache-2.0
@@ -134,4 +140,7 @@ signing_key:
 specification_version: 3
 summary: RESTful API client for Netdot
 test_files:
+- spec/host_spec.rb
 - spec/restclient_spec.rb
+- spec/spec_helper.rb
+- spec/subnet_spec.rb