jgeoip 0.1.0-java → 0.1.5-java

data/Buildfile

@@ -11,12 +11,15 @@ define 'jgeoip' do
   project.version = JGeoIP::VERSION
   
   # add dependencies from jar
-  compile.with('org.kohsuke:geoip:jar:1.2.5')
+  compile.using(:target => '1.6', :source => '1.6').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, :copy_dependencies ]
+  task :setup => [ :clean, :compile, :package, :copy_dependencies ]
 end

data/README.md

@@ -1,5 +1,5 @@
-## Fast JRuby GeoIP Library
-This library will help you with all your GeoIP needs in JRuby.
+## Fast JRuby GeoIP Extension
+This jRuby extension will help you with all your GeoIP needs in JRuby.
 It is pretty small and simple right now but will surely grow up soon.
 You can easily use it with the free GeoIP Library from maxmind.com aswell as the commercial one.
 
@@ -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 location object with all the result properties and a #to_hash method
+Will return a Location object with all the result properties and a #to_hash method
 
 
 ### speed?
@@ -17,8 +17,10 @@ Results are promising:
 
     pure ruby GeoIP:
      35.614000   0.000000  35.614000 ( 35.614000)
-    JGeoIP (Old Version, as extension, updating soon):
-      1.318000   0.000000   1.318000 (  1.318000)
+    JGeoIP (>=0.1.5):
+      0.285000   0.000000   0.285000 (  0.286000)
+    JGeoIP (non extension version, <0.1.5):
+      1.047000   0.000000   1.047000 (  1.048000)    
       
 Please note that we did a warmup to give the JIT a chance.
 The benchmark does 100k lookups.

data/lib/jgeoip/version.rb

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

data/lib/jgeoip.rb

@@ -5,5 +5,8 @@ require File.expand_path('../java/geoip-1.2.5', __FILE__)
 
 # 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__)
+
+# import the jRuby Extension
+require File.expand_path("../java/jgeoip-#{JGeoIP::VERSION}", __FILE__)
+java_import 'org.github.tobsch.jgeoip.JGeoIPLibrary'
+JGeoIPLibrary.new.load(JRuby.runtime, false)

data/script/benchmark.rb

@@ -17,15 +17,20 @@ end
 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
-  result = db.city('github.com')
-end
+# require 'geoip'
+# db = GeoIP.new('/opt/MaxMind/GeoLiteCity.dat')
+# benchmark 'pure ruby GeoIP:'   do
+#   result = db.city('github.com')
+# end
 
 db = JGeoIP.new('/opt/MaxMind/GeoLiteCity.dat')
 benchmark 'JGeoIP:' do
   result = db.city('github.com')
 end
 
+db = JGeoIPJava.new('/opt/MaxMind/GeoLiteCity.dat')
+benchmark 'JGeoIPJava:' do
+  result = db.city('github.com')
+end
+
 

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

@@ -0,0 +1,44 @@
+package org.github.tobsch.jgeoip;
+
+import com.maxmind.geoip.*;
+
+import java.io.IOException;
+
+import org.jruby.Ruby;
+
+import org.jruby.RubyClass;
+import org.jruby.RubyObject;
+
+import org.jruby.anno.JRubyMethod;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.builtin.IRubyObject;
+
+
+public class JGeoIP extends RubyObject {
+  LookupService cl;
+  static RubyClass locationProxyClass;
+
+  public JGeoIP(final Ruby ruby, RubyClass rubyClass) {
+    super(ruby, rubyClass);
+    this.locationProxyClass = ruby.getClass("Location");
+  }
+    
+  @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) {
+      return context.runtime.getNil();
+    }
+    
+    LocationProxy loc = new LocationProxy(context.runtime, locationProxyClass, location);
+        
+    return loc;
+  }
+}

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

@@ -0,0 +1,43 @@
+
+package org.github.tobsch.jgeoip;
+import org.github.tobsch.jgeoip.*;
+import com.maxmind.geoip.*;
+
+import java.io.IOException;
+
+import org.jruby.Ruby;
+import org.jruby.RubyClass;
+import org.jruby.runtime.ObjectAllocator;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.runtime.load.Library;
+
+/**
+ *
+ * 
+ */
+public class JGeoIPLibrary implements Library {
+  private Ruby ruby;
+
+  public void load(Ruby ruby, boolean bln) throws IOException {
+    this.ruby = ruby;
+    
+    // define the jgeoip class
+    final 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);
+    
+    // define the location class
+    final RubyClass location = ruby.defineClass("Location", ruby.getObject(), new ObjectAllocator() {
+      public IRubyObject allocate(Ruby ruby, RubyClass rc) {
+        return new LocationProxy(ruby, rc);
+      }
+    });
+
+    location.defineAnnotatedMethods(LocationProxy.class);
+    
+  }
+}

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

