iplogic 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+# MIT license.  See http://www.opensource.org/licenses/mit-license.php
+
+Copyright (c) 2010 Philotic, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# Because it's just a 32-bit integer.
+
+Usage:
+
+    require 'iplogic'
+    include IPLogic
+
+    ip = IP('11.22.33.44')
+    cidr = CIDR('11.22.32.00/20')
+
+Look in `spec/ip_spec.rb` for a neat summary of al the methods available.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+
+begin
+  require 'spec/rake/spectask'
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.ruby_opts = ["-r spec/spec_helper.rb"]
+  end
+rescue LoadError
+  #pass.  rspec is not required
+end

data/iplogic.gemspec

@@ -0,0 +1,44 @@
+Gem::Specification.new do |s|
+  s.name = 'iplogic'
+  s.version = '0.1.0'
+
+  s.authors = ["Jay Adkisson"]
+  s.date = '2010-11-13'
+  s.description = <<-desc.strip
+    An IPv4 swiss-army chainsaw
+  desc
+
+  s.email = %q{jay@causes.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = %w(
+    Rakefile
+    LICENSE
+    README.md
+    iplogic.gemspec
+    lib/iplogic.rb
+    lib/core_ext.rb
+    lib/core_ext/fixnum.rb
+    lib/iplogic/cidr.rb
+    lib/iplogic/ip.rb
+  )
+
+  s.homepage = 'http://github.com/causes/iplogic'
+  s.require_paths = ["lib"]
+  s.rubygems_version = '1.3.7'
+
+  s.summary = <<-sum
+    Because it's just a 32-bit integer.
+  sum
+
+  s.test_files = %w(
+    spec/ip_spec.rb
+    spec/spec_helper.rb
+    spec/radix_spec.rb
+  )
+
+  s.add_development_dependency('rspec')
+end
+

data/lib/core_ext/fixnum.rb

@@ -0,0 +1,14 @@
+class Fixnum
+  def radix(rad)
+    raise ArgumentError if self < 0
+    return [] if zero?
+
+    i = self
+    digits = []
+    while i > 0
+      i, r = i.divmod(rad)
+      digits << r
+    end
+    digits.reverse
+  end unless 0.respond_to? :radix
+end

data/lib/core_ext.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.join(File.dirname(__FILE__), 'core_ext/*.rb')).each do |f|
+  require f
+end

data/lib/iplogic/cidr.rb

