geoipdb 0.5.5-java

data/geoipdb.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name = "geoipdb"
+  gem.version = "0.5.5"
+  gem.licenses = ["MIT"]
+
+  gem.authors = ["Eugen Martin", "Martin Karlsch", "Thomas Hirsch", "Benedikt Böhm"]
+  gem.email = ["eugeniusmartinus@googlemail.com", "martin.karlsch@madvertise.com", "thomas.hirsch@madvertise.com", "benedikt.boehm@madvertise.com"]
+
+  gem.description = "Returns a GeoLocation and additional information for given IP. Reads Data from CSV-Files and uses internal binary caching."
+  gem.summary = "Fast (>3 Mio queries/sec!!!) GeoIpDb implementation for Ruby using C-Extensions."
+  gem.homepage = "http://github.com/madvertise/geoipdb"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib", "ext"]
+
+  if RUBY_PLATFORM =~ /java/
+    gem.platform = "java"
+    gem.files << "lib/geoipdb.jar"
+  else
+    gem.extensions = ["ext/geoipdb/extconf.rb"]
+  end
+
+  gem.add_development_dependency "rake-compiler"
+end

data/lib/geoipdb.rb

@@ -0,0 +1,8 @@
+require 'ip_information'
+
+if defined?(JRUBY_VERSION)
+  require 'jgeoipdb'
+  require 'rbconfig'
+else
+  require 'geoipdb/geoipdb'
+end

data/lib/ip_information.rb

@@ -0,0 +1,27 @@
+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 mobile?
+    @is_mobile
+  end
+
+  def to_h
+    Hash[ATTRIBS.map do |attrib|
+      [attrib, send(attrib)]
+    end]
+  end
+
+end

data/lib/jgeoipdb.rb

@@ -0,0 +1,43 @@
+require 'java'
+require File.expand_path('../geoipdb.jar', __FILE__)
+
+class GeoIpDb
+
+  def self.init(cities_file, ranges_file, cache_file)
+    self.new(cities_file, ranges_file, cache_file)
+  rescue java.io.FileNotFoundException => e
+    return nil
+  end
+
+  def initialize(cities_file, ranges_file, cache_file)
+    # the Java implementation does not support cache files,
+    # since the java serialisation is slower than the actual csv parsing
+    @jdb = Java::GeoIpDb.new(cities_file, ranges_file)
+  end
+
+  def information_for_ip(ip)
+    range = @jdb.find_range_for_ip(ip)
+    return nil unless range
+
+    city = @jdb.find_city_for_ip_range(range)
+    return nil unless city
+
+    isp = range.isp_name
+    build_ip_information_object(range, city, isp)
+  end
+
+  def build_ip_information_object(range, city, isp)
+    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
+  end
+
+end

data/sample_data/cities.csv

@@ -0,0 +1,7 @@
+COUNTRY,REGION,CITY-NAME,METRO-CODE,CITY-CODE,LATITUDE,LONGITUDE
+***,***,?,0,7,0,0
+afg,?,?,0,1,33,1
+afg,no region,herat,-1,2,34.3452,62.12
+afg,no region,kabul,-1,3,34.5167,69.1833
+afg,no region,kandahar,-1,4,31.6111,65.702
+afg,no region,mazar-e sharif,-1,5,36.7041,67.1096

data/sample_data/citiess_corrupt.csv

@@ -0,0 +1,8 @@
+COUNTRY,REGION,CITY-NAME,METRO-CODE,CITY-CODE,LATITUDE,LONGITUDE
+***,***,?,0,7,0,0
+afg,?,?,0,1,33,1
+afg,no region,herat,-1,2,34.3452,62.
+
+afg,no , , , , region,kabul,-1,3,34.5167,69.1833
+afg,no region,, , kandahar,-1,4,31.6111,65.702
+afg,no region,maza , ,r-e sharif,-1,5,36.7041,67.1096

data/sample_data/ip_ranges.csv

