geoip-c 0.5.6 → 0.6.3

data/README.md

@@ -67,34 +67,35 @@ Install
 Some variation of the following should work.
 
   1. Install the GeoCity C library. You can get it from
-  [maxmind](http://www.maxmind.com/app/c).
+  [MaxMind](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 
+        tar -zxvf GeoIP-1.4.3.tar.gz 
+        cd GeoIP-1.4.3
+        ./configure --prefix=/opt/GeoIP
+        make && sudo make install
 
-       cd GeoIP-1.4.3
+    On Mac OS X, you can install using MacPorts:
 
-       ./configure --prefix=/opt/GeoIP
+        sudo port install libgeoip
 
-       make && sudo make install
-
-  NOTE: for Intel Mac OS X platforms, try the following:
-
-       env ARCHFLAGS="-arch i386" ./configure --prefix=/opt/GeoIP
-
-       env ARCHFLAGS="-arch i386" make
+  2. Now install the `geoip` gem 
 
-       sudo env ARCHFLAGS="-arch i386" make install
+        gem install mtodd-geoip -s http://gems.github.com/ -- --with-geoip-dir=/opt/GeoIP
 
-  2. Now install the `geoip` gem 
+    Alternatively, if you installed libgeoip using MacPorts:
 
-       gem install mtodd-geoip -s http://gems.github.com/ -- --with-geoip-dir=/opt/GeoIP
+        env ARCHFLAGS="-arch x86_64" gem install geoip-c -- --with-opt-dir=/opt/local
 
   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.
      I put this file in 
 
-       /opt/GeoIP/share/GeoIP/GeoLiteCity.dat
+        /opt/GeoIP/share/GeoIP/GeoLiteCity.dat
+
+    If you installed libgeoip using MacPorts then put it in:
+
+        /opt/local/share/GeoIP/GeoLiteCity.dat
 
      If you are a paying customer, you will download the files required below:
 
@@ -111,11 +112,11 @@ Hints
 
   1. Might need to set
 
-       export ARCHFLAGS="-arch i386"
+        export ARCHFLAGS="-arch i386"
 
-     to be able to compile the gem.
+    to be able to compile the gem.
 
-     Example:
+    Example:
 
         env ARCHFLAGS="-arch i386" gem install mtodd-geoip -s http://gems.github.com/ -- --with-geoip-dir=/opt/GeoIP
 
@@ -130,6 +131,16 @@ This iteration of the library is based on the hard work of Ryah Dahl (ry@tinyclo
 [rdocs](http://geoip-city.rubyforge.org/)
 [git repo](https://github.com/ry/geoip-city/tree)
 
+Thanks
+------
+
+Special appreciation and thanks belongs to Ry Dahl for his initial work on this library.
+
+Many thanks to our contributors:
+
+* Charles Brian Quinn
+* Michael Sheakoski
+
 License
 -------
 Copyright (C) 2007--2009 Ryah Dahl (ry@tinyclouds.org), Matt Todd (mtodd@highgroove.com)

data/Rakefile

@@ -22,9 +22,9 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name              = 'geoip-c'
-  s.version           = "0.5.6"
+  s.version           = "0.6.3"
 
-  s.authors           = ['Ryah Dahl', 'Matt Todd', 'Charles Brian Quinn']
+  s.authors           = ['Ryah Dahl', 'Matt Todd', 'Charles Brian Quinn', 'Michael Sheakoski']
   s.email             = 'mtodd@highgroove.com'
 
   s.summary           = "A Binding to the GeoIP C library"

data/geoip.c

@@ -12,6 +12,9 @@
 static VALUE mGeoIP;
 static VALUE mGeoIP_City;
 static VALUE mGeoIP_Organization;
+static VALUE mGeoIP_ISP;
+static VALUE mGeoIP_NetSpeed;
+static VALUE mGeoIP_Domain;
 static VALUE rb_geoip_memory;
 static VALUE rb_geoip_filesystem;
 static VALUE rb_geoip_index;
@@ -56,15 +59,27 @@ static VALUE rb_geoip_database_new(VALUE mGeoIP_Database_Class, int argc, VALUE
   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 { 
+  } else {
     rb_sys_fail("Problem opening database");
   }
   return database;
 }
 
+/* Generic, single-value look up method */
+static VALUE generic_single_value_lookup_response(char *key, char *value)
+{
+  VALUE result = rb_hash_new();
+  if(value) {
+    rb_hash_sset(result, key, rb_str_new2(value));
+    return result;
+  } else {
+    return Qnil;
+  }
+}
+
 /* GeoIP::City ***************************************************************/
 
-VALUE rb_city_record_to_hash(GeoIPRecord *record) 
+VALUE rb_city_record_to_hash(GeoIPRecord *record)
 {
   VALUE hash = rb_hash_new();
 
@@ -88,20 +103,20 @@ VALUE rb_city_record_to_hash(GeoIPRecord *record)
     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;
 }
 
-/* The first argument is the filename of the GeoIPCity.dat file 
+/* 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.
  */
@@ -112,18 +127,18 @@ static VALUE rb_geoip_city_new(int argc, VALUE *argv, VALUE 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
- *    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"} 
- */ 
+ *    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_city_look_up(VALUE self, VALUE addr) {
   GeoIP *gi;
   GeoIPRecord *record = NULL;
-  VALUE hash = Qnil; 
-  
+  VALUE hash = Qnil;
+
   Check_Type(addr, T_STRING);
   Data_Get_Struct(self, GeoIP, gi);
   if(record = GeoIP_record_by_addr(gi, STR2CSTR(addr))) {
@@ -140,7 +155,7 @@ VALUE rb_geoip_city_look_up(VALUE self, VALUE addr) {
  * * :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)
 {
@@ -154,25 +169,96 @@ static VALUE rb_geoip_org_new(int argc, VALUE *argv, VALUE self)
  */ 
 VALUE rb_geoip_org_look_up(VALUE self, VALUE addr) {
   GeoIP *gi;
-  VALUE hash = rb_hash_new();
-  char * name = NULL;
-  
   Check_Type(addr, T_STRING);
   Data_Get_Struct(self, GeoIP, gi);
-  if(name = GeoIP_name_by_addr(gi, STR2CSTR(addr))) {
-    rb_hash_sset(hash, "name", rb_str_new2(name));
-    free(name);
-  }
-  return hash;
+  return generic_single_value_lookup_response("name", GeoIP_name_by_addr(gi, STR2CSTR(addr)));
+}
+
+/* GeoIP::ISP *******************************************************/
+
+/* GeoIP::ISP.new('/path/to/GeoIPISP.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_isp_new(int argc, VALUE *argv, VALUE self)
+{
+  return rb_geoip_database_new(mGeoIP_ISP, 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:
+ *    db.look_up('24.24.24.24')
+ *    => {:isp => "Road Runner"}
+ */
+VALUE rb_geoip_isp_look_up(VALUE self, VALUE addr) {
+  GeoIP *gi;
+  Check_Type(addr, T_STRING);
+  Data_Get_Struct(self, GeoIP, gi);
+  return generic_single_value_lookup_response("isp", GeoIP_name_by_addr(gi, STR2CSTR(addr)));
+}
+
+/* GeoIP::NetSpeed *******************************************************/
+
+/* GeoIP::NetSpeed.new('/path/to/GeoIPNetSpeed.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_netspeed_new(int argc, VALUE *argv, VALUE self)
+{
+  return rb_geoip_database_new(mGeoIP_NetSpeed, 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:
+ *    db.look_up('24.24.24.24')
+ *    => {:netspeed => "Cable/DSL"}
+ */
+VALUE rb_geoip_netspeed_look_up(VALUE self, VALUE addr) {
+  GeoIP *gi;
+  Check_Type(addr, T_STRING);
+  Data_Get_Struct(self, GeoIP, gi);
+  return generic_single_value_lookup_response("netspeed", GeoIP_name_by_addr(gi, STR2CSTR(addr)));
+}
+
+/* GeoIP::Domain *******************************************************/
+
+/* GeoIP::Domain.new('/path/to/GeoIPDomain.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_domain_new(int argc, VALUE *argv, VALUE self)
+{
+  return rb_geoip_database_new(mGeoIP_Domain, 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:
+ *    db.look_up('24.24.24.24')
+ *    => {:domain => "rr.com"}
+ */
+VALUE rb_geoip_domain_look_up(VALUE self, VALUE addr) {
+  GeoIP *gi;
+  Check_Type(addr, T_STRING);
+  Data_Get_Struct(self, GeoIP, gi);
+  return generic_single_value_lookup_response("domain", GeoIP_name_by_addr(gi, STR2CSTR(addr)));
 }
 
 /* GeoIP *********************************************************************/
 
 /* Returns the numeric form of an IP address.
- * 
+ *
  * For example:
  * 24.24.24.24 => 404232216
- * 
+ *
  * This is used in order to be able to perform searches in CSV versions of the
  * data files or in SQL records if the data has been put there.
  */
@@ -253,18 +339,30 @@ void Init_geoip()
 {
   mGeoIP = rb_define_module("GeoIP");
 
-  rb_geoip_memory = ID2SYM(rb_intern("memory")); 
-  rb_geoip_filesystem = ID2SYM(rb_intern("filesystem")); 
-  rb_geoip_index = ID2SYM(rb_intern("index")); 
+  rb_geoip_memory = ID2SYM(rb_intern("memory"));
+  rb_geoip_filesystem = ID2SYM(rb_intern("filesystem"));
+  rb_geoip_index = ID2SYM(rb_intern("index"));
 
   mGeoIP_City = rb_define_class_under(mGeoIP, "City", rb_cObject);
   rb_define_singleton_method(mGeoIP_City, "new",      rb_geoip_city_new,      -1);
-  rb_define_method(mGeoIP_City,           "look_up",  rb_geoip_city_look_up,  1);
-  
+  rb_define_method(          mGeoIP_City, "look_up",  rb_geoip_city_look_up,  1);
+
   mGeoIP_Organization = rb_define_class_under(mGeoIP, "Organization", rb_cObject);
-  rb_define_singleton_method( mGeoIP_Organization, "new",     rb_geoip_org_new,     -1);
-  rb_define_method(           mGeoIP_Organization, "look_up", rb_geoip_org_look_up, 1);
-  
+  rb_define_singleton_method(mGeoIP_Organization, "new",     rb_geoip_org_new,     -1);
+  rb_define_method(          mGeoIP_Organization, "look_up", rb_geoip_org_look_up, 1);
+
+  mGeoIP_ISP = rb_define_class_under(mGeoIP, "ISP", rb_cObject);
+  rb_define_singleton_method(mGeoIP_ISP, "new",     rb_geoip_isp_new,     -1);
+  rb_define_method(          mGeoIP_ISP, "look_up", rb_geoip_isp_look_up, 1);
+
+  mGeoIP_NetSpeed = rb_define_class_under(mGeoIP, "NetSpeed", rb_cObject);
+  rb_define_singleton_method(mGeoIP_NetSpeed, "new",     rb_geoip_netspeed_new,     -1);
+  rb_define_method(          mGeoIP_NetSpeed, "look_up", rb_geoip_netspeed_look_up, 1);
+
+  mGeoIP_Domain = rb_define_class_under(mGeoIP, "Domain", rb_cObject);
+  rb_define_singleton_method(mGeoIP_Domain, "new",     rb_geoip_domain_new,     -1);
+  rb_define_method(          mGeoIP_Domain, "look_up", rb_geoip_domain_look_up, 1);
+
   rb_define_singleton_method(mGeoIP, "addr_to_num", rb_geoip_addr_to_num, 1);
   rb_define_singleton_method(mGeoIP, "num_to_addr", rb_geoip_num_to_addr, 1);
 }

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: geoip-c
 version: !ruby/object:Gem::Version 
-  version: 0.5.6
+  version: 0.6.3
 platform: ruby
 authors: 
 - Ryah Dahl
 - Matt Todd
 - Charles Brian Quinn
+- Michael Sheakoski
 autorequire: 
 bindir: bin
 cert_chain: []