pure_mmdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee81a9604620a2b0900449b3f3cd065a063d4d040f491a9354af1aac7718642a
+  data.tar.gz: 1b37dacbf6496bd6f24c442f4d4b131f60acf930c9abad6e6191afeab9ae93f4
+SHA512:
+  metadata.gz: a5e643c8666abbf5ed503f9892d3a014982de48eec013c30ebad213cbe36bcb40b57f8fa50127fd5aab4e97e19b113558d086dace89c6b8cfeeacff6a58699ae
+  data.tar.gz: f2f71adbf1f3fe81fea7c1585c631bf316b1112c500237807e4dcb481159886f1db9323dfb6d7d729b0ce6874aa4ac6cdc53fd2c3922fd1ae12d545e5ec80f3a

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/data/GeoLite*.mmdb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at trevor@john.tj. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    mmdb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mmdb!
+  pry-byebug (~> 3.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Trevor John
+
+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.md

@@ -0,0 +1,43 @@
+# Mmdb
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mmdb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mmdb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mmdb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mmdb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mmdb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mmdb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+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
+
+  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]
+
+task default: :ensure_maxmind_files_and_spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mmdb/configuration.rb

@@ -0,0 +1,5 @@
+module Mmdb
+  class Configuration
+    attr_accessor :file_path
+  end
+end

data/lib/mmdb/db.rb

@@ -0,0 +1,45 @@
+module Mmdb
+  class DB
+    class InvalidFileFormat < RuntimeError ; end
+
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    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
+    end
+
+    private
+
+    DATA_SEPARATOR_SIZE = 16
+
+    attr_reader :file_path
+
+    def validate_database!
+      raise Mmdb::DatabaseNotFound unless File.exist?(file_path)
+    end
+
+    def decode_node(node)
+      base = decoder.search_tree_size + DATA_SEPARATOR_SIZE
+      position = (node - decoder.node_count) - DATA_SEPARATOR_SIZE
+      decoder.decode(position: position, base: base)
+    end
+
+    def decoder
+      @decode ||= Decoder.new(File.binread(file_path))
+    end
+  end
+end

data/lib/mmdb/decoder.rb

@@ -0,0 +1,160 @@
+module Mmdb
+  class Decoder
+    def initialize(data)
+      @data = data
+    end
+
+    def metadata
+      @metadata ||=
+        begin
+          index = data.rindex(METADATA_BEGIN)
+          raise InvalidFileFormat if index.nil?
+          decode(position: index + METADATA_BEGIN.size, base: 0).value
+        end
+    end
+
+    def start_index
+      @start_index ||= ip_version == 4 ? 96 : 0
+    end
+
+    def ip_version
+      metadata["ip_version"]
+    end
+
+    def node_count
+      metadata["node_count"]
+    end
+
+    def node_byte_size
+      @node_byte_size ||= metadata["record_size"] * 2 / 8
+    end
+
+    def search_tree_size
+      @search_tree_size ||= node_count * node_byte_size
+    end
+
+    def record_byte_size
+      @record_byte_size ||= node_byte_size / 2
+    end
+
+    def read(node:, flag:)
+      position = node_byte_size * node
+      middle = data[position + record_byte_size].ord if node_byte_size.odd?
+      if flag.zero? # LEFT node
+        val = fetch(position, 0)
+        val += ((middle & 0xf0) << 20) if middle
+      else # RIGHT node
+        val = fetch(position + node_byte_size - record_byte_size, 0)
+        val += ((middle & 0xf) << 24) if middle
+      end
+      val
+    end
+
+    def decode(position:, base:)
+      ctrl = data[position + base].ord
+      type = ctrl >> 5
+      position += 1
+
+      if type == POINTER
+        decode_pointer(position, base, ctrl)
+      else
+        if type == EXTENDED_TYPE
+          type = 7 + data[position + base].ord
+          position += 1
+        end
+
+        size = ctrl & 0x1f
+        if size >= 29
+          byte_size = size - 29 + 1
+          val = fetch(position, base, byte_size)
+          position += byte_size
+          size = val + SIZE_BASE_VALUES[byte_size]
+        end
+
+        case type
+        when UTF8
+          val = data[position + base, size].encode('utf-8', 'utf-8')
+          Node.new(position + size, val)
+        when DOUBLE
+          val = data[position + base, size].unpack('G')[0]
+          Node.new(position + size, val)
+        when BYTE
+          val = data[position + base, size]
+          Node.new(position + size, val)
+        when UINT16, UINT32, UINT64, UINT128
+          val = fetch(position, base, size)
+          Node.new(position + size, val)
+        when MAP
+          val = size.times.each_with_object({}) do |_, map|
+            key_node = decode(position: position, base: base)
+            val_node = decode(position: key_node.position, base: base)
+            position = val_node.position
+            map[key_node.value] = val_node.value
+          end
+          Node.new(position, val)
+        when INT32
+          v1 = data[position + base, size].unpack('N')[0]
+          bits = size * 8
+          val = (v1 & ~(1 << bits)) - (v1 & (1 << bits))
+          Node.new(position + size, val)
+        when ARRAY
+          val = Array.new(size) do
+            node = decode(position: position, base: base)
+            position = node.position
+            node.value
+          end
+          Node.new(position, val)
+        when DATA_CACHE_CONTAINER
+          raise 'TODO:'
+        when END_MARKER
+          Node.new(position, nil)
+        when BOOLEAN
+          Node.new(position, !size.zero?)
+        when FLOAT
+          val = data[position + base, size].unpack('g')[0]
+          Node.new(position + size, val)
+        end
+      end
+    end
+
+    private
+
+    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
+    Node = Struct.new(:position, :value)
+    TYPES = [
+      EXTENDED_TYPE        = 0,
+      POINTER              = 1,
+      UTF8                 = 2,
+      DOUBLE               = 3,
+      BYTE                 = 4,
+      UINT16               = 5,
+      UINT32               = 6,
+      MAP                  = 7,
+      INT32                = 8,
+      UINT64               = 9,
+      UINT128              = 10,
+      ARRAY                = 11,
+      DATA_CACHE_CONTAINER = 12,
+      END_MARKER           = 13,
+      BOOLEAN              = 14,
+      FLOAT                = 15
+    ].freeze
+
+    def decode_pointer(position, base, ctrl)
+      size = ((ctrl >> 3) & 0x3) + 1
+      v1 = ctrl & 0x7
+      v2 = fetch(position, base, size)
+      pointer = (v1 << (8 * size)) + v2 + POINTER_BASE_VALUES[size]
+      Node.new(position + size, decode(position: pointer, base: base).value)
+    end
+
+    def fetch(position, base, size = record_byte_size)
+      bytes = data[position + base, size].unpack('C*')
+      bytes.inject(0) { |r, v| (r << 8) + v }
+    end
+  end
+end

