ipadmin 0.1.3.1 → 0.2.0

data/README

@@ -1,5 +1,5 @@
 
- Copyright (c) 2006 Dustin Spinhirne <dspinhir@yahoo.com>
+ Copyright (c) 2006 Dustin Spinhirne <dspinhir at yahoo.com>
  Licensed under the same terms as Ruby, No Warranty is provided.
 
 
@@ -14,178 +14,167 @@
  
 =Examples:
  
- 
+
  #!/usr/bin/ruby
 
  require 'rubygems'
  require_gem 'ipadmin'
 
- #============================================================================#
- # IPAdmin::IPAddr
- #============================================================================#
- puts "IPAdmin::IPAddr"
- print "\n"
-
- # new
- ip4 = IPAdmin::IPAddr.new(:IPAddr => '192.168.1.1/24')
- ip4 = IPAdmin::IPAddr.new(:IPAddr => '192.168.1.1',
-                           :Netmask => '255.255.255.0',
-                           :Tag => {'test' => 'ip4 tag'})
- ip6 = IPAdmin::IPAddr.new(:IPAddr => 'fec0::1/64')
-
- # reader/writer
- puts "TEST 1"
- puts "ip4 tag '#{ip4.tag['test']}'"
- ip4.tag['test'] = 'modified ip4 tag'
- puts "updated ip4 tag '#{ip4.tag['test']}'"
- puts "ip4 version #{ip4.version}"
- print "\n"
-
- # base
- puts "TEST 2"
- puts "ip4 base addr #{ip4.base()}"
- puts "ip6 base addr #{ip6.base()}"
- print "\n"
-
- # broadcast
- puts "TEST 3"
- puts "ip4 bcast addr #{ip4.broadcast()}"
- print "\n"
-
- # desc
- puts "TEST 4"
- puts "ip4 description #{ip4.desc()}"
- puts "ip6 description #{ip6.desc()}"
- print "\n"
-
- # extended masks
- puts "TEST 5"
- puts "ip4 extended hostmask #{ip4.hostmask_ext()}"
- puts "ip4 extended netmask #{ip4.netmask_ext()}"
- print "\n"
-
- # ip
- puts "TEST 6"
- puts "ip4 ip addr #{ip4.ip()}"
- puts "ip6 ip addr #{ip6.ip()}"
- print "\n"
-
- # netmask
- puts "TEST 7"
- puts "ip4 netmask in CIDR format #{ip4.netmask()}"
- puts "ip6 netmask in CIDR format #{ip6.netmask()}"
- print "\n"
- 
- # bits
- puts "TEST 8"
- puts "ip4 netmask in bits #{ip4.bits()}"
- puts "ip6 netmask in bits #{ip6.bits()}"
-
- print "\n\n\n"
- #=====================================#
- #
- #=====================================#
-
  #============================================================================#
  # IPAdmin::CIDR
  #============================================================================#
  puts "IPAdmin::CIDR"
  print "\n"
- 
- ip4 = IPAdmin::IPAddr.new(:IPAddr => '192.168.1.1/24')
- ip6 = IPAdmin::IPAddr.new(:IPAddr => 'fec0::1/64')
 
  # new
  cidr4 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0/24')
- cidr4 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0',
+ cidr4 = IPAdmin::CIDR.new(:CIDR => '192.168.1.1',
                            :Netmask => '255.255.255.0',
                            :Tag => {'test' => 'cidr4 tag'})
- cidr6 = IPAdmin::CIDR.new(:CIDR => 'fec0::0/64')
+ cidr6 = IPAdmin::CIDR.new(:CIDR => 'fec0::1/64')
+ 
+ cidr4_2 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0/26')
+ cidr6_2 = IPAdmin::CIDR.new(:CIDR => 'fec0::0/96')
 
  # reader/writer
- puts "TEST 1"
+ puts "reader/writer"
  puts "cidr4 tag '#{cidr4.tag['test']}'"
  cidr4.tag['test'] = 'modified cidr4 tag'
  puts "updated cidr4 tag '#{cidr4.tag['test']}'"
  puts "cidr4 version #{cidr4.version}"
  print "\n"
-
+  
+ # bits
+ puts "bits"
+ puts "cidr4 netmask in bits #{cidr4.bits()}"
+ puts "cidr6 netmask in bits #{cidr6.bits()}"
+ print "\n"
+ 
  # contains