@@ -0,0 +1,136 @@
+package org.github.tobsch.jgeoip;
+import com.maxmind.geoip.*;
+
+import java.io.IOException;
+
+import org.jruby.Ruby;
+import org.jruby.runtime.ThreadContext;
+import org.jruby.runtime.ObjectAllocator;
+import org.jruby.runtime.builtin.IRubyObject;
+import org.jruby.runtime.load.Library;
+import org.jruby.runtime.Block;
+
+import org.jruby.anno.JRubyMethod;
+
+import org.jruby.RubyClass;
+import org.jruby.RubyArray;
+import org.jruby.RubyClass;
+import org.jruby.RubyObject;
+import org.jruby.RubyHash;
+import org.jruby.RubySymbol;
+
+import java.util.ArrayList;
+
+
+public class LocationProxy extends RubyObject {
+  Location location;
+  
+  private static final ArrayList<String> attributes = new ArrayList<String>();
+  
+  // a map with all properties
+  static {
+    attributes.add("city");
+    attributes.add("postal_code");
+    attributes.add("country_code");
+    attributes.add("country_name");
+    attributes.add("region");
+    attributes.add("latitude");
+    attributes.add("longitude");
+    attributes.add("dma_code");
+    attributes.add("area_code");
+    attributes.add("metro_code");    
+  }
+  
+  public LocationProxy(final Ruby ruby, RubyClass rubyClass) {
+    super(ruby, rubyClass);
+  }
+
+  public LocationProxy(final Ruby ruby, RubyClass rubyClass, Location location) {
+    super(ruby, rubyClass);
+    this.location = location;
+  }
+  
+  @JRubyMethod
+  public RubyArray keys(ThreadContext context) {
+    RubyArray res = RubyArray.newArray(context.runtime);
+    for (String key : attributes) {
+      res.add(RubySymbol.newSymbol(context.runtime, key));
+    }
+    
+    return res;
+  }
+  
+  @JRubyMethod(name = "to_hash")
+  public IRubyObject toHash(ThreadContext context) {
+    RubyHash hash = RubyHash.newHash(context.runtime);
+    for (String key : attributes) {
+      hash.put(RubySymbol.newSymbol(context.runtime, key), get(context, context.runtime.newString(key)));
+    }
+    
+    return hash;
+  }
+  
+  @JRubyMethod(name = "[]")
+  public IRubyObject get(ThreadContext context, IRubyObject key) {
+    if (attributes.contains(key.toString())) {
+      return send(context, key, Block.NULL_BLOCK);
+    } else {
+      return context.runtime.getNil();
+    }
+  }
+  
+  @JRubyMethod
+  public IRubyObject inspect(ThreadContext context) {
+    return toHash(context).inspect();
+  }
+  
+  @JRubyMethod(name = "city")
+  public IRubyObject getCity(ThreadContext context) {
+    return location.city == null ? context.runtime.getNil() : context.runtime.newString(location.city);
+  }
+  
+  @JRubyMethod(name = "postal_code")
+  public IRubyObject getPostalCode(ThreadContext context) {
+    return location.postalCode == null ? context.runtime.getNil() : context.runtime.newString(location.postalCode);
+  }
+
+  @JRubyMethod(name = "country_code")
+  public IRubyObject getCountryCode(ThreadContext context) {
+    return location.countryCode == null ? context.runtime.getNil() : context.runtime.newString(location.countryCode);
+  }
+
+  @JRubyMethod(name = "country_name")
+  public IRubyObject getCountryName(ThreadContext context) {
+    return location.countryName == null ? context.runtime.getNil() : context.runtime.newString(location.countryName);
+  }
+
+  @JRubyMethod(name = "region")
+  public IRubyObject getRegion(ThreadContext context) {
+    return location.region == null ? context.runtime.getNil() : context.runtime.newString(location.region);
+  }
+  
+  @JRubyMethod(name = "latitude")
+  public IRubyObject getLatitude(ThreadContext context) {
+    return context.runtime.newFloat(location.latitude);
+  }
+
+  @JRubyMethod(name = "longitude")
+  public IRubyObject getLongitude(ThreadContext context) {
+    return context.runtime.newFloat(location.latitude);
+  }
+
+  @JRubyMethod(name = "dma_code")
+  public IRubyObject getDMACode(ThreadContext context) {
+    return context.runtime.newFixnum(location.dma_code);
+  }
+
+  @JRubyMethod(name = "area_code")
+  public IRubyObject getAreaCode(ThreadContext context) {
+    return context.runtime.newFixnum(location.area_code);
+  }
+
+  @JRubyMethod(name = "metro_code")
+  public IRubyObject getMetroCode(ThreadContext context) {
+    return context.runtime.newFixnum(location.metro_code);
+  }
+}

