IPinfo 2.2.4 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea1d36760a8a4b60cdc8f48946859ba2cf05d71d7f2c7efe11c7333563a9cb8e
-  data.tar.gz: 49fef88c8e2df4c69006ef76b9d7ad86028dc0cc621e4cb4d529cad060f9802f
+  metadata.gz: d123a1cdf07b3693cc28ea77d42da4d9984cbdc8676ab235c5a837d8cfb2d272
+  data.tar.gz: e322a8feefc0bb770b0318ecb66967c0ab50e0171bf5ca5d1921deb4ab79bdd3
 SHA512:
-  metadata.gz: 1465262219a3a9d5a30d387f63fee35721bd667555eff9b6b25d131b1d58093a70087bf51bf6842bf22331573ef796e7a8ad3689539882976783f18e2233b244
-  data.tar.gz: 97456bb0d405e97448bdb1f6b897914a1aebd749b8f348457e5447630e36a17d420e3e35e04eef565eef946cc4a90475e7c483b366ccd88a8f5d680201e0c1a3
+  metadata.gz: 18d5583c9b890e82dd229ee7138a7f956ed4ce8e32267cf0b0b2eb61417f85792963a83711e7756f572868cfbeefdf828460c9c547c27578d9d5d47bef909ecf
+  data.tar.gz: d404fa4474c572d6c0e1076ecd4c460224db7393ebb9e4c1344f73ecbe4b96d92fdcd0d4f7ce2d8b5f51372c85ad2859ca5cd3328cba1b0d2070808dd17f0cfa

data/.github/workflows/cd_rubygems.yaml

@@ -3,13 +3,15 @@ name: Release package to rubygems.org
 on:
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 jobs:
   publish:
-
     runs-on: ubuntu-latest
 
+    permissions:
+      id-token: write
+
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -25,13 +27,11 @@ jobs:
 
       - name: Run tests
         run: bundle exec rake
-        env: 
+        env:
           IPINFO_TOKEN: ${{ secrets.IPINFO_TOKEN }}
 
       - name: Build
         run: gem build *.gemspec
 
       - name: Publish
-        run: gem push *.gem
-        env:
-          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+        uses: rubygems/release-gem@v1

data/.github/workflows/unittest.yaml

@@ -1,7 +1,12 @@
 name: Unit Tests
 
 on:
+  push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 
 permissions:
   contents: read
@@ -12,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.2', '3.1', '3.0', '2.7', '2.6']
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
       
     steps:
       - name: Checkout

data/README.md

@@ -14,6 +14,8 @@ You'll need an IPinfo API access token, which you can get by signing up for a fr
 
 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:
@@ -215,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

data/ipinfo.gemspec

@@ -9,8 +9,8 @@ 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. '

data/lib/ipinfo/adapter.rb

@@ -52,3 +52,42 @@ class IPinfo::Adapter
         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

data/lib/ipinfo/mod.rb

@@ -2,3 +2,6 @@
 
 module IPinfo
 end
+
+module IPinfoLite
+end

data/lib/ipinfo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IPinfo
-    VERSION = '2.2.4'
+    VERSION = '2.3.1'
 end

data/lib/ipinfo.rb

@@ -119,6 +119,7 @@ class IPinfo::IPinfo
 
     def request_details(ip_address = nil, host_type)
         if isBogon(ip_address)
+            details = {}
             details[:ip] = ip_address
             details[:bogon] = true
             details[:ip_address] = IPAddr.new(ip_address)

