construqt-ipaddress 0.8.1

data/Rakefile

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+
+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|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ipaddress #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r ipaddress.rb"
+end
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  def egrep(pattern)
+    Dir['**/*.rb'].each do |fn|
+      count = 0
+      open(fn) do |f|
+        while line = f.gets
+          count += 1
+          if line =~ pattern
+            puts "#{fn}:#{count}:#{line}"
+          end
+        end
+      end
+    end
+  end
+  egrep /(FIXME|TODO|TBD)/
+end

data/VERSION

@@ -0,0 +1 @@
+0.8.0

data/ipaddress.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{construqt-ipaddress}
+  s.version = "0.8.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marco Ceresa", "Meno Abels"]
+  s.date = %q{2014-11-29}
+  s.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{meno.abels@construqt.me}
+  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}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/ipaddress.rb

@@ -0,0 +1,306 @@
+#
+# = IPAddress
+#
+# A ruby library to manipulate IPv4 and IPv6 addresses
+#
+#
+# Package::     IPAddress
+# Author::      Marco Ceresa <ceresa@ieee.org>
+# License::     Ruby License
+#
+#--
+#
+#++
+
+require 'ipaddress/ipv4'
+require 'ipaddress/ipv6'
+
+module IPAddress
+
+  NAME            = "IPAddress"
+  GEM             = "ipaddress"
+  AUTHORS         = ["Marco Ceresa <ceresa@ieee.org>"]
+
+  #
+  # Parse the argument string to create a new
+  # IPv4, IPv6 or Mapped IP object
+  #
+  #   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"
+  #
+  # All the object created will be instances of the
+  # correct class:
+  #
+  #  ip.class
+  #    #=> IPAddress::IPv4
+  #  ip6.class
+  #    #=> IPAddress::IPv6
+  #  ip_mapped.class
+  #    #=> IPAddress::IPv6::Mapped
+  #
+  def IPAddress::parse(str)
+    case str
+    when /:.+\./
+      IPAddress::IPv6::Mapped.new(str)
+    when /\./
+      IPAddress::IPv4.new(str)
+    when /:/
+      IPAddress::IPv6.new(str)
+    else
+      raise ArgumentError, "Unknown IP Address #{str}"
+    end
+  end
+
+  #
+  # True if the object is an IPv4 address
+  #
+  #   ip = IPAddress("192.168.10.100/24")
+  #
+  #   ip.ipv4?
+  #     #-> true
+  #
+  def ipv4?
+    self.kind_of? IPAddress::IPv4
+  end
+
+  #
+  # True if the object is an IPv6 address
+  #
+  #   ip = IPAddress("192.168.10.100/24")
+  #
+  #   ip.ipv6?
+  #     #-> false
+  #
+  def ipv6?
+    self.kind_of? IPAddress::IPv6
+  end
+
+  #
+  # Checks if the given string is a valid IP address,
+  # either IPv4 or IPv6
+  #
+  # Example:
+  #
+  #   IPAddress::valid? "2002::1"
+  #     #=> true
+  #
+  #   IPAddress::valid? "10.0.0.256"
+  #     #=> false
+  #
+  def self.valid?(addr)
+    valid_ipv4?(addr) || valid_ipv6?(addr)
+  end
+
+  #
+  # Checks if the given string is a valid IPv4 address
+  #
+  # Example:
+  #
+  #   IPAddress::valid_ipv4? "2002::1"
+  #     #=> false
+  #
+  #   IPAddress::valid_ipv4? "172.16.10.1"
+  #     #=> true
+  #
+  def self.valid_ipv4?(addr)
+    if /\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/ =~ addr
+      return $~.captures.all? {|i| i.to_i < 256}
+    end
+    false
+  end
+
+  #
+  # Checks if the argument is a valid IPv4 netmask
+  # expressed in dotted decimal format.
+  #
+  #   IPAddress.valid_ipv4_netmask? "255.255.0.0"
+  #     #=> true
+  #
+  def self.valid_ipv4_netmask?(addr)
+    arr = addr.split(".").map{|i| i.to_i}.pack("CCCC").unpack("B*").first.scan(/01/)
+    arr.empty? && valid_ipv4?(addr)
+  rescue
+    return false
+  end
+
+  #
+  # Checks if the given string is a valid IPv6 address
+  #
+  # Example:
+  #
+  #   IPAddress::valid_ipv6? "2002::1"
+  #     #=> true
+  #
+  #   IPAddress::valid_ipv6? "2002::DEAD::BEEF"
+  #     #=> false
+  #
+  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
+
+  #
+  # Deprecate method
+  #
+  def self.deprecate(message = nil) # :nodoc:
+    message ||= "You are using deprecated behavior which will be removed from the next major or minor release."
+    warn("DEPRECATION WARNING: #{message}")
+  end
+
+  #
+  # private helper for summarize
+  # assumes that networks is output from reduce_networks
+  # means it should be sorted lowers first and uniq
+  #
+  def self.aggregate(networks)
+    stack = networks.map{|i| i.network }.sort! # make input imutable
+    pos = 0
+    while true
+      pos = pos < 0 ? 0 : pos # start @beginning
+      first = stack[pos]
+      unless first
+        break
+      end
+      pos += 1
+      second = stack[pos]
+      unless second
+        break
+      end
+      pos += 1
+      if first.include?(second)
+        pos -= 2
+        stack.delete_at(pos+1)
+      else
+        first.prefix -= 1
+        if first.prefix+1 == second.prefix && first.include?(second)
+          pos -= 2
+          stack[pos] = first
+          stack.delete_at(pos+1)
+          pos -= 1 # backtrack
+        else
+          first.prefix += 1 #reset prefix
+          pos -= 1 # do it with second as first
+        end
+      end
+    end
+    stack[0..pos-1]
+  end
+
+  #
+  # Summarization (or aggregation) is the process when two or more
+  # networks are taken together to check if a supernet, including all
+  # and only these networks, exists. If it exists then this supernet
+  # is called the summarized (or aggregated) network.
+  #
+  # It is very important to understand that summarization can only
+  # occur if there are no holes in the aggregated network, or, in other
+  # words, if the given networks fill completely the address space
+  # of the supernet. So the two rules are:
+  #
+  # 1) The aggregate network must contain +all+ the IP addresses of the
+  #    original networks;
+  # 2) The aggregate network must contain +only+ the IP addresses of the
+  #    original networks;
+  #
+  # A few examples will help clarify the above. Let's consider for
+  # instance the following two networks:
+  #
+  #   ip1 = IPAddress("172.16.10.0/24")
+  #   ip2 = IPAddress("172.16.11.0/24")
+  #
+  # These two networks can be expressed using only one IP address
+  # network if we change the prefix. Let Ruby do the work:
+  #
+  #   IPAddress::IPv4::summarize(ip1,ip2).to_s
+  #     #=> "172.16.10.0/23"
+  #
+  # We note how the network "172.16.10.0/23" includes all the addresses
+  # specified in the above networks, and (more important) includes
+  # ONLY those addresses.
+  #
+  # If we summarized +ip1+ and +ip2+ with the following network:
+  #
+  #   "172.16.0.0/16"
+  #
+  # we would have satisfied rule #1 above, but not rule #2. So "172.16.0.0/16"
+  # is not an aggregate network for +ip1+ and +ip2+.
+  #
+  # If it's not possible to compute a single aggregated network for all the
+  # original networks, the method returns an array with all the aggregate
+  # networks found. For example, the following four networks can be
+  # aggregated in a single /22:
+  #
+  #   ip1 = IPAddress("10.0.0.1/24")
+  #   ip2 = IPAddress("10.0.1.1/24")
+  #   ip3 = IPAddress("10.0.2.1/24")
+  #   ip4 = IPAddress("10.0.3.1/24")
+  #
+  #   IPAddress::IPv4::summarize(ip1,ip2,ip3,ip4).to_string
+  #     #=> "10.0.0.0/22",
+  #
+  # But the following networks can't be summarized in a single network:
+  #
+  #   ip1 = IPAddress("10.0.1.1/24")
+  #   ip2 = IPAddress("10.0.2.1/24")
+  #   ip3 = IPAddress("10.0.3.1/24")
+  #   ip4 = IPAddress("10.0.4.1/24")
+  #
+  #   IPAddress::IPv4::summarize(ip1,ip2,ip3,ip4).map{|i| i.to_string}
+  #     #=> ["10.0.1.0/24","10.0.2.0/23","10.0.4.0/24"]
+  #
+  def self.summarize(networks)
+    aggregate(networks.map{|i| ((i.kind_of?(String)&&IPAddress.parse(i))||i) })
+  end
+
+end # module IPAddress
+
+#
+# IPAddress is a wrapper method built around
+# IPAddress's library classes. Its purpouse is to
+# make you indipendent from the type of IP address
+# you're going to use.
+#
+# For example, instead of creating the three types
+# of IP addresses using their own contructors
+#
+#   ip  = IPAddress::IPv4.new "172.16.10.1/24"
+#   ip6 = IPAddress::IPv6.new "2001:db8::8:800:200c:417a/64"
+#   ip_mapped = IPAddress::IPv6::Mapped "::ffff:172.16.10.1/128"
+#
+# you can just use the IPAddress wrapper:
+#
+#   ip  = IPAddress "172.16.10.1/24"
+#   ip6 = IPAddress "2001:db8::8:800:200c:417a/64"
+#   ip_mapped = IPAddress "::ffff:172.16.10.1/128"
+#
+# All the object created will be instances of the
+# correct class:
+#
+#  ip.class
+#    #=> IPAddress::IPv4
+#  ip6.class
+#    #=> IPAddress::IPv6
+#  ip_mapped.class
+#    #=> IPAddress::IPv6::Mapped
+#
+def IPAddress(str)
+  IPAddress::parse str
+end
+
+#
+# Compatibility with Ruby 1.8
+#
+if RUBY_VERSION =~ /1\.8/
+  class Hash # :nodoc:
+    alias :key :index
+  end
+  module Math # :nodoc:
+    def Math.log2(n)
+      log(n) / log(2)
+    end
+  end
+end
+