qqwry 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qqwry.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Changli Gao
+
+MIT License
+
+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,39 @@
+# QQWry
+
+A Ruby interface for QQWry IP database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qqwry'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qqwry
+
+## Usage
+
+At First, you need to get the latest QQWry IP database from http://www.cz88.net
+
+````ruby
+require 'rubygems'
+require 'bundler/setup'
+require 'qqwry'
+
+db = QQWry::Database.new('QQWry.Dat')
+r = db.query('8.8.8.8')
+puts "#{r.country} #{r.area}"
+````
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*.rb']
+end
+
+task :default => :build

data/bin/qqwry

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'qqwry'
+require 'optparse'
+require 'csv'
+
+db_path = 'QQWry.Dat'
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #$0 [options] (dump FN.csv)|(query IP)|version"
+
+  opts.separator('Version: ' + QQWry::VERSION)
+  opts.separator('Options:')
+
+  opts.on('-d', '--database PATH',
+          'Use the database at PATH instead of QQWry.Dat') do |d|
+    db_path = d
+  end
+
+  opts.on('-h', '--help', 'Show this message') do |h|
+    puts opts
+    exit
+  end
+end
+opt_parser.parse!(ARGV)
+
+db = QQWry::Database.new(db_path)
+case ARGV[0]
+when 'dump'
+  if ARGV.length != 2
+    puts opt_parser
+    exit(1)
+  end
+  CSV.open(ARGV[1], 'w') do |writer|
+    db.each do |r|
+      writer << [r.ip_str_start, r.ip_str_end, r.country, r.area]
+    end
+  end
+when 'query'
+  if ARGV.length != 2
+    puts opt_parser
+    exit(1)
+  end
+  r = db.query(ARGV[1])
+  puts "country: #{r.country}"
+  puts "area: #{r.area}"
+when 'version'
+  if ARGV.length != 1
+    puts opt_parser
+    exit(1)
+  end
+  puts db.version
+else
+  puts opt_parser
+  exit(1)
+end

data/lib/qqwry.rb

@@ -0,0 +1,4 @@
+
+require 'qqwry/database'
+require 'qqwry/record'
+require 'qqwry/version'

data/lib/qqwry/database.rb

@@ -0,0 +1,76 @@
+
+require 'qqwry/record'
+
+module QQWry
+  class Header < BinData::Record
+    SIZE = 8
+    endian :little
+    uint32 :index_offset_start
+    uint32 :index_offset_end
+  end
+
+  class Index < BinData::Record
+    SIZE = 7
+    endian :little
+    uint32 :ip_start
+    uint24 :record_offset
+  end
+
+  class Database
+    def initialize(file = 'QQWrt.Dat')
+      if file.respond_to?(:to_str)
+        @file = File.new(file.to_str)
+      else
+        @file = file
+        @file.seek(0)
+      end
+      @header = QQWry::Header.read(@file)
+    end
+
+    def each
+      offset = @header.index_offset_start
+      while offset <= @header.index_offset_end
+        @file.seek(offset)
+        index = QQWry::Index.read(@file)
+        record = QQWry::Record.new(index.ip_start, @file, index.record_offset)
+        yield record
+        offset += QQWry::Index::SIZE
+      end
+    end
+
+    def version
+      # The last record saves the version info
+      @file.seek(@header.index_offset_end)
+      index = QQWry::Index.read(@file)
+      r = QQWry::Record.new(0, @file, index.record_offset)
+      r.country + r.area
+    end
+
+    def query(ip)
+      if ip.respond_to?(:to_str)
+        ip = ip.to_str.split('.').collect{|i| i.to_i}.pack('C4').unpack('N')[0]
+      end
+      raise ArgumentError, "invalid IP" unless (0...(1 << 32)).include?(ip)
+      @file.seek(QQWry::Header::SIZE)
+      low = 0
+      # the end record is the version info
+      start = @header.index_offset_start
+      high = (@header.index_offset_end - start) / QQWry::Index::SIZE
+      while low <= high
+        middle = (low + high) / 2
+        @file.seek(start + middle * QQWry::Index::SIZE)
+        index = QQWry::Index.read(@file)
+        if ip > index.ip_start
+          low = middle + 1
+        elsif ip < index.ip_start
+          high = middle - 1
+        else
+          return QQWry::Record.new(index.ip_start, @file, index.record_offset)
+        end
+      end
+      @file.seek(start + high * QQWry::Index::SIZE)
+      index = QQWry::Index.read(@file)
+      QQWry::Record.new(index.ip_start, @file, index.record_offset)
+    end
+  end
+end

data/lib/qqwry/record.rb