@@ -0,0 +1,11 @@
+start_ip,end_ip,connection_type,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.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,?
+1.4.0.0,1.4.0.255,mobile,5,?
+1.4.1.0,1.8.255.255,mobile,3,?

data/sample_data/ip_ranges_corrupt.csv

@@ -0,0 +1,20 @@
+asdf,as,dsa,g,asdf,g,as,d,ga,sd,f,as,dg,
+
+
+start_ip,end_ip,field 13,
+0.0.0.0,0.0.0.255,0,
+
+0.0.1.0,0.255.255.255,1,
+
+1.0.0.0,1.0.0.255,2,
+
+1.0.1.0,1.1.0.255,3,
+
+asfdasdf asdf asfasdfasdf§$%&/
+
+1, , , 7 ,.1.1.0,1.1.1.255,4,,asdf,f,as,df,ag,as,df,asd,
+1.1.2.0,1.2.2.255,5,
+1.2.3.0,1.2.3.255,5,
+1.2.4.0,1.3.255.255,2,
+1.4.0.0,1.4.0.255,5,
+1.4.1.0,1.8.255.255,3,

data/spec/geoipdb_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__)+'/spec_helper')
+
+
+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
+
+  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.city_code.should == 3
+    info.city_name.should == 'kabul'
+    info.country_iso_code.should == 'af'
+    info.lat.should == 34.5167
+    info.lng.should == 69.1833
+    info.should_not be_mobile
+  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
+  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 == nil
+  end
+
+  it "should write and read the cachefile correctly"
+
+  after :each do
+    File.unlink CACHE_FILE if File.exist? CACHE_FILE
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rspec'
+
+require 'simplecov'
+SimpleCov.start
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../ext')
+require 'geoipdb'
+
+RSpec.configure do |config|
+end

data/tasks/compile.rake

@@ -0,0 +1,8 @@
+case RUBY_PLATFORM
+when 'java'
+  require 'rake/javaextensiontask'
+  Rake::JavaExtensionTask.new('geoipdb')
+else
+  require 'rake/extensiontask'
+  Rake::ExtensionTask.new('geoipdb')
+end

data/tasks/rspec.rake

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run the specs"
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end

data/tasks/yard.rake

@@ -0,0 +1,5 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.rdoc']
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: geoipdb
+version: !ruby/object:Gem::Version
+  version: 0.5.5
+  prerelease:
+platform: java
+authors:
+- Eugen Martin
+- Martin Karlsch
+- Thomas Hirsch
+- Benedikt Böhm
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: Returns a GeoLocation and additional information for given IP. Reads Data from CSV-Files and uses internal binary caching.
+email:
+- eugeniusmartinus@googlemail.com
+- martin.karlsch@madvertise.com
+- thomas.hirsch@madvertise.com
+- benedikt.boehm@madvertise.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".jrubyrc"
+- ".rspec"
+- ".rvmrc"
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- ext/geoipdb/extconf.rb
+- ext/geoipdb/geoipdb.c
+- ext/geoipdb/ipdb.c
+- ext/geoipdb/ipdb.h
+- ext/geoipdb/src/City.java
+- ext/geoipdb/src/CsvReader.java
+- ext/geoipdb/src/GeoIpDb.java
+- ext/geoipdb/src/IpRange.java
+- geoipdb.gemspec
+- lib/geoipdb.jar
+- lib/geoipdb.rb
+- lib/ip_information.rb
+- lib/jgeoipdb.rb
+- sample_data/cities.csv
+- sample_data/citiess_corrupt.csv
+- sample_data/ip_ranges.csv
+- sample_data/ip_ranges_corrupt.csv
+- spec/geoipdb_spec.rb
+- spec/spec_helper.rb
+- tasks/compile.rake
+- tasks/rspec.rake
+- tasks/yard.rake
+homepage: http://github.com/madvertise/geoipdb
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: !binary |-
+        MA==
+      hash: 2
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Fast (>3 Mio queries/sec!!!) GeoIpDb implementation for Ruby using C-Extensions.
+test_files:
+- spec/geoipdb_spec.rb
+- spec/spec_helper.rb
+has_rdoc: