geoipdb 0.5.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 960fb22c30747c4351d08c9bcc2ec6b42ec91315
-  data.tar.gz: a6b72d92b471418e70c3a15f3c4626c1e4de6eca
+  metadata.gz: 4a9d74eeb52c1411ef3b7615bdab98fa6ed21550
+  data.tar.gz: e496789447d83354ca3bb9305361cb836aef0671
 SHA512:
-  metadata.gz: 44f537dd1fb6558f3804fb0cabf8b174b6f3ecee197ed7dbb0c33f30626cf1b7ad7896908547cfdf4f97bf600e64c049f0aa489e5c8c7e8083aa271e8e3e7e22
-  data.tar.gz: c032a9926161171273711583fb5056f99a984f6dc7ea55b244fc15b6f4492b3b062ed3485470f42c7f266d299cfd29abf382c8c437cd042d8e5a9271d6b54aeb
+  metadata.gz: 4e85f35fbdd49016fa40b71be6a31ea14ed80dcdc75baaadc39124b43afa7f8f5df196851f8be3d1ac18fa3e37d473704bbca6440bb2a204c77f41a0744f368b
+  data.tar.gz: 842b770d73b5e0f054688f3bd45448c04a925a60c3b18ae5aa6324af1a67f352a84070e474f4b95c6e6755eb7a87ff9b738f1fb0300eadd13ef556e0d5f20480

data/.gitignore

@@ -5,14 +5,6 @@
 Gemfile.lock
 coverage
 doc
-ext/Makefile
-ext/geoipdb/Makefile
-ext/geoipdb/geoipdb.bundle
-ext/geoipdb/geoipdb.o
-ext/geoipdb/ipdb.o
-ext/geoipdb/test
-ext/geoipdb/test.o
-lib/geoipdb.jar
 pkg
 rdoc
 tags

data/.ruby-version

@@ -0,0 +1 @@
+jruby

data/Gemfile

@@ -1,9 +1,7 @@
-source "https://rubygems.org"
+source "http://rubygems.org"
 
 gemspec
 
-gem 'liquid-ext'
-
 group :development, :test do
   gem 'liquid-development'
 end

data/Makefile

@@ -0,0 +1,10 @@
+all: jar
+
+clean:
+	rm -rf lib/geoipdb.jar
+
+compile: clean
+	javac `find src/ -name '*.java'`
+
+jar: compile
+	jar cvf lib/geoipdb.jar -C src/ .

data/README.md

@@ -1,9 +1,6 @@
-# geoipdb: fast (in memory!) geo location db.
+# GeoIPDB
 
