ip2geo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cdf86cb50c5d08c734ea15c78ec62d0f218dae67ccdb074b9b889fb0c77681f
-  data.tar.gz: ed6420fd62687669cf430d6525b6415326a595cd60e4fae6a65ce0aae268e182
+  metadata.gz: 9ee64a44d70af371c8e118e89eeb1d6f975f289835c67dfc1695e7e750985df1
+  data.tar.gz: 16f87bf015c8f85a14b51e22b8e336838d9cb9f12ca3ea2b125dd19f7d368ceb
 SHA512:
-  metadata.gz: 2a7f9f99b598e068ccff78fb2ba2199835a2db6ee086f7871228fcd8e785d321b72b7187bc195a77589acbb6a7f7f170e1d3410044355b913d9e41f2766ac0e0
-  data.tar.gz: 190301f6be0572c93262611ec8cc2ee6f4ec631c9c810755777076daa379bc87ab22eaa5f543ef959584acd46c4ab54f3529d8c6218c1acb0c70917c55bc40c7
+  metadata.gz: bbcb5312ccb091395e24a694deb5c4eb1118c66caf00cbd3c993d47146e29529f41d886b5aff731208df87a0de5fc64ca5600cfe0e48feb6da9da6550b4a4c81
+  data.tar.gz: 10502431e5289199d0e4eadbd31fb41e46707534233dbe64574e6c56d6dcf14edc0d50a8461a57b3423e18d4388166eb46c3c5bc6dea73a6880359db3d9025ae

data/LICENSE

@@ -3,4 +3,4 @@ Copyright (c) 2024 Ip2Geo. All rights reserved.
 This software is proprietary and confidential. Unauthorized copying, distribution,
 modification, or use of this software, via any medium, is strictly prohibited.
 
-No license, express or implied, is granted to any person or entity for any purpose.
+No license, express or implied, is granted to any person or entity for any purpose.

data/README.md

@@ -1,7 +1,7 @@
 <div align='center'>
    <a href='https://axios-http.com'>
         <img 
-            src='https://cdn-prod.ip2geo.dev/assets/npm/generals/ip2geo.svg' 
+            src='https://cdn-prod.ip2geo.dev/assets/ruby/generals/ip2geo.svg' 
             alt='Ip2Geo Logo' 
         />
    </a>
@@ -10,7 +10,7 @@
 </div>
 
 <p align='center'>
-    Your go-to IP-to-Geo cloud service — fast, accurate, and built for developers. Start free with 2,000 monthly stored conversions.
+    Your go-to IP-to-Geo cloud service — fast, accurate, and built for developers. Start free with 1,000 monthly stored conversions.
 </p>
 
 <p align='center'>

data/ip2geo.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
     spec.name          = 'ip2geo'
-    spec.version       = '0.0.1'
+    spec.version       = '0.0.2'
     spec.authors       = ['Ip2Geo']
     spec.email         = ['support@ip2geo.dev']
 

data/lib/ip2geo/data/constants.rb

