maxmind-geoip2 0.3.0 → 1.0.0

data/lib/maxmind/geoip2/record/traits.rb

@@ -13,7 +13,7 @@ module MaxMind
         # @!visibility private
         def initialize(record)
           super(record)
-          if !record.key?('network') && record.key?('ip_address') &&
+          if record && !record.key?('network') && record.key?('ip_address') &&
              record.key?('prefix_length')
             ip = IPAddr.new(record['ip_address']).mask(record['prefix_length'])
             # We could use ip.prefix instead of record['prefix_length'], but that
@@ -69,7 +69,7 @@ module MaxMind
         # NAT, this may differ from the IP address locally assigned to it. This
         # attribute is returned by all end points.
         #
-        # @return [String]
+        # @return [String, nil]
         def ip_address
           get('ip_address')
         end
@@ -119,6 +119,15 @@ module MaxMind
           get('is_public_proxy')
         end
 
+        # This is true if the IP address is on a suspected anonymizing network
+        # and belongs to a residential ISP. This property is only available
+        # from GeoIP2 Precision Insights.
+        #
+        # @return [Boolean]
+        def residential_proxy?
+          get('is_residential_proxy')
+        end
+
         # This is true if the IP address is a Tor exit node. This property is only
         # available from GeoIP2 Precision Insights.
         #
@@ -140,7 +149,7 @@ module MaxMind
         # this is the largest network where all of the fields besides ip_address
         # have the same value.
         #
-        # @return [String]
+        # @return [String, nil]
         def network
           get('network')
         end

data/maxmind-geoip2.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.files       = Dir['**/*']
   s.name        = 'maxmind-geoip2'
   s.summary     = 'A gem for interacting with the GeoIP2 webservices and databases.'
-  s.version     = '0.3.0'
+  s.version     = '1.0.0'
 
   s.description = 'A gem for interacting with the GeoIP2 webservices and databases. MaxMind provides geolocation data as downloadable databases as well as through a webservice.'
   s.email = 'support@maxmind.com'
@@ -13,13 +13,20 @@ Gem::Specification.new do |s|
   s.licenses    = ['Apache-2.0', 'MIT']
   s.metadata = {
     'bug_tracker_uri' => 'https://github.com/maxmind/GeoIP2-ruby/issues',
-    'changelog_uri' => 'https://github.com/maxmind/GeoIP2-ruby/blob/master/CHANGELOG.md',
-    'documentation_uri' => 'https://github.com/maxmind/GeoIP2-ruby',
+    'changelog_uri' => 'https://github.com/maxmind/GeoIP2-ruby/blob/main/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/maxmind-geoip2',
     'homepage_uri' => 'https://github.com/maxmind/GeoIP2-ruby',
     'source_code_uri' => 'https://github.com/maxmind/GeoIP2-ruby',
   }
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.5.0'
 
-  s.add_runtime_dependency 'http', ['~> 4.3']
+  s.add_runtime_dependency 'connection_pool', ['~> 2.2']
+  s.add_runtime_dependency 'http', '>= 4.3', '< 6.0'
   s.add_runtime_dependency 'maxmind-db', ['~> 1.1']
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'webmock'
 end

data/test/data/source-data/GeoIP2-Anonymous-IP-Test.json

@@ -18,6 +18,7 @@
          "is_anonymous_vpn" : true,
          "is_hosting_provider" : true,
          "is_public_proxy" : true,
+         "is_residential_proxy" : true,
          "is_tor_exit_node" : true
       }
    },

data/test/data/source-data/GeoIP2-ISP-Test.json

@@ -12587,7 +12587,9 @@
    {
       "2c0f:ff80::/25" : {
          "autonomous_system_number" : 237,
-         "autonomous_system_organization" : "Merit Network Inc."
+         "autonomous_system_organization" : "Merit Network Inc.",
+         "isp" : "Merit Network Inc.",
+         "organization" : "Merit Network Inc."
       }
    }
 ]

data/test/data/source-data/GeoIP2-Precision-Enterprise-Test.json

