IPinfo 1.0.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4c7edbf9ea00bfe0f34278ce345a0be0af732787dac8894043640d1c72f3dda
-  data.tar.gz: a012b52f9d182417c48f96997e80464b37633b46b0e54e2251b36c8d36710174
+  metadata.gz: 7fdee7360c5440bb6a71dcfca62b1b006688952535a1f594c3b9c3105505665b
+  data.tar.gz: a177efbb1348e47dfe3ea6c1cdaef9327a33db6b0233db1884b1b27379ed49b5
 SHA512:
-  metadata.gz: 706d928db455afb05db71bbf170b33616fa141c3f5765ac1045563e24b90e124fd8fbb9743bcdd7ac9b0ba1a7d0ccf30a4615cb2edf0fefe55e5c903f9be8eac
-  data.tar.gz: f49d989cf52c9b1524ce2d4a177cc906ab5c680745fb23f540fa6395c31f6a4bac304f904849f0b8298a89600e93321a2f6e0165988506f8ad0ede81c7873ad1
+  metadata.gz: b4f01041c106a9c69d155ab4981090b94d14cc1637dc2bd522920defb87552640bf8b5e9c540b43e221a76bab8ba961ac7241fe9b602de44167606409440d8c4
+  data.tar.gz: 9f7d2ecce9daf619edf12564690a0281f49f8152b1e3159e34d2e43048862cecae4b55c87baae79e21a3b0371d4cbc2ecdeb3549ec6ee16f18f7327a122e401a

data/.github/workflows/cd_rubygems.yaml

@@ -0,0 +1,37 @@
+name: Release package to rubygems.org
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install apt dependencies
+        run: sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev # needed by faraday-patron gem
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake
+        env:
+          IPINFO_TOKEN: ${{ secrets.IPINFO_TOKEN }}
+
+      - name: Build
+        run: gem build *.gemspec
+
+      - name: Publish
+        uses: rubygems/release-gem@v1

data/.github/workflows/unittest.yaml

@@ -0,0 +1,40 @@
+name: Unit Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+permissions:
+  contents: read
+
+jobs:
+  run:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
+      
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install apt dependencies
+        run: sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev # needed by faraday-patron gem
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        env: 
+          IPINFO_TOKEN: ${{ secrets.IPINFO_TOKEN }}
+        run: bundle exec rake

data/.rubocop.yml

@@ -40,3 +40,9 @@ Style/MethodCallWithArgsParentheses:
 
 Style/MethodCallWithoutArgsParentheses:
     Enabled: false
+
+Naming/FileName:
+    Enabled: false
+
+Naming/PredicateName:
+    Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.2.2

data/README.md

@@ -1,8 +1,8 @@
 # [<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)
 