-Fast GeoIpDb implementation for Ruby using C/Java-Extensions.
-
-* Returns a GeoLocation and additional information for a given IP.
-* Reads Data from CSV-Files and uses internal binary caching.
+Fast GeoIPDB implementation for JRuby.
 
 [![Gem Version](https://badge.fury.io/rb/geoipdb.png)](http://badge.fury.io/rb/geoipdb)
 [![Build Status](https://secure.travis-ci.org/liquidm/geoipdb.png)](http://travis-ci.org/liquidm/geoipdb)

data/Rakefile

@@ -1,16 +1,3 @@
 require "bundler/setup"
 require "bundler/gem_tasks"
 require "liquid/tasks"
-
-case RUBY_PLATFORM
-when 'java'
-  require 'rake/javaextensiontask'
-  Rake::JavaExtensionTask.new('geoipdb')
-else
-  require 'rake/extensiontask'
-  Rake::ExtensionTask.new('geoipdb')
-end
-
-task :default => [:spec]
-task :build => :compile
-task :spec => :compile

data/geoipdb.gemspec

@@ -2,25 +2,18 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "geoipdb"
-  spec.version       = "0.5.8"
+  spec.version       = "1.0.0"
   spec.authors       = ["LiquidM, Inc."]
   spec.email         = ["opensource@liquidm.com"]
-  spec.description   = "Fast GeoIpDb implementation for Ruby"
-  spec.summary       = "Fast GeoIpDb implementation for Ruby"
+  spec.description   = "Fast IPDB implementation for JRuby"
+  spec.summary       = "Fast IPDB implementation for JRuby"
   spec.homepage      = "http://github.com/liquidm/geoipdb"
   spec.licenses      = ["MIT"]
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib", "ext"]
+  spec.require_paths = ["lib"]
 
-  if RUBY_PLATFORM =~ /java/
-    spec.platform = "java"
-    spec.files << "lib/geoipdb.jar"
-  else
-    spec.extensions = ["ext/geoipdb/extconf.rb"]
-  end
-
-  spec.add_development_dependency "rake-compiler"
+  spec.add_dependency "liquid-ext"
 end

data/lib/geoipdb.rb

@@ -1,7 +1,226 @@
-require 'ip_information'
+require 'liquid/boot'
+
+require 'fileutils'
+require 'open-uri'
+require 'singleton'
+require 'uri'
+require 'zlib'
+
+java_import 'java.lang.NumberFormatException'
+java_import 'java.net.InetAddress'
+
+require File.expand_path('../geoipdb.jar', __FILE__)
+
+class IPDB
+  include Singleton
+
+  attr_accessor :base_url
+
+  DATA_FILES = [
+    'cities.csv',
+    'ip_ranges.csv',
+  ]
+
+  class IPDBError < Exception
+  end
+
+  def self.init(base_url)
+    instance.update!(base_url)
+  end
+
+  def self.lookup(ip)
+    instance.lookup(ip)
+  end
+
+  def initialize
+    @version = Gem.loaded_specs['geoipdb'].version.to_s
+    @cache_path = File.expand_path("~/.cache/geoipdb/v#{@version}")
+    # by default load sample data
+    sample_path = File.expand_path('../../sample_data', __FILE__)
+    files = DATA_FILES.map { |file_name| File.join(sample_path, file_name) }
+    self.load(*files)
+  end
+
+  def load(*files)
+    @db = Java::IPDB.new(*files)
+  end
+
+  def update!(base_url)
+    return nil if @initialized
+    @start = Time.now.to_f
+    @base_url = base_url
+    @initialized = true
+
+    $log.info("ipdb:load", cache_path: @cache_path)
+    FileUtils.mkdir_p(@cache_path)
+
+    @updating = false
+    if !uptodate?
+      @updating = true
+      $log.info("ipdb:init", update: true)
+      download_update
+    end
+
+    load_data_files
+  end
+
+  def load_data_files
+    files = DATA_FILES.map { |file_name| File.join(@cache_path, file_name) }
+    self.load(*files)
+    self_test
+    make_backup if @updating
+    $log.info("ipdb:init", rt: Time.now.to_f - @start)
+  rescue IPDBError => e
+    $log.exception(e)
+    $log.info("ipdb:init", revert: true)
+    restore_backup
+    load_data_files
+    self_test
+  end
+
+  def lookup(ip)
+    return nil unless @db
+    ip = InetAddress.get_by_name(ip).address if ip.is_a?(String)
+    range = @db.find_range_for_ip(ip)
+    return nil unless range
+    city = @db.find_city_for_ip_range(range)
+    return nil unless city
+    isp = range.isp_name
+    info = IpInformation.new
+    info.country_iso_code = city.country_iso2
+    info.city_name = city.name
+    info.city_code = city.city_code
+    info.lng = city.lng
+    info.lat = city.lat
+    info.is_mobile  = range.is_mobile
+    info.isp_name = isp && isp.to_sym
+    info
+  rescue EncodingError, NumberFormatException
+    # TODO: do we really want to silence these exceptions?
+    return nil
+  end
+
+  private
+
+  def uptodate?
+    days14 = 24*60*60*14 # 14days
+    now = Time.now.to_f
+
+    DATA_FILES.each do |file_name|
+      path = File.join(@cache_path, file_name)
+      if !File.exist?(path)
+        $log.info("ipdb:check", result: false, file: file_name, reason: "#{path} does not exist")
+        return false
+      elsif File.stat(path).ctime.to_f + days14 < now
+        $log.info("ipdb:check", result: false, file: file_name, reason: "#{path} is too old - needs update!")
+        return false
+      else
+        $log.info("ipdb:check", result: true, file: file_name)
+      end
+    end
+    return true
+  end
+
+  def download_update
+    DATA_FILES.each do |file_name|
+      download(file_name)
+      unzip(file_name)
+    end
+  end
+
+  def download(file_name)
+    $log.info("ipdb:download", file: file_name)
+    file_name = "#{file_name}.gz"
+    source = URI.parse("#{@base_url}/#{file_name}")
+    dest = "#{@cache_path}/#{file_name}"
+    File.write(dest, source.read)
+  end
+
+  def unzip(file_name)
+    $log.info("ipdb:unzip", file: file_name)
+    source = File.join(@cache_path, "#{file_name}.gz")
+    dest = File.join(@cache_path, file_name)
+    Zlib::GzipReader.open(source) do |gz|
+      File.write(dest, gz.read)
+    end
+  end
+
+  def make_backup
+    DATA_FILES.each do |file_name|
+      path = File.join(@cache_path, file_name)
+      backup_path = File.join(@cache_path, "#{file_name}.backup")
+      next unless File.exists?(path)
+      $log.info("ipdb:backup", path: path, backup_path: backup_path)
+      FileUtils.cp(path, backup_path)
+    end
+  end
+
+  def restore_backup
+    DATA_FILES.each do |file_name|
+      path = File.join(@cache_path, file_name)
+      backup_path = File.join(@cache_path, "#{file_name}.backup")
+      if File.exists?(backup_path)
+        $log.info("ipdb:restore", backup_path: backup_path, path: path)
+        FileUtils.cp(backup_path, path)
+      else
+        $log.error("ipdb:restore", reason: "#{backup_path} does not exist")
+        return false
+      end
+    end
+    return true
+  end
+
+  def self_test
+    {
+      '10.0.0.1'      => '--',
+      '127.0.0.1'     => '--',
+      '192.168.1.1'   => '--',
+      '93.219.159.76' => 'de',
+      '91.44.76.101'  => 'de',
+      '82.113.100.1'  => 'de',
+      '84.1.10.4'     => 'hu',
+      '83.23.11.5'    => 'pl',
+      '52.13.100.1'   => 'us',
+    }.each do |ip, country|
+      result = lookup(ip)
+      next if country == result.country_iso_code
+      raise IPDBError.new("IPDB selftest FAILED! IP lookup failed: #{ip} should be #{country} but was #{result.country_iso_code}.")
+    end
+    return true
+  end
+
+end
+
+class IpInformation
+
+  ATTRIBS = [
+    :country_iso_code,
+    :city_code,
+    :city_name,
+    :lat,
+    :lng,
+    :is_mobile,
+    :isp_name,
+  ]
+
+  ATTRIBS.each do |attrib|
+    attr_accessor attrib
+  end
+
+  def initialize(attribs = {})
+    attribs.each do |key, value|
+      send("#{key}=", value)
+    end
+  end
+
+  def mobile?
+    @is_mobile
+  end
+
+  def to_h
+    Hash[ATTRIBS.map do |attrib|
+      [attrib, send(attrib)]
+    end]
+  end
 
-if defined?(JRUBY_VERSION)
-  require 'jgeoipdb'
-else
-  require 'cgeoipdb'
 end

data/sample_data/ip_ranges.csv

@@ -1,9 +1,9 @@
-start_ip,end_ip,connection_type,city_code,isp_name
+start_ip,end_ip,conn-speed,city-code,isp-name
 0.0.0.0,0.0.0.255,mobile,0,?
 0.0.1.0,0.255.255.255,mobile,1,asdf,
 1.0.0.0,1.0.0.255,xdsl,2,vodafone
 1.0.1.0,1.1.0.255,wireless,3,?
-1.1.1.0,1.1.1.255,mobile,4,1vodafone2vodafone3vodafone4vodafone5vodafone1vodafone2vodafone3vodafone4vodafone5vodafone1vodafone2vodafone3vodafone4vodafone5vodafone1vodafone2vodafone3vodafone4vodafone5vodafone
+1.1.1.0,1.1.1.255,mobile,4,o2
 1.1.2.0,1.2.2.255,mobile,5,?
 1.2.3.0,1.2.3.255,mobile,5,?
 1.2.4.0,1.3.255.255,mobile,2,?

data/spec/geoipdb_spec.rb

@@ -1,38 +1,9 @@
-require File.expand_path(File.dirname(__FILE__)+'/spec_helper')
+require 'geoipdb'
 
-
-describe GeoIpDb do
-
-  CACHE_FILE = 'sample_data/ipdb.cache'
-
-  def init_db
-    @db = GeoIpDb.init './sample_data/cities.csv', './sample_data/ip_ranges.csv', CACHE_FILE
-  end
-
-  it "should not throw an exception fault if data is corrupt" do
-    @db = GeoIpDb.init './sample_data/cities_corrupt.csv', './sample_data/ip_ranges_corrupt.csv', CACHE_FILE
-  end
-
-  it "should not init a db object if data files are missing" do
-    GeoIpDb.init( './sample_data/bla.csv', './sample_data/blubb.csv', CACHE_FILE ).should be_nil
-  end
-
-  it "should init correctly with sample data" do
-    init_db
-    @db.should_not be_nil
-  end
-
-  unless defined? JRUBY_VERSION
-    it "initializes cache_file correctly with sample data" do
-      init_db
-      File.exist?(CACHE_FILE).should be_true
-    end
-  end
+describe IPDB do
 
   it "sould find the sample cities correcty" do
-    init_db
-    #afg,no region,kabul,-1,3,34.5167,69.1833
-    info = @db.information_for_ip "1.1.0.254"
+    info = IPDB.lookup "1.1.0.254"
     info.city_code.should == 3
     info.city_name.should == 'kabul'
     info.country_iso_code.should == 'af'
@@ -42,20 +13,14 @@ describe GeoIpDb do
   end
 
   it 'should return correct is_mobile information' do
-    init_db
-    @db.information_for_ip("1.0.0.1").should_not be_mobile
-    @db.information_for_ip("1.1.1.1").should be_mobile
+    IPDB.lookup("1.0.0.1").should_not be_mobile
+    IPDB.lookup("1.1.1.1").should be_mobile
   end
 
   it 'should return correct isp_name in ip_information' do
-    init_db
-    @db.information_for_ip("1.0.0.1").isp_name.should == :vodafone
-    @db.information_for_ip("1.1.1.1").isp_name.should == "1vodafone2vodafone3vodafone4vodafone5vodafone1vodafone2vodafone3vodafone4vodafone5vodafone1vodafone2vodafone3vodafone4vodafone5vodafone1vodafone2vodafone3vodafone4vodafone5vodafone"[0..99].to_sym
-    @db.information_for_ip("1.2.1.1").isp_name.should == :"?"
-  end
-
-  after :each do
-    File.unlink CACHE_FILE if File.exist? CACHE_FILE
+    IPDB.lookup("1.0.0.1").isp_name.should == :vodafone
+    IPDB.lookup("1.1.1.1").isp_name.should == :o2
+    IPDB.lookup("1.2.1.1").isp_name.should == :"?"
   end
 
 end

data/spec/spec_helper.rb

@@ -1,12 +1,15 @@
-require 'rubygems'
-require 'rspec'
+ROOT = File.expand_path('../..', __FILE__)
 
-require 'simplecov'
-SimpleCov.start
+require 'bundler/setup'
+require 'liquid/boot'
 
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-$:.unshift(File.dirname(__FILE__) + '/../ext')
-require 'geoipdb'
+require 'rspec'
 
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
 end