ipadmin 0.1.3 → 0.1.3.1

data/lib/ip_admin.rb

@@ -198,8 +198,7 @@ module_function :compare
 #
 def compare_cidr(cidr1,cidr2)
     
-    puts "compare_cidr() DEPRICATED, DO NOT USE - this will be removed in future releases."
-    
+ 
     # we only accept CIDR objects
     unless ( (cidr1.kind_of? IPAdmin::CIDR)&&(cidr2.kind_of? IPAdmin::CIDR) )
         raise ArgumentError, "Arguments shouldbe of type IPAdmin::CIDR."
@@ -264,7 +263,6 @@ module_function :compare_cidr
 #
 def merge_cidr(cidr_list)
     
-    puts "merge_cidr() DEPRICATED, DO NOT USE - this will be removed in future releases."
     # make sure we have an array with at least 2 objects
     unless ( (cidr_list.kind_of? Array) && (cidr_list.length > 1) )
         raise ArgumentError, "Array of at least two IPAdmin::CIDR objects required."
@@ -1326,6 +1324,7 @@ class CIDR
             
             if (network =~/\./) # assume IPv4
                 @version = 4
+                @all_f = 2**32 - 1
                 
                 if (network =~ /\//)
                     ip,netmask = network.split(/\//)
@@ -1358,6 +1357,7 @@ class CIDR
 
             elsif (network =~/:/) # assume IPv6
                 @version = 6
+                @all_f = 2**128 - 1
                 
                 if (network =~ /\//)
                     ip,netmask = network.split(/\//)
@@ -1538,6 +1538,39 @@ class CIDR
 #=====================================#
 
 
+#==============================================================================#
+# desc_short()
+#==============================================================================#
+
+# Displays the IPv6 network/netmask of this object in IPv6 short-hand
+# notation. This method does not work for IPv4 objects.
+#
+# - Arguments:
+#   * none
+#
+# - Returns:
+#   * Description in network/netmask format.
+#
+# Example:
+#   desc = cidr.desc_short()
+#
+    def desc_short()
+        if (@version == 4)
+            raise "desc_short() is not supported for IPv4 objects."
+        end
+        
+        ip = IPAdmin.unpack_ipv6_addr(@network)
+        ip = IPAdmin.shorten(ip)
+        mask = IPAdmin.unpack_ipv6_netmask(@netmask)
+
+        return("#{ip}/#{mask}")
+
+    end
+
+#======================================#
+#
+#======================================#
+
 
 #============================================================================#
 # enumerate()
@@ -1688,6 +1721,57 @@ class CIDR
 #=====================================#
 
 
+#==============================================================================#
+# last()
+#==============================================================================#
+
+# Provide last IP address in this CIDR object. The broadcast() method is
+# aliased to this method, and thus works for IPv6 despite the fact that the
+# IPv6 protocol does not support IP broadcasting.
+#
+# - Arguments:
+#   * Optional Hash with the following fields:
+#       - :Objectify -- return IPAdmin::CIDR object (optional)
+#
+# - Returns:
+#   * IP address or IPAdmin::CIDR object.
+#
+# Example:
+#   puts cidr.last()
+#
+    def last(options=nil)
+        objectify = nil
+        
+        if (options)
+            unless(options.kind_of?(Hash))
+                raise Argumenterror, "Expected Hash, but " +
+                                     "#{options.class} provided."
+            end
+            objectify = options[:Objectify] if (options.has_key?(:Objectify) &&
+                                                options[:Objectify] != nil)
+        end
+        
+        packed_ip = @network | @hostmask
+        if (@version == 4)
+            ip = IPAdmin.unpack_ipv4_addr(packed_ip)
+        else
+            ip = IPAdmin.unpack_ipv6_addr(packed_ip)
+        end
+        
+        if (objectify)
+            ip = IPAdmin::CIDR.new(:CIDR => ip)
+        end
+
+        return(ip)
+    end
+    
+    alias :broadcast :last
+
+#======================================#
+#
+#======================================#
+
+
 
 #============================================================================#
 # netmask()
@@ -1776,12 +1860,124 @@ class CIDR
         
         return(formatted)
     end
+    
+    alias :base :network
+    alias :first :network
 
 #=====================================#
 #        
 #=====================================#
 
 
+#==============================================================================#
+# next_ip()
+#==============================================================================#
+
+# Provide the next IP following the last available IP within this 
+# CIDR object. 
+#
+# - Arguments:
+#   * Optional Hash with the following fields:
+#       - :Bitstep -- step in X sized steps (optional)
+#       - :Objectify -- return IPAdmin::CIDR object (optional)
+#
+# - Returns:
+#   * IP address or IPAdmin::CIDR object.
+#
+# Example:
+#   puts cidr.next_ip()
+#
+    def next_ip(options=nil)
+        bitstep = 1
+        objectify = nil
+        
+        if (options)
+            unless(options.kind_of?(Hash))
+                raise Argumenterror, "Expected Hash, but " +
+                                     "#{options.class} provided."
+            end
+            bitstep = options[:Bitstep] if (options.has_key?(:Bitstep))
+            objectify = options[:Objectify] if (options.has_key?(:Objectify) &&
+                                                options[:Objectify] != nil)
+        end
+        
+        next_ip = @network + @hostmask + bitstep
+        
+        unless (next_ip <= @all_f)
+            raise "Returned IP is out of bounds for IPv#{@version}."
+        end
+
+        next_ip = IPAdmin.unpack_ipv4_addr(next_ip) if (@version == 4)
+        next_ip = IPAdmin.unpack_ipv6_addr(next_ip) if (@version == 6)
+        if (objectify)
+            next_ip = IPAdmin::CIDR.new(:CIDR => next_ip)
+        end
+        
+        return(next_ip)
+    end
+
+#======================================#
+#
+#======================================#
+
+
+#==============================================================================#
+# next_subnet()
+#==============================================================================#
+
+# Provide the next subnet following this CIDR object. The next subnet will
+# be of the same size as the current CIDR object. 
+#
+# - Arguments:
+#   * Optional Hash with the following fields:
+#       - :Bitstep -- step in X sized steps. (optional)
+#       - :Objectify -- return IPAdmin::CIDR object (optional)
+#
+# - Returns:
+#   * CIDR address or IPAdmin::CIDR object.
+#
+# Example:
+#   puts cidr.next_subnet()
+#
+    def next_subnet(options=nil)
+        bitstep = 1
+        objectify = nil
+        
+        if (options)
+            unless(options.kind_of?(Hash))
+                raise Argumenterror, "Expected Hash, but " +
+                                     "#{options.class} provided."
+            end
+            bitstep = options[:Bitstep] if (options.has_key?(:Bitstep))
+            objectify = options[:Objectify] if (options.has_key?(:Objectify) &&
+                                                options[:Objectify] != nil)
+        end
+        
+        maxbits = 32 if (@version == 4)
+        maxbits = 128 if (@version ==6)
+        bitstep = bitstep * (2**(maxbits - self.bits) )
+        next_sub = @network + bitstep
+        
+        unless (next_sub <= @all_f)
+            raise "Returned subnet is out of bounds for IPv#{@version}."
+        end
+
+        next_sub = IPAdmin.unpack_ipv4_addr(next_sub) if (@version == 4)
+        next_sub = IPAdmin.unpack_ipv6_addr(next_sub) if (@version == 6)
+        next_sub = next_sub << "/" << self.bits.to_s
+        
+        if (objectify)
+            next_sub = IPAdmin::CIDR.new(:CIDR => next_sub)
+        end
+        
+        return(next_sub)
+    end
+
+#======================================#
+#
+#======================================#
+
+
 
 #============================================================================#
 # nth()
@@ -1940,7 +2136,6 @@ class CIDR
 #=====================================#
 
 
-
 #============================================================================#
 # size()
 #============================================================================#
@@ -2131,7 +2326,6 @@ class CIDRTable
 #
     def initialize(version)
         
-        puts "DEPRICATED, DO NOT USE - this will be removed in future releases."
         unless ( version.kind_of? Fixnum )
             raise ArgumentError, "Expected Fixnum, but #{version.class} provided."
         end
@@ -2472,8 +2666,8 @@ end
 #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++#
 
 =begin rdoc
-A class & series of methods for creating and manipulating IP
-addresses. Both IPv4 and IPv6 are supported.
+ DEPRICATED, DO NOT USE - this will be removed in future releases, and all
+ functionality moved to IPAdmin::CIDR
 =end
 
 class IPAddr

data/tests/cidr_test.rb

@@ -29,9 +29,13 @@ class TestCIDR < Test::Unit::TestCase
         assert_equal(1,cidr4.contains(cidr4_2) )
         assert_equal(1,cidr6.contains(cidr6_2) )
         
+        assert_equal('192.168.1.255',cidr4.last() )
+        
         assert_equal('192.168.1.0/24',cidr4.desc() )
         assert_equal('fec0:0000:0000:0000:0000:0000:0000:0000/64',cidr6.desc() )
         
+        assert_equal('fec0::/64',cidr6.desc_short() )
+        
         assert_equal('0.0.0.255',cidr4.hostmask_ext() )        
         
         assert_equal(24,cidr4.bits() )

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: ipadmin
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2006-02-10 00:00:00 -06:00
+  version: 0.1.3.1
+date: 2006-02-15 00:00:00 -06:00
 summary: A package for manipulating IPv4/IPv6 address space.
 require_paths: 
   - lib