data/lib/ipinfo_lite.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'ipinfo/adapter'
+require 'ipinfo/cache/default_cache'
+require 'ipinfo/errors'
+require 'ipinfo/response'
+require_relative 'ipinfo/ipAddressMatcher'
+require_relative 'ipinfo/countriesData'
+require 'ipaddr'
+require 'cgi'
+
+module IPinfoLite
+    include CountriesData
+    DEFAULT_CACHE_MAXSIZE = 4096
+    DEFAULT_CACHE_TTL = 60 * 60 * 24
+    RATE_LIMIT_MESSAGE = 'To increase your limits, please review our ' \
+                         'paid plans at https://ipinfo.io/pricing'
+    # Base URL to get country flag image link.
+    # "PK" -> "https://cdn.ipinfo.io/static/images/countries-flags/PK.svg"
+    COUNTRY_FLAGS_URL = 'https://cdn.ipinfo.io/static/images/countries-flags/'
+
+    class << self
+        def create(access_token = nil, settings = {})
+            IPinfo::IPinfoLite.new(access_token, settings)
+        end
+    end
+end
+
+class IPinfo::IPinfoLite
+    include IPinfoLite
+    attr_accessor :access_token, :countries, :httpc
+
+    def initialize(access_token = nil, settings = {})
+        @access_token = access_token
+        @httpc = IPinfo::AdapterLite.new(access_token, httpc || :net_http)
+
+        maxsize = settings.fetch('maxsize', DEFAULT_CACHE_MAXSIZE)
+        ttl = settings.fetch('ttl', DEFAULT_CACHE_TTL)
+        @cache = settings.fetch('cache', IPinfo::DefaultCache.new(ttl, maxsize))
+        @countries = settings.fetch('countries', DEFAULT_COUNTRY_LIST)
+        @eu_countries = settings.fetch('eu_countries', DEFAULT_EU_COUNTRIES_LIST)
+        @countries_flags = settings.fetch('countries_flags', DEFAULT_COUNTRIES_FLAG_LIST)
+        @countries_currencies = settings.fetch('countries_currencies', DEFAULT_COUNTRIES_CURRENCIES_LIST)
+        @continents = settings.fetch('continents', DEFAULT_CONTINENT_LIST)
+    end
+
+    def details(ip_address = nil)
+        details_base(ip_address)
+    end
+
+    def request_details(ip_address = nil)
+        if ip_address && ip_address != 'me' && isBogon(ip_address)
+            details[:ip] = ip_address
+            details[:bogon] = true
+            details[:ip_address] = IPAddr.new(ip_address)
+
+            return details
+        end
+
+        res = @cache.get(cache_key(ip_address))
+        return res unless res.nil?
+
+        ip_address ||= 'me'
+        response = @httpc.get(escape_path(ip_address))
+
+        if response.status.eql?(429)
+            raise RateLimitError,
+                  RATE_LIMIT_MESSAGE
+        end
+
+        details = JSON.parse(response.body, symbolize_names: true)
+        @cache.set(cache_key(ip_address), details)
+        details
+    end
+
+    def details_base(ip_address)
+        details = request_details(ip_address)
+        if details.key? :country_code
+            details[:country_name] =
+                @countries.fetch(details.fetch(:country_code), nil)
+            details[:is_eu] =
+                @eu_countries.include?(details.fetch(:country_code))
+            details[:country_flag] =
+                @countries_flags.fetch(details.fetch(:country_code), nil)
+            details[:country_currency] =
+                @countries_currencies.fetch(details.fetch(:country_code), nil)
+            details[:continent] =
+                @continents.fetch(details.fetch(:country_code), nil)
+            details[:country_flag_url] = "#{COUNTRY_FLAGS_URL}#{details.fetch(:country_code)}.svg"
+        end
+
+        if details.key? :ip
+            details[:ip_address] =
+                IPAddr.new(details.fetch(:ip))
+        end
+
+        IPinfo::Response.new(details)
+    end
+
+    def isBogon(ip)
+        if ip.nil?
+          return false
+        end
+
+        matcher_object = IPinfo::IpAddressMatcher.new(ip)
+        matcher_object.matches
+    end
+
+    def escape_path(ip)
+        ip ? "/#{CGI.escape(ip)}" : '/'
+    end
+
+    def cache_key(ip)
+        "1:#{ip}"
+    end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: IPinfo
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.3.1
 platform: ruby
 authors:
-- Stanislav K, James Timmins
-- Uman Shahzad
-autorequire: 
+- IPinfo releases
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-04 00:00:00.000000000 Z
+date: 2025-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,8 +138,7 @@ dependencies:
         version: '1.1'
 description: " This is a ruby wrapper for http://ipinfo.io. "
 email:
-- jameshtimmins@gmail.com
-- uman@mslm.io
+- releases@ipinfo.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -168,10 +166,11 @@ files:
 - lib/ipinfo/mod.rb
 - lib/ipinfo/response.rb
 - lib/ipinfo/version.rb
+- lib/ipinfo_lite.rb
 homepage: https://ipinfo.io
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -187,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: This is a ruby wrapper for http://ipinfo.io.
 test_files: []