NAME

GeoIP2::Database::Reader - Perl API for GeoIP2 databases

VERSION

version 0.040002

SYNOPSIS

  use 5.008;

  use GeoIP2::Database::Reader;

  my $reader = GeoIP2::Database::Reader->new(
      file    => '/path/to/database',
      locales => [ 'en', 'de', ]
  );

  my $omni = $reader->omni( ip => '24.24.24.24' );
  my $country = $omni->country();
  say $country->is_code();

DESCRIPTION

This class provides a reader API for all GeoIP2 databases. The methods provided by this reader (country(), city(), city_isp_org() and omni()), correspond to the web service endpoints (Country, City, City/ISP/Org, and Omni). Each method returns a different set of data about an IP address, with country returning the least data and omni the most.

Each method returns a different model class, and these model classes in turn contain multiple record classes. The record classes have attributes which contain data about the IP address.

If the database does not return a particular piece of data for an IP address, the associated attribute is not populated.

The database may not return any information for an entire record, in which case all of the attributes for that record class will be empty.

USAGE

The basic API for this class is the same for all database types. First you create a database reader object with your file and locale params. Then you call the method corresponding to your database type, passing it the IP address you want to look up.

If the request succeeds, the method call will return a model class for the method point you called. This model, in turn, contains multiple record classes, each of which represents part of the data returned by the database.

If the database cannot be read, the reader class throws an exception.

CONSTRUCTOR

This class has a single constructor method:

GeoIP2::Database::Reader->new()

This method creates a new object. It accepts the following arguments:

• file

  This is the path to the GeoIP2 database file which you'd like to query.

• locales

  This is an array reference where each value is a string indicating a locale. This argument will be passed on to record classes to use when their name() methods are called.

  The order of the locales is significant. When a record class has multiple names (country, city, etc.), its name() method will look at each element of this array ref and return the first locale for which it has a name.

  Note that the only locale which is always present in the GeoIP2 data in "en". If you do not include this locale, the name() method may end up returning undef even when the record in question has an English name.

  Currently, the valid list of locale codes is:

  • de - German

  • en - English

    English names may still include accented characters if that is the accepted spelling in English. In other words, English does not mean ASCII.

  • es - Spanish

  • fr - French

  • ja - Japanese

  • pt-BR - Brazilian Portuguese

  • ru - Russian

  • zh-CN - simplified Chinese

  Passing any other locale code will result in an error.

  The default value for this argument is ['en'].

REQUEST METHODS

All of the request methods accept a single argument:

• ip

  This must be a valid IPv4 or IPv6 address. This is the address that you want to look up using the GeoIP2 web service.

  Unlike the web service client class, you cannot pass the string "me" as your ip address.

$reader->country()

This method returns a GeoIP2::Model::Country object.

$reader->city()

This method returns a GeoIP2::Model::City object.

$reader->city_isp_org()

This method returns a GeoIP2::Model::CityISPOrg object.

$reader->omni()

This method returns a GeoIP2::Model::Omni object.

Note that the data which makes the Omni web service different from City/ISP/Org is not available in any downloadable database. This means that calling the $reader->omni() always returns the same data as as $reader->city_isp_org().

EXCEPTIONS

In the case of a fatal error, the reader will throw a GeoIP2::Error::Generic object.

This error class has an $error->message() method and overload stringification to show that message. This means that if you don't explicitly catch errors they will ultimately be sent to STDERR with some sort of (hopefully) useful error message.

WHAT DATA IS RETURNED?

While many of the databases return the same basic records, the attributes which can be populated vary between model classes. In addition, while a database may offer a particular piece of data, MaxMind does not always have every piece of data for any given IP address.

Because of these factors, it is possible for any model class to return a record where some or all of the attributes are unpopulated.

See http://dev.maxmind.com/geoip/geoip2/web-services for details on what data each end point may return.

The only piece of data which is always returned is the ip_address key in the GeoIP2::Record::Traits record.

Every record class attribute has a corresponding predicate method so you can check to see if the attribute is set.

AUTHORS

• Dave Rolsky <drolsky@maxmind.com>

• Greg Oschwald <goschwald@maxmind.com>

• Olaf Alders <oalders@maxmind.com>

CONTRIBUTOR

Graham Knop <haarg@haarg.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by MaxMind, Inc..

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm GeoIP2

perl -MCPAN -e shell
install GeoIP2