ip_ranger 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8974752f76e75a2534351500872629a61731fa1f
+  data.tar.gz: 8338b0d52238c2ff2264d4e8b0ada85893babb9a
+SHA512:
+  metadata.gz: e113d83b46a2897a7e9acabaec026cead9c1725607e537cb00184c72485307797f227735d58d18b6c6af4651ebfea32793b42a117bb026838a0a33087c4a0936
+  data.tar.gz: ccade4126370c6c62d7784e63e3880ba18bb39a77bc334c8e012fb0a11d60e467d6509987fd4e8a3eab0dbe0f80e1bb6f1f37611091909eb35a2594c6830c51d

data/lib/ip_ranger.rb

@@ -0,0 +1 @@
+require 'ip_ranger/ip_range'

data/lib/ip_ranger/ip_address.rb

@@ -0,0 +1,47 @@
+require 'ipaddr'
+require 'delegate'
+
+module IPRanger
+  class IPAddress < DelegateClass(IPAddr)
+    def self.from_integer(i, family, mask = nil)
+      address = IPAddr.new(i, family)
+      address = address.mask(mask) if mask
+
+      new(address)
+    end
+
+    def width
+      ipv4? ? 32 : 128
+    end
+
+    def succ
+      self.class.new(super)
+    end
+
+    def pred
+      self.class.new(IPAddr.new(to_i - 1, family))
+    end
+
+    def to_cidr
+      "#{to_string}/#{prefixlen}"
+    end
+
+    def prefixlen
+      mask_addr.to_s(2).count('1')
+    end
+
+    def first
+      to_range.first.to_i
+    end
+
+    def last
+      to_range.last.to_i
+    end
+
+    private
+
+    def mask_addr
+      __getobj__.instance_variable_get('@mask_addr')
+    end
+  end
+end

data/lib/ip_ranger/ip_range.rb

@@ -0,0 +1,93 @@
+require 'ip_ranger/ip_address'
+
+module IPRanger
+  class IPRange
+    attr_reader :start, :finish
+
+    def initialize(start, finish)
+      @start = IPAddress.new(start.is_a?(IPAddr) ? start : IPAddr.new(start))
+      @finish = IPAddress.new(finish.is_a?(IPAddr) ? finish : IPAddr.new(finish))
+
+      fail ArgumentError, 'IP sequence cannot contain both IPv4 and IPv6!' if @start.family != @finish.family
+    end
+
+    def cidrs
+      cidr_list = []
+      cidr_span = spanning_cidr
+
+      if cidr_span.first < first
+        exclude = first.pred
+        cidr_list = cidr_partition(cidr_span, exclude).last
+        cidr_span = cidr_list.pop
+      end
+
+      if cidr_span.last > last
+        exclude = last.succ
+        cidr_list += cidr_partition(cidr_span, exclude).first
+      else
+        cidr_list << cidr_span
+      end
+
+      cidr_list
+    end
+
+    def first
+      start.first
+    end
+
+    def last
+      finish.last
+    end
+
+    private
+
+    def spanning_cidr
+      ipnum = last
+      prefixlen = finish.prefixlen
+      lowest_ipnum = first
+      width = finish.width
+
+      while prefixlen > 0 && ipnum > lowest_ipnum
+        prefixlen -= 1
+        ipnum &= -(1 << (width - prefixlen))
+      end
+
+      IPAddress.from_integer(ipnum, finish.family, prefixlen)
+    end
+
+    def cidr_partition(target, exclude)
+      exclude = IPAddress.from_integer(exclude, target.family)
+      return [], [], [target] if exclude.last < target.first
+      return [target], [], [] if target.last < exclude.first
+      return [], [target], [] if target.prefixlen >= exclude.prefixlen
+
+      left = []
+      right = []
+
+      new_prefixlen = target.prefixlen + 1
+      target_width = target.width
+
+      target_first = target.first
+      i_lower = target_first
+      i_upper = target_first + (2 ** (target_width - new_prefixlen))
+
+      while exclude.prefixlen >= new_prefixlen
+        if exclude.first >= i_upper
+          left << IPAddress.from_integer(i_lower, target.family, new_prefixlen)
+          matched = i_upper
+        else
+          right << IPAddress.from_integer(i_upper, target.family, new_prefixlen)
+          matched = i_lower
+        end
+
+        new_prefixlen += 1
+        break if new_prefixlen > target_width
+
+        i_lower = matched
+        i_upper = matched + (2 ** (target_width - new_prefixlen))
+      end
+
+      [left, [exclude], right.reverse]
+    end
+  end
+end

