ipadmin 0.4.0 → 0.4.1

data/lib/eui.rb

@@ -13,7 +13,7 @@ class EUI
 #==============================================================================#
 
 # - Arguments:
-#   * EUI as a string, or a Hash with the following fields:
+#   * EUI as a String, or a Hash with the following fields:
 #       - :EUI -- Extended Unique Identifier - String
 #       - :PackedEUI -- Integer representing an Extended Unique Identifier (optional)
 #
@@ -74,11 +74,6 @@ class EUI
         end
     end
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # address()
 #==============================================================================#
@@ -86,7 +81,7 @@ class EUI
 # Returns EUI address.
 #
 # - Arguments:
-#   * Optional hash with the following fields:
+#   * Optional Hash with the following fields:
 #       - :Delimiter -- delimitation character. valid values are (-,:,and .) (optional)
 #
 # - Returns:
@@ -138,11 +133,6 @@ class EUI
         return(address)
     end
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # ei()
 #==============================================================================#
@@ -150,7 +140,7 @@ class EUI
 # Returns Extended Identifier portion of an EUI address (the vendor assigned ID).
 #
 # - Arguments:
-#   * Optional hash with the following fields:
+#   * Optional Hash with the following fields:
 #       - :Delimiter -- delimitation character. valid values are (-, and :) (optional)
 #
 # - Returns:
@@ -182,11 +172,6 @@ class EUI
         return(ei)
     end
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # link_local()
 #==============================================================================#
@@ -194,7 +179,7 @@ class EUI
 # Provide an IPv6 Link Local address based on the current EUI address.
 #
 # - Arguments:
-#   * Optional hash with the following fields:
+#   * Optional Hash with the following fields:
 #       - :Short -- if true, return IPv6 addresses in short-hand notation (optional)
 #       - :Objectify -- if true, return CIDR objects (optional)
 #
@@ -240,11 +225,6 @@ class EUI
         return(link_local)
     end
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # oui()
 #==============================================================================#
@@ -252,7 +232,7 @@ class EUI
 # Returns Organizationally Unique Identifier portion of an EUI address (the vendor ID).
 #
 # - Arguments:
-#   * Optional hash with the following fields:
+#   * Optional Hash with the following fields:
 #       - :Delimiter -- delimitation character. valid values are (-, and :) (optional)
 #
 # - Returns:
@@ -284,11 +264,6 @@ class EUI
         return(oui)
     end
 
-#======================================#
-#
-#======================================#
-
-
 
 # PRIVATE METHODS
 private
@@ -317,11 +292,6 @@ private
         return(octets)
     end
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # unpack_oui()
 #==============================================================================#
@@ -338,11 +308,7 @@ private
         return(octets)
     end
 
-#======================================#
-#
-#======================================#
-
-end
+end # class EUI
 
 # EUI-48 Address - Inherits all methods from IPAdmin::EUI. 
 # Addresses of this type have a 24-bit OUI and a 24-bit EI.

data/lib/methods.rb

@@ -8,7 +8,7 @@ module IPAdmin
 # is the supernet of the other.
 #
 # - Arguments:
-#   * (2) CIDR addresses or IPAdmin::CIDR objects
+#   * (2) Strings, or (2) IPAdmin::CIDR objects
 #
 # - Returns:
 #   * if one is a subnet of another, then return original array in order of [supernet,subnet]
@@ -16,8 +16,10 @@ module IPAdmin
 #   * if neither is a supernet of the other, return nil
 #
 # Examples:
-#   supernet,subnet = IPAdmin.compare(cidr1,cidr2)
-#   supernet,subnet = IPAdmin.compare('192.168.1.0/24','192.168.1.32/27')
+#   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}"
+#   puts "#{(comp2[0]).desc} is the supernet of #{(comp2[1]).desc}"
 #
 
 def compare(cidr1,cidr2)
@@ -80,11 +82,6 @@ def compare(cidr1,cidr2)
 end
 module_function :compare
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # merge()
 #==============================================================================#
@@ -97,7 +94,7 @@ module_function :compare
 # 192.168.0.0/23 and 192.168.2.0/24 rather than into 192.168.0.0/22 
 #
 # - Arguments:
-#   * Array of CIDR addresses or IPAdmin::CIDR objects, or a Hash with 
+#   * Array of Strings, Array of IPAdmin::CIDR objects, or a Hash with 
 #     the following fields:
 #       - :List -- Array of CIDR addresses or IPAdmin::CIDR objects
 #       - :Objectify -- if true, return IPAdmin::CIDR objects (optional)
