maxmind-db 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 604697b9d2de00a32fec3ee2b84c53703f532ecf708ca6cfcd4898fa934d830e
-  data.tar.gz: cdaeb5d99ca07f8c9f6af0354dc23fb3f8678a40e0ea67fe74b7b7dcaabc7ec5
+SHA1:
+  metadata.gz: e8404a64573590d7a01fd9199ae1be5bb1892407
+  data.tar.gz: cfdec2ef12cae84fa914784b90c386d1006fdf47
 SHA512:
-  metadata.gz: 3939f3025d4a715537d6284ac49cfa691bf733711afd6143ec73e586aec96cbcf717115c340214903fd4a8bcc1c4b8c4973d0fa9517491b2c48c5d710cdc9e87
-  data.tar.gz: 54dbe0bebe152e151234b0b0026492d38a80858174c3342d12ff665026d858295b29434d3ea7c8ea56b3b7c669b0d2f921c018b7dba9c16aad996143f9c66ede
+  metadata.gz: 263eff4235eadc529e14266772c3db95bc17950ebc7d73fbb3f5d20ee76f3b2f50035c97ad2e39454e5dbd65dd6093fc56f3a6dd3b8d91a69037b8e396986366
+  data.tar.gz: 8fe05ac4631539293ee2d1485fe7c1908858ef952d76e60e75d9f601f356263bb47928bc8dd670c2989df4437cb0d2a876869c662b1f4aab36d0e8a81ce19552

data/CHANGELOG.md

@@ -1,9 +1,20 @@
 # Changelog
 
-## 1.0.0 - 2019-01-04
+## 1.1.0 (2020-01-08)
+
+* The method `get_with_prefix_length` was added. This method returns both
+  the record and the network prefix length associated with the record in
+  the database.
+* Simplified a check for whether to return early in the decoder. Pull
+  request by Ivan Palamarchuk. GitHub #12.
+* Support for Ruby 2.3 was dropped since it is now end of life.
+
+## 1.0.0 (2019-01-04)
+
 * We no longer include the database's buffer in inspect output. This avoids
   showing excessive output when creating a memory reader in irb. Reported
   by Wojciech Wnętrzak. GitHub #6.
 
-## 1.0.0.beta - 2018-12-24
+## 1.0.0.beta (2018-12-24)
+
 * Initial implementation.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'minitest', group: :development
+gem 'rake', group: :development
+gem 'rubocop', group: :development
+gem 'rubocop-performance', group: :development

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.4)
+    minitest (5.13.0)
+    parallel (1.19.1)
+    parser (2.7.0.1)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rake
+  rubocop
+  rubocop-performance
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -43,7 +43,7 @@ For more information see the
 
 ## Requirements
 
-This code requires Ruby version 2.3 or higher. Older versions may work, but
+This code requires Ruby version 2.4 or higher. Older versions may work, but
 are not supported.
 
 ## Contributing