data/lib/mmdb/query.rb

@@ -0,0 +1,23 @@
+require 'ipaddr'
+
+module Mmdb
+  class Query
+    def initialize(db:, ip:)
+      @db = db
+      @ip = ip
+    end
+
+    def fetch
+      db.query(ip_addr.to_i)
+    end
+
+    private
+
+    attr_reader :db, :ip
+
+    def ip_addr
+      addr = IPAddr.new(ip)
+      addr.ipv4? ? addr.ipv4_compat : addr
+    end
+  end
+end

data/lib/mmdb/version.rb

@@ -0,0 +1,3 @@
+module Mmdb
+  VERSION = "0.1.0"
+end

data/lib/mmdb.rb

@@ -0,0 +1,35 @@
+require "mmdb/configuration"
+require "mmdb/db"
+require "mmdb/decoder"
+require "mmdb/query"
+require "mmdb/version"
+
+module Mmdb
+  class DatabaseNotFound < RuntimeError ; end
+
+  class << self
+    attr_reader :config
+
+    def configure
+      @config ||= Configuration.new
+      yield(config) if block_given?
+    end
+
+    def reset
+      @config = Configuration.new
+      @db = nil
+    end
+
+    def query(ip)
+      Query.new(db: db, ip: ip).fetch
+    end
+
+    private
+
+    attr_reader :db
+
+    def db
+      @db ||= DB.new(config.file_path)
+    end
+  end
+end

data/mmdb.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mmdb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pure_mmdb"
+  spec.version       = Mmdb::VERSION
+  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"
+
+  # 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"
+  else
+    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|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pure_mmdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Trevor John
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-23 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
+  name: rspec
+  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'
+description: The purpose of this gem is to provide fast IP lookups for the MaxMindDB
+  file format without parsing the data stored.
+email:
+- trevor@john.tj
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mmdb.rb
+- lib/mmdb/configuration.rb
+- lib/mmdb/db.rb
+- lib/mmdb/decoder.rb
+- lib/mmdb/query.rb
+- lib/mmdb/version.rb
+- mmdb.gemspec
+homepage: https://github.com/trevorrjohn/mmdb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: This is a ruby implementation of the MaxMindDB file format
+test_files: []