- puts "TEST 2"
- puts "#{cidr4.desc} contains #{ip4.desc}" if ( cidr4.contains(ip4) )
- puts "#{cidr6.desc} contains #{ip6.desc}" if ( cidr6.contains(ip6) )
+ puts "contains"
+ puts "#{cidr4.desc} contains #{cidr4_2.desc}" if ( cidr4.contains(cidr4_2) )
+ puts "#{cidr6.desc} contains #{cidr6_2.desc}" if ( cidr6.contains(cidr6_2) )
  print "\n"
 
  # desc
- puts "TEST 3"
+ puts "desc"
  puts "cidr4 description #{cidr4.desc()}"
  puts "cidr6 description #{cidr6.desc()}"
+ puts "cidr6 short-hand description #{cidr6.desc(:Short => 1)}"
+ print "\n"
+
+ # enumerate
+ puts "enumerate"
+ puts "first 4 cidr4 addresses (bitstep 32)"
+ cidr4.enumerate(:Limit => 4, :Bitstep => 32).each {|x| puts "  #{x}"}
+ 
+ puts "first 4 cidr6 addresses (bitstep 32)"
+ cidr6.enumerate(:Limit => 4, :Bitstep => 32, :Objectify => 1).each {|x| puts "  #{x.desc}"}
  print "\n"
 
- # extended masks
- puts "TEST 4"
+ # hostmask_ext
+ puts "hostmask_ext"
  puts "cidr4 extended hostmask #{cidr4.hostmask_ext()}"
- puts "cidr4 extended netmask #{cidr4.netmask_ext()}"
+ print "\n" 
+  
+ # ip
+ puts "ip"
+ puts "cidr4 ip #{cidr4.ip()}"
+ puts "cidr6 short-hand ip #{cidr6.ip(:Short => 1)}"
+ print "\n"
+ 
+ # last
+ puts "last"
+ puts "cidr4 last ip #{cidr4.last()}"
+ puts "cidr6 last ip #{cidr6.last(:Short => 1)}"
  print "\n"
 
  # netmask
- puts "TEST 5"
+ puts "netmask"
  puts "cidr4 netmask in CIDR format #{cidr4.netmask()}"
  puts "cidr6 netmask in CIDR format #{cidr6.netmask()}"
  print "\n"
  
- # bits
- puts "TEST 6"
- puts "cidr4 netmask in bits #{cidr4.bits()}"
- puts "cidr6 netmask in bits #{cidr6.bits()}"
+ # netmask_ext
+ puts "netmask_ext"
+ puts "cidr4 extended netmask #{cidr4.netmask_ext()}"
  print "\n"
 
  # network
- puts "TEST 7"
+ puts "network"
  puts "cidr4 network address #{cidr4.network()}"
- puts "cidr6 network address #{cidr6.network()}"
+ puts "cidr6 network address #{cidr6.network(:Short => 1)}"
+ print "\n"
+ 
+ # next_ip
+ puts "next_ip"
+ puts "cidr4 next ip #{cidr4.next_ip()}"
+ puts "cidr6 next ip #{cidr6.next_ip(:Short => 1)}"
+ print "\n"
+ 
+ # next_subnet
+ puts "next_subnet"
+ puts "cidr4 next subnet #{cidr4.next_subnet()}"
+ puts "cidr6 next subnet #{cidr6.next_subnet(:Short => 1)}"
  print "\n"
 
  # nth
- puts "TEST 8"
+ puts "nth"
  puts "cidr4 1st ip is #{cidr4.nth(:Index => 1)}"