@@ -44,75 +44,42 @@ module Ip2Geo
     }.freeze
 
     SELECT = {
-      CONVERSION: {
-        ID: 'id',
-        UNIQUE_ID: 'uniqueId',
-        DATA: 'data',
-        STATUS: 'status',
-        STARTED_AT: 'startedAt',
-        COMPLETED_AT: 'completedAt',
-        CREATED_AT: 'createdAt',
-        CREDITED: 'credited',
-        CONVERT_ONLY: 'convertOnly'
-      }.freeze,
-      DATA: {
-        IP: 'data.ip',
-        TYPE: 'data.type',
-        IS_EU: 'data.is_eu',
-        CONTINENT: {
-          NAME: 'data.continent.name',
-          CODE: 'data.continent.code',
-          GEONAME_ID: 'data.continent.geoname_id',
-          COUNTRY: {
-            NAME: 'data.continent.country.name',
-            CODE: 'data.continent.country.code',
-            GEONAME_ID: 'data.continent.country.geoname_id',
-            PHONE_CODE: 'data.continent.country.phone_code',
-            CAPITAL: 'data.continent.country.capital',
-            TLD: 'data.continent.country.tld',
-            SUBDIVISION: {
-              NAME: 'data.continent.country.subdivision.name',
-              CODE: 'data.continent.country.subdivision.code'
-            }.freeze,
-            CITY: {
-              NAME: 'data.continent.country.city.name',
-              GEONAME_ID: 'data.continent.country.city.geoname_id',
-              LATITUDE: 'data.continent.country.city.latitude',
-              LONGITUDE: 'data.continent.country.city.longitude',
-              ACCURACY_RADIUS: 'data.continent.country.city.accuracy_radius',
-              METRO_CODE: 'data.continent.country.city.metro_code',
-              POSTAL_CODE: 'data.continent.country.city.postal_code',
-              TIMEZONE: {
-                NAME: 'data.continent.country.city.timezone.name',
-                TIME_NOW: 'data.continent.country.city.timezone.time_now'
-              }.freeze
-            }.freeze,
-            FLAG: {
-              IMG: 'data.continent.country.flag.img',
-              EMOJI: 'data.continent.country.flag.emoji',
-              EMOJI_UNICODE: 'data.continent.country.flag.emoji_unicode'
-            }.freeze,
-            CURRENCY: {
-              NAME: 'data.continent.country.currency.name',
-              CODE: 'data.continent.country.currency.code',
-              SYMBOL: 'data.continent.country.currency.symbol'
-            }.freeze
-          }.freeze
-        }.freeze,
-        REGISTERED_COUNTRY: {
-          NAME: 'data.registered_country.name',
-          CODE: 'data.registered_country.code',
-          GEONAME_ID: 'data.registered_country.geoname_id'
-        }.freeze,
-        ASN: {
-          NUMBER: 'data.asn.number',
-          NAME: 'data.asn.name'
-        }.freeze,
-        COMPLETION_TIME: {
-          MILISECONDS: 'data.completion_time.miliseconds',
-          SECONDS: 'data.completion_time.seconds'
-        }.freeze
-      }.freeze
+      IP: 'ip',
+      TYPE: 'type',
+      IS_EU: 'is_eu',
+      CONTINENT_NAME: 'continent.name',
+      CONTINENT_CODE: 'continent.code',
+      CONTINENT_GEONAME_ID: 'continent.geoname_id',
+      COUNTRY_NAME: 'continent.country.name',
+      COUNTRY_CODE: 'continent.country.code',
+      COUNTRY_GEONAME_ID: 'continent.country.geoname_id',
+      COUNTRY_PHONE_CODE: 'continent.country.phone_code',
+      COUNTRY_CAPITAL: 'continent.country.capital',
+      COUNTRY_TLD: 'continent.country.tld',
+      SUBDIVISION_NAME: 'continent.country.subdivision.name',
+      SUBDIVISION_CODE: 'continent.country.subdivision.code',
+      CITY_NAME: 'continent.country.city.name',
+      CITY_GEONAME_ID: 'continent.country.city.geoname_id',
+      CITY_LATITUDE: 'continent.country.city.latitude',
+      CITY_LONGITUDE: 'continent.country.city.longitude',
+      CITY_ACCURACY_RADIUS: 'continent.country.city.accuracy_radius',
+      CITY_METRO_CODE: 'continent.country.city.metro_code',
+      CITY_POSTAL_CODE: 'continent.country.city.postal_code',
+      TIMEZONE_NAME: 'continent.country.city.timezone.name',
+      TIMEZONE_TIME_NOW: 'continent.country.city.timezone.time_now',
+      FLAG_IMG: 'continent.country.flag.img',
+      FLAG_EMOJI: 'continent.country.flag.emoji',
+      FLAG_EMOJI_UNICODE: 'continent.country.flag.emoji_unicode',
+      CURRENCY_NAME: 'continent.country.currency.name',
+      CURRENCY_CODE: 'continent.country.currency.code',
+      CURRENCY_SYMBOL: 'continent.country.currency.symbol',
+      REGISTERED_COUNTRY_NAME: 'registered_country.name',
+      REGISTERED_COUNTRY_CODE: 'registered_country.code',
+      REGISTERED_COUNTRY_GEONAME_ID: 'registered_country.geoname_id',
+      ASN_NUMBER: 'asn.number',
+      ASN_NAME: 'asn.name',
+      COMPLETION_TIME_MILISECONDS: 'completion_time.miliseconds',
+      COMPLETION_TIME_SECONDS: 'completion_time.seconds'
     }.freeze
   end
 end

data/lib/ip2geo/data/states.rb

@@ -4,16 +4,20 @@ module Ip2Geo
   module Data
     class State
       class << self
-        attr_accessor :auth_key, :version_update_message, :is_version_checked
+        attr_accessor :auth_key, :version_update_message, :is_version_checked,
+                      :cache, :cache_max_size, :cache_ttl
 
         def reset!
           @auth_key = nil
           @version_update_message = true
           @is_version_checked = false
