ip2location_ruby 8.7.0 → 8.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07d9738099db961a6661f7266017f4f5cf8156cb0b0e2063bf1e2a246dfe39f4
-  data.tar.gz: 9f4e8c1f7c60a58687e8d922816e69e6ddbaa4f4bd06dd9b0938a194278f8188
+  metadata.gz: b86068ea70a1da30468fab1bbd5407f81cd48c9438ce187358c86612794c027d
+  data.tar.gz: 29d1d716f253f9c2ff4a64701733cc2a7c64ea8a8b18492e6c172ae74be53d1c
 SHA512:
-  metadata.gz: 5417dcb43c59394ad2500f0e79ec109fc75bb70b0afca917c3150cd0ac6da7168e94b4381e01624fa8ee43ef05a9ed5bd148a4539c6d90ab23ed927cd2ff4cd2
-  data.tar.gz: 7a60ef9c3759e47b1c2699378103fbfbf3fde9e8007ecfee424739a9226cd0b9e24852e1e11b4f758f2fb67e9eeefc06845688da98d42043b02aaa4d9c8187c3
+  metadata.gz: a68a0213618700b4c52af2c1a406b3ada8650de49f519f17152dacc8dc537ef46105cd5f6029f76e1920873579a9b0828f4a8d5932d758566051f7c5d8e8b843
+  data.tar.gz: 77ffe92c332344206f1d62dffeeb6898eb9bf90277a9aa161c95987128fe85c531a84fd5c7b32cb933d8d6da4a20187c4c0a4902dfbfeeeace401f875ca54f7e

data/Gemfile.lock