@@ -2057,5 +2057,92 @@
             "user_type" : "government"
          }
       }
+   },
+   {
+      "::2.20.32.110/127" : {
+         "city" : {
+            "confidence" : 60,
+            "geoname_id" : 315808,
+            "names" : {
+               "de" : "Elazığ",
+               "en" : "Elâzığ",
+               "fr" : "Elazığ",
+               "ja" : "エラズー",
+               "ru" : "Элязыг",
+               "zh-CN" : "埃拉泽"
+            }
+         },
+         "continent" : {
+            "code" : "AS",
+            "geoname_id" : 6255147,
+            "names" : {
+               "de" : "Asien",
+               "en" : "Asia",
+               "es" : "Asia",
+               "fr" : "Asie",
+               "ja" : "アジア",
+               "pt-BR" : "Ásia",
+               "ru" : "Азия",
+               "zh-CN" : "亚洲"
+            }
+         },
+         "country" : {
+            "confidence" : 90,
+            "geoname_id" : 298795,
+            "iso_code" : "TR",
+            "names" : {
+               "de" : "Türkei",
+               "en" : "Turkey",
+               "es" : "Turquía",
+               "fr" : "Turquie",
+               "ja" : "トルコ共和国",
+               "pt-BR" : "Turquia",
+               "ru" : "Турция",
+               "zh-CN" : "土耳其"
+            }
+         },
+         "location" : {
+            "accuracy_radius" : 50,
+            "latitude" : 38.6229,
+            "longitude" : 39.3217,
+            "time_zone" : "Europe/Istanbul"
+         },
+         "postal" : {
+            "code" : "23100",
+            "confidence" : 30
+         },
+         "registered_country" : {
+            "geoname_id" : 298795,
+            "iso_code" : "TR",
+            "names" : {
+               "de" : "Türkei",
+               "en" : "Turkey",
+               "es" : "Turquía",
+               "fr" : "Turquie",
+               "ja" : "トルコ共和国",
+               "pt-BR" : "Turquia",
+               "ru" : "Турция",
+               "zh-CN" : "土耳其"
+            }
+         },
+         "subdivisions" : [
+            {
+               "confidence" : 60,
+               "geoname_id" : 315807,
+               "iso_code" : "23",
+               "names" : {
+                  "en" : "Elazığ"
+               }
+            }
+         ],
+         "traits" : {
+            "autonomous_system_number" : 8517,
+            "autonomous_system_organization" : "National Academic Network and Information Center",
+            "connection_type" : "Cable/DSL",
+            "isp" : "National Academic Network and Information Center",
+            "organization" : "National Academic Network and Information Center",
+            "user_type" : "business"
+         }
+      }
    }
 ]

data/test/data/test-data/write-test-data.pl

