ipv4_address 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marcin Nowicki
+
+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.rdoc

@@ -0,0 +1,18 @@
+= ipv4_address
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Marcin Nowicki. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ipv4_address"
+    gem.summary = %Q{Recognition of ipv4 addresses}
+    gem.description = %Q{Recognize ipv4 addresses in many ways}
+    gem.email = "pr0d1r2@gmail.com"
+    gem.homepage = "http://github.com/Pr0d1r2/ipv4_address"
+    gem.authors = ["Marcin Nowicki"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ipv4_address #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/ipv4_address.rb

@@ -0,0 +1,144 @@
+require 'ipaddr'
+
+class IPv4Address < IPAddr
+
+  # by IANA
+  RESERVED = ['128.0.0.0/16', '191.255.0.0/16', '192.0.0.0/24', '223.255.255.0/24']
+  PRIVATE = ['10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16']
+  LOOPBACK = ['127.0.0.0/8']
+  LINK_LOCAL = ['169.254.0.0/16']
+  DOCUMENTATION = ['192.0.2.0/24']
+  IPV6_RELAY = ['192.88.99.0/24']
+  BENCHMARK = ['198.18.0.0/15']
+  MULTICAST = ['224.0.0.0/4']
+
+  def reserved?
+    exist_in_pool?(RESERVED)
+  end
+
+  def self.reserved?(addr)
+    begin
+      new(addr).reserved?
+    rescue
+      false
+    end
+  end
+
+  def private?
+    exist_in_pool?(PRIVATE)
+  end
+
+  def self.private?(addr)
+    begin
+      new(addr).private?
+    rescue
+      false
+    end
+  end
+
+  def loopback?
+    exist_in_pool?(LOOPBACK)
+  end
+
+  def self.loopback?(addr)
+    begin
+      new(addr).loopback?
+    rescue
+      false
+    end
+  end
+
+  def link_local?
+    exist_in_pool?(LINK_LOCAL)
+  end
+
+  def self.link_local?(addr)
+    begin
+      new(addr).link_local?
+    rescue
+      false
+    end
+  end
+
+  def documentation?
+    exist_in_pool?(DOCUMENTATION)
+  end
+
+  def self.documentation?(addr)
+    begin
+      new(addr).documentation?
+    rescue
+      false
+    end
+  end
+
+  def ipv6_relay?
+    exist_in_pool?(IPV6_RELAY)
+  end
+
+  def self.ipv6_relay?(addr)
+    begin
+      new(addr).ipv6_relay?
+    rescue
+      false
+    end
+  end
+
+  def benchmark?
+    exist_in_pool?(BENCHMARK)
+  end
+
+  def self.benchmark?(addr)
+    begin
+      new(addr).benchmark?
+    rescue
+      false
+    end
+  end
+
+  def multicast?
+    exist_in_pool?(MULTICAST)
+  end
+
+  def self.multicast?(addr)
+    begin
+      new(addr).multicast?
+    rescue
+      false
+    end
+  end
+
+  def internet_routable?
+    !reserved? &&
+    !private? &&
+    !loopback? &&
+    !link_local? &&
+    !documentation? &&
+    !ipv6_relay? &&
+    !benchmark? &&
+    !multicast?
+  end
+
+  def self.internet_routable?(addr)
+    is?(to_s) && new(addr).internet_routable?
+  end
+
+  def self.is?(addr)
+    begin
+      IPAddr.new(addr)
+      true
+    rescue
+      false
+    end
+  end
+
+  private
+
+  def exist_in_pool?(collection)
+    collection.collect do |address_scope|
+      return true if IPAddr.new(address_scope).include?(self)
+    end
+    false
+  end
+
+end

data/spec/ipv4_address_spec.rb

@@ -0,0 +1,504 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe IPv4Address do
+
+  describe 'self.reserved?' do
+    it 'should be true when is in reserved pool' do
+      %w(
+        128.0.0.1
+        191.255.0.1
+        192.0.0.1
+        223.255.255.1
+      ).each do |address|
+        IPv4Address.reserved?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not in reserved pool' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        10.0.0.1
+        14.0.0.1
+        127.0.0.1
+        169.254.0.1
+        172.16.0.1
+        192.0.2.1
+        192.88.99.1
+        192.168.0.1
+        198.18.0.1
+        224.0.0.1
+        240.0.0.1
+        255.255.255.255
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.reserved?(address).should be_false
+      end
+    end
+  end
+
+  describe 'self.private?' do
+    it 'should be true when address is in private pool' do
+      %w(
+        10.0.0.1
+        172.16.0.1
+        192.168.0.1
+      ).each do |address|
+        IPv4Address.private?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not in private pool' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        14.0.0.1
+        127.0.0.1
+        128.0.0.1
+        169.254.0.1
+        191.255.0.1
+        192.0.0.1
+        192.0.2.1
+        192.88.99.1
+        198.18.0.1
+        223.255.255.1
+        224.0.0.1
+        240.0.0.1
+        255.255.255.255
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.private?(address).should be_false
+      end
+    end
+  end
+
+  describe 'self.loopback?' do
+    it 'should be true when is not in loopback pool' do
+      %w(
+        127.0.0.1
+      ).each do |address|
+        IPv4Address.loopback?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not in loopback pool' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        10.0.0.1
+        14.0.0.1
+        128.0.0.1
+        169.254.0.1
+        172.16.0.1
+        191.255.0.1
+        192.0.0.1
+        192.0.2.1
+        192.88.99.1
+        192.168.0.1
+        198.18.0.1
+        223.255.255.1
+        224.0.0.1
+        240.0.0.1
+        255.255.255.255
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.loopback?(address).should be_false
+      end
+    end
+  end
+
+  describe 'self.link_local?' do
+    it 'should be true when is not in link_local pool' do
+      %w(
+        169.254.0.1
+      ).each do |address|
+        IPv4Address.link_local?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not in link_local pool' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        10.0.0.1
+        14.0.0.1
+        127.0.0.1
+        128.0.0.1
+        172.16.0.1
+        191.255.0.1
+        192.0.0.1
+        192.0.2.1
+        192.88.99.1
+        192.168.0.1
+        198.18.0.1
+        223.255.255.1
+        224.0.0.1
+        240.0.0.1
+        255.255.255.255
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.link_local?(address).should be_false
+      end
+    end
+  end
+
+
+  describe 'self.documentation?' do
+    it 'should be true when is not in documentation pool' do
+      %w(
+        192.0.2.1
+      ).each do |address|
+        IPv4Address.documentation?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not in documentation pool' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        10.0.0.1
+        14.0.0.1
+        127.0.0.1
+        128.0.0.1
+        169.254.0.1
+        172.16.0.1
+        191.255.0.1
+        192.0.0.1
+        192.88.99.1
+        192.168.0.1
+        198.18.0.1
+        223.255.255.1
+        224.0.0.1
+        240.0.0.1
+        255.255.255.255
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.documentation?(address).should be_false
+      end
+    end
+  end
+
+  describe 'self.ipv6_relay?' do
+    it 'should be true when is not in ipv6_relay pool' do
+      %w(
+        192.88.99.1
+      ).each do |address|
+        IPv4Address.ipv6_relay?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not in ipv6_relay pool' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        10.0.0.1
+        14.0.0.1
+        127.0.0.1
+        128.0.0.1
+        169.254.0.1
+        172.16.0.1
+        191.255.0.1
+        192.0.0.1
+        192.0.2.1
+        192.168.0.1
+        198.18.0.1
+        223.255.255.1
+        224.0.0.1
+        240.0.0.1
+        255.255.255.255
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.ipv6_relay?(address).should be_false
+      end
+    end
+  end
+
+  describe 'self.benchmark?' do
+    it 'should be true when is not in benchmark pool' do
+      %w(
+        198.18.0.1
+      ).each do |address|
+        IPv4Address.benchmark?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not in benchmark pool' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        10.0.0.1
+        14.0.0.1
+        127.0.0.1
+        128.0.0.1
+        169.254.0.1
+        172.16.0.1
+        191.255.0.1
+        192.0.0.1
+        192.0.2.1
+        192.88.99.1
+        192.168.0.1
+        223.255.255.1
+        224.0.0.1
+        240.0.0.1
+        255.255.255.255
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.benchmark?(address).should be_false
+      end
+    end
+  end
+
+  describe 'self.multicast?' do
+    it 'should be true when is not in multicast pool' do
+      %w(
+        224.0.0.1
+      ).each do |address|
+        IPv4Address.multicast?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not in multicast pool' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        10.0.0.1
+        14.0.0.1
+        127.0.0.1
+        128.0.0.1
+        169.254.0.1
+        172.16.0.1
+        191.255.0.1
+        192.0.0.1
+        192.0.2.1
+        192.88.99.1
+        192.168.0.1
+        198.18.0.1
+        223.255.255.1
+        240.0.0.1
+        255.255.255.255
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.multicast?(address).should be_false
+      end
+    end
+  end
+
+  describe 'self.is?' do
+    it 'should be true when is an ipv4 address' do
+      %w(
+        74.125.127.83
+        0.0.0.0
+        10.0.0.1
+        14.0.0.1
+        127.0.0.1
+        128.0.0.1
+        169.254.0.1
+        172.16.0.1
+        191.255.0.1
+        192.0.0.1
+        192.0.2.1
+        192.88.99.1
+        192.168.0.1
+        198.18.0.1
+        223.255.255.1
+        224.0.0.1
+        240.0.0.1
+        255.255.255.255
+      ).each do |address|
+        IPv4Address.is?(address).should be_true
+      end
+    end
+
+    it 'should be false when is not an ipv4 address' do
+      %w(
+        256.0.0.0
+        255.256.0.0
+        255.255.256.0
+        255.255.255.256
+        999.999.999.999
+        string
+      ).each do |address|
+        IPv4Address.is?(address).should be_false
+      end
+    end
+  end
+
+  describe 'self.internet_routable?' do
+    before(:each) do
+      @ipv4_address = mock(IPv4Address, :internet_routable? => false)
+    end
+
+    it 'should be true when given string is an ip address and it is internet routable' do
+      IPv4Address.should_receive(:is?).with('IPv4Address').and_return(true)
+      @ipv4_address.should_receive(:internet_routable?).and_return(true)
+      IPv4Address.should_receive(:new).with(:addr).and_return(@ipv4_address)
+      IPv4Address.internet_routable?(:addr).should be_true
+    end
+
+    it 'should be false when string is an ip address but it is not internet routable' do
+      IPv4Address.should_receive(:is?).with('IPv4Address').and_return(true)
+      @ipv4_address.should_receive(:internet_routable?).and_return(false)
+      IPv4Address.should_receive(:new).with(:addr).and_return(@ipv4_address)
+      IPv4Address.internet_routable?(:addr).should be_false
+    end
+
+    it 'should be false when' do
+      IPv4Address.should_receive(:is?).with('IPv4Address').and_return(false)
+      IPv4Address.internet_routable?(:addr).should be_false
+    end
+  end
+
+  describe 'instance method' do
+    before(:each) do
+      @ipv4_address = IPv4Address.new
+    end
+
+    describe 'internet_routable?' do
+      before(:each) do
+        @ipv4_address.stub!(
+          :reserved? => false,
+          :private? => false,
+          :loopback? => false,
+          :link_local? => false,
+          :documentation? => false,
+          :ipv6_relay? => false,
+          :benchmark? => false,
+          :multicast? => false
+        )
+      end
+
+      it 'should be true when address is not in any pools' do
+        @ipv4_address.should_receive(:reserved?).and_return(false)
+        @ipv4_address.should_receive(:private?).and_return(false)
+        @ipv4_address.should_receive(:loopback?).and_return(false)
+        @ipv4_address.should_receive(:link_local?).and_return(false)
+        @ipv4_address.should_receive(:documentation?).and_return(false)
+        @ipv4_address.should_receive(:ipv6_relay?).and_return(false)
+        @ipv4_address.should_receive(:benchmark?).and_return(false)
+        @ipv4_address.should_receive(:multicast?).and_return(false)
+        @ipv4_address.internet_routable?.should be_true
+      end
+
+      it 'should be false when address is in reserved pool' do
+        @ipv4_address.should_receive(:reserved?).and_return(true)
+        @ipv4_address.internet_routable?.should be_false
+      end
+
+      it 'should be false when address is in  pool' do
+        @ipv4_address.should_receive(:private?).and_return(true)
+        @ipv4_address.internet_routable?.should be_false
+      end
+
+      it 'should be false when address is in loopback pool' do
+        @ipv4_address.should_receive(:loopback?).and_return(true)
+        @ipv4_address.internet_routable?.should be_false
+      end
+
+      it 'should be false when address is in link_local pool' do
+        @ipv4_address.should_receive(:link_local?).and_return(true)
+        @ipv4_address.internet_routable?.should be_false
+      end
+
+      it 'should be false when address is in documentation pool' do
+        @ipv4_address.should_receive(:documentation?).and_return(true)
+        @ipv4_address.internet_routable?.should be_false
+      end
+
+      it 'should be false when address is in ipv6_relay pool' do
+        @ipv4_address.should_receive(:ipv6_relay?).and_return(true)
+        @ipv4_address.internet_routable?.should be_false
+      end
+
+      it 'should be false when address is in benchmark pool' do
+        @ipv4_address.should_receive(:benchmark?).and_return(true)
+        @ipv4_address.internet_routable?.should be_false
+      end
+
+      it 'should be false when address is in multicast pool' do
+        @ipv4_address.should_receive(:multicast?).and_return(true)
+        @ipv4_address.internet_routable?.should be_false
+      end
+    end
+
+    it 'reserved? should check_existance in proper pool' do
+      @ipv4_address.should_receive(:exist_in_pool?).with(IPv4Address::RESERVED)
+      @ipv4_address.reserved?
+    end
+
+    it 'private? should check_existance in proper pool' do
+      @ipv4_address.should_receive(:exist_in_pool?).with(IPv4Address::PRIVATE)
+      @ipv4_address.private?
+    end
+
+    it 'loopback? should check_existance in proper pool' do
+      @ipv4_address.should_receive(:exist_in_pool?).with(IPv4Address::LOOPBACK)
+      @ipv4_address.loopback?
+    end
+
+    it 'link_local? should check_existance in proper pool' do
+      @ipv4_address.should_receive(:exist_in_pool?).with(IPv4Address::LINK_LOCAL)
+      @ipv4_address.link_local?
+    end
+
+    it 'documentation? should check_existance in proper pool' do
+      @ipv4_address.should_receive(:exist_in_pool?).with(IPv4Address::DOCUMENTATION)
+      @ipv4_address.documentation?
+    end
+
+    it 'ipv6_relay? should check_existance in proper pool' do
+      @ipv4_address.should_receive(:exist_in_pool?).with(IPv4Address::IPV6_RELAY)
+      @ipv4_address.ipv6_relay?
+    end
+
+    it 'benchmark? should check_existance in proper pool' do
+      @ipv4_address.should_receive(:exist_in_pool?).with(IPv4Address::BENCHMARK)
+      @ipv4_address.benchmark?
+    end
+
+    it 'multicast? should check_existance in proper pool' do
+      @ipv4_address.should_receive(:exist_in_pool?).with(IPv4Address::MULTICAST)
+      @ipv4_address.multicast?
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ipv4_address'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: ipv4_address
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Marcin Nowicki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Recognize ipv4 addresses in many ways
+email: pr0d1r2@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/ipv4_address.rb
+- spec/ipv4_address_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/Pr0d1r2/ipv4_address
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Recognition of ipv4 addresses
+test_files: 
+- spec/ipv4_address_spec.rb
+- spec/spec_helper.rb