sypex_geo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b509a171c46e45958ffd1cd999fd539e7d307e0
+  data.tar.gz: 876b33e9d0a53db5826f9b7850dbdc66b5d616cd
+SHA512:
+  metadata.gz: 2c6922ee63332e359bde80669f918627dfe196aa8cdf4a7b44c9014eaba363dcc6ae1a9e457e9313f0048ead8cd0b7f365f9ea0adf2b2b436eaa47a30daf308b
+  data.tar.gz: 20b94c1123899ced1bbe980ed16cd9e3493237d1741957ae688f988db9e69b477898e4f28ad563f36fd5a0aaf07a9f1b265781a397a3f51ad49ad7ca244bf815

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+pkg/
+.bundle
+.config
+Gemfile.lock
+coverage
+tmp
+*.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=doc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kolesnikov Danil
+
+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,30 @@
+# SypexGeo
+
+[Sypex Geo IP database](http://sypexgeo.net) adapter for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sypex_geo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sypex_geo
+
+## Usage
+
+    require 'sypex_geo'
+
+    db = SypexGeo::Database.new('./sypex_geo_city_max.dat')
+    db.lookup(<IPv4 address>)
+
+## License
+
+Licensed under the MIT License
+
+Copyright (c) 2014 Kolesnikov Danil

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sypex_geo/version.rb

@@ -0,0 +1,3 @@
+module SypexGeo
+  VERSION = '0.0.1'
+end

data/lib/sypex_geo.rb

@@ -0,0 +1,261 @@
+require 'ipaddr'
+require 'sypex_geo/version'
+
+module SypexGeo
+  TYPE_COUNTRY = 0
+  TYPE_REGION  = 1
+  TYPE_CITY    = 2
+
+  COUNTRY_CODES = %w[
+    AP EU AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AZ BA BB BD BE BF BG
+    BH BI BJ BM BN BO BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN
+    CO CR CU CV CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM
+    FO FR FX GA GB GD GE GF GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN
+    HR HT HU ID IE IL IN IO IQ IR IS IT JM JO JP KE KG KH KI KM KN KP KR KW
+    KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD MG MH MK ML MM MN MO MP
+    MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA
+    PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RU RW SA SB SC SD SE SG
+    SH SI SJ SK SL SM SN SO SR ST SV SY SZ TC TD TF TG TH TJ TK TM TN TO TL
+    TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT RS ZA
+    ZM ME ZW A1 A2 O1 AX GG IM JE BL MF
+  ]
+
+  class DatabaseError < StandardError
+  end
+
+  class Database
+    attr_reader :version
+
+    def initialize(path)
+      @file = File.open(path, 'rb')
+
+      setup!
+    end
+
+    def lookup(ip, full = false)
+      if seek = search(ip)
+        read_location(seek, full)
+      end
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id} @version=#{@version}>"
+    end
+
+    protected
+
+    def setup!
+      if header = @file.read(40)
+        id, @version, @time, @type, @charset,
+        @b_idx_len, @m_idx_len, @range, @db_items, @id_len,
+        @max_region, @max_city, @region_size, @city_size,
+        @max_country, @country_size,
+        @pack_size = header.unpack('a3CNCCCnnNCnnNNnNn')
+      end
+
+      raise DatabaseError.new, 'Wrong file format' unless id == 'SxG'
+
+      @pack = @file.read(@pack_size).split("\0")
+      @b_idx_arr = @file.read(@b_idx_len * 4).unpack('N*')
+      @m_idx_arr = @file.read(@m_idx_len * 4).scan(/.{1,4}/m)
+
+      @block_len = 3 + @id_len
+      @db_begin = @file.tell
+      @regions_begin = @db_begin + @db_items * @block_len
+      @cities_begin = @regions_begin + @region_size
+    end
+
+    def search(ip)
+      ip1n = ip.to_i
+
+      return if ip1n == 0 or ip1n == 127 or ip1n >= 224
+
+      ipn = IPAddr.new(ip).hton
+      blocks_min, blocks_max = @b_idx_arr[ip1n - 1], @b_idx_arr[ip1n]
+
+      if blocks_max - blocks_min > @range
+        part = search_idx(ipn, blocks_min / @range, (blocks_max / @range) - 1)
+        min = part > 0 ? part * @range : 0
+        max = part > @m_idx_len ? @db_items : (part + 1) * @range
+        min = blocks_min if min < blocks_min
+        max = blocks_max if max > blocks_max
+      else
+        min = blocks_min
+        max = blocks_max
+      end
+
+      search_db(ipn, min, max)
+    end
+
+    def search_idx(ipn, min, max)
+      idx = @m_idx_arr
+
+      while max - min > 8
+        offset = (min + max) >> 1
+
+        if ipn > idx[offset]
+          min = offset
+        else
+          max = offset
+        end
+      end
+
+      while ipn > idx[min]
+        break if min >= max
+        min += 1
+      end
+
+      min
+    end
+
+    def search_db(ipn, min, max)
+      len = max - min
+      @file.pos = @db_begin + min * @block_len
+      search_db_chunk(@file.read(len * @block_len), ipn, 0, len - 1)
+    end
+
+    def search_db_chunk(data, ipn, min, max)
+      block_len = @block_len
+
+      if max - min > 1
+        ipn = ipn[1, 3]
+
+        while max - min > 8
+          offset = (min + max) >> 1
+
+          if ipn > data[offset * block_len, 3]
+            min = offset
+          else
+            max = offset
+          end
+        end
+
+        while ipn >= data[min * block_len, 3]
+          min += 1
+          break if min >= max
+        end
+      else
+        min += 1
+      end
+
+      data[min * block_len - @id_len, @id_len].unpack('H*').first.hex
+    end
+
+    def read_data(seek, limit, type)
+      @file.pos = (type == TYPE_REGION ? @regions_begin : @cities_begin) + seek
+      Pack.parse(@pack[type], @file.read(limit))
+    end
+
+    def read_country(seek)
+      read_data(seek, @max_country, TYPE_COUNTRY)
+    end
+
+    def read_region(seek)
+      read_data(seek, @max_region, TYPE_REGION)
+    end
+
+    def read_city(seek)
+      read_data(seek, @max_city, TYPE_CITY)
+    end
+
+    def read_location(seek, full = false)
+      region = nil
+      city = nil
+      country = nil
+
+      if seek < @country_size
+        country = read_country(seek)
+      elsif city = read_city(seek)
+        region_seek = city.delete(:region_seek)
+        country_id = city.delete(:country_id)
+        country = { id: country_id, iso: COUNTRY_CODES[country_id - 1] }
+      end
+
+      if full and region_seek
+        region = read_region(region_seek)
+        country = read_country(region.delete(:country_seek))
+      end
+
+      { city: city, region: region, country: country }
+    end
+  end
+
+  class MemoryDatabase < Database
+    def setup!
+      super
+
+      @db = @file.read(@db_items * @block_len)
+      @regions_db = @file.read(@region_size) if @region_size > 0
+      @cities_db = @file.read(@city_size) if @city_size > 0
+    end
+
+    def search_db(ipn, min, max)
+      search_db_chunk(@db, ipn, min, max)
+    end
+
+    def read_data(seek, limit, type)
+      raw = (type == TYPE_REGION ? @regions_db : @cities_db)[seek, limit]
+      Pack.parse(@pack[type], raw)
+    end
+  end
+
+  module Pack
+    def self.parse(pack, data)
+      result = {}
+      pos = 0
+
+      pack.split('/').each do |p|
+        type, name = p.split(':')
+
+        if data.nil? or data.empty?
+          result[name] = type[0] =~ /b|c/ ? '' : 0
+        else
+          if type[0] == 'b'
+            len = data.index("\0", pos) - pos
+            val = data[pos, len].force_encoding('UTF-8')
+            len += 1
+          else
+            len = type_length(type)
+            val = unpack(type, data[pos, len])
+          end
+
+          result[name] = val.is_a?(Array) ? val[0] : val
+          pos += len
+        end
+      end
+
+      Hash[result.map{ |k, v| [ k.to_sym, v ] }]
+    end
+
+    protected
+
+    def self.type_length(type)
+      case type[0]
+      when /t|T/   then 1
+      when /s|S|n/ then 2
+      when /m|M/   then 3
+      when 'd'     then 8
+      when 'c'     then type[1..-1].to_i
+      else 4
+      end
+    end
+
+    def self.unpack(type, val)
+      case type[0]
+      when 't' then val.unpack('c')
+      when 'T' then val.unpack('C')
+      when 's' then val.unpack('s')
+      when 'S' then val.unpack('S')
+      when 'm' then (val + (val[2].ord >> 7) > 0 ? "\xFF" : "\0").unpack('l')
+      when 'M' then (val + "\0").unpack('L')
+      when 'i' then val.unpack('l')
+      when 'I' then val.unpack('L')
+      when 'f' then val.unpack('f')
+      when 'd' then val.unpack('d')
+      when 'n' then val.unpack('s')[0] / (10 ** type[1].to_i)
+      when 'N' then val.unpack('l')[0] / (10 ** type[1].to_i)
+      when 'c' then val.rstrip
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+if ENV['SIMPLECOV']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/support/invalid.dat

