ip_methods 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 2010-09-24 version 0.1.0
+
+* initial version

data/README.rdoc

@@ -0,0 +1,11 @@
+= Introduction
+
+ip_methods is a gem for helping dealing with  IP operations
+
+= Basics 
+
+Here's what you need to know before starting.
+
+== Example Usage
+
+  

data/Rakefile

@@ -0,0 +1,52 @@
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+require "rake"
+require "spec/rake/spectask"
+require "ip_methods/version"
+
+begin
+  require "hanna/rdoctask"
+rescue LoadError => e
+  require "rake/rdoctask"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ip_methods"
+    gem.version = IpMethods::Version::STRING
+    gem.summary = %Q{IpMethods gem for helping with IP operations}
+    gem.description = %Q{Provides an easy way for dealing with IP operations!}
+    gem.email = "morellon@gmail.com"
+    gem.homepage = "http://github.com/morellon/ip_methods"
+    gem.authors = ["morellon"]
+    gem.add_development_dependency "rspec"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format specdoc --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Rspec : run all with RCov"
+Spec::Rake::SpecTask.new('spec:rcov') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'gems', '--exclude', 'spec']
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = "doc"
+  rdoc.title = "IP Methods"
+  rdoc.options += %w[ --line-numbers --inline-source --charset utf-8 ]
+  rdoc.rdoc_files.include("README.rdoc", "CHANGELOG.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+task :default => :spec

data/lib/ip_methods.rb

@@ -0,0 +1,99 @@
+require "ip_methods/version"
+
+# -*- coding: UTF-8 -*-
+module IpMethods
+  IPV4_PATTERN = /^(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)(?:\.(?:25[0-5]|(?:2[0-4]|1\d|[1-9])?\d)){3}$/
+  IPV4_BIT_WIDTH = 32
+  IPV4_BIT_OCTET = 8
+
+  def self.from_bin(ip_bin)
+    "#{ip_bin >> 24}.#{(ip_bin >> 16) & 255}.#{(ip_bin >> 8) & 255}.#{ip_bin & 255}"
+  end
+
+  def self.ip?(ip)
+    ip =~ IPV4_PATTERN
+  end
+
+  def self.mask?(mask)
+    mask.to_s =~ /^\d+$/ && (0..32).include?(mask.to_i)
+  end
+
+  def self.ip_and_mask?(address)
+    parts = address.to_s.split('/')
+    parts.size == 2 && ip?(parts[0]) && mask?(parts[1])
+  end
+
+  def self.to_bin(ip)
+    ip_bin = 0
+    shift = IPV4_BIT_WIDTH - IPV4_BIT_OCTET
+    ip.split('.').each do |part|
+      ip_bin += (part.to_i << shift)
+      shift  -= IPV4_BIT_OCTET
+    end
+    ip_bin
+  end
+
+  def network
+    IpMethods.from_bin(network_bin)
+  end
+
+  def net_mask
+    IpMethods.from_bin(mask_bin)
+  end
+
+  def default_gateway
+    IpMethods.from_bin(network_bin+1)
+  end
+
+  def broadcast
+    IpMethods.from_bin(broadcast_bin)
+  end
+
+  def generate_ips
+    ips = []
+    (network_bin+1..broadcast_bin-1).each {|ip_bin| ips << IpMethods.from_bin(ip_bin)}
+    ips
+  end
+
+  def to_bin
+    IpMethods.to_bin(address)
+  end
+
+  def mask_bin
+    umask = 0
+    range = 32 - mask
+    (0..mask-1).each {|i| umask += 1 << i}
+    umask << range
+  end
+
+  def umask_bin
+    umask = 0
+    range = 32 - mask
+    (0..range-1).each {|i| umask += 1 << i}
+    umask
+  end
+
+  def network_bin
+    self.to_bin & mask_bin
+  end
+
+  def broadcast_bin
+    mask_bin & network_bin | umask_bin;
+  end
+
+  def belongs_to?(range)
+    range = SimpleIP.new(range) unless range.is_a? IpMethods
+    range.mask <= self.mask && SimpleIP.new(self.address, range.mask).network == range.network
+  end
+
+  class SimpleIP
+    include IpMethods
+    attr_accessor :address, :mask
+
+    def initialize(address, mask = 32)
+      (@address, @mask) = address.split('/')
+      @mask ||= mask
+      @mask = @mask.to_i
+    end
+  end
+end

data/lib/ip_methods/version.rb

@@ -0,0 +1,8 @@
+module IpMethods
+  module Version  #:nodoc: all
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/spec/ip_methods_spec.rb

@@ -0,0 +1,56 @@
+# -*- coding: UTF-8 -*-
+require "spec_helper"
+
+describe IpMethods do
+  
+  subject { IpMethods::SimpleIP.new "10.1.2.34", 26 }
+  
+  it "should give the binary ip representation" do
+    subject.to_bin.should == 0b00001010_00000001_00000010_00100010
+  end
+  
+  it "should convert from binary ip representation" do
+    IpMethods.from_bin(subject.to_bin).should == subject.address
+  end
+  
+  it "should give the ip's network address" do
+    subject.network.should == "10.1.2.0"
+  end
+  
+  it "should give the ip's broadcast address" do
+    subject.broadcast.should == "10.1.2.63"
+  end
+  
+  it "should give the ip's default gateway address" do
+    subject.default_gateway.should == "10.1.2.1"
+  end
+  
+  it "should give the ip's net mask address" do
+    subject.net_mask.should == "255.255.255.192"
+  end
+  
+  it "should generate all host ips on this ip range" do
+    ips = []
+    ip = subject.network
+    62.times {|i| ips << "10.1.2.#{i+1}"}
+    subject.generate_ips.should == ips
+  end
+  
+  it "should belong to a wider range" do
+    subject.belongs_to?(IpMethods::SimpleIP.new "10.1.2.34", subject.mask - 1).should be_true
+    subject.belongs_to?(IpMethods::SimpleIP.new "0.0.0.0/0").should be_true
+  end
+  
+  it "should belong to itself" do
+    subject.belongs_to?(subject).should be_true
+    subject.belongs_to?(IpMethods::SimpleIP.new "10.1.2.32/26").should be_true
+  end
+  
+  it "should not belong to a narrower range" do
+    subject.belongs_to?(IpMethods::SimpleIP.new "10.1.2.34", subject.mask + 1).should be_false
+  end
+  
+  it "should not belong to a different range" do
+    subject.belongs_to?(IpMethods::SimpleIP.new "10.2.2.0/26").should be_false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "rubygems"
+require "spec"
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+require "ip_methods"

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: ip_methods
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- morellon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 -03: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: Provides an easy way for dealing with IP operations!
+email: morellon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- README.rdoc
+- Rakefile
+- lib/ip_methods.rb
+- lib/ip_methods/version.rb
+- spec/ip_methods_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/morellon/ip_methods
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: IpMethods gem for helping with IP operations
+test_files: 
+- spec/ip_methods_spec.rb
+- spec/spec_helper.rb