- puts "cidr6 1st ip is #{(cidr6.nth(:Index => 1, :Objectify => 1)).desc}"
+ puts "cidr6 1st ip is #{(cidr6.nth(:Index => 1, :Objectify => 1)).base}"
+ print "\n"
+ 
+ # packed_hostmask
+ puts "packed_hostmask"
+ puts "cidr4 packed_hostmask is #{cidr4.packed_hostmask.to_s(16)}"
+ puts "cidr6 packed_hostmask is #{cidr6.packed_hostmask.to_s(16)}"
+ print "\n"
+ 
+ # packed_netmask
+ puts "packed_netmask"
+ puts "cidr4 packed_netmask is #{cidr4.packed_netmask.to_s(16)}"
+ puts "cidr6 packed_netmask is #{cidr6.packed_netmask.to_s(16)}"
+ print "\n"
+ 
+ # packed_network
+ puts "packed_network"
+ puts "cidr4 packed_network is #{cidr4.packed_network.to_s(16)}"
+ puts "cidr6 packed_network is #{cidr6.packed_network.to_s(16)}"
+ print "\n"
+ 
+ # range
+ puts "range"
+ cidr4.range(:Indexes => [20,0], :Bitstep => 5).each {|x| puts x}
+ cidr6.range(:Indexes => [20,0], :Bitstep => 5).each {|x| puts x}
+ print "\n" 
+ 
+ # remainder
+ puts "remainder"
+ cidr4_2 = IPAdmin::CIDR.new(:CIDR => '192.168.1.64/26')
+ cidr4.remainder(:Exclude => cidr4_2).each {|x| puts x}
+ print "\n" 
+  
+ # resize!
+ puts "resize!"
+ cidr4.resize!(:Subnet => 25)
+ cidr6.resize!(:Subnet => 65)
+ puts "cidr4 resized is #{cidr4.desc}"
+ puts "cidr6 resized is #{cidr6.desc}"
  print "\n"
 
  # size
- puts "TEST 9"
+ puts "size"
  puts "cidr4 size is #{cidr4.size()}"
  puts "cidr6 size is #{cidr6.size()}"
  print "\n"
 
- # enumerate
- puts "TEST 10"
- puts "first 4 cidr4 addresses (bitstep 32)"
- list4 = cidr4.enumerate(:Limit => 4, :Bitstep => 32)
- list4.each do |addr|
-     puts "  #{addr}"
- end
- 
- puts "first 4 cidr6 addresses (bitstep 32)"
- list6 = cidr6.enumerate(:Limit => 4, :Bitstep => 32, :Objectify => 1)
- list6.each do |addr|
-     puts "  #{addr.desc}"
- end
- print "\n"
- 
  # subnet
- puts "TEST 11"
- puts "cidr4 subnetted into at least 3 /28 ranges"
- sn4 = cidr4.subnet(:Subnet => 28, :MinCount => 3)
- sn4.each do |cidr|
-     puts "  #{cidr.desc()}"
- end
+ puts "subnet"
+ puts "#{cidr4.desc} subnetted into at least 3 /28 ranges"
+ cidr4.subnet(:Subnet => 28, :MinCount => 3).each {|x| puts "  #{x}"} 
  
- puts "cidr6 subnetted into at least 4 /66 ranges"
- sn6 = cidr6.subnet(:Subnet => 66, :MinCount => 4)
- sn6.each do |cidr|
-     puts "  #{cidr.desc()}"
- end
+ puts "#{cidr6.desc(:Short => 1)} subnetted into at least 4 /67 ranges"
+ cidr6.subnet(:Subnet => 67, :MinCount => 4, :Short => 1).each {|x| puts "  #{x}"}
 
  print "\n\n\n"
  #=====================================#
@@ -199,100 +188,44 @@
  puts "IPAdmin::Tree"
  print "\n"
 
- cidr4_1 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0/24')
- cidr4_2 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0/26')
- cidr4_3 = IPAdmin::CIDR.new(:CIDR => '192.168.1.64/26')
- cidr4_4 = IPAdmin::CIDR.new(:CIDR => '192.168.1.128/26')
- cidr4_5 = IPAdmin::CIDR.new(:CIDR => '192.168.1.192/26')
- cidr4_6 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0/27')
- cidr4_7 = IPAdmin::CIDR.new(:CIDR => '192.168.1.32/27')
+ cidr4 = [IPAdmin::CIDR.new(:CIDR => '192.168.1.0/24'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.0/26'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.64/26'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.128/26'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.192/26'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.0/27'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.0/28'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.16/28'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.16/29'),
+          IPAdmin::CIDR.new(:CIDR => '192.168.1.32/27')]
  