@@ -1,25 +1,25 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    bindata (2.4.10)
-    diff-lcs (1.1.3)
-    json (>= 2.3.0)
-    rdoc (>= 6.3.1)
-      json (~> 1.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bindata
-  bundler (>= 1.2.0)
-  rdoc (>= 6.3.1)
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bindata (2.4.10)
+    diff-lcs (1.1.3)
+    json (>= 2.3.0)
+    rdoc (>= 6.3.1)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bindata
+  bundler (>= 1.2.0)
+  rdoc (>= 6.3.1)
   rspec (~> 2.8.0)

data/README.md

@@ -2,102 +2,15 @@
 [![Total Downloads](https://img.shields.io/gem/dt/ip2location_ruby.svg)](https://rubygems.org/gems/ip2location_ruby)
 
 # IP2Location Ruby Library
-This is IP2Location Ruby library that enables the user to find the country, region or state, city, latitude and longitude, US ZIP code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, usage type, IP address type and IAB advertising category from IP address using IP2Location database.  The library reads the geo location information from **IP2Location BIN data** file or web service.
+This is IP2Location Ruby library that enables the user to find the country, region or state, district, city, latitude and longitude, ZIP/Postal code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, usage type, address type, IAB category and ASN from IP address using IP2Location database.  The library reads the geo location information from **IP2Location BIN data** file or web service.
 
 Supported IPv4 and IPv6 address.
 
 For more details, please visit:
 [https://www.ip2location.com/developers/ruby](https://www.ip2location.com/developers/ruby)
 
-# INSTALLATION
-Install this package using the command as below:
-
-```
-gem install ip2location_ruby
-```
-
-# Usage
-You can check the **example.rb** file to learn more about usage.
-
-## BIN Database
-An outdated BIN database was provided in the library for your testing. You are recommended to visit the [links](#dependencies) to download the latest BIN database and save it in the ```rb``` folder.
-
-Below is the description of the functions available in the **BIN Database** lookup.
-
-| Function Name | Description |
-|---|---|
-| open | Open the IP2Location BIN data for lookup. |
-| close | Close and clean up the file pointer. |
-| get_package_version | Get the package version (1 to 25 for DB1 to DB25 respectively). |
-| get_module_version | Get the module version. |
-| get_database_version | Get the database version. |
-| get_last_error_message | Return the last error message. |
-| get_all | Return the geolocation information in array. |
-| get_country_short | Return the ISO3166-1 country code (2-digits) of the IP address. |
-| get_country_long  | Return the ISO3166-1 country name of the IP address. |
-| get_region | Return the ISO3166-2 region name of the IP address. Please visit [ISO3166-2 Subdivision Code](https://www.ip2location.com/free/iso3166-2) for the information of ISO3166-2 supported |
-| get_city | Return the city name of the IP address. |
-| get_latitude | Return the city latitude of the IP address. |
-| get_longitude | Return the city longtitude of the IP address. |
-| get_isp | Return the ISP name of the IP address. |
-| get_domain | Return the domain name of IP address. |
-| get_zipcode | Return the zipcode of the city. |
-| get_timezone | Return the UTC time zone (with DST supported). |
-| get_netspeed | Return the Internet connection type. |
-| get_iddcode | Return the IDD prefix to call the city from another country. |
-| get_areacode | Return the area code of the city. |
-| get_weathercode | Return the nearest weather observation station code. |
-| get_weathername | Return the nearest weather observation station name. |
-| get_mcc | Return the Mobile Country Codes (MCC). |
-| get_mnc | Return the Mobile Network Code (MNC). |
-| get_mobilebrand | Commercial brand associated with the mobile carrier. |
-| get_elevation | Return average height of city above sea level in meters (m). |
-| get_usagetype | Return the ISP's usage type of IP address. |
-| get_addresstype | Returns the IP address type (A-Anycast, B-Broadcast, M-Multicast & U-Unicast) of IP address or domain name. |
-| get_category | Returns the IAB content taxonomy category of IP address or domain name. |
-
-## Web Service
-Below is the description of the functions available in the **Web Service** lookup.
-
-| Function Name | Description |
-|---|---|
-| Constructor | Expect 3 input parameters:<ol><li>IP2Location API Key.</li><li>Package (WS1 - WS25)</li></li><li>Use HTTPS or HTTP</li></ol> |
-| lookup | Return the IP information in array.<ul><li>country_code</li><li>country_name</li><li>region_name</li><li>city_name</li><li>latitude</li><li>longitude</li><li>zip_code</li><li>time_zone</li><li>isp</li><li>domain</li><li>net_speed</li><li>idd_code</li><li>area_code</li><li>weather_station_code</li><li>weather_station_name</li><li>mcc</li><li>mnc</li><li>mobile_brand</li><li>elevation</li><li>usage_type</li><li>address_type</li><li>category</li><li>continent<ul><li>name</li><li>code</li><li>hemisphere</li><li>translations</li></ul></li><li>country<ul><li>name</li><li>alpha3_code</li><li>numeric_code</li><li>demonym</li><li>flag</li><li>capital</li><li>total_area</li><li>population</li><li>currency<ul><li>code</li><li>name</li><li>symbol</li></ul></li><li>language<ul><li>code</li><li>name</li></ul></li><li>idd_code</li><li>tld</li><li>translations</li></ul></li><li>region<ul><li>name</li><li>code</li><li>translations</li></ul></li><li>city<ul><li>name</li><li>translations</li></ul></li><li>geotargeting<ul><li>metro</li></ul></li><li>country_groupings</li><li>time_zone_info<ul><li>olson</li><li>current_time</li><li>gmt_offset</li><li>is_dst</li><li>sunrise</li><li>sunset</li></ul></li><ul> |
-| get_credit | Return remaining credit of the web service account. |
-
-## IpTools
-Below is the description of the functions available in the **IpTools** class.
-
-| Function Name | Description |
-|---|---|
-| is_ipv4 | Return either true or false. Verify if a string is a valid IPv4 address. |
-| is_ipv6 | Return either true or false. Verify if a string is a valid IPv6 address. |
-| ipv4_to_decimal | Translate IPv4 address from dotted-decimal address to decimal format. Return null on error. |
-| decimal_to_ipv4 | Translate IPv4 address from decimal number to dotted-decimal address. Return null on error. |
-| ipv6_to_decimal | Translate IPv6 address from hexadecimal address to decimal format. Return null on error. |
-| decimal_to_ipv6 | Translate IPv6 address from decimal number into hexadecimal address. Return null on error. |
-| ipv4_to_cidr | Convert IPv4 range into a list of IPv4 CIDR notation. |
-| cidr_to_ipv4 | Convert IPv4 CIDR notation into a list of IPv4 addresses. |
-| ipv6_to_cidr | Convert IPv6 range into a list of IPv6 CIDR notation. |
-| cidr_to_ipv6 | Convert IPv6 CIDR notation into a list of IPv6 addresses. |
-| compress_ipv6 | Compress a IPv6 to shorten the length. |
-| expand_ipv6 | Expand a shorten IPv6 to full length. |
-
-## Country
-Below is the description of the functions available in the **Country** class.
-
-| Function Name | Description |
-|---|---|
-| Constructor | Expect a IP2Location Country Information CSV file. This database is free for download at https://www.ip2location.com/free/country-information |
-| get_country_info | Provide a ISO 3166 country code to get the country information in array. Will return a full list of countries information if country code not provided. Below is the information returned: <ul><li>country_code</li><li>country_alpha3_code</li><li>country_numeric_code</li><li>capital</li><li>country_demonym</li><li>total_area</li><li>population</li><li>idd_code</li><li>currency_code</li><li>currency_name</li><li>currency_symbol</li><li>lang_code</li><li>lang_name</li><li>cctld</li></ul> |
-
-## Region
-Below is the description of the functions available in the **Region** class.
-
-| Function Name | Description |
-|---|---|
-| Constructor | Expect a IP2Location ISO 3166-2 Subdivision Code CSV file. This database is free for download at https://www.ip2location.com/free/iso3166-2 |
-| get_region_code | Provide a ISO 3166 country code and the region name to get ISO 3166-2 subdivision code for the region. |
+## Developer Documentation
+To learn more about installation, usage, and code examples, please visit the developer documentation at [https://ip2location-ruby.readthedocs.io/en/latest/index.html.](https://ip2location-ruby.readthedocs.io/en/latest/index.html)
 
 # Dependencies
 This library requires IP2Location BIN data file to function. You may download the BIN data file at

data/VERSION

@@ -1 +1 @@
-8.7.0
+8.7.1

data/ip2location_ruby.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name = "ip2location_ruby"
-  s.version = "8.7.0"
+  s.version = "8.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors       = ["ip2location"]
   s.email         = ["support@ip2location.com"]
-  s.description = "The official IP2Location Ruby library to geolocate an IP address. You can lookup for country, region, city, latitude, longitude, zip code, time zone, ISP, domain, area code, usage type, mobile data, weather data and elevation from an IP address. Supported both IPv4 and IPv6 lookup."
+  s.description = "The official IP2Location Ruby library to geolocate an IP address. You can lookup for country, region, district, city, latitude and longitude, ZIP/Postal code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, usage type, address type, IAB category and ASN from an IP address. Supported both IPv4 and IPv6 lookup."
   s.email = "support@ip2location.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",

data/lib/ip2location_ruby/database_config.rb

@@ -33,8 +33,8 @@ class DbConfig
    memo
   }
   # order by value
-  col_array = cols.sort_by {|key,value| value}
+  cols.sort_by {|key,value| value}
  end
  
 end
- 
+ 

data/lib/ip2location_ruby/i2l_float_data.rb

@@ -1,7 +1,7 @@
 class I2lFloatData  < BinData::BasePrimitive
   
   def read_and_return_value(io)
-    addr = BinData::FloatLe.read(io)
+    BinData::FloatLe.read(io)
   end
   
-end
+end

data/lib/ip2location_ruby/i2l_ip_data.rb

@@ -2,9 +2,9 @@ class I2lIpData  < BinData::BasePrimitive
   def read_and_return_value(io)
     iv = eval_parameter(:ip_version)
     if iv == 4
-      addr = BinData::Uint32le.read(io)
+      BinData::Uint32le.read(io)
     elsif iv == 6
-      addr = BinData::Uint128le.read(io)
+      BinData::Uint128le.read(io)
     end
   end
-end
+end

data/lib/ip2location_ruby.rb

@@ -14,7 +14,7 @@ require 'ip2location_ruby/ip2location_record'
 class Ip2location
   attr_accessor :record_class4, :record_class6, :v4, :file, :db_index, :count, :base_addr, :ipno, :count, :record, :database, :columns, :ip_version, :ipv4databasecount, :ipv4databaseaddr, :ipv4indexbaseaddr, :ipv6databasecount, :ipv6databaseaddr, :ipv6indexbaseaddr, :databaseyear, :databasemonth, :databaseday, :last_err_msg
 
-  VERSION = '8.7.0'
+  VERSION = '8.7.1'
   FIELD_NOT_SUPPORTED = 'NOT SUPPORTED'
   INVALID_IP_ADDRESS = 'INVALID IP ADDRESS'
   INVALID_BIN_DATABASE = 'Incorrect IP2Location BIN file format. Please make sure that you are using the latest IP2Location BIN file.'
@@ -29,7 +29,7 @@ class Ip2location
     begin
         self.file = File.open(File.expand_path url, 'rb')
     rescue
-        self.last_err_msg = 'Ip2location.new.open() error in opening ' + url +'.'
+        self.last_err_msg = 'Ip2location.new.open() error in opening ' + url + '.'
         abort('Ip2location.new.open() error in opening ' + url + '. No such file in the /your_ip2location_ruby_library_path/rb/ folder.')
     else
     end
@@ -1154,4 +1154,4 @@ class Ip2locationRegion
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip2location_ruby
 version: !ruby/object:Gem::Version
-  version: 8.7.0
+  version: 8.7.1
 platform: ruby
 authors:
 - ip2location
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -67,9 +67,11 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.0
 description: The official IP2Location Ruby library to geolocate an IP address. You
-  can lookup for country, region, city, latitude, longitude, zip code, time zone,
-  ISP, domain, area code, usage type, mobile data, weather data and elevation from
-  an IP address. Supported both IPv4 and IPv6 lookup.
+  can lookup for country, region, district, city, latitude and longitude, ZIP/Postal
+  code, time zone, Internet Service Provider (ISP) or company name, domain name, net
+  speed, area code, weather station code, weather station name, mobile country code
+  (MCC), mobile network code (MNC) and carrier brand, elevation, usage type, address
+  type, IAB category and ASN from an IP address. Supported both IPv4 and IPv6 lookup.
 email: support@ip2location.com
 executables: []
 extensions: []