MaxMind DB Reader Ruby API
Description
This is the Ruby API for reading MaxMind DB files. MaxMind DB is a binary file format that stores data indexed by IP address subnets (IPv4 or IPv6).
Installation
gem install maxmind-db --pre
Or from source:
gem build maxmind-db.spec
gem install ./maxmind-db-xxx.gem
Usage
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
For more information see the documentation.
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.
If you are having an issue with a MaxMind service that is not specific to the client API, please see our support page.
Versioning
This library uses Semantic Versioning.
Copyright and License
This software is Copyright (c) 2018 by MaxMind, Inc.
This is free software, licensed under the Apache License, Version 2.0 or the MIT License, at your option.