@@ -19,7 +19,7 @@ use Test::MaxMind::DB::Common::Util qw( standard_test_metadata );
 my $Dir = dirname( abs_path($0) );
 
 sub main {
-    my @sizes      = ( 24,        28, 32 );
+    my @sizes = ( 24, 28, 32 );
     my @ipv4_range = ( '1.1.1.1', '1.1.1.32' );
 
     my @ipv4_subnets = Net::Works::Network->range_as_subnets(@ipv4_range);
@@ -71,6 +71,7 @@ sub main {
     }
 
     write_decoder_test_db();
+    write_pointer_decoder_test_db();
     write_deeply_nested_structures_db();
 
     write_geoip2_dbs();
@@ -231,23 +232,7 @@ sub write_test_db {
     );
 
     sub write_decoder_test_db {
-        my $writer = MaxMind::DB::Writer::Tree->new(
-            ip_version    => 6,
-            record_size   => 24,
-            database_type => 'MaxMind DB Decoder Test',
-            languages     => ['en'],
-            description   => {
-                en =>
-                    'MaxMind DB Decoder Test database - contains every MaxMind DB data type',
-            },
-            alias_ipv6_to_ipv4       => 1,
-            remove_reserved_networks => 0,
-            map_key_type_callback    => sub {
-                my $key = $_[0];
-                $key =~ s/X$//;
-                return $key eq 'array' ? [ 'array', 'uint32' ] : $key;
-            },
-        );
+        my $writer = _decoder_writer();
 
         my @subnets
             = map { Net::Works::Network->new_from_string( string => $_ ) }
@@ -285,6 +270,70 @@ sub write_test_db {
 
         return;
     }
+
+    sub write_pointer_decoder_test_db {
+
+        # We want to create a database where most values are pointers
+        no warnings 'redefine';
+        local *MaxMind::DB::Writer::Serializer::_should_cache_value
+            = sub { 1 };
+        my $writer = _decoder_writer();
+
+        # We add these slightly different records so that we end up with
+        # pointers for the individual values in the maps, not just pointers
+        # to the map
+        $writer->insert_network(
+            '1.0.0.0/32',
+            {
+                %all_types,
+                booleanX => 0,
+                arrayX   => [ 1, 2, 3, 4, ],
+                mapXX    => {
+                    utf8_stringX => 'hello',
+                    arrayX       => [ 7, 8, 9, 10 ],
+                    booleanX     => 0,
+                },
+            },
+        );
+
+        $writer->insert_network(
+            '1.1.1.0/32',
+            {
+                %all_types,
+
+                # This has to be 0 rather than 1 as otherwise the buggy
+                # Perl writer will think it is the same as an uint32 value of
+                # 1 and make a pointer to a value of a different type.
+                boolean => 0,
+            },
+        );
+
+        open my $fh, '>', "$Dir/MaxMind-DB-test-pointer-decoder.mmdb";
+        $writer->write_tree($fh);
+        close $fh;
+
+        return;
+    }
+
+    sub _decoder_writer {
+        return MaxMind::DB::Writer::Tree->new(
+            ip_version    => 6,
+            record_size   => 24,
+            database_type => 'MaxMind DB Decoder Test',
+            languages     => ['en'],
+            description   => {
+                en =>
+                    'MaxMind DB Decoder Test database - contains every MaxMind DB data type',
+            },
+            alias_ipv6_to_ipv4       => 1,
+            remove_reserved_networks => 0,
+            map_key_type_callback    => sub {
+                my $key = $_[0];
+                $key =~ s/X*$//;
+                return $key eq 'array' ? [ 'array', 'uint32' ] : $key;
+            },
+        );
+    }
 }
 
 {
@@ -427,6 +476,7 @@ sub _universal_map_key_type_callback {
         is_in_european_union           => 'boolean',
         is_legitimate_proxy            => 'boolean',
         is_public_proxy                => 'boolean',
+        is_residential_proxy           => 'boolean',
         is_satellite_provider          => 'boolean',
         is_tor_exit_node               => 'boolean',
         iso_code                       => 'utf8_string',

data/test/test_client.rb

@@ -42,6 +42,7 @@ class ClientTest < Minitest::Test
     },
     'traits' => {
       'ip_address' => '1.2.3.40',
+      'is_residential_proxy' => true,
       'network' => '1.2.3.0/24',
       'static_ip_score' => 1.3,
       'user_count' => 2,
@@ -82,6 +83,7 @@ class ClientTest < Minitest::Test
 
     assert_equal(42, record.continent.geoname_id)
 
+    assert_equal(true, record.traits.residential_proxy?)
     assert_equal('1.2.3.0/24', record.traits.network)
     assert_equal(1.3, record.traits.static_ip_score)
     assert_equal(2, record.traits.user_count)
@@ -337,12 +339,12 @@ class ClientTest < Minitest::Test
         status: 400,
       },
       '1.2.3.71' => {
-        body: JSON.generate({ 'code': 'HI' }),
+        body: JSON.generate({ code: 'HI' }),
         headers: { 'Content-Type': CONTENT_TYPES[:country] },
         status: 400,
       },
       '1.2.3.8' => {
-        body: JSON.generate({ 'weird': 42 }),
+        body: JSON.generate({ weird: 42 }),
         headers: { 'Content-Type': CONTENT_TYPES[:country] },
         status: 400,
       },

data/test/test_model_country.rb

@@ -77,4 +77,20 @@ class CountryModelTest < Minitest::Test
     model = MaxMind::GeoIP2::Model::Country.new(RAW, ['en'])
     assert_raises(NoMethodError) { model.traits.unknown }
   end
+
+  # This can happen if we're being created from a not fully populated response
+  # when used by minFraud. It shouldn't ever happen from GeoIP2 though.
+  def test_no_traits
+    model = MaxMind::GeoIP2::Model::Country.new(
+      {
+        'continent' => {
+          'code' => 'NA',
+          'geoname_id' => 42,
+          'names' => { 'en' => 'North America' },
+        },
+      },
+      ['en'],
+    )
+    assert_equal(42, model.continent.geoname_id)
+  end
 end

data/test/test_reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'ipaddr'
+require 'maxmind/db'
 require 'maxmind/geoip2'
 require 'minitest/autorun'
 
@@ -16,6 +17,7 @@ class ReaderTest < Minitest::Test
     assert_equal(true, record.anonymous_vpn?)
     assert_equal(false, record.hosting_provider?)
     assert_equal(false, record.public_proxy?)
+    assert_equal(false, record.residential_proxy?)
     assert_equal(false, record.tor_exit_node?)
     assert_equal(ip, record.ip_address)
     assert_equal('1.2.0.0/16', record.network)
@@ -23,6 +25,18 @@ class ReaderTest < Minitest::Test
     reader.close
   end
 
+  def test_anonymous_ip_residential_proxy
+    reader = MaxMind::GeoIP2::Reader.new(
+      'test/data/test-data/GeoIP2-Anonymous-IP-Test.mmdb',
+    )
+    ip = '81.2.69.1'
+    record = reader.anonymous_ip(ip)
+
+    assert_equal(true, record.residential_proxy?)
+
+    reader.close
+  end
+
   def test_asn
     reader = MaxMind::GeoIP2::Reader.new(
       'test/data/test-data/GeoLite2-ASN-Test.mmdb',
@@ -456,4 +470,49 @@ class ReaderTest < Minitest::Test
     assert_equal('GeoIP2-City', reader.metadata.database_type)
     reader.close
   end
+
+  def test_constructor_with_minimum_keyword_arguments
+    reader = MaxMind::GeoIP2::Reader.new(
+      database: 'test/data/test-data/GeoIP2-Country-Test.mmdb',
+    )
+    record = reader.country('81.2.69.160')
+    assert_equal('United Kingdom', record.country.name)
+    reader.close
+  end
+
+  def test_constructor_with_all_keyword_arguments
+    reader = MaxMind::GeoIP2::Reader.new(
+      database: 'test/data/test-data/GeoIP2-Country-Test.mmdb',
+      locales: %w[ru],
+      mode: MaxMind::DB::MODE_MEMORY,
+    )
+    record = reader.country('81.2.69.160')
+    assert_equal('Великобритания', record.country.name)
+    reader.close
+  end
+
+  def test_constructor_missing_database
+    error = assert_raises(ArgumentError) do
+      MaxMind::GeoIP2::Reader.new
+    end
+    assert_equal('Invalid database parameter', error.message)
+
+    error = assert_raises(ArgumentError) do
+      MaxMind::GeoIP2::Reader.new(
+        locales: %w[ru],
+      )
+    end
+    assert_equal('Invalid database parameter', error.message)
+  end
+
+  def test_old_constructor_parameters
+    reader = MaxMind::GeoIP2::Reader.new(
+      'test/data/test-data/GeoIP2-Country-Test.mmdb',
+      %w[ru],
+      mode: MaxMind::DB::MODE_MEMORY,
+    )
+    record = reader.country('81.2.69.160')
+    assert_equal('Великобритания', record.country.name)
+    reader.close
+  end
 end