ipaddress 0.8.0 → 0.8.2

data/Rakefile

@@ -1,25 +1,8 @@
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
+require "bundler/gem_tasks"
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "ipaddress"
-    gem.summary = %Q{IPv4/IPv6 addresses manipulation library}
-    gem.email = "ceresa@gmail.com"
-    gem.homepage = "http://github.com/bluemonk/ipaddress"
-    gem.authors = ["Marco Ceresa"]
-    gem.description   = <<-EOD
-      IPAddress is a Ruby library designed to make manipulation 
-      of IPv4 and IPv6 addresses both powerful and simple. It mantains
-      a layer of compatibility with Ruby's own IPAddr, while 
-      addressing many of its issues.
-    EOD
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -44,7 +27,7 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION.yml')
     config = YAML.load(File.read('VERSION.yml'))

data/ipaddress.gemspec

@@ -1,55 +1,26 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ipaddress/version'
 
-Gem::Specification.new do |s|
-  s.name = %q{ipaddress}
-  s.version = "0.8.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Marco Ceresa"]
-  s.date = %q{2011-05-17}
-  s.description = %q{      IPAddress is a Ruby library designed to make manipulation 
+Gem::Specification.new do |spec|
+  spec.name          = "ipaddress"
+  spec.version       = Ipaddress::VERSION
+  spec.authors       = ["bluemonk", "mikemackintosh"]
+  spec.email         = ["ceresa@gmail.com"]
+  spec.summary       = %q{IPv4/IPv6 address manipulation library}
+  spec.description   = %q{IPAddress is a Ruby library designed to make manipulation 
       of IPv4 and IPv6 addresses both powerful and simple. It mantains
       a layer of compatibility with Ruby's own IPAddr, while 
-      addressing many of its issues.
-}
-  s.email = %q{ceresa@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "CHANGELOG.rdoc",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "ipaddress.gemspec",
-    "lib/ipaddress.rb",
-    "lib/ipaddress/ipv4.rb",
-    "lib/ipaddress/ipv6.rb",
-    "lib/ipaddress/prefix.rb",
-    "test/ipaddress/ipv4_test.rb",
-    "test/ipaddress/ipv6_test.rb",
-    "test/ipaddress/prefix_test.rb",
-    "test/ipaddress_test.rb",
-    "test/test_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/bluemonk/ipaddress}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{IPv4/IPv6 addresses manipulation library}
+      addressing many of its issues.}
+  spec.homepage      = "https://github.com/bluemonk/ipaddress"
+  spec.license       = "MIT"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  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"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end
-

data/lib/ipaddress.rb

@@ -14,6 +14,7 @@
 
 require 'ipaddress/ipv4'
 require 'ipaddress/ipv6'
+require 'ipaddress/mongoid' if defined?(Mongoid)
 
 module IPAddress
 
@@ -25,6 +26,7 @@ module IPAddress
   # Parse the argument string to create a new
   # IPv4, IPv6 or Mapped IP object
   #
+  #   ip  = IPAddress.parse 167837953 # 10.1.1.1  
   #   ip  = IPAddress.parse "172.16.10.1/24"
   #   ip6 = IPAddress.parse "2001:db8::8:800:200c:417a/64"
   #   ip_mapped = IPAddress.parse "::ffff:172.16.10.1/128"
@@ -40,14 +42,42 @@ module IPAddress
   #    #=> IPAddress::IPv6::Mapped
   #
   def IPAddress::parse(str)
+    
+    # Check if an int was passed
+    if str.kind_of? Integer
+      return IPAddress::IPv4.new(ntoa(str))  
+    end
+
     case str
     when /:.+\./
       IPAddress::IPv6::Mapped.new(str)
+    when /\./
+      IPAddress::IPv4.new(str) 
+    when /:/
+      IPAddress::IPv6.new(str)
     else
-      IPAddress::IPv4.new(str) rescue IPAddress::IPv6.new(str)
+      raise ArgumentError, "Unknown IP Address #{str}"
     end
   end
 
+  #
+  # Converts a unit32 to IPv4
+  #
+  #   IPAddress::ntoa(167837953)
+  #     #-> "10.1.1.1"
+  #
+  def self.ntoa(uint)
+    unless(uint.is_a? Numeric and uint <= 0xffffffff and uint >= 0)
+        raise(::ArgumentError, "not a long integer: #{uint.inspect}")
+      end
+      ret = []
+      4.times do 
+        ret.unshift(uint & 0xff)
+        uint >>= 8
+      end
+      ret.join('.')
+  end
+
   #
   # True if the object is an IPv4 address
   #
@@ -131,15 +161,10 @@ module IPAddress
   #   IPAddress::valid_ipv6? "2002::DEAD::BEEF"
   #     #=> false
   #
-  def self.valid_ipv6?(addr)
-    # IPv6 (normal)
-    return true if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*\Z/ =~ addr
-    return true if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*)?\Z/ =~ addr
-    return true if /\A::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*)?\Z/ =~ addr
-    # IPv6 (IPv4 compat)
-    return true if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:/ =~ addr && valid_ipv4?($')
-    return true if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:)?/ =~ addr && valid_ipv4?($')
-    return true if /\A::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:)?/ =~ addr && valid_ipv4?($')
+  def self.valid_ipv6?(addr) 
+    # https://gist.github.com/cpetschnig/294476
+    # http://forums.intermapper.com/viewtopic.php?t=452
+    return true if /^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/ =~ addr
     false
   end
 

data/lib/ipaddress/ipv4.rb

@@ -230,6 +230,21 @@ module IPAddress;
     alias_method :to_i, :u32
     alias_method :to_u32, :u32
     
+    #
+    # Returns the address portion in 
+    # hex
+    #
+    #   ip = IPAddress("10.0.0.0")
+    #
+    #   ip.to_h
+    #     #=> 0a000000
+    #
+    def hex(space=true)
+      "%.4x%.4x" % [to_u32].pack("N").unpack("nn")
+    end
+    alias_method :to_h, :hex
+    alias_method :to_hex, :hex   
+
     #
     # Returns the address portion of an IPv4 object
     # in a network byte order format.
@@ -271,6 +286,21 @@ module IPAddress;
       @octets[index]
     end
     alias_method :octet, :[]
+
+    #
+    # Updated the octet specified at index
+    #
+    #   ip = IPAddress("172.16.100.50/24")
+    #   ip[2] = 200
+    #
+    #   #=>  #<IPAddress::IPv4:0x00000000000000 @address="172.16.200.1", 
+    #   #=>       @prefix=32, @octets=[172, 16, 200, 1], @u32=2886780929>
+    #
+    def []=(index, value)
+      @octets[index] = value.to_i
+      initialize("#{@octets.join('.')}/#{prefix}")
+    end
+    alias_method :octet=, :[]=
     
     #
     # Returns the address portion of an IP in binary format,
@@ -294,7 +324,14 @@ module IPAddress;
     #     #=> "172.16.10.255"
     #
     def broadcast
-      self.class.parse_u32(broadcast_u32, @prefix)
+      case
+      when prefix <= 30
+        self.class.parse_u32(broadcast_u32, @prefix)
+      when prefix == 31
+        self.class.parse_u32(-1, @prefix)
+      when prefix == 32
+        return self
+      end
     end
     
     #
@@ -311,7 +348,7 @@ module IPAddress;
     #     #=> true
     #
     def network?
-      @u32 | @prefix.to_u32 == @prefix.to_u32
+      (@prefix < 32) && (@u32 | @prefix.to_u32 == @prefix.to_u32)
     end
 
     #
@@ -348,7 +385,14 @@ module IPAddress;
     #     #=> "192.168.100.1"
     #
     def first
-      self.class.parse_u32(network_u32+1, @prefix)
+      case
+      when prefix <= 30
+        self.class.parse_u32(network_u32+1, @prefix)
+      when prefix == 31
+        self.class.parse_u32(network_u32, @prefix)
+      when prefix == 32
+        return self
+      end
     end
 
     #
@@ -373,7 +417,14 @@ module IPAddress;
     #     #=> "192.168.100.254"
     #
     def last
-      self.class.parse_u32(broadcast_u32-1, @prefix)
+      case
+      when prefix <= 30
+        self.class.parse_u32(broadcast_u32-1, @prefix)
+      when prefix == 31
+        self.class.parse_u32(broadcast_u32, @prefix)
+      when prefix == 32
+        return self
+      end
     end
 
     #
@@ -569,6 +620,48 @@ module IPAddress;
        self.class.new("192.168.0.0/16")].any? {|i| i.include? self}
     end
 
