geoip_city 0.1.2 → 0.2.0

data/README

@@ -11,7 +11,31 @@ mapping information. It is kindly provided free of charge by MaxMind.com.
    require 'geoip_city'
    db = GeoIPCity::Database.new('/opt/GeoIP/share/GeoIP/GeoLiteCity.dat')
    result = db.look_up('24.24.24.24')
-   puts result.inspect
+   p result 
+   # => {:city=>"Ithaca", 
+   #     :latitude=>42.4277992248535, 
+   #     :longitude=>-76.4981994628906, 
+   #     :country_code3=>"USA", 
+   #     :country_code=>"US",
+   #     :country_name=>"United States", 
+   #     :dma_code=>555,
+   #     :area_code=>607, 
+   #     :region=>"NY" }
+
+There are two optional arguments to database initializer.
+The first argument is the filename of the GeoIPCity.dat file 
+The second argument (optional) is to specify how GeoIP should
+keep the database in memory. There are three possibilities
+* :filesystem -- read database from filesystem, uses least memory.
+* :index -- the most frequently accessed index portion of the database, resulting in faster lookups than :filesystem, but less memory usage than :memory.
+* :memory -- load database into memory, faster performance but uses more memory.
+  (default)
+
+The third argument is boolean and decides whether the system should reload the database if changes are made to the dat file. (You probably don't need this. Default: false.)
+
+For example 
+
+  GeoIPCity::Database.new(dbfile, :filesystem, true)
 
 = Install
 Some variation of the following should work.
@@ -35,7 +59,6 @@ Some variation of the following should work.
    I put this file in 
    /opt/GeoIP/share/GeoIP/GeoLiteCity.dat
 
-
 4. Use it!
 
 = License 

data/Rakefile

@@ -24,7 +24,7 @@ spec = Gem::Specification.new do |s|
   s.name              = 'geoip_city'
   s.author            = 'ry dahl'
   s.email             = 'ry@tinyclouds.org'
-  s.version           = "0.1.2"
+  s.version           = "0.2.0"
   s.summary           = "A Binding to the GeoIP C library"
   s.homepage          = "http://geoip_city.rubyforge.org"
   s.files             = FileList['Rakefile', '*.rb', '*.c', 'README*']

data/extconf.rb

@@ -4,4 +4,6 @@ dir_config("geoip")
 
 if have_library('GeoIP', 'GeoIP_record_by_ipnum') and have_header('GeoIPCity.h')
   create_makefile('geoip_city')
+else
+  abort("you must have geoip c library installed!")
 end

data/geoip_city.c

@@ -9,13 +9,51 @@
 #include <GeoIPCity.h>
 
 static VALUE cDB;
+static VALUE rb_geoip_memory; 
+static VALUE rb_geoip_filesystem; 
+static VALUE rb_geoip_index; 
  
-/* The argument is the filename of the GeoIPCity.dat file */
-VALUE rb_geoip_new(VALUE self, VALUE filename) {
+/* The first argument is the filename of the GeoIPCity.dat file 
+ * load_option = :standard, :index, or :memory. default :memory
+ * check_cache = true or false. default false
+ * 
+ * filesystem: read database from filesystem, uses least memory.
+ *
+ * index: the most frequently accessed index portion of the database,
+ *   resulting in faster lookups than :filesystem, but less memory usage than
+ *   :memory.
+ *
+ * memory: load database into memory, faster performance but uses more
+ *   memory.
+ */
+static VALUE rb_geoip_new(int argc, VALUE *argv, VALUE self)
+{
   GeoIP *gi;
   VALUE database = Qnil;
+  VALUE filename, load_option = Qnil, check_cache = Qnil;
+  int flag;
+
+  rb_scan_args(argc, argv, "12", &filename, &load_option, &check_cache);
+  if(NIL_P(load_option))
+    load_option = rb_geoip_memory;
+  if(NIL_P(check_cache))
+    check_cache = Qfalse;
+  Check_Type(load_option, T_SYMBOL);
+
+  if(load_option == rb_geoip_memory) {
+    flag = GEOIP_MEMORY_CACHE;
+  } else if(load_option == rb_geoip_filesystem) {
+    flag = GEOIP_STANDARD;
+  } else if(load_option == rb_geoip_index) {
+    flag = GEOIP_INDEX_CACHE;
+  } else {
+    rb_raise(rb_eTypeError, "the second option must be :memory, :filesystem, or :index");
+    return Qnil;
+  }
 
-  if(gi = GeoIP_open(STR2CSTR(filename), GEOIP_MEMORY_CACHE)) {
+  if(RTEST(check_cache)) flag |= GEOIP_CHECK_CACHE;
+  
+  if(gi = GeoIP_open(STR2CSTR(filename), flag)) {
     database = Data_Wrap_Struct(cDB, 0, GeoIP_delete, gi);
     rb_obj_call_init(database, 0, 0);
   } else { 
@@ -84,7 +122,11 @@ void Init_geoip_city ()
 {
   VALUE mGeoIP = rb_define_module("GeoIPCity");
 
+  rb_geoip_memory = ID2SYM(rb_intern("memory")); 
+  rb_geoip_filesystem = ID2SYM(rb_intern("filesystem")); 
+  rb_geoip_index = ID2SYM(rb_intern("index")); 
+
   cDB = rb_define_class_under(mGeoIP, "Database", rb_cObject);
-  rb_define_singleton_method(cDB, "new", rb_geoip_new, 1);
+  rb_define_singleton_method(cDB, "new", rb_geoip_new, -1);
   rb_define_method(cDB, "look_up", rb_geoip_look_up, 1);
 }

data/test.rb

@@ -1,5 +1,8 @@
 require 'test/unit'
-require 'geoip_city'
+require File.dirname(__FILE__) + '/geoip_city'
+require 'rubygems'
+require 'ruby-debug'
+Debugger.start
 
 class GeoIPTest < Test::Unit::TestCase
   
@@ -9,7 +12,7 @@ class GeoIPTest < Test::Unit::TestCase
   end
   
   
-  def test_construction
+  def test_construction_default
     db = GeoIPCity::Database.new(@dbfile)
     
     assert_raises TypeError do 
@@ -17,11 +20,36 @@ class GeoIPTest < Test::Unit::TestCase
     end
     
     h = db.look_up('24.24.24.24')
+    #debugger
     assert_kind_of Hash, h
     assert_equal 'Ithaca', h[:city]
     assert_equal 'United States', h[:country_name]
   end
 
+  def test_construction_index
+    db = GeoIPCity::Database.new(@dbfile, :index)
+    h = db.look_up('24.24.24.24')
+    assert_equal 'Ithaca', h[:city]
+  end
+
+  def test_construction_filesystem
+    db = GeoIPCity::Database.new(@dbfile, :filesystem)
+    h = db.look_up('24.24.24.24')
+    assert_equal 'Ithaca', h[:city]
+  end
+
+  def test_construction_memory
+    db = GeoIPCity::Database.new(@dbfile, :memory)
+    h = db.look_up('24.24.24.24')
+    assert_equal 'Ithaca', h[:city]
+  end
+
+  def test_construction_filesystem_check
+    db = GeoIPCity::Database.new(@dbfile, :filesystem, true)
+    h = db.look_up('24.24.24.24')
+    assert_equal 'Ithaca', h[:city]
+  end
+
   def test_bad_db_file
     assert_raises Errno::ENOENT do
       GeoIPCity::Database.new('/blah')

metadata

@@ -1,50 +1,57 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: geoip_city
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2007-12-09 00:00:00 -08:00
-summary: A Binding to the GeoIP C library
-require_paths: 
-- .
-email: ry@tinyclouds.org
-homepage: http://geoip_city.rubyforge.org
-rubyforge_project: 
-description: 
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: false
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - ry dahl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-05 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ry@tinyclouds.org
+executables: []
+
+extensions: 
+- extconf.rb
+extra_rdoc_files: []
+
 files: 
 - Rakefile
 - extconf.rb
 - test.rb
 - geoip_city.c
 - README
-test_files: 
-- test.rb
+has_rdoc: false
+homepage: http://geoip_city.rubyforge.org
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
-extensions: 
-- extconf.rb
+require_paths: 
+- .
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A Binding to the GeoIP C library
+test_files: 
+- test.rb