@@ -0,0 +1,108 @@
+module IPLogic
+  class CIDR
+    include Enumerable
+
+    class << self
+      def wrap(*args)
+        return args.first if args.first.is_a? CIDR
+        if args.size == 2
+          ip, bits = args
+
+          bits = case bits
+          when Integer
+            bits
+          when String
+            netmask_to_bits(IP.wrap(bits))
+          when IP
+            netmask_to_bits(bits)
+          else
+            bits.to_i
+          end
+
+          new(ip, bits)
+        elsif args.size == 1
+          arg = args.first
+          if arg =~ /(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\/(\d+)/
+            new($1, $2)
+          end
+        end
+      end
+    private
+      def netmask_to_bits(netmask)
+        # TODO: there's probably a clever mathy way to do this,
+        # but this works just fine.
+        netmask.to_i.to_s(2) =~ /^(1*)0*$/
+        $1.length
+      end
+    end
+
+    attr_reader :ip, :bits
+    alias prefix_length bits
+
+    def initialize(ip, bits)
+      @bits = bits.to_i
+      @ip = IP.wrap(ip)
+    end
+
+    ALL = self.new(0,0)
+    def self.all
+      ALL
+    end
+
+    def inv_bits
+      32 - bits
+    end
+
+    def inspect
+      "#<CIDR [ #{ip}/#{bits} ]>"
+    end
+
+    def netmask
+      @netmask ||= IP.wrap(
+        ((1 << bits) - 1) << (32 - bits)
+      )
+    end
+
+    def size
+      @size ||= (1 << inv_bits)
+    end
+
+    def min
+      @min ||= IP.wrap(
+        (ip.to_i >> inv_bits) << inv_bits
+      )
+    end
+    alias :begin :min
+    alias first   min
+    alias prefix  min
+
+    def max
+      @max ||= min + (size - 1)
+    end
+    alias :end :max
+    alias last  max
+
+    def rest_field
+      @rest_field ||= ip - min
+    end
+    alias rest rest_field
+
+    def significant_octets
+      4 - (bits / 8)
+    end
+
+    def zone
+      ip.parts[0..-(1+significant_octets)].reverse.join('.')
+    end
+
+    def each(&blk)
+      (min..max).each(&blk)
+    end
+  end
+
+  def CIDR(*args)
+    return CIDR if args.empty?
+
+    CIDR.wrap(*args)
+  end
+end

data/lib/iplogic/ip.rb

@@ -0,0 +1,148 @@
+module IPLogic
+  class IP
+    class << self
+      # Basic monad wrapper for IP addresses.
+      #
+      # You can pass it:
+      #
+      # a String
+      # >> IP('11.22.33.44')
+      # => #<IP [ 11.22.33.44 ]>
+      #
+      # an Integer
+      # >> IP(0xFFFFFFFF)
+      # => #<IP [ 255.255.255.255 ]>
+      #
+      # an Array of int-ish objects
+      # >> IP(['11', 22, 33, '44'])
+      # => #<IP [ 11.22.33.44 ]>
+      #
+      # nil
+      # >> IP(nil)
+      # =>  #<IP [ 0.0.0.0 ]>
+      #
+      # an IP
+      # >> ip = IP('11.22.33.44')
+      # => #<IP [ 11.22.33.44 ]>
+      # >> IP(ip)
+      # => #<IP [ 11.22.33.44 ]>
+      # >> ip.object_id == IP(ip).object_id
+      # => true
+      #   
+      def wrap(arg)
+        return arg if arg.is_a? IP
+
+        int = case arg
+        when Array
+          parts_to_int(arg)
+        when String
+          parts_to_int(arg.split('.'))
+        when Fixnum
+          arg
+        when nil
+          0
+        else
+          raise ArgumentError, <<-msg.strip
+            Couldn't parse #{arg.inspect} to an IP.
+          msg
+        end
+
+        return new(int)
+      end
+
+    private
+      def parts_to_int(parts)
+        r = 0
+        parts.reverse.each_with_index do |part, i|
+          r += (part.to_i << 8*i)
+        end
+        r
+      end
+    end
+
+    # -*- instance methods -*-
+    attr_reader :int
+    alias to_i int
+    alias to_int int
+
+    def initialize(int)
+      @int = int
+    end
+
+    # 255.255.255.255
+    MAXIP = self.new(0xFFFFFFFF)
+    def self.max
+      MAXIP
+    end
+
+    def parts
+      @parts ||= begin
+        rad = int.radix(256)
+        [0]*([4-rad.size,0].max) + rad
+      end
+    end
+
+    def to_s
+      parts.join('.')
+    end
+    alias to_str to_s
+
+    def inspect
+      "#<IP [ #{self} ]>"
+    end
+
+    def eql?(other)
+      self.int == IP(other).int
+    end
+    alias == eql?
+
+    include Comparable
+    def <=>(other)
+      self.int <=> other.int
+    end
+
+    def +(int_ish)
+      IP(int + int_ish.to_i)
+    end
+
+    def succ
+      self + 1
+    end
+
+    def -(int_ish)
+      self + (-int_ish.to_i)
+    end
+
+    def prefix(netmask)
+      CIDR.wrap(self, netmask).min
+    end
+    alias min prefix
+
+    def max(netmask)
+      CIDR.wrap(self, netmask).max
+    end
+
+    def rest_field(netmask)
+      CIDR.wrap(self, netmask).rest_field
+    end
+    alias rest rest_field
+
+    def netmask?
+      maxint32 = 0xFFFFFFFF
+      (0..32).any? do |i|
+        (int-1) + (1 << i) == maxint32
+      end
+    end
+
+    def assert_netmask!
+      raise ArgumentError, <<-msg.strip unless netmask?
+        #{self.inspect} is not a valid netmask.
+      msg
+    end
+  end
+
+  def IP(*args)
+    return IP if args.empty?
+    IP.wrap(args.first)
+  end
+end

data/lib/iplogic.rb

@@ -0,0 +1,9 @@
+module IPLogic
+  VERSION = '0.1.0'
+
+  LIB = File.expand_path(File.dirname(__FILE__))
+end
+
+require File.join(IPLogic::LIB, 'core_ext')
+require File.join(IPLogic::LIB, 'iplogic', 'ip')
+require File.join(IPLogic::LIB, 'iplogic', 'cidr')

data/spec/ip_spec.rb

@@ -0,0 +1,222 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe IP do
+  it "parses a string" do
+    ip = IP('11.22.33.44')
+    ip.should be_a IP
+    ip.inspect.should include '11.22.33.44'
+  end
+
+  it "parses an integer" do
+    ip = IP(255)
+    ip.should be_a IP
+    ip.inspect.should include '0.0.0.255'
+
+    ip = IP(0xA00A10FF)
+    ip.should be_a IP
+    ip.inspect.should include '160.10.16.255'
+  end
+
+  it "parses an array of int-ish objects" do
+    four = Class.new do
+      def to_i
+        4
+      end
+    end.new
+
+    ip = IP([7, '42', four, nil])
+    ip.should be_a IP
+    ip.inspect.should include '7.42.4.0'
+  end
+
+  it "parses nil" do
+    ip = IP(nil)
+    ip.should be_a IP
+    ip.inspect.should include '0.0.0.0'
+  end
+
+  it "parses an IP" do
+    ip = IP('11.22.33.44')
+    IP(ip).should be_a IP
+    IP(ip).object_id.should == ip.object_id
+  end
+
+  it "knows its integer representation" do
+    i = rand(0xFFFFFFFF)
+    IP(i).to_i.should == i
+  end
+
+  it "knows its string representation" do
+    IP('11.22.33.44').to_s.should == '11.22.33.44'
+  end
+
+  it "knows its parts" do
+    IP('44.33.22.11').parts.should == [44, 33, 22, 11]
+  end
+
+  it "knows the max" do
+    IP::MAXIP.to_i.should == 0xFFFFFFFF
+    IP.max.to_i.should == 0xFFFFFFFF
+    IP.max.to_s.should == '255.255.255.255'
+  end
+
+  it "is comparable" do
+    IP.included_modules.should include Comparable
+    IP.public_methods.should include '<=>'
+
+    i1, i2 = rand(0xFFFFFFFF), rand(0xFFFFFFFF)
+    (IP(i1) <=> IP(i2)).should == (i1 <=> i2)
+  end
+
+  it "can add, subtract, and succ" do
+    i1, i2 = rand(0xFFFFFFF), rand(0xFFFFFFF)
+    ip1 = IP(i1)
+    ipsum = IP(i1) + i2
+    ipsum.should be_a IP
+    ipsum.to_i.should == i1 + i2
+
+    ip1.succ.to_i.should == i1 + 1
+    (ipsum - i2).to_i.should == i1
+    (ipsum - ip1).to_i.should == i2
+  end
+
+  it "knows its prefix and rest field given a netmask" do
+    ip = IP('11.22.33.44')
+
+    ip.prefix('255.255.255.0').should == IP('11.22.33.00')
+    ip.rest_field('255.255.255.0').should == IP('0.0.0.44')
+    (ip.prefix('255.255.255.0') + ip.rest_field('255.255.255.0')).
+      should == ip
+
+    ip.prefix('255.255.240.0').should == IP('11.22.32.00')
+    ip.rest_field('255.255.240.0').should == IP('0.0.1.44')
+    (ip.prefix('255.255.240.0') + ip.rest_field('255.255.240.0')).
+      should == ip
+  end
+
+  it "knows whether it's a netmask" do
+    zero_bits = rand(32)
+    (0..32).each do |bits|
+      IP((0xFFFFFFFF >> bits) << bits).should be_netmask
+    end
+
+    IP('1.2.3.4').should_not be_netmask
+    IP('0.255.0.0').should_not be_netmask
+  end
+
+  describe CIDR do
+    it "parses an IP-ish and netmask-ish" do
+      r = CIDR('4.33.222.111', '255.255.240.0')
+      r.should be_a CIDR
+      r.inspect.should include '4.33.222.111/20'
+
+      r = CIDR(IP('4.33.222.111'), 20)
+      r.should be_a CIDR
+      r.inspect.should include '4.33.222.111/20'
+
+      r = CIDR('4.33.222.111', IP('255.255.240.0'))
+      r.should be_a CIDR
+      r.inspect.should include '4.33.222.111/20'
+    end
+
+    it "parses slash notation" do
+      r = CIDR('11.22.33.44/8')
+      r.should be_a CIDR
+      r.inspect.should include '11.22.33.44/8'
+    end
+
+    it "knows its bits" do
+      i = rand(33)
+      CIDR("1.1.1.1/#{i}").bits.
+        should == i
+    end
+
+    it "knows its ip" do
+      CIDR('11.22.33.44/20').ip.
+        should == IP('11.22.33.44')
+    end
+
+    it "knows its netmask" do
+      CIDR('11.22.33.44/20').netmask.
+        should == IP('255.255.240.0')
+
+      CIDR('11.22.33.44/8').netmask.
+        should == IP('255.0.0.0')
+
+      CIDR('11.22.33.44/32').netmask.
+        should == IP('255.255.255.255')
+
+      CIDR('1.1.1.1/0').netmask.
+        should == IP('0.0.0.0')
+    end
+
+    it "knows its min" do
+      CIDR('11.22.33.44/20').min.
+        should == IP('11.22.32.0')
+
+      CIDR('11.22.33.44/8').min.
+        should == IP('11.0.0.0')
+
+      CIDR('11.22.33.44/32').min.
+        should == IP('11.22.33.44')
+
+      CIDR('11.22.33.44/0').min.
+        should == IP('0.0.0.0')
+    end
+
+    it "knows its max" do
+      CIDR('11.22.33.44/20').max.
+        should == IP('11.22.47.255')
+
+      CIDR('11.22.33.44/8').max.
+        should == IP('11.255.255.255')
+
+      CIDR('11.22.33.44/32').max.
+        should == IP('11.22.33.44')
+
+      CIDR('11.22.33.44/0').max.
+        should == IP('255.255.255.255')
+    end
+
+    it "knows its rest field" do
+      CIDR('11.22.33.44/20').rest_field.
+        should == IP('0.0.1.44')
+
+      CIDR('11.22.33.44/8').rest_field.
+        should == IP('0.22.33.44')
+
+      CIDR('11.22.33.44/32').rest_field.
+        should == IP('0.0.0.0')
+
+      CIDR('11.22.33.44/0').rest_field.
+        should == IP('11.22.33.44')
+    end
+
+    it "knows its size" do
+      CIDR('11.22.33.44/20').size.
+        should == 0x1000
+
+      CIDR('11.22.33.44/8').size.
+        should == 0x1000000
+
+      CIDR('11.22.33.44/32').size.
+        should == 1
+
+      CIDR('11.22.33.44/0').size.
+        should == 0x100000000
+    end
+
+    it "is enumerable" do
+      r = CIDR('11.22.33.44/24')
+      r.should respond_to :each
+      CIDR.included_modules.should include Enumerable
+
+      a = r.to_a
+
+      a.size.should == r.size
+      a.first.should == r.first
+      a.last.should == r.last
+    end
+
+  end
+end

data/spec/radix_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe "Radix" do
+  before :each do
+    @lim = 50 + rand(100)
+    @rad = 2 + rand(9)
+  end
+
+  it "calculates radix" do
+    (1..@lim).each do |i|
+      i.radix(@rad).join.should == i.to_s(@rad)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec'
+
+require File.expand_path(File.join(
+  File.dirname(__FILE__),
+  '..',
+  'lib',
+  'iplogic'
+))
+
+include IPLogic

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: iplogic
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jay Adkisson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: An IPv4 swiss-army chainsaw
+email: jay@causes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- Rakefile
+- LICENSE
+- README.md
+- iplogic.gemspec
+- lib/iplogic.rb
+- lib/core_ext.rb
+- lib/core_ext/fixnum.rb
+- lib/iplogic/cidr.rb
+- lib/iplogic/ip.rb
+- spec/ip_spec.rb
+- spec/spec_helper.rb
+- spec/radix_spec.rb
+has_rdoc: true
+homepage: http://github.com/causes/iplogic
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Because it's just a 32-bit integer.
+test_files: 
+- spec/ip_spec.rb
+- spec/spec_helper.rb
+- spec/radix_spec.rb