ipcat 0.1.0

data/README.md

@@ -0,0 +1,28 @@
+# ipcat-ruby
+
+A ruby port of the [ipcat](https://github.com/client9/ipcat) library to classify IP addresses from known datacenters
+
+## Installation
+
+With bundler:
+
+    # In Gemfile
+    gem 'ipcat'
+
+Or with rubygems:
+
+    gem install ipcat
+
+## Usage
+
+    IPCat.matches?(ip_address)
+
+It will return an IPCat::IPRange if ip_address is from a known datacenter; nil otherwise.
+
+For example,
+
+    range = IPCat.matches?('8.18.145.0') # => instance of IPCat::IPRange
+    range.name # => 'Amazon AWS'
+
+    IPCat.matches?('127.0.0.1') # => nil
+

data/Rakefile

@@ -0,0 +1,17 @@
+require "rubygems"
+require "bundler/setup"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+    t.pattern = "spec/*_spec.rb"
+end
+
+task :default => :test
+
+task :generate_dataset do
+
+  $:.unshift './lib'
+  require 'ipcat'
+  IPCat.load_csv!
+  File.open("data/datacenters", 'w') {|f| f << Marshal.dump(IPCat.ranges) }
+end

data/lib/ipcat.rb

@@ -0,0 +1,70 @@
+##
+# IPCat
+# Ruby lib for https://github.com/client9/ipcat/
+
+require 'ipaddr'
+require 'ipcat/iprange'
+require 'ipcat/version'
+
+
+class IPCat
+  class << self
+    def matches?(ip)
+      bsearch(ip_to_fixnum(ip))
+    end
+
+    def ip_to_fixnum(ip)
+      Fixnum === ip ? ip : IPAddr.new(ip).to_i
+    end
+
+    def ranges
+      @ranges ||= []
+    end
+
+    def reset_ranges!(new_ranges = [])
+      @ranges = new_ranges
+    end
+
+    def load_csv!(path='https://raw.github.com/client9/ipcat/master/datacenters.csv')
+      reset_ranges!
+
+      require 'open-uri'
+      open(path).readlines.each do |line|
+        next if line =~/\s*#/ # Skip comments
+        first, last, name, url = line.split(',')
+        self.ranges << IPRange.new(first, last, name, url).freeze
+      end
+      self.ranges.freeze
+    end
+
+    def load!
+      reset_ranges!
+      # NB: loading an array of marshaled ruby objects takes ~15ms;
+      # versus ~100ms to load a CSV file
+      path = File.join(File.dirname(__FILE__), '..', 'data', 'datacenters')
+      @ranges = Marshal.load(File.read(path))
+      @ranges.each(&:freeze)
+      @ranges.freeze
+    rescue
+      load_csv!
+    end
+
+    # Assume ranges is an array of comparable objects
+    def bsearch(needle, haystack=ranges, first=0, last=ranges.size-1)
+      return nil if last < first # not found, or empty range
+
+      cur = first + (last - first)/2
+      case ranges[cur] <=> needle
+      when -1 # needle is larger than cur value
+        bsearch(needle, haystack, cur+1, last)
+      when 1 # needle is smaller than cur value
+        bsearch(needle, haystack, first, cur-1)
+      when 0
+        ranges[cur]
+      end
+    end
+  end
+end
+
+# Load dataset
+IPCat.load!

data/lib/ipcat/iprange.rb

@@ -0,0 +1,34 @@
+class IPCat
+  class IPRange
+
+    attr_accessor :first, :last, :name, :url
+
+    def initialize(first, last, name=nil, url=nil)
+      @first = IPCat.ip_to_fixnum(first)
+      @last  = IPCat.ip_to_fixnum(last)
+      @name, @url = name, url
+      raise ArgumentError.new("first must be <= last") if @first > @last
+    end
+
+    def <=>(obj)
+      case obj
+      when Fixnum
+        compare_with_fixnum(obj)
+      when IPRange
+        # Assume all IPRanges are non-overlapping
+        first <=> obj.first
+      end
+    end
+
+    protected
+    def compare_with_fixnum(i)
+      if first > i
+        1
+      elsif last < i
+        -1
+      else
+        0
+      end
+    end
+  end
+end

data/lib/ipcat/version.rb

@@ -0,0 +1,3 @@
+class IPCat
+  VERSION = '0.1.0'
+end

data/spec/benchmark_spec.rb

@@ -0,0 +1,32 @@
+require_relative 'spec_helper'
+require 'minitest/benchmark'
+
+describe 'IPCat.bsearch' do
+
+  # Makes +n+ IPRanges
+  def make_ranges(n)
+    ips = (n*2).times.map{ rand(2**32) }.sort
+    ranges = []
+    ips.each_slice(2) do |first, last|
+      ranges << IPCat::IPRange.new(first, last)
+    end
+
+    ranges
+  end
+
+  before do
+    @ips = 1000.times.map{ rand(2**32) }
+    @ranges = MiniTest::Spec.bench_range.inject({}) {|h, n|
+      h[n] = make_ranges(n)
+      h
+    }
+  end
+
+  it("should be logarithmic") do
+    assert_performance_logarithmic 0.95 do |n|
+      IPCat.reset_ranges!(@ranges[n])
+      @ips.each { |ip| IPCat.bsearch(ip) }
+    end
+  end
+
+end

data/spec/ipcat_iprange_spec.rb

@@ -0,0 +1,26 @@
+require_relative 'spec_helper'
+
+describe 'IPCat::IPRange' do
+  attr_accessor :range
+
+  before do
+    IPCat.reset_ranges!
+    first = IPAddr.new('1.2.3.0').to_i
+    last = IPAddr.new('1.2.3.255').to_i
+    @range = IPCat::IPRange.new(first, last, 'example', 'www.example.com')
+  end
+
+  describe '#initialize' do
+    it "should fail if last < first" do
+      ->{ IPCat::IPRange.new(2, 1) }.must_raise ArgumentError
+    end
+  end
+
+  describe '#<=> for fixnums' do
+    it("should match first")   { (range <=> range.first).must_equal 0 }
+    it("should match last")    { (range <=> range.last).must_equal 0 }
+    it("should match first-1") { (range <=> range.first - 1).must_equal 1 }
+    it("should match last+1")  { (range <=> range.last + 1).must_equal -1 }
+  end
+end
+

data/spec/ipcat_spec.rb

@@ -0,0 +1,24 @@
+require_relative 'spec_helper'
+
+describe 'IPCat' do
+
+  before do
+    IPCat.reset_ranges!
+    start = IPAddr.new('1.2.3.0').to_i
+    stop = IPAddr.new('1.2.3.255').to_i
+    IPCat.ranges << IPCat::IPRange.new(start, stop, 'example', 'www.example.com')
+  end
+
+  describe '#ranges' do
+   it("has a range") { IPCat.ranges.size.must_equal 1 }
+  end
+
+  describe '#matches?' do
+    it("should match 1.2.3.0") { IPCat.matches?('1.2.3.0').must_be_instance_of IPCat::IPRange }
+    it("should match 1.2.3.1") { IPCat.matches?('1.2.3.1').must_be_instance_of IPCat::IPRange }
+    it("should match 1.2.3.1") { IPCat.matches?('1.2.3.1').must_be_instance_of IPCat::IPRange }
+    it("should not match 1.1.1.1") { IPCat.matches?('1.1.1.1').must_be_nil }
+    it("should not match 2.2.2.2") { IPCat.matches?('2.2.2.2').must_be_nil }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler/setup"
+
+require "minitest/autorun"
+require 'debugger'
+
+require "ipcat"

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: ipcat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Suggs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+description: ! 'A ruby port of the ipcat library: https://github.com/client9/ipcat/'
+email: aaron@ktheory.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ipcat/iprange.rb
+- lib/ipcat/version.rb
+- lib/ipcat.rb
+- data/datacenters
+- Rakefile
+- README.md
+- spec/benchmark_spec.rb
+- spec/ipcat_iprange_spec.rb
+- spec/ipcat_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kickstarter/ipcat-ruby
+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
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: dataset for categorizing IP addresses in ruby
+test_files:
+- spec/benchmark_spec.rb
+- spec/ipcat_iprange_spec.rb
+- spec/ipcat_spec.rb
+- spec/spec_helper.rb