pure_mmdb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d0010e9343a3b56eb03d19206b390f02ec7b3e42
-  data.tar.gz: cab205542fbf0509a112424350449242f5161c12
+SHA256:
+  metadata.gz: f8802f1401a6393ae12434a4e641406ccd3c88eef1d79c9cfb9ed4be05635e32
+  data.tar.gz: 4e490273a556bcb6e5a82bbaddb73449742e72a8f98b7d1558708f4fe3bcf154
 SHA512:
-  metadata.gz: b86efda039d51dec77abda477a507b54f5ff1e57b381fadd4c3ab12aed9b6d032e4108b62a9635e1a04ae1de8af14eeb7aa63cace07dad90cfaa92122d679b70
-  data.tar.gz: fe9c616737556a8afe3b734c7fae57b55bedbdf04cac6f7cfc879da4eb0948bafe2ed61b6b66a6bdfabd11c88b45114f9d0ddc367bea478ae8df53ac147b3497
+  metadata.gz: 786886fc0f4eb99b148ee5501ad775f2c36cf0ae14368a058a016eb19cb6ac41698f15cc741e53e2db6cec3c74f0f2080b374cb6fbe466f359abccb315c3e564
+  data.tar.gz: 00bf41b8e96779fc34c78426e53f89950ede79cc247592b4c13a9c23c8b6500108ce2d4db672bd41097244fde671483d205f2a689ba4d0de958582464d824a23

data/.gitignore

@@ -10,6 +10,4 @@
 # rspec failure tracking
 .rspec_status
 
-spec/data/GeoLite*.mmdb
-
 *.gem

data/.travis.yml

@@ -4,10 +4,11 @@ env:
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-before_install: gem install bundler -v 1.16.1
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+before_install: gem install bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
@@ -16,4 +17,7 @@ script:
   - bundle exec rake
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
+notifications:
+  email:
+    on_success: never # default: change
+    on_failure: always # default: always

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in mmdb.gemspec
 gemspec

data/Gemfile.lock

@@ -6,40 +6,40 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (9.1.0)
+    byebug (11.1.1)
     coderay (1.1.2)
     diff-lcs (1.3)
-    method_source (0.9.0)
-    pry (0.11.3)
+    method_source (0.9.2)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.5.1)
-      byebug (~> 9.1)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
       pry (~> 0.10)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  pry-byebug (~> 3.0)
+  bundler (>= 1.16)
+  pry-byebug (>= 3.0)
   pure_mmdb!
-  rake (~> 10.0)
+  rake (>= 10.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/Rakefile

@@ -1,22 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec)
-
-desc "Downloads maxmind free DBs if required"
-task :ensure_maxmind_files do
-  unless File.exist?('spec/data/GeoLite2-City.mmdb')
-    sh 'curl http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz -o spec/data/GeoLite2-City.mmdb.gz'
-    sh 'gunzip spec/data/GeoLite2-City.mmdb.gz'
-  end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-  unless File.exist?('spec/data/GeoLite2-Country.mmdb')
-    sh 'curl http://geolite.maxmind.com/download/geoip/database/GeoLite2-Country.mmdb.gz -o spec/data/GeoLite2-Country.mmdb.gz'
-    sh 'gunzip spec/data/GeoLite2-Country.mmdb.gz'
-  end
-end
-
-desc "Downloads maxmind free DBs if required and runs all specs"
-task ensure_maxmind_files_and_spec: [:ensure_maxmind_files, :spec]
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :ensure_maxmind_files_and_spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "mmdb"
+require 'bundler/setup'
+require 'mmdb'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "mmdb"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/mmdb/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mmdb
   class Configuration
     DEFAULT_FILE_KEY = :file

data/lib/mmdb/db.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Mmdb
   class DB
-    class InvalidFileFormat < RuntimeError ; end
+    class InvalidFileFormat < RuntimeError; end
 
     def initialize(file_path)
       @file_path = file_path
@@ -8,18 +10,7 @@ module Mmdb
 
     def query(ip_addr)
       validate_database!
-      node = 0
-      (decoder.start_index...128).each do |i|
-        flag = (ip_addr >> (127 - i)) & 1
-        next_node = decoder.read(node: node, flag: flag)
-        raise InvalidFileFormat if next_node.zero?
-        if next_node < decoder.node_count
-          node = next_node
-        else
-          return decode_node(next_node).value
-        end
-      end
-      raise InvalidFileFormat
+      find_node!(ip_addr)
     end
 
     private
@@ -28,6 +19,26 @@ module Mmdb
 
     attr_reader :file_path
 