@@ -108,7 +105,7 @@ module_function :compare
 #
 # - Notes:
 #   * I have designed this with enough flexibility that you can pass in CIDR 
-#     addresses that arent even related (ex. 192.168.1.0/26, 192.168.1.64/26,
+#     addresses that arent even related (ex. 192.168.1.0/26, 192.168.1.64/27, 192.168.1.96/27
 #     10.1.0.0/26, 10.1.0.64/26) and they will be merged properly (ie 192.168.1.0/25,
 #     and 10.1.0.0/25 would be returned).
 #
@@ -264,11 +261,6 @@ def merge(options)
 end
 module_function :merge
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # minimum_size()
 #==============================================================================#
@@ -277,7 +269,7 @@ module_function :merge
 # netmask (in bits) required for that subnet.
 #
 # - Arguments:
-#   * Integer or Hash with the following fields:
+#   * Integer or a Hash with the following fields:
 #       - :IPCount -- the number of IP addresses required - Integer
 #       - :Version -- IP version - Integer(optional)
 #
@@ -332,16 +324,11 @@ def minimum_size(options)
 end
 module_function :minimum_size
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # pack_ip_addr()
 #==============================================================================#
 
-# Convert IP addresses into an integer.
+# Convert IP addresses into an Integer.
 #
 # - Arguments:
 #   * IP address as a String, or a Hash with the following fields:
@@ -462,21 +449,16 @@ def pack_ip_addr(options)
 end
 module_function :pack_ip_addr
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # pack_ip_netmask()
 #==============================================================================#
 
-# Convert IP netmask into an integer.Netmask may be in either CIDR (/yy) or
+# Convert IP netmask into an Integer. Netmask may be in either CIDR (/yy) or
 # extended (y.y.y.y) format. CIDR formatted netmasks may either
 # be a String or an Integer.
 #
 # - Arguments
-#   * Netmask as a String, or a Integer, or a Hash with the following fields:
+#   * String or Integer, or a Hash with the following fields:
 #       - :Netmask -- Netmask - String or Integer
 #       - :Version -- IP version - Integer (optional)
 #
@@ -484,7 +466,8 @@ module_function :pack_ip_addr
 #   * Integer
 #
 # - Notes:
-#   * Version defaults to 4
+#   * Version defaults to 4. It may be necessary to specify the version if
+#     an IPv6 netmask of /32 or smaller were passed.
 #
 # Examples:
 #   packed = IPAdmin.pack_ip_netmask('255.255.255.0')
@@ -552,11 +535,6 @@ def pack_ip_netmask(options)
 end
 module_function :pack_ip_netmask
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # range()
 #==============================================================================#
@@ -565,17 +543,17 @@ module_function :pack_ip_netmask
 # return all IP addresses between them.
 #
 # - Arguments:
-#   * Array of (2)CIDR addresses or IPAdmin::CIDR objects, or a Hash
+#   * Array of (2) Strings, Array of (2) IPAdmin::CIDR objects, or a Hash
 #     with the following fields:
 #       - :Bitstep -- enumerate in X sized steps - Integer (optional)
-#       - :Boundaries -- array of (2) CIDR addresses or IPAdmin::CIDR objects
+#       - :Boundaries -- Array of (2) Strings, or Array of (2) IPAdmin::CIDR objects
 #       - :Inclusive -- if true, include boundaries in returned data
 #       - :Limit -- limit returned list to X number of items - Integer (optional)
 #       - :Objectify -- if true, return CIDR objects (optional)
 #       - :Short -- if true, return IPv6 addresses in short-hand notation (optional)
 #
 # - Returns:
-#   * Array of CIDR address Strings or IPAdmin::CIDR objects
+#   * Array of Strings, or Array of IPAdmin::CIDR objects
 #
 # - Notes:
 #   * IPAdmin.range will use the original IP address passed during the initialization
@@ -691,11 +669,6 @@ def range(options)
 end
 module_function :range
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # shorten()
 #==============================================================================#
@@ -704,7 +677,7 @@ module_function :range
 # The address should not contain a netmask.
 #
 # - Arguments:
-#   * IP address as a String
+#   * String
 #
 # - Returns:
 #   * String
@@ -787,11 +760,6 @@ def shorten(addr)
 end
 module_function :shorten
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # sort()
 #==============================================================================#
@@ -800,10 +768,10 @@ module_function :shorten
 # sort them from lowest to highest by Network/Netmask.
 #
 # - Arguments:
