jgeoip 0.0.6-java → 0.1.0-java

data/Buildfile

@@ -13,13 +13,10 @@ define 'jgeoip' do
   # add dependencies from jar
   compile.with('org.kohsuke:geoip:jar:1.2.5')
   
-  # package our shiny little bidder jar
-  package :jar, :file => _("lib/java/jgeoip-#{JGeoIP::VERSION}.jar")
-  
   desc 'copy all dependent jars to lib folder'
   task :copy_dependencies do
     cp project.compile.dependencies.collect(&:to_s), project.path_to('lib/java') 
   end
   
-  task :setup => [ :clean, :compile, :package, :copy_dependencies ]
+  task :setup => [ :clean, :copy_dependencies ]
 end

data/README.md

@@ -7,7 +7,7 @@ You can easily use it with the free GeoIP Library from maxmind.com aswell as the
 
     p JGeoIP.new('/opt/MaxMind/GeoLiteCity.dat').city('github.com')
 
-Will return a hash with all the result properties.
+Will return a location object with all the result properties and a #to_hash method
 
 
 ### speed?
@@ -17,7 +17,7 @@ Results are promising:
 
     pure ruby GeoIP:
      35.614000   0.000000  35.614000 ( 35.614000)
-    JGeoIP:
+    JGeoIP (Old Version, as extension, updating soon):
       1.318000   0.000000   1.318000 (  1.318000)
       
 Please note that we did a warmup to give the JIT a chance.
@@ -25,6 +25,6 @@ The benchmark does 100k lookups.
 Those results are Java 7, jruby-1.6.5 based. Looking forward to 1.7.0.
 
 ### TODO
-* migrate from the hash to a location object which is able to calculate the distance to another one and might just be a container for the original maxmind one
+* switch back to an extension and a proxy object: this is surely faster. but time is money at the moment
 * integrate the other lookup methods: so far we're just able to do city lookups
 * check all the license related stuff: the maxmind lib is LGPL, which would be okay for me    

data/jgeoip.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Tobias Schlottke"]
   s.email       = ["tobias.schlottke@gmail.com"]
   s.homepage    = "http://github.com/tobsch/jgeoip"
-  s.summary     = 'Fast JRuby extension for Maxminds GeoIP Databases'
-  s.description = 'This gem wraps maxminds original java library with a pure jRuby extension, which should make things faster than calling the lib through jRuby directly.'
+  s.summary     = 'Fast jRuby library for Maxminds GeoIP Databases'
+  s.description = 'This gem wraps maxminds original java library, which should make things faster than using other pure ruby libraries.'
   s.platform    = 'java'
   
   s.files         = `git ls-files`.split("\n")

data/lib/jgeoip.rb

@@ -1,12 +1,9 @@
 require 'java'
 
-# load the version file
-require File.expand_path('../jgeoip/version', __FILE__)
-
 # Load the required jars
 require File.expand_path('../java/geoip-1.2.5', __FILE__)
-require File.expand_path("../java/jgeoip-#{JGeoIP::VERSION}", __FILE__)
 
-# import the jRuby Extension
-java_import 'org.github.tobsch.jgeoip.JGeoIPLibrary'
-JGeoIPLibrary.new.load(JRuby.runtime, false)
+# load the version file
+require File.expand_path('../jgeoip/version', __FILE__)
+require File.expand_path('../jgeoip/jgeoip', __FILE__)
+require File.expand_path('../jgeoip/location', __FILE__)

data/lib/jgeoip/jgeoip.rb

@@ -0,0 +1,12 @@
+class JGeoIP
+  # Import the geoip jar
+  java_import 'com.maxmind.geoip.LookupService'
+
+  def initialize(database_path)
+    @cl = LookupService.new(database_path, LookupService::GEOIP_MEMORY_CACHE)
+  end
+  
+  def city(search_string)
+    @cl.getLocation(search_string)
+  end
+end

data/lib/jgeoip/location.rb

