maxmind-db 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0783d0fa6b13e4fa43dd70dd24c876452e1d5911a8de8296669bd4f806e38ec9'
+  data.tar.gz: 22720864310267dc946e90f1b6b7fb12ee506e2959414b7214539479401a24a6
+SHA512:
+  metadata.gz: 2705b919ec933748987b7495ce750361eb62643e8f5cf8ef142215af61c4f6f6b539cdec47976b58346cad0748241d362aee16f054a14a9986cdcee8c7c534ff
+  data.tar.gz: a7f994be60c64df42176ef98131433812a739eef6533fafde8a867eeb8e097b18127e276cb49eaf42d5d93f84ef807958b4f4cf84d5c6276b49fc56b0decd298

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.0.1.pre - 2018-12-24
+* Initial implementation.

data/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/LICENSE-MIT

@@ -0,0 +1,17 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.dev.md

@@ -0,0 +1,30 @@
+# How to release
+* Update changelog and set release date
+* Bump version in `maxmind-db.gemspec`
+* Commit: `git commit -m v1.0.0`
+* Push: `git push`
+* Tag: `git tag -a v1.0.0 -m v1.0.0`
+* Push tag: `git push --tags`
+* Create `.gem` file: `gem build maxmind-db.spec`
+* Complete prerequisites (see below)
+* Upload to rubygems.org: `gem push <.gem>`
+
+
+# Prerequisites
+
+## Step 1
+Sign up for an account at rubygems.org if you don't have one.
+
+Enable multi factor authentication.
+
+
+## Step 2
+Ask someone who is an owner of the gem to add you as one.
+
+They do this by using the `gem owner` command
+([docs](https://guides.rubygems.org/command-reference/#gem-owner)).
+
+
+## Step 3
+Go to your rubygems.org profile and find the curl command to run to
+download your API key.

data/README.md

@@ -0,0 +1,54 @@
+# MaxMind DB Reader Ruby API
+
+## Description
+
+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).
+
+## Usage
+
+```ruby
+require 'maxmind/db'
+
+reader = MaxMind::DB.new('GeoIP2-City.mmdb', mode: MaxMind::DB::MODE_MEMORY)
+
+record = reader.get('1.1.1.1')
+if record.nil?
+  puts '1.1.1.1 was not found in the database'
+else
+  puts record['country']['iso_code']
+  puts record['country']['names']['en']
+end
+
+reader.close
+```
+
+## Requirements
+
+This code requires Ruby version 2.3 or higher. Older versions may work, but
+are not supported.
+
+## Contributing
+
+Patches and pull requests are encouraged. Please include unit tests
+whenever possible.
+
+## Support
+
+Please report all issues with this code using the [GitHub issue
+tracker](https://github.com/maxmind/MaxMind-DB-Reader-ruby/issues).
+
+If you are having an issue with a MaxMind service that is not specific to the
+client API, please see [our support page](https://www.maxmind.com/en/support).
+
+## Versioning
+
+This library uses [Semantic Versioning](https://semver.org/).
+
+## Copyright and License
+
+This software is Copyright (c) 2018 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

@@ -0,0 +1,12 @@
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+RuboCop::RakeTask.new
+
+desc 'Run tests and RuboCop'
+task default: :test
+task default: :rubocop

data/bin/mmdb-benchmark.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require 'maxmind/db'
+
+def main
+  args = parse_args
+  return false if args.nil?
+
+  reader = MaxMind::DB.new(args[:database], mode: MaxMind::DB::MODE_MEMORY)
+  benchmark(reader, args[:ip_file])
+  true
+end
+
+def parse_args
+  if ARGV.length != 2
+    print_usage
+    return nil
+  end
+
+  database = ARGV[0]
+  ip_file  = ARGV[1]
+
+  {
+    database: database,
+    ip_file:  ip_file,
+  }
+end
+
+def print_usage
+  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.'
+end
+
+def benchmark(reader, file)
+  n = 0
+  count = 200_000
+  start = Time.now.to_f
+  File.open(file) do |fh|
+    fh.each do |line|
+      n += 1
+      line.strip!
+
+      reader.get(line)
+
+      write_status(start, n) if n % 1000 == 0
+      break if n == count
+    end
+  end
+end
+
+def write_status(start, count)
+  now = Time.now.to_f
+  elapsed = now - start
+  rate = 1.0 * count / elapsed
+  puts format('%d @ %.2f lookups per second (%d seconds elapsed)', count, rate, elapsed)
+end
+
+exit 0 if main
+
+exit 1

data/lib/maxmind/db.rb

@@ -0,0 +1,274 @@
+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'
+
+module MaxMind # :nodoc:
+  # DB provides a way to read {MaxMind DB
+  # files}[http://maxmind.github.io/MaxMind-DB/].
+  #
+  # {MaxMind DB}[http://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.
+  #
+  # == Example
+  #
+  #   require 'maxmind/db'
+  #
+  #   reader = MaxMind::DB.new('GeoIP2-City.mmdb', mode: MaxMind::DB::MODE_MEMORY)
+  #
+  #   record = reader.get('1.1.1.1')
+  #   if record.nil?
+  #     puts '1.1.1.1 was not found in the database'
+  #   else
+  #     puts record['country']['iso_code']
+  #     puts record['country']['names']['en']
+  #   end
+  #
+  #   reader.close
+  #
+  # == Exceptions
+  #
+  # DB raises an InvalidDatabaseError if the database is corrupt or invalid. It
+  # can raise other exceptions, such as ArgumentError, if other errors occur.
+  class DB
+    # Choose the default method to open the database. Currently the default is
+    # MODE_FILE.
+    MODE_AUTO = :MODE_AUTO
+    # Open the database as a regular file and read on demand.
+    MODE_FILE = :MODE_FILE
+    # Read the database into memory. This is faster than MODE_FILE but causes
+    # increased memory use.
+    MODE_MEMORY = :MODE_MEMORY
+    # Treat the database parameter as containing a database already read into
+    # memory. It must be a binary string. This primarily exists for testing.
+    MODE_PARAM_IS_BUFFER = :MODE_PARAM_IS_BUFFER # :nodoc:
+
+    DATA_SECTION_SEPARATOR_SIZE = 16
+    private_constant :DATA_SECTION_SEPARATOR_SIZE
+    METADATA_START_MARKER = "\xAB\xCD\xEFMaxMind.com".freeze.b.freeze
+    private_constant :METADATA_START_MARKER
+    METADATA_START_MARKER_LENGTH = 14
+    private_constant :METADATA_START_MARKER_LENGTH
+    METADATA_MAX_SIZE = 131_072
+    private_constant :METADATA_MAX_SIZE
+
+    # Return the metadata associated with the {MaxMind
+    # DB}[http://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
+    # 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
+    # is safe to use after forking only if you use MODE_MEMORY or if your
+    # version of Ruby supports IO#pread.
+    #
+    # Creating the DB may raise an exception if initialization fails.
+    #
+    # +database+ is a path to a {MaxMind
+    # DB}[http://maxmind.github.io/MaxMind-DB/].
+    #
+    # +options+ is an option hash where each key is a symbol. The options
+    # control the behaviour of the DB.
+    #
+    # The available options are:
+    #
+    # [+:mode+] defines how to open the database. It may be one of MODE_AUTO,
+    #           MODE_FILE, or MODE_MEMORY. If you don't provide one, DB uses
+    #           MODE_AUTO. Refer to the definition of those constants for an
+    #           explanation of their meaning.
+    def initialize(database, options = {})
+      options[:mode] = MODE_AUTO unless options.key?(:mode)
+
+      case options[:mode]
+      when MODE_AUTO, MODE_FILE
+        @io = FileReader.new(database)
+      when MODE_MEMORY
+        @io = MemoryReader.new(database)
+      when MODE_PARAM_IS_BUFFER
+        @io = MemoryReader.new(database, is_buffer: true)
+      else
+        raise ArgumentError, 'Invalid mode'.freeze
+      end
+
+      begin
+        @size = @io.size
+
+        metadata_start = find_metadata_start
+        metadata_decoder = Decoder.new(@io, metadata_start)
+        metadata_map, = metadata_decoder.decode(metadata_start)
+        @metadata = Metadata.new(metadata_map)
+        @decoder = Decoder.new(@io, @metadata.search_tree_size +
+                               DATA_SECTION_SEPARATOR_SIZE)
+
+        # Store copies as instance variables to reduce method calls.
+        @ip_version       = @metadata.ip_version
+        @node_count       = @metadata.node_count
+        @node_byte_size   = @metadata.node_byte_size
+        @record_size      = @metadata.record_size
+        @search_tree_size = @metadata.search_tree_size
+
+        @ipv4_start = nil
+        # Find @ipv4_start up front. If we don't, we either have a race to
+        # get/set it or have to synchronize access.
+        start_node(0)
+      rescue StandardError => e
+        @io.close
+        raise e
+      end
+    end
+
+    # Return the record for the +ip_address+ in the {MaxMind
+    # DB}[http://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+.
+    #
+    # +get+ 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(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.
+
+      ip_version = ip.ipv6? ? 6 : 4
+      if ip_version == 6 && @ip_version == 4
+        raise ArgumentError,
+              "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
+
+      resolve_data_pointer(pointer)
+    end
+
+    private
+
+    IP_VERSION_TO_BIT_COUNT = {
+      4 => 32,
+      6 => 128,
+    }.freeze
+    private_constant :IP_VERSION_TO_BIT_COUNT
+
+    def find_address_in_tree(ip_address, ip_version)
+      packed = ip_address.hton
+
+      bit_count = IP_VERSION_TO_BIT_COUNT[ip_version]
+      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))
+        node = read_node(node, bit)
+      end
+
+      return 0 if node == node_count
+
+      return node if node > node_count
+
+      raise InvalidDatabaseError, 'Invalid node in search tree'.freeze
+    end
+
+    def start_node(length)
+      return 0 if @ip_version != 6 || length == 128
+
+      return @ipv4_start if @ipv4_start
+
+      node = 0
+      96.times do
+        break if node >= @metadata.node_count
+        node = read_node(node, 0)
+      end
+
+      @ipv4_start = node
+    end
+
+    # Read a record from the indicated node. Index indicates whether it's the
+    # left (0) or right (1) record.
+    #
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def read_node(node_number, index)
+      base_offset = node_number * @node_byte_size
+
+      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]
+      end
+
+      if @record_size == 28
+        if index == 0
+          buf = @io.read(base_offset, 4)
+          n = buf.unpack('N'.freeze)[0]
+          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
+      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]
+      end
+
+      raise InvalidDatabaseError, "Unsupported record size: #{@record_size}"
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    def resolve_data_pointer(pointer)
+      offset_in_file = pointer - @node_count + @search_tree_size
+
+      if offset_in_file >= @size
+        raise InvalidDatabaseError,
+              'The MaxMind DB file\'s search tree is corrupt'.freeze
+      end
+
+      data, = @decoder.decode(offset_in_file)
+      data
+    end
+
+    def find_metadata_start
+      metadata_max_size = @size < METADATA_MAX_SIZE ? @size : METADATA_MAX_SIZE
+
+      stop_index = @size - metadata_max_size
+      index = @size - METADATA_START_MARKER_LENGTH
+      while index >= stop_index
+        return index + METADATA_START_MARKER_LENGTH if at_metadata?(index)
+        index -= 1
+      end
+
+      raise InvalidDatabaseError,
+            'Metadata section not found. Is this a valid MaxMind DB file?'.freeze
+    end
+
+    def at_metadata?(index)
+      @io.read(index, METADATA_START_MARKER_LENGTH) == METADATA_START_MARKER
+    end
+
+    public
+
+    # Close the DB and return resources to the system.
+    #
+    # There is no useful return value. #close raises an exception if there is
+    # an error.
+    def close
+      @io.close
+    end
+  end
+end