maxmind-db 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 485d10049eaba35df9d49f7aa4637857a3fe84f38dec3e2a163c675fc8f2e474
-  data.tar.gz: 964008df8d8bc5bc8c558fb004cbb7eda6843295cb3abd5fea3fc193da58981d
+  metadata.gz: d5705dca32ee40fdadd07a1f6abc8a0ff56e23b699ecb9ba159344a9325c8456
+  data.tar.gz: d71304945c1c09f3af09a85b03dbbcf8cbeb4652456441a7f6978b2cb9db6adc
 SHA512:
-  metadata.gz: 92181b893b438f63a874d915817f4e325aa4a20fb12e8e373e6d6f4885235472353391db4508f313f7d4b5b9ab33e6f09cd05a5b88e718b59dc352dc18f415be
-  data.tar.gz: a03201ffac72cac0228545ce2f1a3a5e3d84ad807d33fac18bfffd3da4a5be69d0bceee96c5c87429b394410ed3e3efc17f20893700b7811558c7a383d4773e4
+  metadata.gz: b8c1a541fcf270945c34254e2e5817ac52864f6cea427d223cb4b5c9c4036afdc61380954462fe063beeacd3407507a647eff776ab8913a561eef6eed71a6730
+  data.tar.gz: 70c1967f07e22885938b7fb1e9cbd0a73c9d4f3efab144a6aa4c2e40bac81ce8445d2702ad51d2b32e028a6eef053f132542d9d9c1086030d224575a4bb39e64

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.2.0 (2023-11-22)
+
+* Ruby 2.4 is no longer supported. If you're using Ruby 2.4, please use
+  version 1.1.1 of this gem.
+* `Object#respond_to?` is no longer called on every read. Pull request by
+  Jean byroot Boussier. GitHub #65.
+* The `get` and `get_prefix_length` methods now accept the IP addresses as
+  `IPAddr` objects. Strings are still accepted too. Pull request by Eddie
+  Lebow. GitHub #69.
+
 ## 1.1.1 (2020-06-23)
 
 * Fixed the memory reader's inspect method to no longer attempt to modify a

data/README.dev.md

@@ -3,16 +3,20 @@
 * Update changelog: Set version and release date
 * Set version in `maxmind-db.gemspec`
 * Add them: `git add -p`
+* Create a branch e.g. `horgh/release` and switch to it.
+  * `main` is protected.
 * Commit: `git commit -m v1.0.0`
 * Tag: `git tag -a v1.0.0 -m v1.0.0`
 * Clean up to be sure nothing stray gets into gem: `git clean -dxff`
 * Create `.gem` file: `gem build maxmind-db.gemspec`
 * Complete prerequisites (see below)
-  * You only need to do this if `~/.gem/credentials` is missing
-    `:rubygems_api_key`.
+  * You only need to do this once. You can tell if this is necessary if you
+    are lacking `:rubygems_api_key` in `~/.local/share/gem/credentials`
+    (previously `~/.gem/credentials`)
 * Upload to rubygems.org: `gem push maxmind-db-1.0.0.gem`
 * Push: `git push`
 * Push tag: `git push --tags`
+* Make a PR and get it merged.
 * Double check it looks okay at https://rubygems.org/gems/maxmind-db and
   https://www.rubydoc.info/gems/maxmind-db
 
@@ -22,7 +26,7 @@
 ## Step 1
 Sign up for an account at rubygems.org if you don't have one.
 
-Enable multi factor authentication.
+Enable multi factor authentication (for both UI and API).
 
 
 ## Step 2
@@ -33,5 +37,9 @@ They do this by using the `gem owner` command
 
 
 ## Step 3
