maxmind_geoip2 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d44d6918c53ce5896328cf616a9aa3a8ab27ab52
+  data.tar.gz: 8834d5eba9dcac03dd2fe670412da8d65e57d4ad
+SHA512:
+  metadata.gz: c7f4cb6969a08e851c94c1112261bea19e8a81d306338fc6eb1e0172fd51237ab29f57974490dbf46a5e0400a080bbb291f28ccaed1d8c1081a755dbce3bf2f6
+  data.tar.gz: 20ae0471170fa6022f853257fcb93ff37ed9c3774b07e748db0aa562903e41c47cfdb14a1465f88e8618b1733ed3d20943a71751cc89411db0b616d35538d1ac

data/.gitignore

@@ -0,0 +1,7 @@
+mkmf.log
+Makefile
+GeoIP2.so
+*.o
+Gemfile.lock
+*.bundle
+GeoLite2-City.mmdb

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+# Ruby Maxmind GeoIP2 Bindings
+
+## Description
+
+Searches city by ip address in local database from [maxmind.com](http://dev.maxmind.com/geoip/geoip2/geolite2/).
+
+Use it with rails. For now, I think.
+
+## Installation
+
+[libmaxminddb](https://github.com/maxmind/libmaxminddb) must be installed.
+
+```
+gem 'maxmind_geoip2'
+```
+
+## Usage
+
+### Configuration, can be moved to rails initializer
+
+```ruby
+MaxmindGeoIP2.file '<local_db_file.mmdb>' # default: GeoLite2-City.mmdb
+MaxmindGeoIP2.locale 'ru' # default: 'ru'
+```
+
+### Further usage:
+
+Returns nil if nothing found and raises exception if file not opened or not found
+
+```ruby
+city = MaxmindGeoIP2.locate(<ip address>, <optional lang>)
+
+city = MaxmindGeoIP2.locate '77.93.127.33'
+=> {"city"=>"Тамбов",
+"city_geoname_id"=>484646,
+"country"=>"Россия",
+"country_geoname_id"=>2017370,
+"country_code"=>"RU",
+"continent"=>"Европа",
+"continent_code"=>"EU",
+"continent_geoname_id"=>6255148,
+"subdivision"=>"Тамбовская область",
+"subdivision_code"=>"TAM",
+"postal_code"=>nil,
+"latitude"=>52.731700000000004,
+"longitude"=>41.4433,
+"time_zone"=>"Europe/Moscow"}
+
+city = MaxmindGeoIP2.locate '77.93.127.33', 'en'
+=> {"city"=>"Tambov",
+"city_geoname_id"=>484646,
+"country"=>"Russia",
+"country_geoname_id"=>2017370,
+"country_code"=>"RU",
+"continent"=>"Europe",
+"continent_code"=>"EU",
+"continent_geoname_id"=>6255148,
+"subdivision"=>"Tambovskaya Oblast'",
+"subdivision_code"=>"TAM",
+"postal_code"=>nil,
+"latitude"=>52.731700000000004,
+"longitude"=>41.4433,
+"time_zone"=>"Europe/Moscow"}
+```

data/Rakefile

@@ -0,0 +1,37 @@
+require "rake/extensiontask"
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+Rake::ExtensionTask.new "maxmind_geoip2" do |ext|
+  ext.lib_dir = "lib/maxmind_geoip2"
+end
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+end
+
+desc "Download free IP to City database"
+task :download_free_database do
+  file = 'GeoLite2-City.mmdb'
+  if File.exist?(file)
+    puts "File already exists"
+  else
+    puts "Downloading file"
+    `curl http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz | gzip -d > #{file}`
+  end
+end
+
+desc "An IRB console with the project loaded"
+task :console do
+  $: << 'lib'
+  require 'maxmind_geoip2'
+  MaxmindGeoIP2.file('GeoLite2-City.mmdb')
+  require 'irb'
+  require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end
+
+task default: [:compile, :test]

data/ext/maxmind_geoip2/extconf.rb

@@ -0,0 +1,14 @@
+require 'mkmf'
+extension_name = 'maxmind_geoip2'
+
+$LDFLAGS << " #{ENV['LDFLAGS']}"
+$CFLAGS << " #{ENV['CFLAGS']}"
+
+RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+
+if have_header('maxminddb.h') and have_library('maxminddb')
+  create_makefile("#{extension_name}/#{extension_name}")
+else
+  abort "you must have mmdb library"
+end
+

data/ext/maxmind_geoip2/maxmind_geoip2.c

@@ -0,0 +1,150 @@
+#include "maxminddb.h"
+
+#include <ruby.h>
+#include <ruby/encoding.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+
+VALUE mMaxmindGeoIP2 = Qnil;
+
+const char **lookup_path_parse(char *lookup_path, char *lang)
+{
+
+    const char **result;
+    if (NULL != lang)
+        result = malloc(sizeof(char *) * (strlen(lookup_path) + strlen(lang) + 1 ));
+    else
+        result = malloc(sizeof(char *) * (strlen(lookup_path) + 1));
+
+    char *token;
+    char *string = strdup(lookup_path);
+
+    token = strtok(string, " ");
+    int i = 0;
+    while (token != NULL) {
+        result[i++] = token;
+        token = strtok(NULL, " ");
+    }
+    if (NULL != lang) {
+        result[i++] = lang;
+    }
+    result[i] = NULL;
+    return result;
+}
+
+VALUE locate_by_path(MMDB_lookup_result_s *result, char *lookup_path, char *lang)
+{
+    VALUE return_value = Qnil;
+
+    MMDB_entry_data_s entry_data;
+    const char **lp = lookup_path_parse(lookup_path, lang);
+    int status = MMDB_aget_value(&result->entry, &entry_data, lp);
+    if (MMDB_SUCCESS == status)
+    {
+        if (entry_data.offset)
+        {
+            if (entry_data.has_data) {
+                if (entry_data.type == MMDB_DATA_TYPE_UTF8_STRING)
+                    return_value = rb_enc_str_new(strndup((char *)entry_data.utf8_string, entry_data.data_size), entry_data.data_size, rb_utf8_encoding());
+                if (entry_data.type == MMDB_DATA_TYPE_UINT32)
+                    return_value = rb_int_new(entry_data.uint32);
+                if (entry_data.type == MMDB_DATA_TYPE_DOUBLE)
+                    return_value = rb_float_new(entry_data.double_value);
+            }
+        }
+    }
+    free(lp);
+    return return_value;
+}
+
+VALUE mMaxmindGeoIP2_locate(int argc, VALUE *argv, VALUE self)
+{
+    VALUE locate_result = Qnil;
+
+    if (argc > 3 || argc == 0) {
+        rb_raise(rb_eArgError, "wrong number of arguments");
+    }
+
+
+    char *lang;
+    if (argc == 2) {
+        Check_Type(argv[1], T_STRING);
+        lang = StringValuePtr(argv[1]);
+    } else {
+        VALUE  loc = rb_iv_get(self, "@_locale");
+        Check_Type(loc, T_STRING);
+        lang = StringValuePtr(loc);
+    }
+
+    VALUE ipaddr = argv[0];
+    Check_Type(ipaddr, T_STRING);
+    char *ip_address = StringValuePtr(ipaddr);
+
+    char *filename;
+    VALUE file = rb_iv_get(self, "@_file");
+    Check_Type(file, T_STRING);
+    filename = StringValuePtr(file);
+
+
+    MMDB_s mmdb;
+    int status = MMDB_open(filename, MMDB_MODE_MMAP, &mmdb);
+    if (MMDB_SUCCESS == status)
+    {
+        int gai_error, mmdb_error;
+        MMDB_lookup_result_s result =
+            MMDB_lookup_string(&mmdb, ip_address, &gai_error, &mmdb_error);
+
+        if (result.found_entry)
+        {
+            locate_result = rb_hash_new();
+            rb_hash_aset(locate_result, rb_str_new2("city"), locate_by_path(&result, "city names", lang));
+            rb_hash_aset(locate_result, rb_str_new2("city_geoname_id"), locate_by_path(&result, "city geoname_id", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("country"), locate_by_path(&result, "country names", lang));
+            rb_hash_aset(locate_result, rb_str_new2("country_geoname_id"), locate_by_path(&result, "country geoname_id", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("country_code"), locate_by_path(&result, "country iso_code", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("continent"), locate_by_path(&result, "continent names", lang));
+            rb_hash_aset(locate_result, rb_str_new2("continent_code"), locate_by_path(&result, "continent code", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("continent_geoname_id"), locate_by_path(&result, "continent geoname_id", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("subdivision"), locate_by_path(&result, "subdivisions 0 names", lang));
+            rb_hash_aset(locate_result, rb_str_new2("subdivision_code"), locate_by_path(&result, "subdivisions 0 iso_code", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("subdivision_geoname_id"), locate_by_path(&result, "subdivisions 0 geoname_id", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("postal_code"), locate_by_path(&result, "postal code", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("latitude"), locate_by_path(&result, "location latitude", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("longitude"), locate_by_path(&result, "location longitude", NULL));
+            rb_hash_aset(locate_result, rb_str_new2("time_zone"), locate_by_path(&result, "location time_zone", NULL));
+        }
+        MMDB_close(&mmdb);
+    } else {
+        rb_raise(rb_eIOError, "unable to open file %s", filename);
+    }
+    return locate_result;
+}
+
+VALUE mMaxmindGeoIP2_file(VALUE self, VALUE filepath)
+{
+    rb_iv_set(self, "@_file", filepath);
+    return Qtrue;
+}
+
+VALUE mMaxmindGeoIP2_locale(VALUE self, VALUE language)
+{
+    rb_iv_set(self, "@_locale", language);
+    return Qtrue;
+}
+
+void Init_maxmind_geoip2()
+{
+      mMaxmindGeoIP2 = rb_define_module("MaxmindGeoIP2");
+      rb_define_module_function(mMaxmindGeoIP2, "locate", mMaxmindGeoIP2_locate, -1);
+      rb_define_module_function(mMaxmindGeoIP2, "file", mMaxmindGeoIP2_file, 1);
+      rb_define_module_function(mMaxmindGeoIP2, "locale", mMaxmindGeoIP2_locale, 1);
+
+      rb_define_attr(mMaxmindGeoIP2, "_file", 1, 1);
+      rb_define_attr(mMaxmindGeoIP2, "_locale", 1, 1);
+
+      rb_iv_set(mMaxmindGeoIP2, "@_file", rb_str_new2("GeoLite2-City.mmdb"));
+      rb_iv_set(mMaxmindGeoIP2, "@_locale", rb_str_new2("ru"));
+}

data/lib/maxmind_geoip2.rb

@@ -0,0 +1 @@
+require 'maxmind_geoip2/maxmind_geoip2'

data/maxmind_geoip2.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name         = 'maxmind_geoip2'
+  s.version      = "0.0.8"
+
+  s.licenses     = ['WTFPL']
+
+  s.authors      = ['Maksim Stepanov']
+  s.email        = ['stepanov.ms@mail.ru']
+
+  s.summary      = "A Binding to the GeoIP2 C library"
+  s.description  = 'Generic GeoIP2 lookup tool.'
+  s.homepage     = "http://github.com"
+
+  s.files        = `git ls-files`.split("\n")
+  s.extensions   = ['ext/maxmind_geoip2/extconf.rb']
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake', '~>10.0'
+  s.add_development_dependency 'rake-compiler'
+end

data/spec/maxmind_geoip2_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe MaxmindGeoIP2 do
+  describe '.locate' do
+    let(:result) { MaxmindGeoIP2.locate('74.125.237.168') }
+
+    it 'sets string encodings to utf8' do
+      result['country'].encoding.must_equal(Encoding::UTF_8)
+    end
+
+    it 'has a continent' do
+      result['continent'].must_be_instance_of(String)
+    end
+
+    it 'has a continent_code' do
+      result['continent_code'].must_be_instance_of(String)
+    end
+
+    it 'has a continent_geoname_id' do
+      result['continent_geoname_id'].must_be_instance_of(Fixnum)
+    end
+
+    it 'has the correct continent_geoname_id' do
+      result['continent_geoname_id'].must_equal(6255149)
+    end
+
+    it 'has a country' do
+      result['country'].must_be_instance_of(String)
+    end
+
+    it 'has a country_code' do
+      result['country_code'].must_be_instance_of(String)
+    end
+
+    it 'has a country_geoname_id' do
+      result['country_geoname_id'].must_be_instance_of(Fixnum)
+    end
+
+    it 'has a city' do
+      result['city'].must_be_instance_of(String)
+    end
+
+    it 'has a city_geoname_id' do
+      result['city_geoname_id'].must_be_instance_of(Fixnum)
+    end
+
+    it 'has a subdivision' do
+      result['subdivision'].must_be_instance_of(String)
+    end
+
+    it 'has a subdivision_code' do
+      result['subdivision_code'].must_be_instance_of(String)
+    end
+
+    it 'has a subdivision_geoname_id' do
+      result['subdivision_geoname_id'].must_be_instance_of(Fixnum)
+    end
+
+    it 'has a postal_code' do
+      result['postal_code'].must_be_instance_of(String)
+    end
+
+    it 'has a latitude' do
+      result['latitude'].must_be_instance_of(Float)
+    end
+
+    it 'has a longitude' do
+      result['longitude'].must_be_instance_of(Float)
+    end
+
+    it 'has a time_zone' do
+      result['time_zone'].must_be_instance_of(String)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+
+require 'maxmind_geoip2'
+
+unless File.exist?('GeoLite2-City.mmdb')
+  raise "GeoLite2-City.mmdb doesn't exist. Run rake download_free_database to get it"
+end
+
+MaxmindGeoIP2.file('GeoLite2-City.mmdb')

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: maxmind_geoip2
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Maksim Stepanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generic GeoIP2 lookup tool.
+email:
+- stepanov.ms@mail.ru
+executables: []
+extensions:
+- ext/maxmind_geoip2/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- ext/maxmind_geoip2/extconf.rb
+- ext/maxmind_geoip2/maxmind_geoip2.c
+- lib/maxmind_geoip2.rb
+- maxmind_geoip2.gemspec
+- spec/maxmind_geoip2_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com
+licenses:
+- WTFPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A Binding to the GeoIP2 C library
+test_files: []