data/spec/ip_ranger/ip_address_spec.rb

@@ -0,0 +1,73 @@
+require 'ip_ranger'
+
+RSpec.describe IPRanger::IPAddress do
+  describe '#to_cidr' do
+    it 'returns a full address with netmask' do
+      address = described_class.new(IPAddr.new('192.168.0.0/20'))
+
+      expect(address.to_cidr).to eq('192.168.0.0/20')
+    end
+  end
+
+  describe '#width' do
+    it 'returns 32 for an IPv4' do
+      address = described_class.new(IPAddr.new('192.168.1.1'))
+
+      expect(address.width).to eq(32)
+    end
+
+    it 'returns 128 for an IPv6' do
+      address = described_class.new(IPAddr.new('::1'))
+
+      expect(address.width).to eq(128)
+    end
+  end
+
+  describe '#succ' do
+    it 'returns the succeeding IPv4 address' do
+      address = described_class.new(IPAddr.new('192.168.1.1'))
+
+      expect(address.succ).to eq(IPAddr.new('192.168.1.2'))
+    end
+
+    it 'returns the succeeding IPv6 address' do
+      address = described_class.new(IPAddr.new('::1'))
+
+      expect(address.succ).to eq(IPAddr.new('::2'))
+    end
+  end
+
+  describe '#pred' do
+    it 'returns the preceeding IPv4 address' do
+      address = described_class.new(IPAddr.new('192.168.1.2'))
+
+      expect(address.pred).to eq(IPAddr.new('192.168.1.1'))
+    end
+
+    it 'returns the preceeding IPv6 address' do
+      address = described_class.new(IPAddr.new('::2'))
+
+      expect(address.pred).to eq(IPAddr.new('::1'))
+    end
+  end
+
+  describe '#prefixlen' do
+    it 'returns a length of 32 if a single IPv4 address' do
+      address = described_class.new(IPAddr.new('192.168.1.1'))
+
+      expect(address.prefixlen).to eq(32)
+    end
+
+    it 'returns a length of 128 if a single IPv6 address' do
+      address = described_class.new(IPAddr.new('::1'))
+
+      expect(address.prefixlen).to eq(128)
+    end
+
+    it 'returns the length if masked' do
+      address = described_class.new(IPAddr.new('192.168.1.1/24'))
+
+      expect(address.prefixlen).to eq(24)
+    end
+  end
+end

data/spec/ip_ranger/ip_range_spec.rb