+    def find_node!(ip_addr)
+      (decoder.start_index...128).inject(0) do |node, i|
+        next_node = read_next_node!(node, build_flag(ip_addr, i))
+        return decode_node(next_node).value if next_node >= decoder.node_count
+
+        next_node
+      end
+      raise InvalidFileFormat
+    end
+
+    def build_flag(ip_addr, index)
+      (ip_addr >> (127 - index)) & 1
+    end
+
+    def read_next_node!(node, flag)
+      decoder.read(node: node, flag: flag).tap do |next_node|
+        raise InvalidFileFormat if next_node.zero?
+      end
+    end
+
     def validate_database!
       raise Mmdb::DatabaseNotFound unless File.exist?(file_path)
     end
@@ -39,7 +50,7 @@ module Mmdb
     end
 
     def decoder
-      @decode ||= Decoder.new(File.binread(file_path))
+      @decoder ||= Decoder.new(File.binread(file_path))
     end
   end
 end

data/lib/mmdb/decoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mmdb
   class Decoder
     def initialize(data)
@@ -9,6 +11,7 @@ module Mmdb
         begin
           index = data.rindex(METADATA_BEGIN)
           raise InvalidFileFormat if index.nil?
+
           decode(position: index + METADATA_BEGIN.size, base: 0).value
         end
     end
@@ -18,15 +21,15 @@ module Mmdb
     end
 
     def ip_version
-      metadata["ip_version"]
+      metadata['ip_version']
     end
 
     def node_count
-      metadata["node_count"]
+      metadata['node_count']
     end
 
     def node_byte_size
-      @node_byte_size ||= metadata["record_size"] * 2 / 8
+      @node_byte_size ||= metadata['record_size'] * 2 / 8
     end
 
     def search_tree_size
@@ -122,8 +125,8 @@ module Mmdb
     attr_reader :data
 
     METADATA_BEGIN = ([0xAB, 0xCD, 0xEF].pack('C*') + 'MaxMind.com').encode('ascii-8bit', 'ascii-8bit')
-    SIZE_BASE_VALUES = [0, 29, 285, 65821].freeze
-    POINTER_BASE_VALUES = [0, 0, 2048, 526336].freeze
+    SIZE_BASE_VALUES = [0, 29, 285, 65_821].freeze
+    POINTER_BASE_VALUES = [0, 0, 2048, 526_336].freeze
     Node = Struct.new(:position, :value)
     TYPES = [
       EXTENDED_TYPE        = 0,

data/lib/mmdb/query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ipaddr'
 
 module Mmdb

data/lib/mmdb/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mmdb
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

data/lib/mmdb.rb

@@ -1,11 +1,13 @@
-require "mmdb/configuration"
-require "mmdb/db"
-require "mmdb/decoder"
-require "mmdb/query"
-require "mmdb/version"
+# frozen_string_literal: true
+
+require 'mmdb/configuration'
+require 'mmdb/db'
+require 'mmdb/decoder'
+require 'mmdb/query'
+require 'mmdb/version'
 
 module Mmdb
-  class DatabaseNotFound < RuntimeError ; end
+  class DatabaseNotFound < RuntimeError; end
 
   class << self
     attr_reader :config
@@ -26,19 +28,12 @@ module Mmdb
 
     private
 
-    attr_reader :databases
-
     def db_for_key(file_key)
-      databases[file_key].tap do |db|
-        raise DatabaseNotFound if db.nil?
-      end
+      databases.fetch(file_key) { raise DatabaseNotFound }
     end
 
     def databases
-      @databases ||=
-        config.files.map do |key, file_path|
-          [key, DB.new(file_path)]
-        end.to_h
+      @databases ||= Hash[config.files.map { |k, f| [k, DB.new(f)] }]
     end
   end
 end

data/mmdb.gemspec

@@ -1,37 +1,38 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "mmdb/version"
+require 'mmdb/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "pure_mmdb"
+  spec.name          = 'pure_mmdb'
   spec.version       = Mmdb::VERSION
-  spec.authors       = ["Trevor John"]
-  spec.email         = ["trevor@john.tj"]
+  spec.authors       = ['Trevor John']
+  spec.email         = ['trevor@john.tj']
 
-  spec.summary       = %q{This is a ruby implementation of the MaxMindDB file format}
-  spec.description   = %q{The purpose of this gem is to provide fast IP lookups for the MaxMindDB file format without parsing the data stored.}
-  spec.homepage      = "https://github.com/trevorrjohn/mmdb"
-  spec.license       = "MIT"
+  spec.summary       = 'This is a ruby implementation of the MaxMindDB file format'
+  spec.description   = 'The purpose of this gem is to provide fast IP lookups for the MaxMindDB file format without parsing the data stored.'
+  spec.homepage      = 'https://github.com/trevorrjohn/mmdb'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "pry-byebug", "~> 3.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'pry-byebug', '>= 3.0'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: pure_mmdb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Trevor John
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -112,8 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: This is a ruby implementation of the MaxMindDB file format