-#   * Array of CIDR addresses or IPAdmin::CIDR objects
+#   * Array of Strings, or Array of IPAdmin::CIDR objects
 #
 # - Returns:
-#   * Array of CIDR address Strings or IPAdmin::CIDR objects
+#   * Array of Strings, or Array of IPAdmin::CIDR objects
 #
 # - Notes:
 #   * IPAdmin.sort will use the original IP address passed during the initialization
@@ -811,7 +779,7 @@ module_function :shorten
 #
 # Examples:
 #   sorted = IPAdmin.sort([cidr1,cidr2])
-#   sorted = IPAdmin.sort(['192.168.1.32/27','192.168.1.0/27'])
+#   sorted = IPAdmin.sort(['192.168.1.32/27','192.168.1.0/27','192.168.2.0/24'])
 #
 def sort(list)
 
@@ -868,11 +836,6 @@ def sort(list)
 end
 module_function :sort
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # unpack_ip_addr()
 #==============================================================================#
@@ -880,7 +843,7 @@ module_function :sort
 # Unack a packed IP address back into a printable string.
 #
 # - Arguments:
-#   * Integer or a Hash with the following fields:
+#   * Integer, or a Hash with the following fields:
 #       - :Integer -- Integer representaion of an IP address
 #       - :Version -- IP version - Integer (optional)
 #       - :IPv4Mapped -- if true, unpack IPv6 as an IPv4 mapped address (optional)
@@ -978,20 +941,15 @@ def unpack_ip_addr(options)
 end
 module_function :unpack_ip_addr 
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # unpack_ip_netmask()
 #==============================================================================#
 
-# Unack a packed IP netmask into a integer representing the number of
+# Unpack a packed IP netmask into an Integer representing the number of
 # bits in the CIDR mask.
 #
 # - Arguments:
-#   * Integer or a Hash with the following fields:
+#   * Integer, or a Hash with the following fields:
 #       - :Integer -- Integer representation of an IP Netmask
 #
 # - Returns:
@@ -1042,11 +1000,6 @@ def unpack_ip_netmask(options)
 end
 module_function :unpack_ip_netmask 
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # unshorten()
 #==============================================================================#
@@ -1055,7 +1008,7 @@ module_function :unpack_ip_netmask
 # notation. The address should not contain a netmask.
 #
 # - Arguments:
-#   * IP address as a String
+#   * String
 #
 # - Returns:
 #   * String
@@ -1084,11 +1037,6 @@ def unshorten(addr)
 end
 module_function :unshorten
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # validate_eui()
 #==============================================================================#
@@ -1096,7 +1044,7 @@ module_function :unshorten
 # Validate an EUI-48 or EUI-64 address. 
 #
 # - Arguments
-#   * EUI address as a String, or a Hash with the following fields:
+#   * String, or a Hash with the following fields:
 #       - :EUI -- Address to validate - String
 #
 # - Returns:
@@ -1151,11 +1099,6 @@ def validate_eui(options)
 end
 module_function :validate_eui
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # validate_ip_addr()
 #==============================================================================#
@@ -1163,7 +1106,7 @@ module_function :validate_eui
 # Validate an IP address. The address should not contain a netmask.
 #
 # - Arguments
-#   * IP address as a String or Integer, or a Hash with the following fields:
+#   * String or Integer, or a Hash with the following fields:
 #       - :IP -- IP address to validate - String or Integer
 #       - :Version -- IP version - Integer (optional)
 #
@@ -1318,11 +1261,6 @@ def validate_ip_addr(options)
 end
 module_function :validate_ip_addr
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # validate_ip_netmask()
 #==============================================================================#
@@ -1330,7 +1268,7 @@ module_function :validate_ip_addr
 # Validate IP Netmask.
 #
 # - Arguments:
-#   * Netmask as a String or Integer, or a Hash with the following fields:
+#   * String or Integer, or a Hash with the following fields:
 #       - :Netmask -- Netmask to validate - String or Integer
 #       - :Packed -- if true, the provided Netmask is a packed Integer
 #       - :Version -- IP version - Integer (optional)
@@ -1450,11 +1388,6 @@ def validate_ip_netmask(options)
 end
 module_function :validate_ip_netmask
 
-#======================================#
-#
-#======================================#
-
-
 #==============================================================================#
 # NetStruct
 #==============================================================================#
@@ -1469,11 +1402,7 @@ module_function :validate_ip_netmask
 #
 NetStruct = Struct.new(:cidr, :parent, :children)
 
-#======================================#
-#
-#======================================#
-
+end # module IPAdmin
 
-end
 __END__