@@ -0,0 +1,35 @@
+class Java::ComMaxmindGeoip::Location
+  # returns a list of all relevant keys
+  def keys
+    mapping.keys
+  end
+  
+  # getter for all value
+  def [](key)
+    mapping.key?(key) ? self.send(mapping[key]) : nil
+  end
+  
+  def inspect
+    to_hash.inspect
+  end
+  
+  def to_hash
+    mapping.inject({}) { |mem, map| mem[map.first] = self[map.last]; mem }
+  end
+  
+  protected
+    def mapping
+      {
+        :city         => :city,
+        :postal_code  => :postalCode,
+        :country_code => :countryCode,
+        :country_name => :countryName,
+        :region       => :region,
+        :latitude     => :latitude,
+        :longitude    => :longitude,
+        :dma_code     => :dma_code,
+        :area_code    => :area_code,
+        :metro_code   => :metro_code
+      }
+    end
+end

data/lib/jgeoip/version.rb

@@ -1,3 +1,3 @@
 class JGeoIP
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/script/benchmark.rb

@@ -13,19 +13,19 @@ def benchmark(description, &block)
     }
   }
 end
+# check the JGeoIP
+require File.expand_path('../../lib/jgeoip.rb', __FILE__)
 
 # check the pure lib
 require 'geoip'
 db = GeoIP.new('/opt/MaxMind/GeoLiteCity.dat')
-benchmark 'pure ruby GeoIP:' do
+benchmark 'pure ruby GeoIP:'   do
   result = db.city('github.com')
 end
 
-
-# check the JGeoIP
-require File.expand_path('../../lib/jgeoip.rb', __FILE__)
 db = JGeoIP.new('/opt/MaxMind/GeoLiteCity.dat')
 benchmark 'JGeoIP:' do
   result = db.city('github.com')
 end
 
+

data/test/unit/jgeoip_test.rb

@@ -16,7 +16,13 @@ class JGeoIPTest < Test::Unit::TestCase
     
     should 'find the city by ip too' do
       result = @geo.city('207.97.227.239')
-      assert_equal 'San Francisco', result[:city] 
+      assert_equal 'United States', result[:country_name]
+    end
+    
+    should 'be able to return the result as a hash' do
+      result = @geo.city('85.183.18.35')
+      assert_kind_of Hash, result.to_hash
+      assert_equal 'Germany', result[:country_name]
     end
 
     should 'throw a clean exception if the ip was not found' do

metadata

@@ -2,7 +2,7 @@
 name: jgeoip
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.0.6
+  version: 0.1.0
 platform: java
 authors:
 - Tobias Schlottke
@@ -58,7 +58,7 @@ dependencies:
   requirement: *2106
   prerelease: false
   type: :development
-description: This gem wraps maxminds original java library with a pure jRuby extension, which should make things faster than calling the lib through jRuby directly.
+description: This gem wraps maxminds original java library, which should make things faster than using other pure ruby libraries.
 email:
 - tobias.schlottke@gmail.com
 executables: []
@@ -81,17 +81,16 @@ files:
   amdlb2lwLmdlbXNwZWM=
 - !binary |-
   bGliL2phdmEvZ2VvaXAtMS4yLjUuamFy
-- !binary |-
-  bGliL2phdmEvamdlb2lwLTAuMC42Lmphcg==
 - !binary |-
   bGliL2pnZW9pcC5yYg==
+- !binary |-
+  bGliL2pnZW9pcC9qZ2VvaXAucmI=
+- !binary |-
+  bGliL2pnZW9pcC9sb2NhdGlvbi5yYg==
 - !binary |-
   bGliL2pnZW9pcC92ZXJzaW9uLnJi
 - !binary |-
   c2NyaXB0L2JlbmNobWFyay5yYg==
-- !binary |-
-  c3JjL21haW4vamF2YS9vcmcvZ2l0aHViL3RvYnNjaC9qZ2VvaXAvSkdlb0lQ
-  TGlicmFyeS5qYXZh
 - !binary |-
   dGVzdC90ZXN0X2hlbHBlci5yYg==
 - !binary |-
@@ -121,7 +120,7 @@ rubyforge_project:
 rubygems_version: 1.8.15
 signing_key:
 specification_version: 3
