ruby-ip 0.9.1 → 0.9.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97b94276cb0106a57dda469aa8d5ac6b930c6c48
+  data.tar.gz: 1597755efb6569844d8b0d659f9b836a155eaf99
+SHA512:
+  metadata.gz: 68be79249a2c3e1bdca7574e7c2006b6d6dc503fedb408a71da4eedfd765ef65d0feb08ee1b5c893f2e073a29060d3d040395f48744730368bc7c041a7c8c9ea
+  data.tar.gz: f25236b45eb5a3fad698935032ed79c1e490dc7a91512a7b3fbcb789b711f31d40cda38788b59afc15d045b1f0de5778d1715b6c0ed00521a88b4d1d052e608a

data/README.rdoc

@@ -16,8 +16,10 @@ Docs:: http://deploy2.github.com/ruby-ip/
     ip = IP.new("192.0.2.53/24")
     ip.to_s       # "192.0.2.53/24"
     ip.to_i       # 3221226037
+    ip.to_b       # 11000000000000000000001000110101
     ip.to_hex     # "c0000235"
     ip.to_addr    # "192.0.2.53"
+    ip.to_arpa    # "53.2.0.192.in-addr.arpa."
     ip.pfxlen     # 24
 
 * Qualify IP address with "routing context" (VRF)
@@ -67,6 +69,23 @@ Docs:: http://deploy2.github.com/ruby-ip/
     ip ^ 7             #<IP::V4 192.0.2.50/24>
     ~ip                #<IP::V4 63.255.253.202/24>
 
+* Advanced Subnet Operations
+    sn = IP.new('192.168.0.0/24')
+    ip = IP.new('192.168.0.48/32')
+    sn.split                    [#<IP::V4 192.168.0.0/25>, 
+                                #<IP::V4 192.168.0.128/25>] (2 evenly divided subnets)
+    sn.divide_by_subnets(3)     [#<IP::V4 192.168.0.0/26>, 
+                                #<IP::V4 192.168.0.64/26>, 
+                                #<IP::V4 192.168.0.128/26>, 
+                                #<IP::V4 192.168.0.192/26>] (4 evenly divided subnets)
+    #keep in mind this always takes into account a network and broadcast address
+    sn.divide_by_hosts(100)     [#<IP::V4 192.168.0.0/25>, 
+                                #<IP::V4 192.168.0.128/25>] (128 hosts each)
+    ip = IP.new('192.168.0.48/32')
+    ip.is_in?(sn)
+    => true 
+    
+
 * Convert to and from a compact Array representation
 
     ip1 = IP.new("192.0.2.53/24@cust1")

data/lib/ip/base.rb

@@ -76,7 +76,10 @@ class IP
   def to_i
     @addr
   end
-
+  # returns the address in Binary
+  def to_b
+    @addr.to_s(2).to_i
+  end
   # Return the address as a hexadecimal string (8 or 32 digits)
   def to_hex
     @addr.to_s(16).rjust(self.class::ADDR_BITS>>2,"0")
@@ -187,6 +190,55 @@ class IP
     self.class.new(@addr & ~mask, self.class::ADDR_BITS, @ctx) ..
     self.class.new(@addr | mask, self.class::ADDR_BITS, @ctx)
   end
+  # test if the address is in the provided subnet
+  def is_in?(subnet)
+    return subnet.network.to_i <= self.network.to_i &&
+      subnet.broadcast.to_i >= self.broadcast.to_i
+  end
+  #this function sub-divides a subnet into two subnets of equal size
+  def split
+    nets = Array.new
+    if self.pfxlen < self.class::ADDR_BITS
+      if self.class::ADDR_BITS == 32
+        new_base = IP::V4.new(self.network.to_i, (self.pfxlen + 1))
+        nets = [new_base, IP::V4.new((new_base.broadcast + 1).to_i, (self.pfxlen + 1))]
+      end
+      if self.class::ADDR_BITS == 128
+        new_base = IP::V6.new(self.network.to_i, (self.pfxlen + 1))
+        nets = [new_base, IP::V6.new((new_base.broadcast + 1).to_i, (self.pfxlen + 1))]
+      end
+    end
+    return nets
+  end
+
+  # subdivide a larger subnet into smaller subnets by number of subnets of equal size, 
+  # stop when subnets reach their smallest possible size (i.e. 31 for IP4)
+  def divide_by_subnets(number_subnets)
+    nets = Array.new
+    nets << self
+    begin
+      new_nets = Array.new
+      nets.each do |net|
+        new_nets = new_nets | net.split
+      end
+      nets = new_nets
+    end until number_subnets <= nets.length && nets[0].pfxlen <= (self.class::ADDR_BITS - 1)
+    return nets
+  end
+  
+  # subdivide a larger subnet into smaller subnets by number of hosts
+  def divide_by_hosts(number_hosts)
+    nets = Array.new
+    nets << self
+    while number_hosts <= (nets[0].split[0].size - 2) && nets[0].pfxlen <= (self.class::ADDR_BITS - 1)
+      new_nets = Array.new
+      nets.each do |net|
+        new_nets = new_nets | net.split
+      end
+      nets = new_nets
+    end
+    return nets
+  end
 
   # The number of IP addresses in subnet
   #    IP.new("1.2.3.4/24").size   => 256
@@ -195,23 +247,23 @@ class IP
   end
 
   def +(other)
-    self.class.new(@addr + other.to_int, @pfxlen, @ctx)
+    self.class.new(@addr + other.to_i, @pfxlen, @ctx)
   end
 
   def -(other)
-    self.class.new(@addr - other.to_int, @pfxlen, @ctx)
+    self.class.new(@addr - other.to_i, @pfxlen, @ctx)
   end
 
   def &(other)
-    self.class.new(@addr & other.to_int, @pfxlen, @ctx)
+    self.class.new(@addr & other.to_i, @pfxlen, @ctx)
   end
 
   def |(other)
-    self.class.new(@addr | other.to_int, @pfxlen, @ctx)
+    self.class.new(@addr | other.to_i, @pfxlen, @ctx)
   end
 
   def ^(other)
-    self.class.new(@addr ^ other.to_int, @pfxlen, @ctx)
+    self.class.new(@addr ^ other.to_i, @pfxlen, @ctx)
   end
 
   def ~
@@ -286,6 +338,11 @@ class IP
       sprintf("%d.%d.%d.%d",
         (@addr>>24)&0xff, (@addr>>16)&0xff, (@addr>>8)&0xff, @addr&0xff)
     end
+    #return the arpa version of the address for reverse DNS: http://en.wikipedia.org/wiki/Reverse_DNS_lookup
+    def to_arpa
+      sprintf("%d.%d.%d.%d.in-addr.arpa.",
+        @addr&0xff, (@addr>>8)&0xff, (@addr>>16)&0xff,(@addr>>24)&0xff)
+    end
   end
   
   class V6 < IP
@@ -357,6 +414,23 @@ class IP
       end
     end
 
+    # Return just the address in non-compact form, required for reverse IP.
+    def to_addr_full
+      if ipv4_compat?
+        "::#{native.to_addr}"
+      elsif ipv4_mapped?
+        "::ffff:#{native.to_addr}"
+      elsif @addr.zero?
+        "::"
+      else
+        return to_hex.scan(/..../).join(':')
+      end
+    end
+    #return the arpa version of the address for reverse DNS: http://en.wikipedia.org/wiki/Reverse_DNS_lookup
+    def to_arpa
+      return self.to_addr_full.reverse.gsub(':','').split(//).join('.') + ".ip6.arpa"
+    end
+
     def ipv4_mapped?
       (@addr >> 32) == 0xffff
     end

data/test/ip_test.rb

@@ -9,6 +9,7 @@ class IPTest < Test::Unit::TestCase
       assert_equal "1.2.3.4/26", res.to_s
       assert_equal "1.2.3.4/26", res.to_addrlen
       assert_equal 0x01020304, res.to_i
+      assert_equal 1000000100000001100000100, res.to_b
       assert_equal 26, res.pfxlen
       assert_nil res.ctx
     end
@@ -75,7 +76,22 @@ class IPTest < Test::Unit::TestCase
     should "disallow invalid pfxlen" do
       assert_raises(ArgumentError) { IP.new("1.2.3.4/33") }
     end
-    
+
+    context "ip math" do
+      setup do
+        @addr1 = IP.new("1.2.3.4/24@foo")
+        @addr2 = IP.new("1.2.3.5/24@foo")
+      end
+
+      should "add to ip address" do
+        assert_equal @addr2, (@addr1 + 1)
+      end
+
+      should "subtract from ip address" do
+        assert_equal @addr1, (@addr2 - 1)
+      end
+    end
+
     context "address not on subnet boundary" do
       setup do
         @addr = IP.new("1.2.3.4/24@foo")
@@ -93,6 +109,10 @@ class IPTest < Test::Unit::TestCase
         assert_equal "1.2.3.4", @addr.to_addr
       end
       
+      should "have to_arpa" do
+        assert_equal "4.3.2.1.in-addr.arpa.", @addr.to_arpa
+      end
+
       should "have to_i" do
         assert_equal 0x01020304, @addr.to_i
       end
@@ -128,6 +148,47 @@ class IPTest < Test::Unit::TestCase
       should "have to_range" do
         assert_equal IP.new("1.2.3.0@foo")..IP.new("1.2.3.255@foo"), @addr.to_range
       end
+
+      should "have is_in?" do
+        assert_equal IP.new("1.2.3.0/25").is_in?(IP.new("1.2.3.0/24")), true
+      end
+      
+      should "find whether an IP is included in a range" do
+        assert_equal IP.new("1.2.3.1").is_in?(IP.new("1.2.3.0/24")), true
+      end
+      
+      should "find whether an IP is not included a range" do
+        assert_equal IP.new("1.2.4.1").is_in?(IP.new("1.2.3.0/24")), false
+      end
+      
+      should "find when a subnet is included in a range" do
+        assert_equal IP.new("1.2.3.0/30").is_in?(IP.new("1.2.3.0/24")), true
+      end
+
+      should "find when a subnet is not included in a range" do
+        assert_equal IP.new("1.2.4.0/30").is_in?(IP.new("1.2.3.0/24")), false
+      end
+
+      should "have split" do
+        assert_equal IP.new("1.2.3.0/24").split, [IP.new("1.2.3.0/25"), IP.new("1.2.3.128/25")]
+      end
+
+      should "have divide_by_subnets be exact" do
+        assert_equal IP.new("1.2.3.0/24").divide_by_subnets(4), [IP.new("1.2.3.0/26"), IP.new("1.2.3.64/26"),IP.new("1.2.3.128/26"), IP.new("1.2.3.192/26")]
+      end
+
+      should "have divide_by_subnets choose next largest" do
+        assert_equal IP.new("1.2.3.0/24").divide_by_subnets(3), [IP.new("1.2.3.0/26"), IP.new("1.2.3.64/26"),IP.new("1.2.3.128/26"), IP.new("1.2.3.192/26")]
+      end
+      should "have divide_by_hosts subnet boundary" do
+        assert_equal IP.new("1.2.3.0/24").divide_by_hosts(128), [IP.new("1.2.3.0/24")]
+      end
+      should "have divide_by_hosts full subnet" do
+        assert_equal IP.new("1.2.3.0/24").divide_by_hosts(126), [IP.new("1.2.3.0/25"), IP.new("1.2.3.128/25")]
+      end
+      should "have divide_by_hosts partial subnet" do
+        assert_equal IP.new("1.2.3.0/24").divide_by_hosts(68), [IP.new("1.2.3.0/25"), IP.new("1.2.3.128/25")]
+      end
       
       should "have size" do
         assert_equal 256, @addr.size
@@ -486,7 +547,10 @@ class IPTest < Test::Unit::TestCase
         @addr.to_s
         @addr.to_addrlen
         @addr.to_addr
+        @addr.to_arpa
         @addr.to_i
+        @addr.to_b
+        @addr.split
         @addr.to_a
         @addr.to_ah
         @addr.to_hex

metadata

@@ -1,32 +1,22 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-ip
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 9
-  - 1
-  version: 0.9.1
+version: !ruby/object:Gem::Version
+  version: 0.9.3
 platform: ruby
-authors: 
+authors:
 - Brian Candler
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-13 00:00:00 +00:00
-default_executable: 
+date: 2011-12-13 00:00:00.000000000 Z
 dependencies: []
-
 description: IP address manipulation library
 email: b.candler@pobox.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - lib/ip/base.rb
 - lib/ip/cpal.rb
 - lib/ip/socket.rb
@@ -38,38 +28,29 @@ files:
 - Rakefile
 - LICENSE.txt
 - COPYING.txt
-has_rdoc: true
 homepage: http://github.com/deploy2/ruby-ip
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --inline-source
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: ruby-ip
-rubygems_version: 1.3.6
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 2
 summary: IP address manipulation library
 test_files: []
-