mtodd-geoip 0.5.0 → 0.5.1

data/README.md

@@ -15,7 +15,7 @@ mapping information. It is kindly provided free of charge by MaxMind.com.
 Usage
 
     require 'geoip'
-    db = GeoIP::City::Database.new('/opt/GeoIP/share/GeoIP/GeoLiteCity.dat')
+    db = GeoIP::City.new('/opt/GeoIP/share/GeoIP/GeoLiteCity.dat')
     result = db.look_up('24.24.24.24')
     p result 
     # => {:city=>"Ithaca", 
@@ -49,8 +49,17 @@ There are arguments to database initializer.
 
 For example 
 
-    GeoIPCity::Database.new(dbfile, :filesystem, true)
+    GeoIP::City.new(dbfile, :filesystem, true)
 
+Usage for Organization Search
+-----------------------------
+
+    require 'geoip'
+    db = GeoIP::Organization.new('/opt/GeoIP/share/GeoIP/GeoIPOrg.dat')
+    db.look_up('24.24.24.24')
+    # => {:name=>"Road Runner"}
+
+The name is the only data available for Organizations.
 
 Install
 -------
@@ -69,18 +78,34 @@ Some variation of the following should work.
 
        make && sudo make install
 
-  2. Now install the `geoip_city` gem 
+  NOTE: for Intel Mac OS X platforms, try the following:
+
+       env ARCHFLAGS="-arch i386" ./configure --prefix=/opt/GeoIP
 
-       sudo gem install geoip_city -- --with-geoip-dir=/opt/GeoIP
+       env ARCHFLAGS="-arch i386" make
+
+       sudo env ARCHFLAGS="-arch i386" make install
+
+  2. Now install the `geoip` gem 
+
+       gem install mtodd-geoip -s http://gems.github.com/ -- --with-geoip-dir=/opt/GeoIP
 
   3. Download the GeoLite City database file in binary format at http://www.maxmind.com/app/geolitecity