- cidr6_1 = IPAdmin::CIDR.new(:CIDR => 'fec0::/64')
- cidr6_2 = IPAdmin::CIDR.new(:CIDR => 'fec0::/66')
- cidr6_3 = IPAdmin::CIDR.new(:CIDR => 'fec0::4000:0:0:0/66')
- cidr6_4 = IPAdmin::CIDR.new(:CIDR => 'fec0::8000:0:0:0/66')
- cidr6_5 = IPAdmin::CIDR.new(:CIDR => 'fec0::c000:0:0:0/66')
- cidr6_6 = IPAdmin::CIDR.new(:CIDR => 'fec0::/67')
- cidr6_7 = IPAdmin::CIDR.new(:CIDR => 'fec0::2000:0:0:0/67')
+ cidr6 = [IPAdmin::CIDR.new(:CIDR => 'fec0::/64'),
+          IPAdmin::CIDR.new(:CIDR => 'fec0::/66'),
+          IPAdmin::CIDR.new(:CIDR => 'fec0::4000:0:0:0/66'),
+          IPAdmin::CIDR.new(:CIDR => 'fec0::8000:0:0:0/66'),
+          IPAdmin::CIDR.new(:CIDR => 'fec0::c000:0:0:0/66'),
+          IPAdmin::CIDR.new(:CIDR => 'fec0::c000:0:0:0/67'),
+          IPAdmin::CIDR.new(:CIDR => 'fec0::/67'),
+          IPAdmin::CIDR.new(:CIDR => 'fec0::2000:0:0:0/67')]
 
  # new
  tree4 = IPAdmin::Tree.new(:Version => 4)
  tree6 = IPAdmin::Tree.new(:Version => 6)
 
  # add
- tree4.add(cidr4_1)
- tree4.add(cidr4_2)
- tree4.add(cidr4_3)
- tree4.add(cidr4_4)
- tree4.add(cidr4_5)
- tree4.add(cidr4_6)
- tree4.add(cidr4_7)
- 
- tree6.add(cidr6_1)
- tree6.add(cidr6_2)
- tree6.add(cidr6_3)
- tree6.add(cidr6_4)
- tree6.add(cidr6_5)
- tree6.add(cidr6_6)
- tree6.add(cidr6_7)
- 
- # show
- puts "TEST 1"
- puts "tree4 is..."
- puts tree4.show()
- print "\n"
- puts "tree6 is..."
- puts tree6.show()
- print "\n"
- 
- # collapse
- puts "TEST 2"
- puts "collapsed tree4 is..."
- new_tree4 = tree4.collapse()
- puts new_tree4.show()
- print "\n"
- puts "collapsed tree6 is..."
- new_tree6 = tree6.collapse()
- puts new_tree6.show()
- print "\n"
- 
- # find space
- puts "TEST 3"
- puts "available /27 space"
- space = tree4.find_space(:Size => 27)
- space.each do |obj|
-    puts "  #{obj.desc}"
+ puts "add"
+ cidr4.each do |x| 
+    puts "adding #{x.desc}..."
+    tree4.add(x)
  end
- print "\n"
- puts "available /67 space"
- space = tree6.find_space(:Size => 67)
- space.each do |obj|
-    puts "  #{obj.desc}"
+ cidr6.each do |x| 
+    puts "adding #{x.desc}..."
+    tree6.add(x)
  end
  print "\n"
  
- # remove
- puts "TEST 4"
- puts "removing #{cidr4_4.desc}"
- tree4.remove(cidr4_4)
- puts tree4.show()
- print "\n"
- puts "removing #{cidr6_4.desc}"
- tree6.remove(cidr6_4)
- puts tree6.show()
- print "\n"
- 
- # prune
- puts "TEST 5"
- puts "pruning #{cidr4_2.desc}"
- tree4.prune(cidr4_2)
-
- puts "pruning #{cidr6_2.desc}"
- tree6.prune(cidr6_2)
- print "\n"
- 
- # dump
- puts "TEST 6"
+  # dump
+ puts "dump"
  puts "dumping & printing tree4"
  dumped = tree4.dump()
  dumped.each do |val|
@@ -318,6 +251,54 @@
         puts obj.desc()
     end
  end
+ print "\n"
+  
+ # find space
+ puts "find_space with at least 28 IP's in it"
+ puts "available space with at least 28 IPs"
+ space = tree4.find_space(:IPCount => 28)
+ space.each do |obj|
+    puts "  #{obj.desc}"
+ end
+ print "\n"
+ puts "available /67 space"
+ space = tree6.find_space(:Subnet => 67)
+ space.each do |obj|
+    puts "  #{obj.desc}"
+ end
+ print "\n"
+ 
+ # remove
+ puts "remove"
+ puts "removing #{cidr4[8].desc}"
+ tree4.remove(cidr4[8])
+ puts tree4.show()
+ print "\n"
+ puts "removing #{cidr6[5].desc}"
+ tree6.remove(cidr6[5])
+ puts tree6.show()
+ print "\n"
+ 
+ # prune
+ puts "prune"
+ puts "pruning #{cidr4[4].desc}"
+ tree4.prune(cidr4[4])
+ puts tree4.show()
+ print "\n"
+ puts "pruning #{cidr6[1].desc}"
+ tree6.prune(cidr6[1])
+ puts tree6.show()
+ print "\n"
+ 
+  # collapse
+ puts "collapse"
+ puts "collapsed tree4 is..."
+ new_tree4 = tree4.collapse()
+ puts new_tree4.show()
+ print "\n"
+ puts "collapsed tree6 is..."
+ new_tree6 = tree6.collapse()
+ puts new_tree6.show()
 
  print "\n\n\n"
  #=====================================#