+    #
+    # Checks if an IPv4 address objects belongs
+    # to a multicast network RFC3171
+    #
+    # Example:
+    #
+    #   ip = IPAddress "224.0.0.0/4"
+    #   ip.multicast?
+    #     #=> true
+    #    
+    def multicast?
+      [self.class.new("224.0.0.0/4")].any? {|i| i.include? self}
+    end
+
+    #
+    # Checks if an IPv4 address objects belongs
+    # to a multicast network RFC3171
+    #
+    # Example:
+    #
+    #   ip = IPAddress "224.0.0.0/4"
+    #   ip.multicast?
+    #     #=> true
+    #    
+    def multicast?
+      [self.class.new("224.0.0.0/4")].any? {|i| i.include? self}
+    end
+
+    #
+    # Checks if an IPv4 address objects belongs
+    # to a loopback network RFC1122
+    #
+    # Example:
+    #
+    #   ip = IPAddress "127.0.0.1"
+    #   ip.loopback?
+    #     #=> true
+    #    
+    def loopback?
+      [self.class.new("127.0.0.0/8")].any? {|i| i.include? self}
+    end
+
     #
     # Returns the IP address in in-addr.arpa format
     # for DNS lookups
@@ -583,6 +676,26 @@ module IPAddress;
     end
     alias_method :arpa, :reverse
     