-     Maybe this [direct link](http://www.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz) will work. 
+     Maybe this [direct link](http://www.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz) will work.
      I put this file in 
 
        /opt/GeoIP/share/GeoIP/GeoLiteCity.dat
 
+     If you are a paying customer, you will download the files required below:
+
+     [MaxMind Customer Downloads](http://www.maxmind.com/app/download_files)
+
+     You will want to get the City Rev1 data file and Organization files at minimum.
+
   4. Use it!
 
+     See above for usage details.
+
 Hints
 -----
 
@@ -92,14 +117,25 @@ Hints
 
      Example:
 
-        sudo env ARCHFLAGS="-arch i386" gem install geoip_city -- --with-geoip-dir=/opt/GeoIP
+        env ARCHFLAGS="-arch i386" gem install mtodd-geoip -s http://gems.github.com/ -- --with-geoip-dir=/opt/GeoIP
 
-  2. You might find [this shell
-  script](http://github.com/grimen/my_shell_scripts/blob/8cf04cb6829e68a47f2d6f9d9e057766ea72beb4/install_geoip-city.sh)
+  2. You might find [this shell script](http://github.com/grimen/my_shell_scripts/blob/8cf04cb6829e68a47f2d6f9d9e057766ea72beb4/install_geoip-city.sh)
      helpful to install the C library.
 
-License 
+Links
+-----
+
+This iteration of the library is based on the hard work of Ryan Dahl (ry@tinyclouds.org). You can find the original RDocs and Git Repo below:
+
+[rdocs](http://geoip-city.rubyforge.org/)
+[git repo](https://github.com/ry/geoip-city/tree)
+
+License
 -------
 Copyright (C) 2007--2009 Ryan Dahl (ry@tinyclouds.org), Matt Todd (mtodd@highgroove.com)
 
-I give permission for you to do whatever you'd like to do with this software.
+This program is free software. It comes without any warranty, to
+the extent permitted by applicable law. You can redistribute it
+and/or modify it under the terms of the Do What The Fuck You Want
+To Public License, Version 2, as published by Sam Hocevar. See
+http://sam.zoy.org/wtfpl/COPYING for more details.

data/Rakefile

@@ -22,13 +22,16 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name              = 'geoip'
-  s.description       = 'Generic GeoIP lookup tool. Based on the geoip_city RubyGem by Ryan Dahl'
-  s.author            = 'Matt Todd'
+  s.version           = "0.5.1"
+
+  s.authors           = ['Ryan Dahl', 'Matt Todd', 'Charles Brian Quinn']
   s.email             = 'mtodd@highgroove.com'
-  s.version           = "0.5.0"
+
   s.summary           = "A Binding to the GeoIP C library"
+  s.description       = 'Generic GeoIP lookup tool. Based on the geoip_city RubyGem by Ryan Dahl'
   s.homepage          = "http://github.com/mtodd/geoip"
-  s.files             = FileList['Rakefile', '*.rb', '*.c', 'README*']
+
+  s.files             = ["Rakefile", "extconf.rb", "test.rb", "geoip.c", "README.md"]
   s.test_files        = 'test.rb'
   s.extensions        = 'extconf.rb'
   s.require_path      = '.'
@@ -44,7 +47,7 @@ task(:compile => 'Makefile') { sh 'make' }
 file('Makefile' => "geoip.c") { ruby 'extconf.rb' }
 
 task :install => [:gem] do
-  `sudo env ARCHFLAGS="-arch i386" gem install pkg/geoip-0.5.0.gem -- --with-geoip-dir=/opt/GeoIP`
+  `env ARCHFLAGS="-arch i386" gem install pkg/geoip-0.5.0.gem -- --with-geoip-dir=/opt/GeoIP`
 end
 
 task(:webpage) do

data/geoip.c

@@ -1,4 +1,5 @@
 /* ry dahl <ry@tinyclouds.org> May 21, 2007 */
+/* Matt Todd <mtodd@highgroove.com> June 4, 2009 */
 /* This program is free software. It comes without any warranty, to
  * the extent permitted by applicable law. You can redistribute it
  * and/or modify it under the terms of the Do What The Fuck You Want
@@ -15,11 +16,52 @@ static VALUE rb_geoip_memory;
 static VALUE rb_geoip_filesystem;
 static VALUE rb_geoip_index;
 
-/* helper  */
+/* helpers */
 void rb_hash_sset(VALUE hash, const char *str, VALUE v) {
   rb_hash_aset(hash, ID2SYM(rb_intern(str)), v);
 }
 
+int check_load_option(VALUE load_option) {
+  if(load_option == rb_geoip_memory) {
+    return GEOIP_MEMORY_CACHE;
+  } else if(load_option == rb_geoip_filesystem) {
+    return GEOIP_STANDARD;
+  } else if(load_option == rb_geoip_index) {
+    return GEOIP_INDEX_CACHE;
+  } else {
+    rb_raise(rb_eTypeError, "the second option must be :memory, :filesystem, or :index");
+    return Qnil;
+  }
+}
+
+/* Generic initializer */
+static VALUE rb_geoip_database_new(VALUE mGeoIP_Database_Class, 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(flag = check_load_option(load_option)) flag;
+
+  if(RTEST(check_cache)) flag |= GEOIP_CHECK_CACHE;
+
+  if(gi = GeoIP_open(STR2CSTR(filename), flag)) {
+    database = Data_Wrap_Struct(mGeoIP_Database_Class, 0, GeoIP_delete, gi);
+    rb_obj_call_init(database, 0, 0);
+  } else { 
+    rb_sys_fail("Problem opening database");
+  }
+  return database;
+}
+
 /* GeoIP::City ***************************************************************/
 
 VALUE rb_city_record_to_hash(GeoIPRecord *record) 
@@ -65,38 +107,7 @@ VALUE rb_city_record_to_hash(GeoIPRecord *record)
  */
 static VALUE rb_geoip_city_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(RTEST(check_cache)) flag |= GEOIP_CHECK_CACHE;
-  
-  if(gi = GeoIP_open(STR2CSTR(filename), flag)) {
-    database = Data_Wrap_Struct(mGeoIP_City, 0, GeoIP_delete, gi);
-    rb_obj_call_init(database, 0, 0);
-  } else { 
-    rb_sys_fail("Problem opening database");
-  }
-  return database; 
+  return rb_geoip_database_new(mGeoIP_City, argc, argv, self);
 }
 
 /* Pass this function an IP address as a string, it will return a hash
@@ -124,84 +135,31 @@ VALUE rb_geoip_city_look_up(VALUE self, VALUE addr) {
 
 /* GeoIP::Organization *******************************************************/
 
-// VALUE rb_org_record_to_hash(GeoIPRecord *record) 
-// {
-//   VALUE hash = rb_hash_new();
-// 
-//   if(record->country_code)
-//     rb_hash_sset(hash, "country_code", rb_str_new2(record->country_code));
-//   if(record->country_code3)
-//     rb_hash_sset(hash, "country_code3", rb_str_new2(record->country_code3));
-//   if(record->country_name)
-//     rb_hash_sset(hash, "country_name", rb_str_new2(record->country_name));
-//   if(record->region)
-//     rb_hash_sset(hash, "region", rb_str_new2(record->region));
-//   if(record->city)
-//     rb_hash_sset(hash, "city", rb_str_new2(record->city));
-//   if(record->postal_code)
-//     rb_hash_sset(hash, "postal_code", rb_str_new2(record->postal_code));
-//   if(record->latitude)
-//     rb_hash_sset(hash, "latitude", rb_float_new((double)record->latitude));
-//   if(record->longitude)
-//     rb_hash_sset(hash, "longitude", rb_float_new((double)record->longitude));
-//   if(record->dma_code)
-//     rb_hash_sset(hash, "dma_code", INT2NUM(record->dma_code));
-//   if(record->area_code)
-//     rb_hash_sset(hash, "area_code", INT2NUM(record->area_code));
-//   
-//   return hash;
-// }
-
+/* GeoIP::Organization.new('/path/to/GeoIPOrg.dat', load_option)
+ * load_option can be:
+ * * :memory - load the data into memory, fastest (default)
+ * * :filesystem - look up from filesystem, least memory intensive
+ * * :index - stores in memory most recent queries
+ * 
+ */
 static VALUE rb_geoip_org_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(RTEST(check_cache)) flag |= GEOIP_CHECK_CACHE;
-  
-  if(gi = GeoIP_open(STR2CSTR(filename), flag)) {
-    database = Data_Wrap_Struct(mGeoIP_Organization, 0, GeoIP_delete, gi);
-    rb_obj_call_init(database, 0, 0);
-  } else { 
-    rb_sys_fail("Problem opening database");
-  }
-  return database; 
+  return rb_geoip_database_new(mGeoIP_Organization, argc, argv, self);
 }
 
 /* Pass this function an IP address as a string, it will return a hash
- * containing all the information that the database knows about the IP
+ * containing all the information that the database knows about the IP:
  *    db.look_up('24.24.24.24') 
- *    => {} 
+ *    => {:name => "Road Runner"}
  */ 
 VALUE rb_geoip_org_look_up(VALUE self, VALUE addr) {
   GeoIP *gi;
-  GeoIPRecord *record = NULL;
   VALUE hash = rb_hash_new();
   char * name = NULL;
   
   Check_Type(addr, T_STRING);
   Data_Get_Struct(self, GeoIP, gi);
-  if(name = GeoIP_org_by_addr(gi, STR2CSTR(addr))) {
+  if(name = GeoIP_name_by_addr(gi, STR2CSTR(addr))) {
     rb_hash_sset(hash, "name", rb_str_new2(name));
   }
   return hash;
@@ -209,12 +167,6 @@ VALUE rb_geoip_org_look_up(VALUE self, VALUE addr) {
 
 /* GeoIP *********************************************************************/
 
-/* module GeoIP
- *   class City; end
- *   class Organization; end
- * end
- */
-
 void Init_geoip()
 {
   mGeoIP = rb_define_module("GeoIP");

data/test.rb

@@ -1,19 +1,28 @@
 require 'test/unit'
-require File.dirname(__FILE__) + '/geoip_city'
+require File.dirname(__FILE__) + '/geoip'
 require 'rubygems'
-require 'ruby-debug'
-Debugger.start
+# require 'ruby-debug'
+# Debugger.start
 
-class GeoIPTest < Test::Unit::TestCase
+class Test::Unit::TestCase
+
+  def assert_look_up(db, addr, field, value)
+    h = db.look_up(addr)
+    assert_equal value, h[field]
+    h
+  end
+
+end
+
+class GeoIPCityTest < Test::Unit::TestCase
   
   def setup
     ## Change me!
-    @dbfile = '/opt/GeoIP-1.4.2/share/GeoIP/GeoLiteCity.dat'
+    @dbfile = '/opt/GeoIP/share/GeoIP/GeoLiteCity.dat'
   end
-  
-  
+
   def test_construction_default
-    db = GeoIPCity::Database.new(@dbfile)
+    db = GeoIP::City.new(@dbfile)
     
     assert_raises TypeError do 
       db.look_up(nil) 
@@ -22,38 +31,81 @@ class GeoIPTest < Test::Unit::TestCase
     h = db.look_up('24.24.24.24')
     #debugger
     assert_kind_of Hash, h
-    assert_equal 'Ithaca', h[:city]
+    assert_equal 'Jamaica', 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]
+    db = GeoIP::City.new(@dbfile, :index)
+    assert_look_up(db, '24.24.24.24', :city, 'Jamaica')
   end
 
   def test_construction_filesystem
-    db = GeoIPCity::Database.new(@dbfile, :filesystem)
-    h = db.look_up('24.24.24.24')
-    assert_equal 'Ithaca', h[:city]
+    db = GeoIP::City.new(@dbfile, :filesystem)
+    assert_look_up(db, '24.24.24.24', :city, 'Jamaica')
   end
 
   def test_construction_memory
-    db = GeoIPCity::Database.new(@dbfile, :memory)
-    h = db.look_up('24.24.24.24')
-    assert_equal 'Ithaca', h[:city]
+    db = GeoIP::City.new(@dbfile, :memory)
+    assert_look_up(db, '24.24.24.24', :city, 'Jamaica')
   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]
+    db = GeoIP::City.new(@dbfile, :filesystem, true)
+    assert_look_up(db, '24.24.24.24', :city, 'Jamaica')
   end
 
   def test_bad_db_file
     assert_raises Errno::ENOENT do
-      GeoIPCity::Database.new('/blah')
+      GeoIP::City.new('/blah')
     end
   end
+
+end
+
+class GeoIPOrgTest < Test::Unit::TestCase
   
+  def setup
+    ## Change me!
+    @dbfile = '/opt/GeoIP/share/GeoIP/GeoIPOrg.dat'
+  end
+
+  def test_construction_default
+    db = GeoIP::Organization.new(@dbfile)
+    
+    assert_raises TypeError do 
+      db.look_up(nil) 
+    end
+    
+    h = db.look_up('24.24.24.24')
+    assert_kind_of Hash, h
+    assert_equal 'Road Runner', h[:name]
+  end
+
+  def test_construction_index
+    db = GeoIP::Organization.new(@dbfile, :index)
+    assert_look_up(db, '24.24.24.24', :name, 'Road Runner')
+  end
+
+  def test_construction_filesystem
+    db = GeoIP::Organization.new(@dbfile, :filesystem)
+    assert_look_up(db, '24.24.24.24', :name, 'Road Runner')
+  end
+
+  def test_construction_memory
+    db = GeoIP::Organization.new(@dbfile, :memory)
+    assert_look_up(db, '24.24.24.24', :name, 'Road Runner')
+  end
+
+  def test_construction_filesystem_check
+    db = GeoIP::Organization.new(@dbfile, :filesystem, true)
+    assert_look_up(db, '24.24.24.24', :name, 'Road Runner')
+  end
+
+  def test_bad_db_file
+    assert_raises Errno::ENOENT do
+      GeoIP::Organization.new('/blah')
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mtodd-geoip
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Ryan Dahl