@@ -328,27 +309,29 @@
  # IPAdmin Methods
  #============================================================================#
  puts "IPAdmin Methods"
-
+ print "\n"
+ 
  # validate ip
- puts "TEST 1"
+ puts "validate ip"
  puts "192.168.1.0 is valid" if ( IPAdmin.validate_ipv4_addr('192.168.1.0') )
- puts "192.168.1.0 is valid" if ( IPAdmin.validate_ipv6_addr('fec0::0') )
+ puts "fec0::0 is valid" if ( IPAdmin.validate_ipv6_addr('fec0::0') )
  print "\n"
 
  # validate netmask
- puts "TEST 2"
+ puts "validate netmask"
  puts "255.255.255.0 is valid" if (IPAdmin.validate_ipv4_netmask('255.255.255.0') )
  puts "/24 is valid" if ( IPAdmin.validate_ipv4_netmask(24) )
  puts "/64 is valid" if ( IPAdmin.validate_ipv6_netmask(64) )
 
  cidr4_1 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0/24')
  cidr4_2 = IPAdmin::CIDR.new(:CIDR => '192.168.1.0/25')
+ cidr4_3 = IPAdmin::CIDR.new(:CIDR => '192.168.1.50')
  cidr6_1 = IPAdmin::CIDR.new(:CIDR => 'fec0::0/10')
  cidr6_2 = IPAdmin::CIDR.new(:CIDR => 'fec0::0/64')
  print "\n"
 
  # compare
- puts "TEST 3"
+ puts "compare"
  comp1 = IPAdmin.compare(cidr4_1,cidr4_2)
  comp2 = IPAdmin.compare(cidr6_1,cidr6_2)
  puts "#{(comp1[0]).desc} is the supernet of #{(comp1[1]).desc}"
@@ -358,31 +341,32 @@
  cidr4_2 = IPAdmin::CIDR.new(:CIDR => '192.168.0.0/24')
  cidr6_1 = IPAdmin::CIDR.new(:CIDR => 'fec0::0/128')
  cidr6_2 = IPAdmin::CIDR.new(:CIDR => 'fec0::1/128')
-
- ip1 = IPAdmin::IPAddr.new(:IPAddr => '192.168.1.0')
- ip2 = IPAdmin::IPAddr.new(:IPAddr => '192.168.1.50')
  print "\n"
 
  # range
- puts "TEST 4"
- list = IPAdmin.range(:Boundaries => [ip1,ip2], :Bitstep => 20 )
- puts "ip's between #{ip1.desc} and #{ip2.desc} (bitstep of 20)"
+ puts "range"
+ list = IPAdmin.range(:Boundaries => [cidr4_1,cidr4_3], :Bitstep => 20 )
+ puts "ip's between #{cidr4_1.base} and #{cidr4_3.base} (bitstep of 20)"
  list.each do |x|
   puts "  #{x}"
  end
  print "\n"
 
  # arpa
- puts "TEST 5"
+ puts "arpa"
  puts "arpa for #{cidr4_1.desc()} is #{IPAdmin.arpa(cidr4_1)}"
  puts "arpa for #{cidr6_1.desc()} is #{IPAdmin.arpa(cidr6_1)}"
  print "\n"
  
  # shorten
- puts "TEST 6"
+ puts "shorten"
  puts "shorthand notation for  #{cidr6_1.network()} is #{IPAdmin.shorten(cidr6_1.network)}"
+ print "\n"
+ 
+ # unshorten
+ puts "unshorten"
+ puts "expanded notation for  fec0:: is #{IPAdmin.unshorten('fec0::')}"
 
- print "\n\n\n"
  #=====================================#
  #
  #=====================================#