@@ -0,0 +1 @@
+invalid

data/spec/sypex_geo_spec.rb

@@ -0,0 +1,116 @@
+require 'sypex_geo'
+
+describe SypexGeo do
+  let(:demo_ip) do
+    # Random Moscow IP.
+    '80.90.64.1'
+  end
+
+  let(:default_db_file) do
+    File.expand_path(__FILE__ + '/../support/sypexgeo_city_max.dat')
+  end
+
+  let(:invalid_db_file) do
+    File.expand_path(__FILE__ + '/../support/invalid.dat')
+  end
+
+  let(:db_file) do
+    ENV['SYPEXGEO_CITY_MAX_DB'] || default_db_file
+  end
+
+  let(:city_info) do
+    {
+      city: {
+        id: 524901,
+        lat: 55,
+        lon: 37,
+        name_ru: 'Москва',
+        name_en: 'Moscow',
+        okato: '45'
+      },
+      country: {
+        id: 185,
+        iso: 'RU'
+      },
+      region: nil
+    }
+  end
+
+  let(:location_info) do
+    {
+      city: {
+        id: 524901,
+        lat: 55,
+        lon: 37,
+        name_ru: 'Москва',
+        name_en: 'Moscow',
+        okato: '45'
+      },
+      region: {
+        id: 524894,
+        name_ru: 'Москва',
+        name_en: 'Moskva',
+        lat: 55,
+        lon: 37,
+        iso: 'RU-MOW',
+        timezone: 'Europe/Moscow',
+        okato: '45'
+      },
+      country: {
+        id: 185,
+        iso: 'RU',
+        continent: 'EU',
+        lat: 60,
+        lon: 100,
+        name_ru: 'Россия',
+        name_en: 'Russia',
+        timezone: 'Europe/Moscow'
+      }
+    }
+  end
+
+  shared_examples 'geoip_database' do
+    describe '#initialize' do
+      it 'raises error if database is invalid' do
+        expect do
+          subject.class.new(invalid_db_file)
+        end.to raise_error(SypexGeo::DatabaseError)
+      end
+    end
+
+    describe '#lookup' do
+      it 'returns nil if IP address is reserved' do
+        expect(subject.lookup('0.0.0.0')).to be_nil
+        expect(subject.lookup('127.0.0.0')).to be_nil
+        expect(subject.lookup('224.0.0.0')).to be_nil
+        expect(subject.lookup('255.0.0.0')).to be_nil
+      end
+
+      it 'raises IPAddr::InvalidAddressError if IP address is invalid' do
+        expect do
+          subject.lookup('1.invalid')
+        end.to raise_error(IPAddr::InvalidAddressError)
+      end
+
+      it 'returns city info' do
+        expect(subject.lookup(demo_ip)).to eq(city_info)
+      end
+
+      it 'returns detailed location info if specified' do
+        expect(subject.lookup(demo_ip, true)).to eq(location_info)
+      end
+    end
+  end
+
+  describe SypexGeo::Database do
+    subject(:db) { SypexGeo::Database.new(db_file) }
+
+    it_behaves_like 'geoip_database'
+  end
+
+  describe SypexGeo::MemoryDatabase do
+    subject(:db) { SypexGeo::MemoryDatabase.new(db_file) }
+
+    it_behaves_like 'geoip_database'
+  end
+end

data/sypex_geo.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'sypex_geo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sypex_geo'
+  spec.version       = SypexGeo::VERSION
+  spec.authors       = ['Kolesnikov Danil']
+  spec.email         = ['kolesnikovde@gmail.com']
+  spec.summary       = 'Sypex Geo IP database adapter for Ruby.'
+  spec.description   = 'Sypex Geo IP database adapter for Ruby.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: sypex_geo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kolesnikov Danil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sypex Geo IP database adapter for Ruby.
+email:
+- kolesnikovde@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sypex_geo.rb
+- lib/sypex_geo/version.rb
+- spec/spec_helper.rb
+- spec/support/invalid.dat
+- spec/sypex_geo_spec.rb
+- sypex_geo.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Sypex Geo IP database adapter for Ruby.
+test_files:
+- spec/spec_helper.rb
+- spec/support/invalid.dat
+- spec/sypex_geo_spec.rb