README.rdoc in geoip-0.9.0 vs README.rdoc in geoip-1.0.0
- old
+ new
@@ -16,43 +16,50 @@
== SYNOPSIS:
require 'geoip'
# Use the country database:
- GeoIP.new('GeoIP.dat').country('www.atlantis.sk')
- => ["www.atlantis.sk", "217.67.18.26", 196, "SK", "SVK", "Slovakia", "EU"]
+ c = GeoIP.new('GeoIP.dat').country('www.nokia.com')
+ => ["www.nokia.com", "147.243.3.83", 69, "FI", "FIN", "Finland", "EU"]
+ c.country_code3
+ => "FIN"
+ c.to_hash
+ => {:country_code3=>"FIN", :country_name=>"Finland", :continent_code=>"EU", :request=>"www.nokia.com", :country_code=>69, :country_code2=>"FI", :ip=>"147.243.3.83"}
Returned values are the requested hostname, the IP address as a dotted quad,
Maxmind's country code, the ISO3166-1 alpha-2 country code, the ISO3166-2 alpha-3
country code, the ISO3166 country name, and the continent code.
# Use the city database:
- GeoIP.new('GeoLiteCity.dat').country('www.atlantis.sk')
- => ["www.atlantis.sk", "217.67.18.26", "SK", "SVK", "Slovakia", "EU", "02", "Bratislava", "", 48.15, 17.1167, nil, nil, "Europe/Bratislava"]
+ c = GeoIP.new('GeoLiteCity.dat').city('github.com')
+ => ["github.com", "207.97.227.239", "US", "USA", "United States", "NA", "CA", "San Francisco", "94110", 37.7484, -122.4156, 807, 415, "America/Los_Angeles"]
+ >> c.longitude
+ => -122.4156
+ >> c.timezone
+ => "America/Los_Angeles"
GeoIP.new('GeoCity.dat').city('github.com')
=> ["github.com", "207.97.227.239", "US", "USA", "United States", "NA", "CA", "San Francisco", "94110", 37.7484, -122.4156, 807, 415, "America/Los_Angeles"]
Returned values are the requested hostname, the IP address as a dotted quad,
the ISO3166-1 alpha-2 country code, the ISO3166-2 alpha-3 country code, the
ISO3166 country name, the continent code, the region (state or territory) name,
city name, postal_code/zipcode, latitude, longitude, USA DMA code, USA area code,
timezone name.
- Result arrays from both city and country also contain accessor methods as appropriate:
+ Result arrays from both city and country have mixed-in accessor methods as appropriate:
request, ip, country_code, country_code2, country_code3, country_name, continent_code,
region_name, city_name, postal_code, latitude, longitude, dma_code, area_code, timezone
GeoIP.new('GeoIPASNum.dat').asn("www.fsb.ru")
=> ["AS8342", "RTComm.RU Autonomous System"]
== REQUIREMENTS:
-You need at least the free GeoLiteCity.dat, for which the last known download
-location is <http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz>,
-or the city database from <http://www.maxmind.com/app/geolitecity>.
-
-The ASN database location is
+You need one of the free GeoLite country, city or ASN databases, or a subscription database version.
+The last known download locations for the GeoLite database versions are
+<http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz>,
+<http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz>,
<http://geolite.maxmind.com/download/geoip/database/asnum/GeoIPASNum.dat.gz>.
This API requires the file to be decompressed for searching. Other versions
of this database are available for purchase which contain more detailed
information, but this information is not returned by this implementation.