+    #
+    # Return a list of IP's between @address
+    # and the supplied IP
+    #
+    #   ip = IPAddress("172.16.100.51/32")
+    #
+    #   ip.to("172.16.100.100")
+    #     #=> ["172.16.100.51",
+    #     #=>  "172.16.100.52",
+    #     #=>  ...
+    #     #=>  "172.16.100.99",
+    #     #=>  "172.16.100.100"]
+    #
+    def to(e)
+      unless e.is_a? IPAddress::IPv4
+        e = IPv4.new(e)
+      end
+
+      Range.new(@u32, e.to_u32).map{|i| IPAddress.ntoa(i) }
+    end
     #
     # Splits a network into different subnets
     #
@@ -598,9 +711,9 @@ module IPAddress;
     #
     #   network / 4   # implies map{|i| i.to_string}
     #     #=> ["172.16.10.0/26",
-    #          "172.16.10.64/26",
-    #          "172.16.10.128/26",
-    #          "172.16.10.192/26"]
+    #     #=>  "172.16.10.64/26",
+    #     #=>  "172.16.10.128/26",
+    #     #=>  "172.16.10.192/26"]
     #
     # If +num+ is any other number, the supernet will be 
     # divided into some networks with a even number of hosts and
@@ -610,8 +723,8 @@ module IPAddress;
     #
     #   network / 3   # implies map{|i| i.to_string}
     #     #=> ["172.16.10.0/26",
-    #          "172.16.10.64/26",
-    #          "172.16.10.128/25"]
+    #     #=>  "172.16.10.64/26",
+    #     #=>  "172.16.10.128/25"]
     #
     # Returns an array of IPv4 objects
     #
@@ -969,12 +1082,9 @@ module IPAddress;
     #
     private
 
+    # Tweaked to remove the #upto(32)
     def newprefix(num)
-      num.upto(32) do |i|
-        if (a = Math::log2(i).to_i) == Math::log2(i)
-          return @prefix + a 
-        end
-      end
+      return @prefix + (Math::log2(num).ceil )
     end
     
     def sum_first_found(arr)

data/lib/ipaddress/ipv6.rb

@@ -252,6 +252,15 @@ module IPAddress;
     end
     alias_method :group, :[]
 
+    #
+    # Updated the octet specified at index
+    #
+    def []=(index, value)
+      @groups[index] = value
+      initialize("#{IN6FORMAT % @groups}/#{prefix}")
+    end
+    alias_method :group=, :[]=
+
     # 
     # Returns a Base16 number representing the IPv6 
     # address

data/lib/ipaddress/mongoid.rb

@@ -0,0 +1,75 @@
+module IPAddress
+
+  #
+  # Mongoid field serialization
+  #
+  # IPAddress objects are converted to String
+  #
+  #   IPAddress.mongoize IPAddress.parse("172.16.10.1")
+  #     #=> "172.16.10.1"
+  #
+  # Prefix will be removed from host adresses
+  #
+  #   IPAddress.mongoize "172.16.10.1/32"
+  #     #=> "172.16.10.1"
+  #
+  # Prefix will be kept for network addresses
+  #
+  #   IPAddress.mongoize "172.16.10.1/24"
+  #     #=> "172.16.10.1/24"
+  #
+  # IPv6 addresses will be stored uncompressed to ease DB search and sorting
+  #
+  #   IPAddress.mongoize "2001:db8::8:800:200c:417a"
+  #     #=> "2001:0db8:0000:0000:0008:0800:200c:417a"
+  #   IPAddress.mongoize "2001:db8::8:800:200c:417a/64"
+  #     #=> "2001:0db8:0000:0000:0008:0800:200c:417a/64"
+  #
+  # Invalid addresses will be serialized as nil
+  #
+  #   IPAddress.mongoize "invalid"
+  #     #=> nil
+  #   IPAddress.mongoize ""
+  #     #=> nil
+  #   IPAddress.mongoize 1
+  #     #=> nil
+  #   IPAddress.mongoize nil
+  #     #=> nil
+  #
+  def self.mongoize(ipaddress)
+    ipaddress = self.parse(ipaddress) unless ipaddress.is_a?(IPAddress)
+    if ipaddress.bits.length == ipaddress.prefix
+      ipaddress.address
+    elsif ipaddress.is_a?(IPAddress::IPv6)
+      ipaddress.to_string_uncompressed
+    else
+      ipaddress.to_string
+    end
+  rescue ArgumentError
+    nil
+  end
+
+  #
+  # Mongoid field deserialization
+  #
+  def self.demongoize(string)
+    parse(string)
+  rescue ArgumentError
+    nil
+  end
+
+  #
+  # Delegates to IPAddress.mongoize
+  #
+  def self.evolve(ipaddress)
+    mongoize(ipaddress)
+  end
+
+  #
+  # Sends self object to IPAddress#mongoize
+  #
+  def mongoize
+    IPAddress.mongoize(self)
+  end
+
+end