README.md in IPinfo-1.0.1 vs README.md in IPinfo-1.1.0
- old
+ new
@@ -1,18 +1,18 @@
# [<img src="https://ipinfo.io/static/ipinfo-small.svg" alt="IPinfo" width="24"/>](https://ipinfo.io/) IPinfo Ruby Client Library
-This is the official Ruby client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:
- - [IP geolocation data](https://ipinfo.io/ip-geolocation-api) (city, region, country, postal code, latitude and longitude)
- - [ASN information](https://ipinfo.io/asn-api) (ISP or network operator, associated domain name, and type, such as business, hosting or company)
+This is the official Ruby client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to look up your own IP address, or get any of the following details for an IP:
+ - [IP geolocation data](https://ipinfo.io/ip-geolocation-api) (city, region, country, postal code, latitude, and longitude)
+ - [ASN information](https://ipinfo.io/asn-api) (ISP or network operator, associated domain name, and type, such as business, hosting, or company)
- [Firmographic data](https://ipinfo.io/ip-company-api) (the name and domain of the business that uses the IP address)
- [Carrier details](https://ipinfo.io/ip-carrier-api) (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)
Check all the data we have for your IP address [here](https://ipinfo.io/what-is-my-ip).
### Getting Started
-You'll need an IPinfo API access token, which you can get by singing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup).
+You'll need an IPinfo API access token, which you can get by signing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup).
The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see [https://ipinfo.io/pricing](https://ipinfo.io/pricing)
#### Installation
@@ -31,29 +31,41 @@
$ gem install IPinfo
#### Quick Start
```ruby
-require 'IPinfo'
+require 'ipinfo'
access_token = '123456789abc'
handler = IPinfo::create(access_token)
ip_address = '216.239.36.21'
details = handler.details(ip_address)
city = details.city # Emeryville
loc = details.loc # 37.8342,-122.2900
```
+##### Note about Rails 6+
+
+If using this package in Rails 6+, the Zeitwerk auto-loader may not properly
+recognize the gem due to its naming conventions (uppercased gem/module name).
+See issue https://github.com/ipinfo/ruby/issues/24.
+
+A workaround is to insert this in `application.rb`:
+
+```ruby
+require 'ipinfo' unless defined?(IPinfo)
+```
+
#### Usage
The `IPinfo.details()` method accepts an IP address as an optional, positional
argument. If no IP address is specified, the API will return data for the IP
address from which it receives the request.
```ruby
-require 'IPinfo'
+require 'ipinfo'
access_token = '123456789abc'
handler = IPinfo::create(access_token)
details = handler.details()
@@ -84,20 +96,78 @@
##### Country Name
`details.country_name` will return the country name, as supplied by the
`countries.json` file. See below for instructions on changing that file for use
-with non-English languages. `details.country` will still return country code.
+with non-English languages. `details.country` will still return the country code.
```ruby
country = details.country # US
country_name = details.country_name # United States
```
+##### European Union (EU) Country
+
+`details.is_eu` will return `true` if the country is a member of the European Union (EU), as supplied by the `eu.json` file.
+
+```ruby
+is_eu = details.is_eu # false
+```
+
+It is possible to change the file by setting the `eu_countries` setting when creating the `IPinfo` object.
+
+The file must be a `.json` file with the [following structure](lib/ipinfo/eu.json).
+
+##### Country Flag
+
+`details.country_flag` will return `emoji` and `unicode` of a country's flag, as supplied by the `eu.json` file.
+
+```ruby
+country_flag = details.country_flag # {"emoji"=>"🇺🇸", "unicode"=>"U+1F1FA U+1F1F8"}
+country_flag_emoji = details.country_flag['emoji'] # 🇺🇸
+country_flag_unicode = details.country_flag['unicode'] # U+1F1FA U+1F1F8
+```
+
+##### Country Flag URL
+
+`details.country_flag_url` will return a public link to the country's flag image as an SVG which can be used anywhere.
+
+```ruby
+country_flag = details.country_flag_url # {"https://cdn.ipinfo.io/static/images/countries-flags/US.svg"}
+```
+
+##### Country Currency
+
+`details.country_currency` will return `code` and `symbol` of a country's currency, as supplied by the `currency.json` file.
+
+```ruby
+country_currency = details.country_currency # {"code"=>"USD", "symbol"=>"$"}
+country_currency_code = details.country_currency['code'] # USD
+country_currency_symbol = details.country_currency['symbol'] # $
+```
+
+It is possible to change the file by setting the `countries_currencies` setting when creating the `IPinfo` object.
+
+The file must be a `.json` file with the [following structure](lib/ipinfo/currency.json).
+
+##### Continent
+
+`details.continent` will return `code` and `name` of the continent, as supplied by the `continent.json` file.
+
+```ruby
+continent = details.continent # {"code"=>"NA", "name"=>"North America"}
+continent_code = details.continent['code'] # NA
+continent_name = details.continent['name'] # North America
+```
+
+It is possible to change the file by setting the `continents` setting when creating the `IPinfo` object.
+
+The file must be a `.json` file with the [following structure](lib/ipinfo/continent.json).
+
#### IP Address
-`details.ip_address` will return the an `IPAddr` object from the
+`details.ip_address` will return the `IPAddr` object from the
[Ruby Standard Library](https://ruby-doc.org/stdlib-2.5.1/libdoc/ipaddr/rdoc/IPAddr.html).
`details.ip` will still return a string.
```ruby
ip = details.ip # 104.175.221.247
@@ -215,12 +285,12 @@
}
```
### Other Libraries
-There are official IPinfo client libraries available for many languages including PHP, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API.
+There are official IPinfo client libraries available for many languages including PHP, Go, Java, Ruby, and many popular frameworks such as Django, Rails, and Laravel. There are also many third-party libraries and integrations available for our API.
### About IPinfo
-Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, privacy detection, reverse IP, and IP type data sets. Our API handles over 20 billion requests a month for 100,000 businesses and developers.
+Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, hosted domains, and IP type data sets. Our API handles over 40 billion requests a month for 100,000 businesses and developers.
[](https://ipinfo.io/)