+          @cache = true
+          @cache_max_size = 1000
+          @cache_ttl = 300
         end
       end
 
       reset!
     end
   end
-end
+end

data/lib/ip2geo/helpers/cache.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Ip2Geo
+  module Helpers
+    class Cache
+      @mutex = Mutex.new
+
+      class << self
+        def get(key)
+          @mutex.synchronize do
+            entry = store[key]
+            return nil unless entry
+
+            if expired?(entry)
+              store.delete(key)
+              access_order.delete(key)
+              return nil
+            end
+
+            update_access_order(key)
+            entry[:data]
+          end
+        end
+
+        def set(key, data)
+          @mutex.synchronize do
+            store[key] = { data: data, timestamp: Time.now.to_f }
+            update_access_order(key)
+            evict_if_needed
+          end
+        end
+
+        def clear
+          @mutex.synchronize do
+            @store = {}
+            @access_order = []
+          end
+        end
+
+        private
+
+        def store
+          @store ||= {}
+        end
+
+        def access_order
+          @access_order ||= []
+        end
+
+        def update_access_order(key)
+          access_order.delete(key)
+          access_order.push(key)
+        end
+
+        def evict_if_needed
+          while store.size > Data::State.cache_max_size && access_order.any?
+            oldest = access_order.shift
+            store.delete(oldest) if oldest
+          end
+        end
+
+        def expired?(entry)
+          (Time.now.to_f - entry[:timestamp]) > Data::State.cache_ttl
+        end
+      end
+    end
+  end
+end

data/lib/ip2geo/methods/convert_ip.rb

@@ -8,12 +8,9 @@ module Ip2Geo
         #
         # @param options [Hash] The options for the conversion
         # @option options [String] :ip The IP address to retrieve geo information for (required)
-        # @option options [Boolean] :convert_only If true, stores minimal data and charges $0.001 per conversion
-        #   instead of $0.0005 (default: false)
         # @return [Hash, nil] The API response containing geo data, or nil if the request fails
         def call(options = {})
           ip = options[:ip]
-          convert_only = options.fetch(:convert_only, false)
 
           unless ip
             return error_response(
@@ -29,7 +26,28 @@ module Ip2Geo
             )
           end
 
-          url = "#{Data::API_ENDPOINT}#{Data::ENDPOINTS[:CONVERT]}?ip=#{ip}&convertOnly=#{convert_only}"
+          url = "#{Data::API_ENDPOINT}#{Data::ENDPOINTS[:CONVERT]}?ip=#{ip}"
+
+          if Data::State.cache
+            cache_key = "convert:#{ip}"
+            cached = Helpers::Cache.get(cache_key)
+
+            if cached
+              Thread.new do
+                fresh = Helpers::Http.request(url)
+                Helpers::Cache.set(cache_key, fresh) if fresh && fresh['success']
+              rescue StandardError
+                # silently ignore background refresh errors
+              end
+
+              return cached
+            end
+
+            response = Helpers::Http.request(url)
+            Helpers::Cache.set(cache_key, response) if response && response['success']
+            return response
+          end
+
           Helpers::Http.request(url)
         rescue StandardError => e
           warn "[Ip2Geo::ConvertIP] Error: #{e.message}"
@@ -53,4 +71,4 @@ module Ip2Geo
       end
     end
   end
-end
+end

data/lib/ip2geo/methods/convert_ips.rb

@@ -8,12 +8,9 @@ module Ip2Geo
         #
         # @param options [Hash] The options for the conversion
         # @option options [Array<String>] :ips An array of IP addresses to retrieve geo information for (required)
-        # @option options [Boolean] :convert_only If true, stores minimal data and charges $0.001 per conversion
-        #   instead of $0.0005 (default: false)
         # @return [Hash, nil] The API response containing geo data for all IPs, or nil if the request fails
         def call(options = {})
           ips = options[:ips]
