maxmind-db 1.1.1 → 1.2.0

data/test/data/test-data/README.md

@@ -10,17 +10,17 @@ pointers to map keys and values, as well as to the whole map.
 
 There are several ways to figure out what IP addresses are actually in the
 test databases. You can take a look at the
-[source-data directory](https://github.com/maxmind/MaxMind-DB/tree/master/source-data)
+[source-data directory](https://github.com/maxmind/MaxMind-DB/tree/main/source-data)
 in this repository. This directory contains JSON files which are used to
 generate many (but not all) of the database files.
 
 You can also use the
-[mmdb-dump-database script](https://github.com/maxmind/MaxMind-DB-Reader-perl/blob/master/eg/mmdb-dump-database)
+[mmdb-dump-database script](https://github.com/maxmind/MaxMind-DB-Reader-perl/blob/main/eg/mmdb-dump-database)
 in the
 [MaxMind-DB-Reader-perl repository](https://github.com/maxmind/MaxMind-DB-Reader-perl).
 
 Some databases are intentionally broken and cannot be dumped. You can look at
 the
-[script which generates these databases](https://github.com/maxmind/MaxMind-DB/blob/master/test-data/write-test-data.pl)
+[script which generates these databases](https://github.com/maxmind/MaxMind-DB/blob/main/test-data/write-test-data.pl)
 to see what IP addresses they include, which will be necessary for those
 databases which cannot be dumped because they contain intentional errors.

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 => $_ ) }
@@ -258,7 +243,7 @@ sub write_test_db {
             ::4.5.6.7/128
             abcd::/64
             1000::1234:0000/112
-        );
+            );
 
         for my $subnet (@subnets) {
             $writer->insert_network(
@@ -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;
+            },
+        );
+    }
 }
 
 {
@@ -330,7 +379,7 @@ sub write_test_db {
             ::4.5.6.7/128
             abcd::/64
             1000::1234:0000/112
-        );
+            );
 
         for my $subnet (@subnets) {
             $writer->insert_network(
@@ -362,6 +411,8 @@ sub write_geoip2_dbs {
         ['GeoIP2-Static-IP-Score'],
         ['GeoIP2-User-Count'],
         ['GeoLite2-ASN'],
+        ['GeoLite2-City'],
+        ['GeoLite2-Country'],
         );
 }
 
@@ -427,6 +478,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',
@@ -435,6 +487,8 @@ sub _universal_map_key_type_callback {
         location                       => 'map',
         longitude                      => 'double',
         metro_code                     => 'uint16',
+        mobile_country_code            => 'utf8_string',
+        mobile_network_code            => 'utf8_string',
         names                          => 'map',
         organization                   => 'utf8_string',
         population_density             => 'uint32',
@@ -442,6 +496,7 @@ sub _universal_map_key_type_callback {
         registered_country             => 'map',
         represented_country            => 'map',
         score                          => 'double',
+        static_ip_score                => 'double',
         subdivisions                   => [ 'array', 'map' ],
         time_zone                      => 'utf8_string',
         traits                         => 'map',
@@ -604,7 +659,7 @@ sub write_test_serialization_data {
     $serializer->store_data( map => { long_key  => 'long_value1' } );
     $serializer->store_data( map => { long_key2 => 'long_value2' } );
 
-    open my $fh, '>', 'maps-with-pointers.raw';
+    open my $fh, '>', "$Dir/maps-with-pointers.raw";
     print {$fh} ${ $serializer->buffer() }
         or die "Cannot write to maps-with-pointers.raw: $!";
     close $fh;
@@ -630,7 +685,7 @@ sub write_db_with_metadata_pointers {
 
     _populate_all_networks( $writer, {} );
 
-    open my $fh, '>', 'MaxMind-DB-test-metadata-pointers.mmdb';
+    open my $fh, '>', "$Dir/MaxMind-DB-test-metadata-pointers.mmdb";
 
     $writer->write_tree($fh);
 

data/test/test_decoder.rb

@@ -150,9 +150,9 @@ class DecoderTest < Minitest::Test
     "\x34\x35\x36\x37\x38\x39\x30\x31\x32\x33\x34".b +
     "\x35\x36\x37\x38\x39\x30\x31\x32\x33\x34\x35".b +
     "\x36\x37\x38\x39\x30".b => '123456789012345678901234567890',
-    "\x5e\x00\xd7".b + "\x78".b * 500 => 'x' * 500,
-    "\x5e\x06\xb3".b + "\x78".b * 2000 => 'x' * 2000,
-    "\x5f\x00\x10\x53".b + "\x78".b * 70_000 => 'x' * 70_000,
+    "\x5e\x00\xd7".b + ("\x78".b * 500) => 'x' * 500,
+    "\x5e\x06\xb3".b + ("\x78".b * 2000) => 'x' * 2000,
+    "\x5f\x00\x10\x53".b + ("\x78".b * 70_000) => 'x' * 70_000,
   }
   # rubocop:enable Style/ClassVars
 
@@ -194,9 +194,9 @@ class DecoderTest < Minitest::Test
       "\x02".b + ctrl_byte + "\x01\xf4".b => 500,
       "\x02".b + ctrl_byte + "\x2a\x78".b => 10_872,
     }
-    (bits / 8 + 1).times do |power|
-      expected = 2**(8 * power) - 1
-      input = [power].pack('C') + ctrl_byte + "\xff".b * power
+    ((bits / 8) + 1).times do |power|
+      expected = (2**(8 * power)) - 1
+      input = [power].pack('C') + ctrl_byte + ("\xff".b * power)
       uints[input] = expected
     end
     uints

data/test/test_reader.rb

@@ -12,10 +12,11 @@ class ReaderTest < Minitest::Test
     ]
 
     modes.each do |mode|
-      [24, 28, 32].each do |record_size|
-        [4, 6].each do |ip_version|
-          filename = 'test/data/test-data/MaxMind-DB-test-ipv' +
-                     ip_version.to_s + '-' + record_size.to_s + '.mmdb'
+      record_sizes = [24, 28, 32]
+      record_sizes.each do |record_size|
+        ip_versions = [4, 6]
+        ip_versions.each do |ip_version|
+          filename = "test/data/test-data/MaxMind-DB-test-ipv#{ip_version}-#{record_size}.mmdb"
           reader = MaxMind::DB.new(filename, mode: mode)
           check_metadata(reader, ip_version, record_size)
           if ip_version == 4
@@ -134,7 +135,7 @@ class ReaderTest < Minitest::Test
     }]
 
     tests.each do |test|
-      reader = MaxMind::DB.new('test/data/test-data/' + test['file_name'])
+      reader = MaxMind::DB.new("test/data/test-data/#{test['file_name']}")
       record, prefix_length = reader.get_with_prefix_length(test['ip'])
 
       assert_equal(test['expected_prefix_length'], prefix_length,
@@ -179,6 +180,14 @@ class ReaderTest < Minitest::Test
     reader.close
   end
 
+  def test_metadata_pointers
+    reader = MaxMind::DB.new(
+      'test/data/test-data/MaxMind-DB-test-metadata-pointers.mmdb'
+    )
+    assert_equal('Lots of pointers in metadata', reader.metadata.database_type)
+    reader.close
+  end
+
   def test_no_ipv4_search_tree
     reader = MaxMind::DB.new(
       'test/data/test-data/MaxMind-DB-no-ipv4-search-tree.mmdb'
@@ -235,7 +244,7 @@ class ReaderTest < Minitest::Test
     e = assert_raises ArgumentError do
       reader.get('not_ip')
     end
-    assert(e.message.match(/invalid address/))
+    assert(e.message.include?('invalid address'))
     reader.close
   end
 
@@ -243,7 +252,7 @@ class ReaderTest < Minitest::Test
     e = assert_raises SystemCallError do
       MaxMind::DB.new('file-does-not-exist.mmdb')
     end
-    assert(e.message.match(/No such file or directory/))
+    assert(e.message.include?('No such file or directory'))
   end
 
   def test_nondatabase
@@ -260,14 +269,14 @@ class ReaderTest < Minitest::Test
     e = assert_raises ArgumentError do
       MaxMind::DB.new('README.md', {}, 'blah')
     end
-    assert(e.message.match(/wrong number of arguments/))
+    assert(e.message.include?('wrong number of arguments'))
   end
 
   def test_no_constructor_args
     e = assert_raises ArgumentError do
       MaxMind::DB.new
     end
-    assert(e.message.match(/wrong number of arguments/))
+    assert(e.message.include?('wrong number of arguments'))
   end
 
   def test_too_many_get_args
@@ -277,7 +286,7 @@ class ReaderTest < Minitest::Test
     e = assert_raises ArgumentError do
       reader.get('1.1.1.1', 'blah')
     end
-    assert(e.message.match(/wrong number of arguments/))
+    assert(e.message.include?('wrong number of arguments'))
     reader.close
   end
 
@@ -288,7 +297,7 @@ class ReaderTest < Minitest::Test
     e = assert_raises ArgumentError do
       reader.get
     end
-    assert(e.message.match(/wrong number of arguments/))
+    assert(e.message.include?('wrong number of arguments'))
     reader.close
   end
 
@@ -299,7 +308,7 @@ class ReaderTest < Minitest::Test
     e = assert_raises ArgumentError do
       reader.metadata('hi')
     end
-    assert(e.message.match(/wrong number of arguments/))
+    assert(e.message.include?('wrong number of arguments'))
     reader.close
   end
 
@@ -310,7 +319,7 @@ class ReaderTest < Minitest::Test
     e = assert_raises NoMethodError do
       reader.metadata.what
     end
-    assert(e.message.match(/undefined method `what'/))
+    assert(e.message.include?('undefined method `what\''))
     reader.close
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maxmind-db
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - William Storey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -90,7 +90,6 @@ files:
 - maxmind-db.gemspec
 - test/data/LICENSE
 - test/data/MaxMind-DB-spec.md
-- test/data/MaxMind-DB-test-metadata-pointers.mmdb
 - test/data/README.md
 - test/data/bad-data/README.md
 - test/data/bad-data/libmaxminddb/libmaxminddb-offset-integer-overflow.mmdb
@@ -101,6 +100,7 @@ files:
 - test/data/bad-data/maxminddb-golang/invalid-string-length.mmdb
 - test/data/bad-data/maxminddb-golang/metadata-is-an-uint128.mmdb
 - test/data/bad-data/maxminddb-golang/unexpected-bytes.mmdb
+- test/data/bad-data/maxminddb-python/bad-unicode-in-map-key.mmdb
 - test/data/perltidyrc
 - test/data/source-data/GeoIP2-Anonymous-IP-Test.json
 - test/data/source-data/GeoIP2-City-Test.json
@@ -114,6 +114,8 @@ files:
 - test/data/source-data/GeoIP2-Static-IP-Score-Test.json
 - test/data/source-data/GeoIP2-User-Count-Test.json
 - test/data/source-data/GeoLite2-ASN-Test.json
+- test/data/source-data/GeoLite2-City-Test.json
+- test/data/source-data/GeoLite2-Country-Test.json
 - test/data/source-data/README
 - test/data/test-data/GeoIP2-Anonymous-IP-Test.mmdb
 - test/data/test-data/GeoIP2-City-Test-Broken-Double-Format.mmdb
@@ -129,6 +131,8 @@ files:
 - test/data/test-data/GeoIP2-Static-IP-Score-Test.mmdb
 - test/data/test-data/GeoIP2-User-Count-Test.mmdb
 - test/data/test-data/GeoLite2-ASN-Test.mmdb
+- test/data/test-data/GeoLite2-City-Test.mmdb
+- test/data/test-data/GeoLite2-Country-Test.mmdb
 - test/data/test-data/MaxMind-DB-no-ipv4-search-tree.mmdb
 - test/data/test-data/MaxMind-DB-string-value-entries.mmdb
 - test/data/test-data/MaxMind-DB-test-broken-pointers-24.mmdb
@@ -145,6 +149,7 @@ files:
 - test/data/test-data/MaxMind-DB-test-mixed-28.mmdb
 - test/data/test-data/MaxMind-DB-test-mixed-32.mmdb
 - test/data/test-data/MaxMind-DB-test-nested.mmdb
+- test/data/test-data/MaxMind-DB-test-pointer-decoder.mmdb
 - test/data/test-data/README.md
 - test/data/test-data/maps-with-pointers.raw
 - test/data/test-data/write-test-data.pl
@@ -158,10 +163,11 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/maxmind/MaxMind-DB-Reader-ruby/issues
-  changelog_uri: https://github.com/maxmind/MaxMind-DB-Reader-ruby/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/maxmind/MaxMind-DB-Reader-ruby/blob/main/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/maxmind-db
   homepage_uri: https://github.com/maxmind/MaxMind-DB-Reader-ruby
   source_code_uri: https://github.com/maxmind/MaxMind-DB-Reader-ruby
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -170,15 +176,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.4.18
 signing_key: 
 specification_version: 4
 summary: A gem for reading MaxMind DB files.