@@ -10,10 +10,12 @@ Check all the data we have for your IP address [here](https://ipinfo.io/what-is-
 
 ### 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)
 
+The library also supports the Lite API, see the [Lite API section](#lite-api) for more info.
+
 #### Installation
 
 Add this line to your application's Gemfile:
@@ -33,30 +35,44 @@ Or install it yourself as:
 #### 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)
+details_v6 = handler.details_v6() # to get details from ipinfo's IPv6 host
 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
+The `IPinfo.details()` and `IPinfo.details_v6()` methods accept 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()
+details_v6 = handler.details_v6() # to get details from ipinfo's IPv6 host
 city = details.city # "Emeryville"
 loc = details.loc # 37.8342,-122.2900
 ```
@@ -74,7 +90,7 @@ handler = IPinfo::create(access_token)
 
 #### Details Data
 
-`handler.details()` will return a `Response` object that contains all fields
+`handler.details()` and `handler.details_v6` will return a `Response` object that contains all fields
 listed in the [IPinfo developerdocs](https://ipinfo.io/developers/responses#full-response)
 with a few minor additions. Properties can be accessed directly.
 
@@ -84,18 +100,74 @@ hostname = details.hostname # cpe-104-175-221-247.socal.res.rr.com
 
 ##### 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.
+`details.country_name` will return the country name, as defined by `DEFAULT_COUNTRY_LIST`
+within `countriesData.rb`. See below for instructions on changing that file for use
+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 defined by `DEFAULT_EU_COUNTRIES_LIST` within `countriesData.rb`.
+
+```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.
+
+##### Country Flag
+
+`details.country_flag` will return `emoji` and `unicode` of a country's flag, as defined by
+`DEFAULT_COUNTRIES_FLAG_LIST` within `countriesData.rb`.
+
+```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 defined by
+`DEFAULT_COUNTRIES_CURRENCIES_LIST` within `countriesData.rb`.
+
+```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.
+
+##### Continent
+
+`details.continent` will return `code` and `name` of the continent, as defined by
+`DEFAULT_CONTINENT_LIST` within `countriesData.rb`.
+
+```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.
+
 #### 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.
 
@@ -145,6 +217,23 @@ details.all = {
 }
 ```
 
+### Lite API
+
+The library gives the possibility to use the [Lite API](https://ipinfo.io/developers/lite-api) too, authentication with your token is still required.
+
+The returned details are slightly different from the Core API.
+
+```ruby
+require 'ipinfo_lite'
+
+access_token = '123456789abc'
+handler = IPinfoLite::create(access_token)
+
+details = handler.details('8.8.8.8')
+details.country_code # US
+details.country # United States
+```
+
 #### Caching
 
 In-memory caching of `details` data is provided by default via the
@@ -203,24 +292,22 @@ When looking up an IP address, the response object includes a
 American English. It is possible to return the country name in other languages
 by setting the `countries` setting when creating the `IPinfo` object.
 
-The file must be a `.json` file with the following structure:
-
 ```
 {
- "BD": "Bangladesh",
- "BE": "Belgium",
- "BF": "Burkina Faso",
- "BG": "Bulgaria"
+ "BD" => "Bangladesh",
+ "BE" => "Belgium",
+ "BF" => "Burkina Faso",
+ "BG" => "Bulgaria"
  ...
 }
 ```
 
 ### 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.
 
 [![image](https://avatars3.githubusercontent.com/u/15721521?s=128&u=7bb7dde5c4991335fb234e68a30971944abc6bf3&v=4)](https://ipinfo.io/)

data/ipinfo.gemspec

@@ -9,24 +9,22 @@ Gem::Specification.new do |spec|
     spec.name = 'IPinfo'
     spec.version = IPinfo::VERSION
     spec.required_ruby_version = '>= 2.5.0'
-    spec.authors       = ['Stanislav K, James Timmins', 'Uman Shahzad']
-    spec.email         = ['jameshtimmins@gmail.com', 'uman@mslm.io']
+    spec.authors       = ['IPinfo releases']
+    spec.email         = ['releases@ipinfo.io']
 
     spec.summary       = ' This is a ruby wrapper for http://ipinfo.io. '
     spec.description   = ' This is a ruby wrapper for http://ipinfo.io. '
     spec.homepage      = 'https://ipinfo.io'
 
-    # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
-    # 'allowed_push_host' to allow pushing to a single host or delete this
-    # section to allow pushing to any host.
-    if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = "http://mygemserver.com'"
-    else
-        raise 'RubyGems 2.0 or newer is required to protect against ' \
-          'public gem pushes.'
-    end
+    spec.add_runtime_dependency 'faraday', '~> 2.0'
+    # add development dependency to test against faraday adapters that are been moved out the gem
+    spec.add_development_dependency 'async-http-faraday'
+    spec.add_development_dependency 'faraday-net_http_persistent', '~> 2.0'
+    spec.add_development_dependency 'faraday-typhoeus', '~> 1.0'
+    spec.add_development_dependency 'faraday-patron', '~> 2.0'
+    spec.add_development_dependency 'faraday-httpclient', '~> 2.0'
+    spec.add_development_dependency 'faraday-excon', '~> 2.1'
 
-    spec.add_runtime_dependency 'faraday', '~> 1.0'
     spec.add_runtime_dependency 'json', '~> 2.1'
     spec.add_runtime_dependency 'lru_redux', '~> 1.1'
 

data/lib/ipinfo/adapter.rb

@@ -3,9 +3,136 @@
 require 'faraday'
 require 'cgi'
 require 'ipinfo/mod'
+require_relative './version.rb'
 
 class IPinfo::Adapter
-    HOST = 'ipinfo.io'
+    HOST = 'https://ipinfo.io'
+    HOST_V6 = 'https://v6.ipinfo.io'
+
+    attr_reader :conn
+
+    def initialize(token = nil, adapter = :net_http)
+        @token = token
+        @conn = connection(adapter)
+    end
+
+    def get(uri, host_type= :v4)
+        host = (host_type == :v6) ? HOST_V6 : HOST
+        @conn.get(host + uri) do |req|
+            default_headers.each_pair do |key, value|
+                req.headers[key] = value
+            end
+            req.params['token'] = CGI.escape(token) if token
+        end
+    end
+
+    def post(uri, body, timeout = 2)
+        @conn.post(HOST + uri) do |req|
+            req.body = body
+            req.options.timeout = timeout
+        end
+    end
+
+    private
+
+    attr_reader :token
+
+    def connection(adapter)
+        Faraday.new() do |conn|
+            conn.adapter(adapter)
+        end
+    end
+
+    def default_headers
+        headers = {
+            'User-Agent' => "IPinfoClient/Ruby/#{IPinfo::VERSION}",
+            'Accept' => 'application/json'
+        }
+        headers['Authorization'] = "Bearer #{CGI.escape(token)}" if token
+        headers
+    end
+end
+
+class IPinfo::AdapterLite
+    HOST = 'https://api.ipinfo.io/lite/'
+
+    attr_reader :conn
+
+    def initialize(token = nil, adapter = :net_http)
+        @token = token
+        @conn = connection(adapter)
+    end
+
+    def get(uri)
+        @conn.get(HOST + uri) do |req|
+            default_headers.each_pair do |key, value|
+                req.headers[key] = value
+            end
+            req.params['token'] = CGI.escape(token) if token
+        end
+    end
+
+    private
+
+    attr_reader :token
+
+    def connection(adapter)
+        Faraday.new() do |conn|
+            conn.adapter(adapter)
+        end
+    end
+
+    def default_headers
+        headers = {
+            'User-Agent' => "IPinfoClient/Ruby/#{IPinfo::VERSION}",
+            'Accept' => 'application/json'
+        }
+        headers['Authorization'] = "Bearer #{CGI.escape(token)}" if token
+        headers
+    end
+end
+
+class IPinfo::AdapterCore
+    HOST = 'https://api.ipinfo.io/lookup'
+
+    attr_reader :conn
+
+    def initialize(token = nil, adapter = :net_http)
+        @token = token
+        @conn = connection(adapter)
+    end
+
+    def get(uri)
+        @conn.get(HOST + uri) do |req|
+            default_headers.each_pair do |key, value|
+                req.headers[key] = value
+            end
+            req.params['token'] = CGI.escape(token) if token
+        end
+    end
+
+    private
+
+    attr_reader :token
+
+    def connection(adapter)
+        Faraday.new() do |conn|
+            conn.adapter(adapter)
+        end
+    end
+
+    def default_headers
+        headers = {
+            'User-Agent' => "IPinfoClient/Ruby/#{IPinfo::VERSION}",
+            'Accept' => 'application/json'
+        }
+        headers['Authorization'] = "Bearer #{CGI.escape(token)}" if token
+        headers
+    end
+end
+
+class IPinfo::AdapterPlus
+    HOST = 'https://api.ipinfo.io/lookup'
 
     attr_reader :conn
 
@@ -15,7 +142,7 @@ class IPinfo::Adapter
     end
 
     def get(uri)
-        @conn.get(uri) do |req|
+        @conn.get(HOST + uri) do |req|
             default_headers.each_pair do |key, value|
                 req.headers[key] = value
             end
@@ -28,14 +155,14 @@ class IPinfo::Adapter
     attr_reader :token
 
     def connection(adapter)
-        Faraday.new(url: "https://#{HOST}") do |conn|
+        Faraday.new() do |conn|
             conn.adapter(adapter)
         end
     end
 
     def default_headers
         headers = {
-            'User-Agent' => 'IPinfoClient/Ruby/1.0',
+            'User-Agent' => "IPinfoClient/Ruby/#{IPinfo::VERSION}",
             'Accept' => 'application/json'
         }
         headers['Authorization'] = "Bearer #{CGI.escape(token)}" if token