geoip2_compat 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f9ed49b988f87ea47456f82c323a7e0520dc910
+  data.tar.gz: 663287416d22813c84be2cd401ac5a31f607c450
+SHA512:
+  metadata.gz: 08b74a2d6381a209c2a9968e55a9b68af4b275689d43d329d6777a4fac2353879f096a8e757b925cd9dd7a3ba9bae4ae24df244be96fbe7257614828d758301f
+  data.tar.gz: fddf485a7961547ac96ef674b072e86c1b53d97d0256a53525cb2b79570b427879688b9cf96d7b0b1e919c5a45f62389048003d1ea2636b8fce5735a283a109b

data/.gitignore

@@ -0,0 +1,5 @@
+*.bundle
+*.so
+test/*.mmdb
+tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - 1.9.3
+  - rbx-2
+sudo: false
+cache: bundler

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Dirkjan Bussink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# Ruby GeoIP2 compatibility bindings
+
+Implements the new Maxmind database format while keeping the output
+complatible with https://github.com/mtodd/geoip
+
+## Dependencies
+
+This depends on [libmaxminddb](https://github.com/maxmind/libmaxminddb)
+
+## Installation
+
+`gem install geoip2_compat`
+
+## Usage
+
+```
+geoip = GeoIP2Compat.new(dbfile)
+geoip.lookup("24.24.24.24")
+```

data/Rakefile

@@ -0,0 +1,34 @@
+require "rake/extensiontask"
+require 'rake/testtask'
+
+Rake::ExtensionTask.new "geoip2_compat" do |ext|
+  ext.lib_dir = "lib/geoip2_compat"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task :download do
+  file = "test/GeoLite2-City.mmdb"
+  unless File.exist?(file)
+    `curl http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz | gzip -d > #{file}`
+  end
+end
+
+task :vendor do
+  version = "1.0.3"
+  mkdir_p "tmp/"
+  dir = "tmp/libmaxminddb-#{version}"
+  cd "tmp/" do
+    sh "curl -L https://github.com/maxmind/libmaxminddb/releases/download/#{version}/libmaxminddb-#{version}.tar.gz | tar xz"
+  end
+  cp "#{dir}/src/maxminddb-compat-util.h", "ext/geoip2_compat/maxminddb-compat-util.h"
+  cp "#{dir}/src/maxminddb.c", "ext/geoip2_compat/maxminddb.c"
+  cp "#{dir}/include/maxminddb.h", "ext/geoip2_compat/maxminddb.h"
+  cp "#{dir}/include/maxminddb_config.h.in", "ext/geoip2_compat/maxminddb_config.h"
+end
+
+task default: [:compile, :download, :test]

data/ext/geoip2_compat/extconf.rb

@@ -0,0 +1,11 @@
+require "mkmf"
+extension_name = "geoip2_compat"
+
+$LDFLAGS << " #{ENV['LDFLAGS']}"
+$CFLAGS << " -std=c99 #{ENV['CFLAGS']}"
+
+RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+
+$defs << ' -DPACKAGE_VERSION=\"1.0.3\"'
+
+create_makefile("#{extension_name}/#{extension_name}")

data/ext/geoip2_compat/geoip2_compat.c

@@ -0,0 +1,186 @@
+#include <ruby.h>
+#include <ruby/encoding.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <stdarg.h>
+
+#include <maxminddb.h>
+
+VALUE cgeoip2_compat;
+VALUE egeoip2_compat_Exception;
+
+ID geoip2_compat_COUNTRY_CODE;
+ID geoip2_compat_COUNTRY_NAME;
+ID geoip2_compat_REGION;
+ID geoip2_compat_REGION_NAME;
+ID geoip2_compat_CITY;
+ID geoip2_compat_POSTAL_CODE;
+ID geoip2_compat_LATITUDE;
+ID geoip2_compat_LONGITUDE;
+
+static void geoip2_compat_internal_close(MMDB_s* mmdb)
+{
+  if(mmdb->file_content) {
+    MMDB_close(mmdb);
+  }
+  mmdb->file_content = NULL;
+}
+
+static VALUE geoip2_compat_close(VALUE self)
+{
+  MMDB_s *mmdb;
+  Data_Get_Struct(self, MMDB_s, mmdb);
+  geoip2_compat_internal_close(mmdb);
+  return self;
+}
+
+static VALUE geoip2_compat_path(VALUE self)
+{
+  MMDB_s *mmdb;
+  Data_Get_Struct(self, MMDB_s, mmdb);
+
+  return rb_str_new2(mmdb->filename);
+}
+
+static void geoip2_compat_lookup_internal(MMDB_lookup_result_s* result, VALUE hash, ID name, ...)
+{
+  MMDB_entry_data_s entry_data;
+
+  va_list path;
+  va_start(path, name);
+  int status = MMDB_vget_value(&result->entry, &entry_data, path);
+  va_end(path);
+
+  if (MMDB_SUCCESS != status) return;
+
+  if (entry_data.has_data) {
+    VALUE val = Qnil;
+    switch (entry_data.type) {
+      case MMDB_DATA_TYPE_UTF8_STRING:
+        val = rb_enc_str_new(entry_data.utf8_string, entry_data.data_size, rb_utf8_encoding());
+        break;
+      case MMDB_DATA_TYPE_BYTES:
+        val = rb_str_new((const char*)entry_data.bytes, entry_data.data_size);
+        break;
+      case MMDB_DATA_TYPE_DOUBLE:
+        val = rb_float_new(entry_data.double_value);
+        break;
+      case MMDB_DATA_TYPE_UINT16:
+        val = UINT2NUM(entry_data.uint16);
+        break;
+      case MMDB_DATA_TYPE_UINT32:
+        val = UINT2NUM(entry_data.uint32);
+        break;
+      case MMDB_DATA_TYPE_INT32:
+        val = INT2NUM(entry_data.int32);
+        break;
+      case MMDB_DATA_TYPE_UINT64:
+        val = UINT2NUM(entry_data.uint64);
+        break;
+      case MMDB_DATA_TYPE_BOOLEAN:
+        val = entry_data.boolean ? Qtrue : Qfalse;
+        break;
+      case MMDB_DATA_TYPE_FLOAT:
+        val = rb_float_new(entry_data.float_value);
+        break;
+    }
+    rb_hash_aset(hash, ID2SYM(name), val);
+  }
+}
+
+static VALUE geoip2_compat_lookup(VALUE self, VALUE ip)
+{
+  int status, gai_error, mmdb_error;
+  Check_Type(ip, T_STRING);
+
+  char* ip_addr = StringValuePtr(ip);
+  MMDB_s *mmdb;
+  Data_Get_Struct(self, MMDB_s, mmdb);
+
+  MMDB_lookup_result_s result =
+    MMDB_lookup_string(mmdb, ip_addr, &gai_error, &mmdb_error);
+
+  if (mmdb_error != MMDB_SUCCESS) {
+    rb_raise(egeoip2_compat_Exception,
+      "geoip2_compat - lookup failed: %s", MMDB_strerror(mmdb_error)
+    );
+  }
+
+  if (gai_error != 0) {
+    rb_raise(egeoip2_compat_Exception,
+      "geoip2_compat - getaddrinfo failed: %s", gai_strerror(gai_error)
+    );
+  }
+
+  if (!result.found_entry) return Qnil;
+
+  VALUE hash = rb_hash_new();
+
+  geoip2_compat_lookup_internal(&result, hash, geoip2_compat_COUNTRY_CODE, "country", "iso_code", NULL);
+  geoip2_compat_lookup_internal(&result, hash, geoip2_compat_COUNTRY_NAME, "country", "names", "en", NULL);
+  geoip2_compat_lookup_internal(&result, hash, geoip2_compat_REGION, "subdivisions", "0", "iso_code", NULL);
+  geoip2_compat_lookup_internal(&result, hash, geoip2_compat_REGION_NAME, "subdivisions", "0", "names", "en", NULL);
+  geoip2_compat_lookup_internal(&result, hash, geoip2_compat_CITY, "city", "names", "en", NULL);
+  geoip2_compat_lookup_internal(&result, hash, geoip2_compat_POSTAL_CODE, "postal", "code", NULL);
+  geoip2_compat_lookup_internal(&result, hash, geoip2_compat_LATITUDE, "location", "latitude", NULL);
+  geoip2_compat_lookup_internal(&result, hash, geoip2_compat_LONGITUDE, "location", "longitude", NULL);
+
+  return hash;
+}
+
+static void geoip2_compat_free(MMDB_s *mmdb)
+{
+  geoip2_compat_internal_close(mmdb);
+  ruby_xfree(mmdb);
+}
+
+static VALUE geoip2_compat_allocate(VALUE klass)
+{
+  MMDB_s* mmdb = ruby_xmalloc(sizeof(MMDB_s));
+  mmdb->file_content = NULL;
+  return Data_Wrap_Struct(klass, NULL, geoip2_compat_free, mmdb);
+}
+
+static VALUE geoip2_compat_initialize(VALUE self, VALUE path)
+{
+  Check_Type(path, T_STRING);
+  char* db = StringValuePtr(path);
+  MMDB_s *mmdb;
+  Data_Get_Struct(self, MMDB_s, mmdb);
+
+  int status = MMDB_open(db, MMDB_MODE_MMAP, mmdb);
+
+  if (status != MMDB_SUCCESS) {
+    rb_raise(egeoip2_compat_Exception, "GeoIP2Compat - %s: %s",
+      MMDB_strerror(status), db
+    );
+  }
+  return self;
+}
+
+void Init_geoip2_compat()
+{
+  cgeoip2_compat = rb_define_class("GeoIP2Compat", rb_cObject);
+  egeoip2_compat_Exception = rb_define_class_under(cgeoip2_compat, "Error", rb_eStandardError);
+
+  rb_global_variable(&cgeoip2_compat);
+  rb_global_variable(&egeoip2_compat_Exception);
+
+  rb_define_alloc_func(cgeoip2_compat, geoip2_compat_allocate);
+  rb_define_method(cgeoip2_compat, "initialize", geoip2_compat_initialize, 1);
+  rb_define_method(cgeoip2_compat, "path", geoip2_compat_path, 0);
+  rb_define_method(cgeoip2_compat, "close", geoip2_compat_close, 0);
+  rb_define_method(cgeoip2_compat, "lookup", geoip2_compat_lookup, 1);
+
+  geoip2_compat_COUNTRY_CODE  = rb_intern("country_code");
+  geoip2_compat_COUNTRY_NAME  = rb_intern("country_name");
+  geoip2_compat_REGION        = rb_intern("region");
+  geoip2_compat_REGION_NAME   = rb_intern("region_name");
+  geoip2_compat_CITY          = rb_intern("city");
+  geoip2_compat_POSTAL_CODE   = rb_intern("postal_code");
+  geoip2_compat_LATITUDE      = rb_intern("latitude");
+  geoip2_compat_LONGITUDE     = rb_intern("longitude");
+}

data/ext/geoip2_compat/maxminddb-compat-util.h

@@ -0,0 +1,167 @@
+#include <stdlib.h>
+#include <string.h>
+
+/* *INDENT-OFF* */
+
+/* The memmem, strdup, and strndup functions were all copied from the
+ * FreeBSD source, along with the relevant copyright notice.
+ *
+ * It'd be nicer to simply use the functions available on the system if they
+ * exist, but there doesn't seem to be a good way to detect them without also
+ * defining things like _GNU_SOURCE, which we want to avoid, because then we
+ * end up _accidentally_ using GNU features without noticing, which then
+ * breaks on systems like OSX.
+ *
+ * C is fun! */
+
+/* Applies to memmem implementation */
+/*-
+ * Copyright (c) 2005 Pascal Gloor <pascal.gloor@spale.com>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote
+ *    products derived from this software without specific prior written
+ *    permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+static void *
+mmdb_memmem(const void *l, size_t l_len, const void *s, size_t s_len)
+{
+	register char *cur, *last;
+	const char *cl = (const char *)l;
+	const char *cs = (const char *)s;
+
+	/* we need something to compare */
+	if (l_len == 0 || s_len == 0)
+		return NULL;
+
+	/* "s" must be smaller or equal to "l" */
+	if (l_len < s_len)
+		return NULL;
+
+	/* special case where s_len == 1 */
+	if (s_len == 1)
+		return memchr(l, (int)*cs, l_len);
+
+	/* the last position where its possible to find "s" in "l" */
+	last = (char *)cl + l_len - s_len;
+
+	for (cur = (char *)cl; cur <= last; cur++)
+		if (cur[0] == cs[0] && memcmp(cur, cs, s_len) == 0)
+			return cur;
+
+	return NULL;
+}
+
+/* Applies to strnlen implementation */
+/*-
+ * Copyright (c) 2009 David Schultz <das@FreeBSD.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+static size_t
+mmdb_strnlen(const char *s, size_t maxlen)
+{
+	size_t len;
+
+	for (len = 0; len < maxlen; len++, s++) {
+		if (!*s)
+			break;
+	}
+	return (len);
+}
+
+/* Applies to strdup and strndup implementation */
+/*
+ * Copyright (c) 1988, 1993
+ *	The Regents of the University of California.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+static char *
+mmdb_strdup(const char *str)
+{
+	size_t len;
+	char *copy;
+
+	len = strlen(str) + 1;
+	if ((copy = malloc(len)) == NULL)
+		return (NULL);
+	memcpy(copy, str, len);
+	return (copy);
+}
+
+static char *
+mmdb_strndup(const char *str, size_t n)
+{
+	size_t len;
+	char *copy;
+
+	len = mmdb_strnlen(str, n);
+	if ((copy = malloc(len + 1)) == NULL)
+		return (NULL);
+	memcpy(copy, str, len);
+	copy[len] = '\0';
+	return (copy);
+}
+/* *INDENT-ON* */