geoip_city 0.1

data/README

@@ -0,0 +1,50 @@
+= What?
+This is a library which provides a single function. The function takes as
+input an IP address and it outputs a hash containing best-guess geographical
+information (like city, country, latitude, and longitude).
+
+Actually this is only a Ruby binding to a C library which provides this
+function. Also, you must download a large binary database with all this
+mapping information. It is kindly provided free of charge by MaxMind.com. 
+
+= How To Use
+Some variation of the following should work.
+
+1. Install the GeoCity C library. You can get it from here  
+   http://www.maxmind.com/app/c
+   For example, I like to install mine in /opt/GeoIP
+   so I do this:
+     tar -zxvf GeoIP-1.4.3.tar.gz 
+     cd GeoIP-1.4.3
+     ./configure --prefix=/opt/GeoIP
+     make && sudo make install
+
+2. Now install the geoip Ruby gem (this package!)
+
+   Hint: You need to make sure that gcc can find the GeoIP header and library
+   files. One way to do this is to ensure that your CPATH and LIBRARY_PATH
+   enviromental variables include the GeoIP directory. So, if you want, do
+   this:
+     export CPATH="/opt/GeoIP/include:$CPATH"
+     export LIBRARY_PATH="/opt/GeoIP/lib:$LIBRARY_PATH"
+     sudo gem install geoip_city
+   
+
+3. Download the GeoLite City database file in binary format from:
+   http://www.maxmind.com/app/geolitecity
+   Maybe this direct link will work:
+   http://www.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
+   I put this file in 
+   /opt/GeoIP/share/GeoIP/GeoLiteCity.dat
+
+
+4. Use it!
+     require 'geoip'
+     db = GeoIP::Database.new('/opt/GeoIP/share/GeoIP/GeoLiteCity.dat')
+     result = db.look_up('24.24.24.24')
+     puts result.inspect
+
+= License 
+Copyright (C) 2007 Ryan Dahl (ry@tinyclouds.org)
+
+I give permission for you to do whatever you'd like to do with this software.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+task :default => [:compile, :test]
+
+CLEAN.add "geoip_city.{o,bundle,so,obj,pdb,lib,def,exp}"
+CLOBBER.add ['Makefile', 'mkmf.log','doc']
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.add ['README', 'geoip_city.c']
+  rdoc.main = "README" # page to start on
+  rdoc.rdoc_dir = 'doc/' # rdoc output folder
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = 'test.rb'
+  t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.name              = 'geoip_city'
+  s.author            = 'ry dahl'
+  s.email             = 'ry@tinyclouds.org'
+  s.version           = "0.1"
+  s.summary           = "A Binding to the GeoIP C library"
+  s.homepage          = "http://geoip_city.rubyforge.org"
+  s.files             = FileList['Rakefile', '*.rb', '*.c', 'README*']
+  s.test_files        = 'test.rb'
+  s.extensions        = 'extconf.rb'
+  s.require_path      = '.'
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+  p.gem_spec = spec
+end
+
+desc 'compile the extension'
+task(:compile => 'Makefile') { sh 'make' }
+file('Makefile' => "geoip_city.c") { ruby 'extconf.rb' }

data/extconf.rb

@@ -0,0 +1,7 @@
+require 'mkmf'
+
+dir_config("geoip")
+
+if have_library('GeoIP', 'GeoIP_record_by_ipnum') and have_header('GeoIPCity.h')
+  create_makefile('geoip_city')
+end

data/geoip_city.c

@@ -0,0 +1,88 @@
+/* ry dahl <ry@tinyclouds.org> May 21, 2007 */
+/* 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. */
+#include <ruby.h>
+#include <GeoIP.h>
+#include <GeoIPCity.h>
+
+static VALUE cDB;
+ 
+/* The argument is the filename of the GeoIPCity.dat file */
+VALUE rb_geoip_new(VALUE self, VALUE filename) {
+  GeoIP *gi;
+  VALUE database = Qnil;
+
+  if(gi = GeoIP_open(STR2CSTR(filename), GEOIP_MEMORY_CACHE)) {
+    database = Data_Wrap_Struct(cDB, 0, GeoIP_delete, gi);
+    rb_obj_call_init(database, 0, 0);
+  }
+  return database; 
+}
+
+/* helper  */
+void rb_hash_sset(VALUE hash, const char *str, VALUE v) {
+  rb_hash_aset(hash, ID2SYM(rb_intern(str)), v);
+}
+
+VALUE rb_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;
+}
+
+/* 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
+ *    db.look_up('24.24.24.24') 
+ *    => {:city=>"Ithaca", :latitude=>42.4277992248535, 
+ *        :country_code=>"US", :longitude=>-76.4981994628906, 
+ *        :country_code3=>"USA", :dma_code=>555, 
+ *        :country_name=>"United States", :area_code=>607, 
+ *        :region=>"NY"} 
+ */ 
+VALUE rb_geoip_look_up(VALUE self, VALUE addr) {
+  GeoIP *gi;
+  GeoIPRecord *record = NULL;
+  VALUE hash = Qnil; 
+  
+  Check_Type(addr, T_STRING);
+  Data_Get_Struct(self, GeoIP, gi);
+  if(record = GeoIP_record_by_addr(gi, STR2CSTR(addr))) {
+    hash =  rb_record_to_hash(record); 
+    GeoIPRecord_delete(record);
+  }
+  return hash;
+}
+
+void Init_geoip_city ()
+{
+  VALUE mGeoIP = rb_define_module("GeoIPCity");
+
+  cDB = rb_define_class_under(mGeoIP, "Database", rb_cObject);
+  rb_define_singleton_method(cDB, "new", rb_geoip_new, 1);
+  rb_define_method(cDB, "look_up", rb_geoip_look_up, 1);
+}

data/test.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'geoip_city'
+
+class GeoIPTest < Test::Unit::TestCase
+  
+  def setup
+    ## Change me!
+    @dbfile = '/opt/GeoIP-1.4.2/share/GeoIP/GeoLiteCity.dat'
+  end
+  
+  
+  def test_construction
+    db = GeoIPCity::Database.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 'Ithaca', h[:city]
+    assert_equal 'United States', h[:country_name]
+  end
+  
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: geoip_city
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2007-10-27 00:00:00 +02: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: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- ry dahl
+files: 
+- Rakefile
+- extconf.rb
+- test.rb
+- geoip_city.c
+- README
+test_files: 
+- test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: 
+- extconf.rb
+requirements: []
+
+dependencies: []
+