@@ -0,0 +1,88 @@
+require 'ip_ranger'
+
+RSpec.describe IPRanger::IPRange do
+  it 'converts an IP range to two IPs' do
+    ip_range = described_class.new('1.1.1.1', '1.1.1.2')
+
+    expect(ip_range.cidrs).to contain_exactly(IPAddr.new('1.1.1.1/32'), IPAddr.new('1.1.1.2/32'))
+  end
+
+  it 'converts an IP range with two common subnets to CIDR blocks' do
+    ip_range = described_class.new('1.1.3.5', '1.1.11.50')
+
+    expect(ip_range.cidrs).to contain_exactly(
+      IPAddr.new('1.1.3.5/32'),
+      IPAddr.new('1.1.3.6/31'),
+      IPAddr.new('1.1.3.8/29'),
+      IPAddr.new('1.1.3.16/28'),
+      IPAddr.new('1.1.3.32/27'),
+      IPAddr.new('1.1.3.64/26'),
+      IPAddr.new('1.1.3.128/25'),
+      IPAddr.new('1.1.4.0/22'),
+      IPAddr.new('1.1.8.0/23'),
+      IPAddr.new('1.1.10.0/24'),
+      IPAddr.new('1.1.11.0/27'),
+      IPAddr.new('1.1.11.32/28'),
+      IPAddr.new('1.1.11.48/31'),
+      IPAddr.new('1.1.11.50/32')
+    )
+  end
+
+  it 'converts an IP range with no common subnets to CIDR blocks' do
+    ip_range = described_class.new('192.168.0.1', '200.50.50.50')
+
+    expect(ip_range.cidrs).to contain_exactly(
+      IPAddr.new('192.168.0.1/32'),
+      IPAddr.new('192.168.0.2/31'),
+      IPAddr.new('192.168.0.4/30'),
+      IPAddr.new('192.168.0.8/29'),
+      IPAddr.new('192.168.0.16/28'),
+      IPAddr.new('192.168.0.32/27'),
+      IPAddr.new('192.168.0.64/26'),
+      IPAddr.new('192.168.0.128/25'),
+      IPAddr.new('192.168.1.0/24'),
+      IPAddr.new('192.168.2.0/23'),
+      IPAddr.new('192.168.4.0/22'),
+      IPAddr.new('192.168.8.0/21'),
+      IPAddr.new('192.168.16.0/20'),
+      IPAddr.new('192.168.32.0/19'),
+      IPAddr.new('192.168.64.0/18'),
+      IPAddr.new('192.168.128.0/17'),
+      IPAddr.new('192.169.0.0/16'),
+      IPAddr.new('192.170.0.0/15'),
+      IPAddr.new('192.172.0.0/14'),
+      IPAddr.new('192.176.0.0/12'),
+      IPAddr.new('192.192.0.0/10'),
+      IPAddr.new('193.0.0.0/8'),
+      IPAddr.new('194.0.0.0/7'),
+      IPAddr.new('196.0.0.0/6'),
+      IPAddr.new('200.0.0.0/11'),
+      IPAddr.new('200.32.0.0/12'),
+      IPAddr.new('200.48.0.0/15'),
+      IPAddr.new('200.50.0.0/19'),
+      IPAddr.new('200.50.32.0/20'),
+      IPAddr.new('200.50.48.0/23'),
+      IPAddr.new('200.50.50.0/27'),
+      IPAddr.new('200.50.50.32/28'),
+      IPAddr.new('200.50.50.48/31'),
+      IPAddr.new('200.50.50.50/32')
+    )
+  end
+
+  it 'returns one address when the range is a single IP' do
+    ip_range = described_class.new('192.168.1.1', '192.168.1.1')
+
+    expect(ip_range.cidrs).to contain_exactly(IPAddr.new('192.168.1.1/32'))
+  end
+
+  it 'converts an IPv6 range to CIDR blocks' do
+    ip_range = described_class.new('2001:db8::', '2001:db8:0000:0000:0000:0000:0000:0001')
+
+    expect(ip_range.cidrs).to contain_exactly(IPAddr.new('2001:db8::/127'))
+  end
+
+  it 'raises if given incompatible IP addresses' do
+    expect { described_class.new('192.168.1.1', '2001:0db8:0000:0042:0000:8a2e:0370:7334') }.
+      to raise_error('IP sequence cannot contain both IPv4 and IPv6!')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  config.disable_monkey_patching!
+  config.warnings = true
+  config.default_formatter = 'doc' if config.files_to_run.one?
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ip_ranger
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Maciej Gajewski
+- Paul Mucur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email: support@altmetric.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ip_ranger.rb
+- lib/ip_ranger/ip_address.rb
+- lib/ip_ranger/ip_range.rb
+- spec/ip_ranger/ip_address_spec.rb
+- spec/ip_ranger/ip_range_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/altmetric/ip_ranger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A utility for converting IP ranges to CIDR subnets
+test_files:
+- spec/ip_ranger/ip_address_spec.rb
+- spec/ip_ranger/ip_range_spec.rb
+- spec/spec_helper.rb