-          convert_only = options.fetch(:convert_only, false)
 
           unless ips.is_a?(Array) && !ips.empty?
             return error_response(
@@ -45,7 +42,27 @@ module Ip2Geo
           end
 
           url = "#{Data::API_ENDPOINT}#{Data::ENDPOINTS[:CONVERT]}"
-          body = { ips: ips, convertOnly: convert_only }
+          body = { ips: ips }
+
+          if Data::State.cache
+            cache_key = "convert-multi:#{ips.sort.join(',')}"
+            cached = Helpers::Cache.get(cache_key)
+
+            if cached
+              Thread.new do
+                fresh = Helpers::Http.request(url, body)
+                Helpers::Cache.set(cache_key, fresh) if fresh && fresh['success']
+              rescue StandardError
+                # silently ignore background refresh errors
+              end
+
+              return cached
+            end
+
+            response = Helpers::Http.request(url, body)
+            Helpers::Cache.set(cache_key, response) if response && response['success']
+            return response
+          end
 
           Helpers::Http.request(url, body)
         rescue StandardError => e
@@ -70,4 +87,4 @@ module Ip2Geo
       end
     end
   end
-end
+end

data/lib/ip2geo/methods/get_conversion.rb

@@ -21,7 +21,7 @@ module Ip2Geo
           end
 
           params = []
-          params << "select=#{select.join(',')}" if select.is_a?(Array) && !select.empty?
+          params << "select=#{select.map { |f| "data.#{f}" }.join(',')}" if select.is_a?(Array) && !select.empty?
 
           query_string = params.empty? ? '' : "?#{params.join('&')}"
           url = "#{Data::API_ENDPOINT}#{Data::ENDPOINTS[:CONVERSIONS][:GET]}#{query_string}"

data/lib/ip2geo/methods/get_conversions.rb

@@ -21,7 +21,7 @@ module Ip2Geo
           end
 
           params = []
-          params << "select=#{select.join(',')}" if select.is_a?(Array) && !select.empty?
+          params << "select=#{select.map { |f| "data.#{f}" }.join(',')}" if select.is_a?(Array) && !select.empty?
 
           query_string = params.empty? ? '' : "?#{params.join('&')}"
           url = "#{Data::API_ENDPOINT}#{Data::ENDPOINTS[:CONVERSIONS][:GET]}#{query_string}"

data/lib/ip2geo/methods/init.rb

@@ -9,11 +9,55 @@ module Ip2Geo
         # @param key [String] The API key used to authenticate with Ip2Geo
         # @param options [Hash] Optional configuration
         # @option options [Boolean] :version_update_message Whether to display version update messages (default: true)
+        # @option options [Boolean] :cache Whether to enable caching for successful conversions (default: true)
+        # @option options [Integer] :cache_max_size Maximum cached entries, min: 10, max: 50000 (default: 1000)
+        # @option options [Integer] :cache_ttl Cache TTL in seconds, min: 30, max: 86400 (default: 300)
         # @return [Boolean] Whether the initialization was successful
         def call(key, options = {})
           Data::State.auth_key = key
           Data::State.version_update_message = options.fetch(:version_update_message, true)
 
+          if options.key?(:cache)
+            unless options[:cache] == true || options[:cache] == false
+              raise ArgumentError, 'Init: "cache" must be a boolean.'
+            end
+
+            Data::State.cache = options[:cache]
+          end
+
+          if options.key?(:cache_max_size)
+            unless options[:cache_max_size].is_a?(Integer)
+              raise ArgumentError, 'Init: "cache_max_size" must be an integer.'
+            end
+
+            if options[:cache_max_size] < 10
+              raise ArgumentError, 'Init: "cache_max_size" must be at least 10.'
+            end
+
+            if options[:cache_max_size] > 50_000
+              raise ArgumentError, 'Init: "cache_max_size" must be at most 50000.'
+            end
+
+            Data::State.cache_max_size = options[:cache_max_size]
+          end
+
+          if options.key?(:cache_ttl)
+            unless options[:cache_ttl].is_a?(Integer)
+              raise ArgumentError, 'Init: "cache_ttl" must be an integer (seconds).'
+            end
+
+            if options[:cache_ttl] < 30
+              raise ArgumentError, 'Init: "cache_ttl" must be at least 30 (30 seconds).'
+            end
+
+            if options[:cache_ttl] > 86_400
+              raise ArgumentError, 'Init: "cache_ttl" must be at most 86400 (1 day).'
+            end
+
+            Data::State.cache_ttl = options[:cache_ttl]
+          end
+
+          Helpers::Cache.clear unless Data::State.cache
           Helpers::CheckVersion.call
 
           true
@@ -25,4 +69,4 @@ module Ip2Geo
       end
     end
   end
-end
+end

data/lib/ip2geo/methods/list_conversions.rb

@@ -21,7 +21,7 @@ module Ip2Geo
           params = []
           params << "offset=#{offset}" if offset.positive?
           params << "limit=#{limit}" if limit != 50
-          params << "select=#{select.join(',')}" if select.is_a?(Array) && !select.empty?
+          params << "select=#{select.map { |f| "data.#{f}" }.join(',')}" if select.is_a?(Array) && !select.empty?
           params << "ipSearch=#{ip_search}" if ip_search
 
           query_string = params.empty? ? '' : "?#{params.join('&')}"

data/lib/ip2geo.rb

@@ -21,6 +21,7 @@
 require_relative 'ip2geo/data/constants'
 require_relative 'ip2geo/data/states'
 require_relative 'ip2geo/data/messages'
+require_relative 'ip2geo/helpers/cache'
 require_relative 'ip2geo/helpers/http'
 require_relative 'ip2geo/helpers/ip_validation'
 require_relative 'ip2geo/helpers/check_version'
@@ -40,11 +41,15 @@ module Ip2Geo
         # @param key [String] The API key used to authenticate with Ip2Geo
         # @param options [Hash] Optional configuration
         # @option options [Boolean] :version_update_message Whether to display version update messages (default: true)
+        # @option options [Boolean] :cache Whether to enable caching for successful conversions (default: true)
+        # @option options [Integer] :cache_max_size Maximum cached entries, min: 10, max: 50000 (default: 1000)
+        # @option options [Integer] :cache_ttl Cache TTL in seconds, min: 30, max: 86400 (default: 300)
         # @return [Boolean] Whether the initialization was successful
         #
         # @example
         #   Ip2Geo.init('your-api-key')
         #   Ip2Geo.init('your-api-key', version_update_message: false)
+        #   Ip2Geo.init('your-api-key', cache_max_size: 500, cache_ttl: 60)
         def init(key, options = {})
             Methods::Init.call(key, options)
         end
@@ -53,12 +58,10 @@ module Ip2Geo
         #
         # @param options [Hash] The options for the conversion
         # @option options [String] :ip The IP address to retrieve geo information for (required)
-        # @option options [Boolean] :convert_only If true, stores minimal data (default: false)
         # @return [Hash, nil] The API response containing geo data
         #
         # @example
         #   result = Ip2Geo.convert_ip(ip: '8.8.8.8')
-        #   result = Ip2Geo.convert_ip(ip: '8.8.8.8', convert_only: true)
         def convert_ip(options = {})
             Methods::ConvertIP.call(options)
         end
@@ -67,7 +70,6 @@ module Ip2Geo
         #
         # @param options [Hash] The options for the conversion
         # @option options [Array<String>] :ips An array of IP addresses (required)
-        # @option options [Boolean] :convert_only If true, stores minimal data (default: false)
         # @return [Hash, nil] The API response containing geo data for all IPs
         #
         # @example
@@ -85,7 +87,7 @@ module Ip2Geo
         #
         # @example
         #   result = Ip2Geo.get_conversion(conversion_id: 'abc123')
-        #   result = Ip2Geo.get_conversion(conversion_id: 'abc123', select: ['id', 'data.ip'])
+        #   result = Ip2Geo.get_conversion(conversion_id: 'abc123', select: ['ip', 'continent.country.name'])
         def get_conversion(options = {})
             Methods::GetConversion.call(options)
         end
@@ -137,10 +139,8 @@ module Ip2Geo
         # @return [Hash] The SELECT constants
         #
         # @example
-        #   Ip2Geo.select[:CONVERSION][:ID]
-        #   # => 'id'
-        #   Ip2Geo.select[:DATA][:CONTINENT][:COUNTRY][:NAME]
-        #   # => 'data.continent.country.name'
+        #   Ip2Geo.select[:COUNTRY_NAME]
+        #   # => 'continent.country.name'
         def select
             Data::SELECT
         end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip2geo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ip2Geo
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-01-30 00:00:00.000000000 Z
+date: 2026-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -39,6 +40,7 @@ files:
 - lib/ip2geo/data/constants.rb
 - lib/ip2geo/data/messages.rb
 - lib/ip2geo/data/states.rb
+- lib/ip2geo/helpers/cache.rb
 - lib/ip2geo/helpers/check_version.rb
 - lib/ip2geo/helpers/http.rb
 - lib/ip2geo/helpers/ip_validation.rb
@@ -55,6 +57,7 @@ metadata:
   homepage_uri: https://ip2geo.dev
   changelog_uri: https://docs.ip2geo.dev/changelog
   documentation_uri: https://docs.ip2geo.dev
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,7 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Official Ruby SDK for Ip2Geo - IP to Geolocation API.
 test_files: []