IPinfo 1.0.1 → 1.1.0

data/lib/ipinfo.rb

@@ -8,14 +8,27 @@ require 'ipinfo/errors'
 require 'ipinfo/response'
 require 'ipinfo/version'
 require 'json'
+require_relative 'ipinfo/ipAddressMatcher'
 
 module IPinfo
     DEFAULT_CACHE_MAXSIZE = 4096
     DEFAULT_CACHE_TTL = 60 * 60 * 24
     DEFAULT_COUNTRY_FILE = File.join(File.dirname(__FILE__),
                                      'ipinfo/countries.json')
+    DEFAULT_EU_COUNTRIES_FILE = File.join(File.dirname(__FILE__),
+                                     'ipinfo/eu.json')
+    DEFAULT_COUNTRIES_FLAG_FILE = File.join(File.dirname(__FILE__),
+                                     'ipinfo/flags.json')
+    DEFAULT_COUNTRIES_CURRENCIES_FILE = File.join(File.dirname(__FILE__),
+                                     'ipinfo/currency.json')
+    DEFAULT_CONTINENT_FILE = File.join(File.dirname(__FILE__),
+                                     'ipinfo/continent.json')
     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 = {})
@@ -35,8 +48,16 @@ class IPinfo::IPinfo
         maxsize = settings.fetch('maxsize', DEFAULT_CACHE_MAXSIZE)
         ttl = settings.fetch('ttl', DEFAULT_CACHE_TTL)
         @cache = settings.fetch('cache', DefaultCache.new(ttl, maxsize))
-        @countries = prepare_countries(settings.fetch('countries',
+        @countries = prepare_json(settings.fetch('countries',
                                                       DEFAULT_COUNTRY_FILE))
+        @eu_countries = prepare_json(settings.fetch('eu_countries',
+                                                      DEFAULT_EU_COUNTRIES_FILE))
+        @countries_flags = prepare_json(settings.fetch('countries_flags',
+                                                      DEFAULT_COUNTRIES_FLAG_FILE))
+        @countries_currencies = prepare_json(settings.fetch('countries_currencies',
+                                                      DEFAULT_COUNTRIES_CURRENCIES_FILE))
+        @continents = prepare_json(settings.fetch('continents',
+                                                      DEFAULT_CONTINENT_FILE))
     end
 
     def details(ip_address = nil)
@@ -44,6 +65,15 @@ class IPinfo::IPinfo
         if details.key? :country
             details[:country_name] =
                 @countries.fetch(details.fetch(:country), nil)
+            details[:is_eu] =
+                @eu_countries.include?(details.fetch(:country))
+            details[:country_flag] =
+                @countries_flags.fetch(details.fetch(:country), nil)
+            details[:country_currency] =
+                @countries_currencies.fetch(details.fetch(:country), nil)
+            details[:continent] = 
+                @continents.fetch(details.fetch(:country), nil)
+            details[:country_flag_url] = COUNTRY_FLAGS_URL + details.fetch(:country) + ".svg"
         end
 
         if details.key? :ip
@@ -60,10 +90,73 @@ class IPinfo::IPinfo
         Response.new(details)
     end
 
+    def get_map_url(ips)
+        if !ips.kind_of?(Array)
+            return JSON.generate({:error => 'Invalid input. Array required!'})
+        end
+        if ips.length > 500000
+            return JSON.generate({:error => 'No more than 500,000 ips allowed!'})
+        end
+
+        json_ips = JSON.generate({:ips => ips})
+        res = @httpc.post('/tools/map', json_ips)
+
+        obj = JSON.parse(res.body)
+        obj['reportUrl']
+    end
+
+    def batch_requests(url_array, api_token)
+        result = Hash.new
+        lookup_ips = []
+
+        url_array.each { |url|
+            ip = @cache.get(cache_key(url))
+
+            unless ip.nil?
+                result.store(url, ip)
+            else
+                lookup_ips << url
+            end
+        }
+
+        if lookup_ips.empty?
+            return result
+        end
+
+        begin
+            lookup_ips.each_slice(1000){ |ips|
+                json_arr = JSON.generate(lookup_ips)
+                res = @httpc.post("/batch?token=#{api_token}", json_arr, 5)
+
+                raise StandardError, "Request Quota Exceeded" if res.status == 429
+
+                data = JSON.parse(res.body)
+                data.each { |key, val|
+                    @cache.set(cache_key(key), val)
+                }
+
+                result.merge!(data)
+            }
+
+        rescue StandardError => e
+            return e.message
+        end
+
+        result
+    end
+
     protected
 
     def request_details(ip_address = nil)
-        res = @cache.get(ip_address)
+        if 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?
 
         response = @httpc.get(escape_path(ip_address))
@@ -74,7 +167,7 @@ class IPinfo::IPinfo
         end
 
         details = JSON.parse(response.body, symbolize_names: true)
-        @cache.set(ip_address, details)
+        @cache.set(cache_key(ip_address), details)
         details
     end
 
@@ -86,14 +179,27 @@ class IPinfo::IPinfo
                  end
     end
 
-    def prepare_countries(filename)
+    def prepare_json(filename)
         file = File.read(filename)
         JSON.parse(file)
     end
 
     private
 
+    def isBogon(ip)
+        if ip.nil?
+            return false
+        end
+
+        matcher_object = 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: IPinfo
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Stanislav K, James Timmins
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -62,10 +62,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/cd_rubygems.yaml"
+- ".github/workflows/unittest.yaml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -77,8 +78,13 @@ files:
 - lib/ipinfo/adapter.rb
 - lib/ipinfo/cache/cache_interface.rb
 - lib/ipinfo/cache/default_cache.rb
+- lib/ipinfo/continent.json
 - lib/ipinfo/countries.json
+- lib/ipinfo/currency.json
 - lib/ipinfo/errors.rb
+- lib/ipinfo/eu.json
+- lib/ipinfo/flags.json
+- lib/ipinfo/ipAddressMatcher.rb
 - lib/ipinfo/mod.rb
 - lib/ipinfo/response.rb
 - lib/ipinfo/version.rb

data/.travis.yml

@@ -1,11 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-
-before_install:
-- gem install bundler