data/test/unit/jgeoip_test.rb

@@ -14,17 +14,38 @@ class JGeoIPTest < Test::Unit::TestCase
       assert_equal 'San Francisco', result[:city] 
     end
     
+    should 'be a proper location object' do
+      result = @geo.city('github.com')
+      assert_kind_of Location, result
+    end
+    
     should 'find the city by ip too' do
       result = @geo.city('207.97.227.239')
       assert_equal 'United States', result[:country_name]
     end
-    
-    should 'be able to return the result as a hash' do
+
+    should 'return nil if an attribute does not exist' do
+      result = @geo.city('207.97.227.239')
+      assert_equal nil, result[:fooooooo]
+    end
+
+    should 'return a nil value if there is no value for an attribute' do
       result = @geo.city('85.183.18.35')
-      assert_kind_of Hash, result.to_hash
+      assert_equal nil, result.postal_code
+      assert_equal 0, result.dma_code
+    end
+
+    should 'be able to return the result as a hash' do
+      result = @geo.city('85.183.18.35').to_hash
+      assert_kind_of Hash, result
       assert_equal 'Germany', result[:country_name]
     end
 
+    should 'be inspectable' do
+      result = @geo.city('85.183.18.35').inspect
+      assert_match '{:city=>"Othmarschen"', result
+    end
+
     should 'throw a clean exception if the ip was not found' do
       result = @geo.city('127.0.0.1')
       assert_equal nil, result

metadata

@@ -2,14 +2,14 @@
 name: jgeoip
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.1.0
+  version: 0.1.5
 platform: java
 authors:
 - Tobias Schlottke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
+date: 2012-02-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda-context
@@ -17,8 +17,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: '0'
     none: false
   requirement: *2056
   prerelease: false
@@ -40,8 +39,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: '0'
     none: false
   requirement: *2090
   prerelease: false
@@ -52,8 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
+        version: '0'
     none: false
   requirement: *2106
   prerelease: false
@@ -65,36 +62,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- !binary |-
-  LmdpdGlnbm9yZQ==
-- !binary |-
-  LnJ2bXJj
-- !binary |-
-  QnVpbGRmaWxl
-- !binary |-
-  R2VtZmlsZQ==
-- !binary |-
-  UkVBRE1FLm1k
-- !binary |-
-  UmFrZWZpbGU=
-- !binary |-
-  amdlb2lwLmdlbXNwZWM=
-- !binary |-
-  bGliL2phdmEvZ2VvaXAtMS4yLjUuamFy
-- !binary |-
-  bGliL2pnZW9pcC5yYg==
-- !binary |-
-  bGliL2pnZW9pcC9qZ2VvaXAucmI=
-- !binary |-
-  bGliL2pnZW9pcC9sb2NhdGlvbi5yYg==
-- !binary |-
-  bGliL2pnZW9pcC92ZXJzaW9uLnJi
-- !binary |-
-  c2NyaXB0L2JlbmNobWFyay5yYg==
-- !binary |-
-  dGVzdC90ZXN0X2hlbHBlci5yYg==
-- !binary |-
-  dGVzdC91bml0L2pnZW9pcF90ZXN0LnJi
+- .gitignore
+- .rvmrc
+- Buildfile
+- Gemfile
+- README.md
+- Rakefile
+- jgeoip.gemspec
+- lib/java/geoip-1.2.5.jar
+- lib/java/jgeoip-0.1.5.jar
+- lib/jgeoip.rb
+- lib/jgeoip/version.rb
+- script/benchmark.rb
+- src/main/java/org/github/tobsch/jgeoip/JGeoIP.java
+- src/main/java/org/github/tobsch/jgeoip/JGeoIPLibrary.java
+- src/main/java/org/github/tobsch/jgeoip/LocationProxy.java
+- test/test_helper.rb
+- test/unit/jgeoip_test.rb
 homepage: http://github.com/tobsch/jgeoip
 licenses: []
 post_install_message:
@@ -105,15 +89,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
+      version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
+      version: '0'
   none: false
 requirements: []
 rubyforge_project:
@@ -122,8 +104,6 @@ signing_key:
 specification_version: 3
 summary: Fast jRuby library for Maxminds GeoIP Databases
 test_files:
-- !binary |-
-  dGVzdC90ZXN0X2hlbHBlci5yYg==
-- !binary |-
-  dGVzdC91bml0L2pnZW9pcF90ZXN0LnJi
+- test/test_helper.rb
+- test/unit/jgeoip_test.rb
 ...

data/lib/jgeoip/jgeoip.rb

@@ -1,12 +0,0 @@
-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

@@ -1,35 +0,0 @@
-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