@@ -0,0 +1,78 @@
+
+require 'rubygems'
+require 'bundler/setup'
+require 'bindata'
+require 'iconv'
+
+module QQWry
+  class Record
+    attr_reader :ip_start, :ip_end, :country, :area
+
+    def initialize(ip_start, file, offset)
+      @ip_start = ip_start
+      file.seek(offset)
+      @ip_end = BinData::Uint32le.read(file).to_i
+      case BinData::Uint8.read(file).to_i
+      when 0x1
+        offset = BinData::Uint24le.read(file).to_i
+        file.seek(offset)
+        case BinData::Uint8.read(file).to_i
+        when 0x2
+          file.seek(BinData::Uint24le.read(file).to_i)
+          @country = BinData::Stringz.read(file).to_s
+          file.seek(offset + 4)
+        else
+          file.seek(-1, IO::SEEK_CUR)
+          @country = BinData::Stringz.read(file).to_s
+        end
+        parse_area(file)
+      when 0x2
+        offset = BinData::Uint24le.read(file).to_i
+        parse_area(file)
+        file.seek(offset)
+        @country = BinData::Stringz.read(file).to_s
+      else
+        file.seek(-1, IO::SEEK_CUR)
+        @country = BinData::Stringz.read(file).to_s
+        parse_area(file)
+      end
+      if @country
+        @country = Iconv.conv('UTF-8', 'GBK', @country)
+        @country = nil if @country=~ /\s*CZ88\.NET\s*/
+      end
+    end
+
+    def ip_str_start
+      ip_str(@ip_start)
+    end
+
+    def ip_str_end
+      ip_str(@ip_end)
+    end
+
+    private
+
+    def ip_str(ip)
+      [ip].pack('N').unpack('C4').join('.')
+    end
+
+    def parse_area(file)
+      case BinData::Uint8.read(file).to_i
+      when 0x1, 0x2
+        offset = BinData::Uint24le.read(file).to_i
+        if offset > 0
+          file.seek(offset)
+          @area = BinData::Stringz.read(file).to_s
+        end
+      else
+        file.seek(-1, IO::SEEK_CUR)
+        @area = BinData::Stringz.read(file).to_s
+      end
+      if @area
+        @area = Iconv.conv('UTF-8', 'GBK', @area)
+        # CZ88.NET is an advertisement
+        @area = nil if @area =~ /\s*CZ88\.NET\s*/
+      end
+    end
+  end
+end

data/lib/qqwry/version.rb

@@ -0,0 +1,4 @@
+
+module QQWry
+  VERSION = '0.0.1'
+end

data/qqwry.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qqwry/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "qqwry"
+  gem.version       = QQWry::VERSION
+  gem.authors       = ["Changli Gao"]
+  gem.email         = ["xiaosuo@gmail.com"]
+  gem.description   = %q{A Ruby interface for QQWry IP database}
+  gem.summary       = %q{A Ruby interface for QQWry IP database}
+  gem.homepage      = 'https://github.com/xiaosuo/qqwry'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.license       = 'MIT'
+  gem.add_dependency  'bindata'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'bindata'
+end

data/test/tc_database.rb

@@ -0,0 +1,82 @@
+
+require 'test/unit'
+require 'qqwry'
+
+class TC_DataBase < Test::Unit::TestCase
+  # one record
+  def test_one_record
+    s = "\x12\x00\x00\x00\x12\x00\x00\x00" + # header
+        "\xff\xff\xff\xffc1\x00a1\x00" + # record
+        "\x00\x00\x00\x00\x08\x00\x00" # index
+    db = QQWry::Database.new(StringIO.new(s))
+    assert_equal('c1a1', db.version)
+    records = []
+    db.each{|r| records << r}
+    assert_equal(1, records.length)
+    assert_equal('c1', records[0].country)
+    assert_equal('a1', records[0].area)
+    ['0.0.0.0', 0x01020304, '255.255.255.255'].each do |ip|
+      r = db.query(ip)
+      assert_equal('c1', r.country)
+      assert_equal('a1', r.area)
+    end
+    assert_raise(ArgumentError){db.query(-1)}
+    assert_raise(ArgumentError){db.query(1 << 32)}
+  end
+
+  # two records
+  def test_two_record
+    s = "\x1c\x00\x00\x00\x23\x00\x00\x00" + # header
+        "\xff\xff\x00\x00c1\x00a1\x00" + # record 1
+        "\xff\xff\xff\xffc2\x00a2\x00" + # record 2
+        "\x00\x00\x00\x00\x08\x00\x00" + # index 1
+        "\x00\x00\x01\x00\x12\x00\x00" # index 2
+    db = QQWry::Database.new(StringIO.new(s))
+    assert_equal('c2a2', db.version)
+    records = []
+    db.each{|r| records << r}
+    assert_equal(2, records.length)
+    r = [{:c => 'c1', :a => 'a1'}, {:c => 'c2', :a => 'a2'}]
+    (0...2).each do |i|
+      assert_equal(r[i][:c], records[i].country)
+      assert_equal(r[i][:a], records[i].area)
+    end
+    s = {'0.0.0.0' => r[0], '0.0.254.254' => r[0], '0.0.255.255' => r[0],
+         '0.1.0.0' => r[1], '0.1.2.3' => r[1], '255.255.255.255' => r[1]}
+    s.each do |ip, r|
+      rec = db.query(ip)
+      assert_equal(r[:c], rec.country)
+      assert_equal(r[:a], rec.area)
+    end
+  end
+
+  # three records
+  def test_three_record
+    s = "\x26\x00\x00\x00\x34\x00\x00\x00" + # header
+        "\xff\xff\x00\x00c1\x00a1\x00" + # record 1
+        "\xff\xff\xff\x00c2\x00a2\x00" + # record 2
+        "\xff\xff\xff\xffc3\x00a3\x00" + # record 3
+        "\x00\x00\x00\x00\x08\x00\x00" + # index 1
+        "\x00\x00\x01\x00\x12\x00\x00" + # index 2
+        "\x00\x00\x00\x01\x1c\x00\x00" # index 3
+    db = QQWry::Database.new(StringIO.new(s))
+    assert_equal('c3a3', db.version)
+    records = []
+    db.each{|r| records << r}
+    assert_equal(3, records.length)
+    r = [{:c => 'c1', :a => 'a1'}, {:c => 'c2', :a => 'a2'},
+         {:c => 'c3', :a => 'a3'}]
+    (0...3).each do |i|
+      assert_equal(r[i][:c], records[i].country)
+      assert_equal(r[i][:a], records[i].area)
+    end
+    s = {'0.0.0.0' => r[0], '0.0.254.254' => r[0], '0.0.255.255' => r[0],
+         '0.1.0.0' => r[1], '0.1.8.254' => r[1], '0.255.255.255' => r[1],
+         '1.0.0.0' => r[2], '1.2.3.4' => r[2], '255.255.255.255' => r[2]}
+    s.each do |ip, r|
+      rec = db.query(ip)
+      assert_equal(r[:c], rec.country)
+      assert_equal(r[:a], rec.area)
+    end
+  end
+end

