IPLookup

IPLookup uses GeoIP2 MaxMind DB to lookup the country, timezone, coordinates and subdivision for a given ip address.

Dependencies

  • Uses the gem maxminddb as a database reader.
  • Uses the gem TZInfo for timezone lookup.
  • Uses the gem Zlib to decompress database file.

Installation

Add this line to your application's Gemfile:

gem 'ip_lookup'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ip_lookup

Configuration

Before using the gem the db file needs to be downloaded / updated. 

# download / update database
IPLookup.DB.update update_period: 30, update_uri: "http://path_to_database_GeoLite2-City.mmdb.gz"

NOTE: The gem provides post-install hook to download / update the db using Gem extensions.

Usage

ip_lookup = IPLookup.new "213.61.214.178", silent_exceptions: false

ip_lookup.country 
# => "de"

ip_lookup.timezone
# => "Europe/Berlin"

ip_lookup.coordinates
# => [51.2993, 9.491]

ip_lookup.subdivision
# => "be"

Defaults:

  • silent_exceptions: false

*NOTE: If silent exceptions is set to true, IPLookup returns default values in case the IP address couln't be looked up.

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 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.

License

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

Code of Conduct

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