@@ -65,7 +65,7 @@ This library uses [Semantic Versioning](https://semver.org/).
 
 ## Copyright and License
 
-This software is Copyright (c) 2018 - 2019 by MaxMind, Inc.
+This software is Copyright (c) 2018 - 2020 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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 require 'rubocop/rake_task'
 

data/bin/mmdb-benchmark.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'maxmind/db'
 
@@ -27,9 +28,11 @@ def parse_args
 end
 
 def print_usage
-  STDERR.puts "Usage: #{$PROGRAM_NAME} <MMDB file> [IP file]"
+  # 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.'
+  # rubocop:enable Style/StderrPuts
 end
 
 def benchmark(reader, file)

data/lib/maxmind/db.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ipaddr'
 require 'maxmind/db/decoder'
 require 'maxmind/db/errors'
@@ -7,9 +9,9 @@ require 'maxmind/db/metadata.rb'
 
 module MaxMind # :nodoc:
   # DB provides a way to read {MaxMind DB
-  # files}[http://maxmind.github.io/MaxMind-DB/].
+  # files}[https://maxmind.github.io/MaxMind-DB/].
   #
-  # {MaxMind DB}[http://maxmind.github.io/MaxMind-DB/] is a binary file format
+  # {MaxMind DB}[https://maxmind.github.io/MaxMind-DB/] is a binary file format
   # that stores data indexed by IP address subnets (IPv4 or IPv6).
   #
   # This class is a pure Ruby implementation of a reader for the format.
@@ -49,7 +51,7 @@ module MaxMind # :nodoc:
 
     DATA_SECTION_SEPARATOR_SIZE = 16
     private_constant :DATA_SECTION_SEPARATOR_SIZE
-    METADATA_START_MARKER = "\xAB\xCD\xEFMaxMind.com".freeze.b.freeze
+    METADATA_START_MARKER = "\xAB\xCD\xEFMaxMind.com".b.freeze
     private_constant :METADATA_START_MARKER
     METADATA_START_MARKER_LENGTH = 14
     private_constant :METADATA_START_MARKER_LENGTH
@@ -57,11 +59,11 @@ module MaxMind # :nodoc:
     private_constant :METADATA_MAX_SIZE
 
     # Return the metadata associated with the {MaxMind
-    # DB}[http://maxmind.github.io/MaxMind-DB/] as a Metadata object.
+    # DB}[https://maxmind.github.io/MaxMind-DB/] as a Metadata object.
     attr_reader :metadata
 
     # Create a DB. A DB provides a way to read {MaxMind DB
-    # files}[http://maxmind.github.io/MaxMind-DB/]. If you're performing
+    # files}[https://maxmind.github.io/MaxMind-DB/]. If you're performing
     # multiple lookups, it's most efficient to create one DB and reuse it.
     #
     # Once created, the DB is safe to use for lookups from multiple threads. It
@@ -71,7 +73,7 @@ module MaxMind # :nodoc:
     # Creating the DB may raise an exception if initialization fails.
     #
     # +database+ is a path to a {MaxMind
-    # DB}[http://maxmind.github.io/MaxMind-DB/].
+    # DB}[https://maxmind.github.io/MaxMind-DB/].
     #
     # +options+ is an option hash where each key is a symbol. The options
     # control the behaviour of the DB.
@@ -93,7 +95,7 @@ module MaxMind # :nodoc:
       when MODE_PARAM_IS_BUFFER
         @io = MemoryReader.new(database, is_buffer: true)
       else
-        raise ArgumentError, 'Invalid mode'.freeze
+        raise ArgumentError, 'Invalid mode'
       end
 
       begin
@@ -124,7 +126,7 @@ module MaxMind # :nodoc:
     end
 
     # Return the record for the +ip_address+ in the {MaxMind
-    # DB}[http://maxmind.github.io/MaxMind-DB/]. The record can be one of
+    # DB}[https://maxmind.github.io/MaxMind-DB/]. The record can be one of
     # several types and depends on the contents of the database.
     #
     # If no record is found for +ip_address+, +get+ returns +nil+.
@@ -134,6 +136,25 @@ module MaxMind # :nodoc:
     # +ip_address+ is a string in the standard notation. It may be IPv4 or
     # IPv6.
     def get(ip_address)
+      record, = get_with_prefix_length(ip_address)
+
+      record
+    end
+
+    # Return an array containing the record for the +ip_address+ in the
+    # {MaxMind DB}[https://maxmind.github.io/MaxMind-DB/] and its associated
+    # network prefix length. The record can be one of several types and
+    # depends on the contents of the database.
+    #
+    # If no record is found for +ip_address+, the record will be +nil+ and
+    # the prefix length will be the value for the missing network.
+    #
+    # +get_with_prefix_length+ raises an exception if there is an error
+    # performing the lookup.
+    #
+    # +ip_address+ is a string in the standard notation. It may be IPv4 or
+    # IPv6.
+    def get_with_prefix_length(ip_address)
       ip = IPAddr.new(ip_address)
       # We could check the IP has the correct prefix (32 or 128) but I do not
       # for performance reasons.
@@ -144,10 +165,10 @@ module MaxMind # :nodoc:
               "Error looking up #{ip}. You attempted to look up an IPv6 address in an IPv4-only database."
       end
 
-      pointer = find_address_in_tree(ip, ip_version)
-      return nil if pointer == 0
+      pointer, depth = find_address_in_tree(ip, ip_version)
+      return nil, depth if pointer == 0
 
-      resolve_data_pointer(pointer)
+      [resolve_data_pointer(pointer), depth]
     end
 
     private
@@ -165,19 +186,22 @@ module MaxMind # :nodoc:
       node = start_node(bit_count)
 
       node_count = @node_count
-      bit_count.times do |i|
-        break if node >= node_count
 
-        c = packed[i >> 3].ord
-        bit = 1 & (c >> 7 - (i % 8))
+      depth = 0
+      loop do
+        break if depth >= bit_count || node >= node_count
+
+        c = packed[depth >> 3].ord
+        bit = 1 & (c >> 7 - (depth % 8))
         node = read_node(node, bit)
+        depth += 1
       end
 
-      return 0 if node == node_count
+      return 0, depth if node == node_count
 
-      return node if node > node_count
+      return node, depth if node > node_count
 
-      raise InvalidDatabaseError, 'Invalid node in search tree'.freeze
+      raise InvalidDatabaseError, 'Invalid node in search tree'
     end
 
     def start_node(length)
@@ -205,28 +229,26 @@ module MaxMind # :nodoc:
       if @record_size == 24
         offset = index == 0 ? base_offset : base_offset + 3
         buf = @io.read(offset, 3)
-        node_bytes = "\x00".freeze.b << buf
-        # When we support only Ruby 2.4+, we can change String#unpack calls
-        # that take the first element to String#unpack1.
-        return node_bytes.unpack('N'.freeze)[0]
+        node_bytes = "\x00".b << buf
+        return node_bytes.unpack1('N')
       end
 
       if @record_size == 28
         if index == 0
           buf = @io.read(base_offset, 4)
-          n = buf.unpack('N'.freeze)[0]
+          n = buf.unpack1('N')
           last24 = n >> 8
           first4 = (n & 0xf0) << 20
           return first4 | last24
         end
         buf = @io.read(base_offset + 3, 4)
-        return buf.unpack('N'.freeze)[0] & 0x0fffffff
+        return buf.unpack1('N') & 0x0fffffff
       end
 
       if @record_size == 32
         offset = index == 0 ? base_offset : base_offset + 4
         node_bytes = @io.read(offset, 4)
-        return node_bytes.unpack('N'.freeze)[0]
+        return node_bytes.unpack1('N')
       end
 
       raise InvalidDatabaseError, "Unsupported record size: #{@record_size}"
@@ -238,7 +260,7 @@ module MaxMind # :nodoc:
 
       if offset_in_file >= @size
         raise InvalidDatabaseError,
-              'The MaxMind DB file\'s search tree is corrupt'.freeze
+              'The MaxMind DB file\'s search tree is corrupt'
       end
 
       data, = @decoder.decode(offset_in_file)
@@ -257,7 +279,7 @@ module MaxMind # :nodoc:
       end
 
       raise InvalidDatabaseError,
-            'Metadata section not found. Is this a valid MaxMind DB file?'.freeze
+            'Metadata section not found. Is this a valid MaxMind DB file?'
     end
 
     def at_metadata?(index)

data/lib/maxmind/db/decoder.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'maxmind/db/errors'
 
 module MaxMind # :nodoc:
   class DB
-    # +Decoder+ decodes a {MaxMind DB}[http://maxmind.github.io/MaxMind-DB/]
+    # +Decoder+ decodes a {MaxMind DB}[https://maxmind.github.io/MaxMind-DB/]
     # data section.
     #
     # Typically you will interact with this class through a Reader rather than
@@ -47,44 +49,44 @@ module MaxMind # :nodoc:
       def decode_double(size, offset)
         verify_size(8, size)
         buf = @io.read(offset, 8)
-        [buf.unpack('G'.freeze)[0], offset + 8]
+        [buf.unpack1('G'), offset + 8]
       end
 
       def decode_float(size, offset)
         verify_size(4, size)
         buf = @io.read(offset, 4)
-        [buf.unpack('g'.freeze)[0], offset + 4]
+        [buf.unpack1('g'), offset + 4]
       end
 
       def verify_size(expected, actual)
         return if expected == actual
 
         raise InvalidDatabaseError,
-              'The MaxMind DB file\'s data section contains bad data (unknown data type or corrupt data)'.freeze
+              'The MaxMind DB file\'s data section contains bad data (unknown data type or corrupt data)'
       end
 
       def decode_int32(size, offset)
-        decode_int('l>'.freeze, 4, size, offset)
+        decode_int('l>', 4, size, offset)
       end
 
       def decode_uint16(size, offset)
-        decode_int('n'.freeze, 2, size, offset)
+        decode_int('n', 2, size, offset)
       end
 
       def decode_uint32(size, offset)
-        decode_int('N'.freeze, 4, size, offset)
+        decode_int('N', 4, size, offset)
       end
 
       def decode_uint64(size, offset)
-        decode_int('Q>'.freeze, 8, size, offset)
+        decode_int('Q>', 8, size, offset)
       end
 
       def decode_int(type_code, type_size, size, offset)
         return 0, offset if size == 0
 
         buf = @io.read(offset, size)
-        buf = buf.rjust(type_size, "\x00".freeze) if size != type_size
-        [buf.unpack(type_code)[0], offset + size]
+        buf = buf.rjust(type_size, "\x00") if size != type_size
+        [buf.unpack1(type_code), offset + size]
       end
 
       def decode_uint128(size, offset)
@@ -93,14 +95,14 @@ module MaxMind # :nodoc:
         buf = @io.read(offset, size)
 
         if size <= 8
-          buf = buf.rjust(8, "\x00".freeze)
-          return buf.unpack('Q>'.freeze)[0], offset + size
+          buf = buf.rjust(8, "\x00")
+          return buf.unpack1('Q>'), offset + size
         end
 
-        a_bytes = buf[0...-8].rjust(8, "\x00".freeze)
+        a_bytes = buf[0...-8].rjust(8, "\x00")
         b_bytes = buf[-8...buf.length]
-        a = a_bytes.unpack('Q>'.freeze)[0]
-        b = b_bytes.unpack('Q>'.freeze)[0]
+        a = a_bytes.unpack1('Q>')
+        b = b_bytes.unpack1('Q>')
         a <<= 64
         [a | b, offset + size]
       end
@@ -122,19 +124,19 @@ module MaxMind # :nodoc:
         when 0
           new_offset = offset + 1
           buf = (size & 0x7).chr << @io.read(offset, 1)
-          pointer = buf.unpack('n'.freeze)[0] + @pointer_base
+          pointer = buf.unpack1('n') + @pointer_base
         when 1
           new_offset = offset + 2
-          buf = "\x00".freeze.b << (size & 0x7).chr << @io.read(offset, 2)
-          pointer = buf.unpack('N'.freeze)[0] + 2048 + @pointer_base
+          buf = "\x00".b << (size & 0x7).chr << @io.read(offset, 2)
+          pointer = buf.unpack1('N') + 2048 + @pointer_base
         when 2
           new_offset = offset + 3
           buf = (size & 0x7).chr << @io.read(offset, 3)
-          pointer = buf.unpack('N'.freeze)[0] + 526_336 + @pointer_base
+          pointer = buf.unpack1('N') + 526_336 + @pointer_base
         else
           new_offset = offset + 4
           buf = @io.read(offset, 4)
-          pointer = buf.unpack('N'.freeze)[0] + @pointer_base
+          pointer = buf.unpack1('N') + @pointer_base
         end
 
         return pointer, new_offset if @pointer_test
@@ -208,9 +210,7 @@ module MaxMind # :nodoc:
       def size_from_ctrl_byte(ctrl_byte, offset, type_num)
         size = ctrl_byte & 0x1f
 
-        return size, offset if type_num == 1
-
-        return size, offset if size < 29
+        return size, offset if type_num == 1 || size < 29
 
         if size == 29
           size_bytes = @io.read(offset, 1)
@@ -220,12 +220,12 @@ module MaxMind # :nodoc:
 
         if size == 30
           size_bytes = @io.read(offset, 2)
-          size = 285 + size_bytes.unpack('n'.freeze)[0]
+          size = 285 + size_bytes.unpack1('n')
           return size, offset + 2
         end
 
-        size_bytes = "\x00".freeze.b << @io.read(offset, 3)
-        size = 65_821 + size_bytes.unpack('N'.freeze)[0]
+        size_bytes = "\x00".b << @io.read(offset, 3)
+        size = 65_821 + size_bytes.unpack1('N')
         [size, offset + 3]
       end
     end

data/lib/maxmind/db/errors.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module MaxMind # :nodoc:
   class DB
     # An InvalidDatabaseError means the {MaxMind
-    # DB}[http://maxmind.github.io/MaxMind-DB/] file is corrupt or invalid.
+    # DB}[https://maxmind.github.io/MaxMind-DB/] file is corrupt or invalid.
     class InvalidDatabaseError < RuntimeError
     end
   end