-summary: Fast JRuby extension for Maxminds GeoIP Databases
+summary: Fast jRuby library for Maxminds GeoIP Databases
 test_files:
 - !binary |-
   dGVzdC90ZXN0X2hlbHBlci5yYg==

data/src/main/java/org/github/tobsch/jgeoip/JGeoIPLibrary.java

@@ -1,88 +0,0 @@
-
-package org.github.tobsch.jgeoip;
-import com.maxmind.geoip.*;
-
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Iterator;
-import java.util.List;
-import java.util.HashMap;
-import org.jruby.runtime.Block;
-import java.util.Map;
-import java.util.HashSet;
-import java.util.Set;
-import java.lang.Object;
-import org.jruby.Ruby;
-import org.jruby.RubyNil;
-import org.jruby.RubyArray;
-import org.jruby.RubyClass;
-import org.jruby.RubyFixnum;
-import org.jruby.RubyObject;
-import org.jruby.RubyStruct;
-import org.jruby.RubyString;
-import org.jruby.RubyFloat;
-import org.jruby.RubyHash;
-import org.jruby.anno.JRubyMethod;
-import org.jruby.runtime.ObjectAllocator;
-import org.jruby.runtime.ThreadContext;
-import org.jruby.runtime.builtin.IRubyObject;
-import org.jruby.runtime.load.Library;
-import org.jruby.RubySymbol;
-
-/**
- *
- * 
- */
-public class JGeoIPLibrary implements Library {
-  private Ruby ruby;
-
-  public void load(Ruby ruby, boolean bln) throws IOException {
-    this.ruby = ruby;
-
-    RubyClass jgeoip = ruby.defineClass("JGeoIP", ruby.getObject(), new ObjectAllocator() {
-      public IRubyObject allocate(Ruby ruby, RubyClass rc) {
-        return new JGeoIP(ruby, rc);
-      }
-    });
-
-    jgeoip.defineAnnotatedMethods(JGeoIP.class);
-  }
-
-  public class JGeoIP extends RubyObject {
-    LookupService cl;
-
-    public JGeoIP(final Ruby ruby, RubyClass rubyClass) {
-      super(ruby, rubyClass);
-    }
-    
-    @JRubyMethod
-    public IRubyObject initialize(ThreadContext context, IRubyObject databaseLocation) throws IOException {
-	    cl = new LookupService(databaseLocation.toString(), LookupService.GEOIP_MEMORY_CACHE);
-      
-      return context.nil;
-    }
-
-    @JRubyMethod
-    public IRubyObject city(ThreadContext context, IRubyObject searchString) throws IOException {
-      Location location = cl.getLocation(searchString.toString());
-      if (location == null) {
-        RubyNil nil = new RubyNil(ruby);
-        return nil;
-      }
-      
-      RubyHash loc = new RubyHash(ruby);
-      loc.put(RubySymbol.newSymbol(ruby, "city"), RubyString.newString(ruby, location.city));
-      loc.put(RubySymbol.newSymbol(ruby, "postal_code"), RubyString.newString(ruby, location.postalCode));
-      loc.put(RubySymbol.newSymbol(ruby, "country_code"), RubyString.newString(ruby, location.countryCode));
-      loc.put(RubySymbol.newSymbol(ruby, "country_name"), RubyString.newString(ruby, location.countryName));
-      loc.put(RubySymbol.newSymbol(ruby, "region"), RubyString.newString(ruby, location.region));
-      loc.put(RubySymbol.newSymbol(ruby, "latitude"), RubyFloat.newFloat(ruby, location.latitude));
-      loc.put(RubySymbol.newSymbol(ruby, "longitude"), RubyFloat.newFloat(ruby, location.longitude));
-      loc.put(RubySymbol.newSymbol(ruby, "dma_code"), RubyFixnum.newFixnum(ruby, location.dma_code));
-      loc.put(RubySymbol.newSymbol(ruby, "area_code"), RubyFixnum.newFixnum(ruby, location.area_code));
-      loc.put(RubySymbol.newSymbol(ruby, "metro_code"), RubyFixnum.newFixnum(ruby, location.metro_code));
-      
-      return loc;
-    }
-  }
-}