MaxMindDB

The purpose of this gem is to implement the MaxMindDB File Format in Ruby.

The gem is highly influenced by the implementation of the MaxMindDB gem and I have to give a lot of credit to that project.

Add this line to your application's Gemfile:

gem 'pure_mmdb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pure_mmdb

To configure the gem, simply set the file_path in the configure block.

Mmdb.configure do |c|
  c.file_path = '/path/to/db.mmdb'
end
Mmdb.query('192.168.1.1')
#=> { 'data' => 'hash' }

If you need to have multiple database files you can query each file individually after specifying the files. You can configure as many database files as you like. The database will only be loaded into memory once it is queried.

Mmdb.configure do |c|
  c.files = {
    vpn: 'path to vpn.mmdb',
    location: 'path to location.mmdb'
  }
end
Mmdb.lookup('192.168.1.1', file_key: :vpn)
#=> { 'data' => 'vpn data' }
Mmdb.lookup('192.168.1.1', file_key: :location)
#=> { 'data' => 'location data' }

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/trevorrjohn/mmdb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Mmdb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.