data/test/tc_record.rb

@@ -0,0 +1,59 @@
+
+require 'test/unit'
+require 'qqwry'
+
+class TC_Record < Test::Unit::TestCase
+  def teardown
+    io = StringIO.new(@s)
+    r = QQWry::Record.new(0x01020300, io, 3)
+    assert_equal(0x01020300, r.ip_start)
+    assert_equal(0x01020304, r.ip_end)
+    assert_equal('1.2.3.0', r.ip_str_start)
+    assert_equal('1.2.3.4', r.ip_str_end)
+    if @nil_country
+      assert_equal(nil, r.country)
+    else
+      assert_equal('country', r.country)
+    end
+    if @nil_area
+      assert_equal(nil, r.area)
+    else
+      assert_equal('area', r.area)
+    end
+  end
+
+  def test_simple
+    @s = "pad\x04\x03\x02\x01country\x00area\x00"
+  end
+
+  def test_mode1
+    @s = "pad\x04\x03\x02\x01\x01\x0b\x00\x00country\x00area\x00"
+  end
+
+  def test_mode2
+    @s = "pad\x04\x03\x02\x01\x02\x10\x00\x00area\x00country\x00"
+  end
+
+  def test_mix1
+    @s = "pad\x04\x03\x02\x01\x01\x0b\x00\x00\x02\x14\x00\x00area\x00country\x00"
+  end
+
+  def test_mix2
+    @s = "pad\x04\x03\x02\x01\x01\x0b\x00\x00\x02\x13\x00\x00\x01\x1b\x00\x00country\x00area\x00"
+  end
+
+  def test_mix2_2
+    @s = "pad\x04\x03\x02\x01\x01\x0b\x00\x00\x02\x13\x00\x00\x02\x1b\x00\x00country\x00area\x00"
+  end
+
+  def test_zero_offset
+    @s = "pad\x04\x03\x02\x01\x01\x0b\x00\x00\x02\x13\x00\x00\x02\x00\x00\x00country\x00area\x00"
+    @nil_area = true
+  end
+
+  def test_adv
+    @s = "pad\x04\x03\x02\x01\x01\x0b\x00\x00\x02\x13\x00\x00\x02\x1c\x00\x00CZ88.NET\x00 CZ88.NET \x00"
+    @nil_country = true
+    @nil_area = true
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: qqwry
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Changli Gao
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bindata
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bindata
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A Ruby interface for QQWry IP database
+email: 
+- xiaosuo@gmail.com
+executables: 
+- qqwry
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/qqwry
+- lib/qqwry.rb
+- lib/qqwry/database.rb
+- lib/qqwry/record.rb
+- lib/qqwry/version.rb
+- qqwry.gemspec
+- test/tc_database.rb
+- test/tc_record.rb
+homepage: https://github.com/xiaosuo/qqwry
+licenses: 
+- MIT
+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.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby interface for QQWry IP database
+test_files: 
+- test/tc_database.rb
+- test/tc_record.rb