-Go to your rubygems.org profile and find the curl command to run to
-download your API key.
+Run `gem signin`. This will prompt you for your username and password, and
+then create an API key for you. Select the scopes `index_rubygems` and
+`push_rubygem` (I'm not sure the former is required, but anyway).
+
+Note you may need an up to date version of rubygems to do this as I believe
+support for API keys like this is a newer addition.

data/README.md

@@ -6,7 +6,6 @@ This is the Ruby API for reading [MaxMind
 DB](https://maxmind.github.io/MaxMind-DB/) files. MaxMind DB is a binary
 file format that stores data indexed by IP address subnets (IPv4 or IPv6).
 
-
 ## Installation
 
 ```
@@ -36,7 +35,7 @@ For more information see the
 
 ## Requirements
 
-This code requires Ruby version 2.4 or higher.
+This code requires Ruby version 2.5 or higher.
 
 ## Contributing
 
@@ -57,7 +56,7 @@ This library uses [Semantic Versioning](https://semver.org/).
 
 ## Copyright and License
 
-This software is Copyright (c) 2018 - 2020 by MaxMind, Inc.
+This software is Copyright (c) 2018 - 2023 by MaxMind, Inc.
 
 This is free software, licensed under the [Apache License, Version
 2.0](LICENSE-APACHE) or the [MIT License](LICENSE-MIT), at your option.

data/bin/mmdb-benchmark.rb

@@ -29,9 +29,9 @@ end
 
 def print_usage
   # rubocop:disable Style/StderrPuts
-  STDERR.puts "Usage: #{$PROGRAM_NAME} <MMDB file> <IP file>"
-  STDERR.puts
-  STDERR.puts 'Benchmark by reading IPs from the IP file and looking up each one in the MMDB file.'
+  $stderr.puts "Usage: #{$PROGRAM_NAME} <MMDB file> <IP file>"
+  $stderr.puts
+  $stderr.puts 'Benchmark by reading IPs from the IP file and looking up each one in the MMDB file.'
   # rubocop:enable Style/StderrPuts
 end
 

data/lib/maxmind/db/decoder.rb

@@ -12,6 +12,8 @@ module MaxMind
     #
     # @!visibility private
     class Decoder
+      # rubocop:disable Style/OptionalBooleanParameter
+
       # Create a +Decoder+.
       #
       # +io+ is the DB. It must provide a +read+ method. It must be opened in
@@ -28,6 +30,7 @@ module MaxMind
         @pointer_base = pointer_base
         @pointer_test = pointer_test
       end
+      # rubocop:enable Style/OptionalBooleanParameter
 
       private
 

data/lib/maxmind/db/file_reader.rb

@@ -6,10 +6,36 @@ module MaxMind
   class DB
     # @!visibility private
     class FileReader
+      if ::File.method_defined?(:pread)
+        PReadFile = ::File
+      else
+        # For Windows support
+        class PReadFile
+          def initialize(filename, mode)
+            @mutex = Mutex.new
+            @file = File.new(filename, mode)
+          end
+
+          def size
+            @file.size
+          end
+
+          def close
+            @file.close
+          end
+
+          def pread(size, offset)
+            @mutex.synchronize do
+              @file.seek(offset, IO::SEEK_SET)
+              @file.read(size)
+            end
+          end
+        end
+      end
+
       def initialize(filename)
-        @fh = File.new(filename, 'rb')
+        @fh = PReadFile.new(filename, 'rb')
         @size = @fh.size
-        @mutex = Mutex.new
       end
 
       attr_reader :size
@@ -21,15 +47,7 @@ module MaxMind
       def read(offset, size)
         return ''.b if size == 0
 
-        # When we support only Ruby 2.5+, remove this and require pread.
-        if @fh.respond_to?(:pread)
-          buf = @fh.pread(size, offset)
-        else
-          @mutex.synchronize do
-            @fh.seek(offset, IO::SEEK_SET)
-            buf = @fh.read(size)
-          end
-        end
+        buf = @fh.pread(size, offset)
 
         raise InvalidDatabaseError, 'The MaxMind DB file contains bad data' if buf.nil? || buf.length != size
 

data/lib/maxmind/db.rb

@@ -3,9 +3,9 @@
 require 'ipaddr'
 require 'maxmind/db/decoder'
 require 'maxmind/db/errors'
-require 'maxmind/db/file_reader.rb'
-require 'maxmind/db/memory_reader.rb'
-require 'maxmind/db/metadata.rb'
+require 'maxmind/db/file_reader'
+require 'maxmind/db/memory_reader'
+require 'maxmind/db/metadata'
 
 module MaxMind
   # DB provides a way to read {MaxMind DB
@@ -130,8 +130,7 @@ module MaxMind
     #
     # If no record is found for the IP address, +get+ returns +nil+.
     #
-    # @param ip_address [String] a string in the standard notation. It may be
-    #   IPv4 or IPv6.
+    # @param ip_address [String, IPAddr] IPv4 or IPv6 address.
     #
     # @raise [ArgumentError] if you attempt to look up an IPv6 address in an
     #   IPv4-only database.
@@ -153,8 +152,7 @@ module MaxMind
     # If no record is found for the IP address, the record will be +nil+ and
     # the prefix length will be the value for the missing network.
     #
-    # @param ip_address [String] a string in the standard notation. It may be
-    #   IPv4 or IPv6.
+    # @param ip_address [String, IPAddr] IPv4 or IPv6 address.
     #
     # @raise [ArgumentError] if you attempt to look up an IPv6 address in an
     #   IPv4-only database.
@@ -163,7 +161,8 @@ module MaxMind
     #
     # @return [Array<(Object, Integer)>]
     def get_with_prefix_length(ip_address)
-      ip = IPAddr.new(ip_address)
+      ip = ip_address.is_a?(IPAddr) ? ip_address : IPAddr.new(ip_address)
+
       # We could check the IP has the correct prefix (32 or 128) but I do not
       # for performance reasons.
 
@@ -200,7 +199,7 @@ module MaxMind
         break if depth >= bit_count || node >= node_count
 
         c = packed[depth >> 3].ord
-        bit = 1 & (c >> 7 - (depth % 8))
+        bit = 1 & (c >> (7 - (depth % 8)))
         node = read_node(node, bit)
         depth += 1
       end
@@ -273,7 +272,7 @@ module MaxMind
     end
 
     def find_metadata_start
-      metadata_max_size = @size < METADATA_MAX_SIZE ? @size : METADATA_MAX_SIZE
+      metadata_max_size = [@size, METADATA_MAX_SIZE].min
 
       stop_index = @size - metadata_max_size
       index = @size - METADATA_START_MARKER_LENGTH

data/maxmind-db.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.files       = Dir['**/*']
   s.name        = 'maxmind-db'
   s.summary     = 'A gem for reading MaxMind DB files.'
-  s.version     = '1.1.1'
+  s.version     = '1.2.0'
 
   s.description = 'A gem for reading MaxMind DB files. MaxMind DB is a binary file format that stores data indexed by IP address subnets (IPv4 or IPv6).'
   s.email       = 'support@maxmind.com'
@@ -13,12 +13,13 @@ Gem::Specification.new do |s|
   s.licenses    = ['Apache-2.0', 'MIT']
   s.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',
   }
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.5.0'
 
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rake'

data/test/data/MaxMind-DB-spec.md

@@ -26,9 +26,10 @@ not be broken by minor version changes to the format.
 The binary database is split into three parts:
 
 1. The binary search tree. Each level of the tree corresponds to a single bit
-in the 128 bit representation of an IPv6 address.
-2. The data section. These are the values returned to the client for a
-specific IP address, e.g. "US", "New York", or a more complex map type made up
+in the prefix of the network the IP address belongs to.
+2. The data section with the values for the networks in the binary search
+tree. These values may be comprised of a single data type, e.g., the string
+"US" or "New York", or they may be a more complex map or array type made up
 of multiple fields.
 3. Database metadata. Information about the database itself.
 
@@ -48,15 +49,15 @@ of this sequence.
 The maximum allowable size for the metadata section, including the marker that
 starts the metadata, is 128KiB.
 
-The metadata is stored as a map data structure. This structure is described
-later in the spec. Changing a key's data type or removing a key would
-constitute a major version change for this spec.
+The metadata is stored as a separate data section comprised of a map data
+structure starting at the beginning of that section. This structure is
+described later in the spec.
 
 Except where otherwise specified, each key listed is required for the database
 to be considered valid.
 
-Adding a key constitutes a minor version change. Removing a key or changing
-its type constitutes a major version change.
+Changing a key's data type or removing a key would constitute a major version
+change for this spec. Adding a key constitutes a minor version change.
 
 The list of known keys for the current version of the format is as follows:
 
@@ -304,7 +305,8 @@ will point to the beginning of a field. It is illegal for a pointer to point
 to another pointer.
 
 Pointer values start from the beginning of the data section, *not* the
-beginning of the file.
+beginning of the file. Pointers in the metadata start from the beginning of
+the metadata section.
 
 ### UTF-8 string - 2
 
@@ -337,8 +339,10 @@ by the length specifier in the control byte. See below for details.
 
 A length of zero always indicates the number 0.
 
-When storing a signed integer, the left-most bit is the sign. A 1 is negative
-and a 0 is positive.
+When storing a signed integer, fields shorter than the maximum byte length
+are always positive. When the field is the maximum length, e.g., 4 bytes for
+32-bit integers, the left-most bit is the sign. A 1 is negative and a 0 is
+positive.
 
 The type numbers for our integer types are:
 

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
       }
    },