ip2location_ruby 8.0.1 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6498bb18d849412de400120c7e71a6f1f4fe7bfa
-  data.tar.gz: fc922eede3355f2223b152d491194f654c9a56fb
+SHA256:
+  metadata.gz: d40ddb96c3b68fc1ff4d851a0389f715e09c41c3b185d8936558686fa39ce2a4
+  data.tar.gz: 1b0d493cddb9e69b692be6f3a84b4e178d1ad16a1c63641732638b6134cf51e1
 SHA512:
-  metadata.gz: 4730d2e28e3b5815ccb9949ca64d7d7918e3228b1ce2942f9d46313c1020527cc6a3042a0c8410fc750360627bb5467116aac6efdbd8351103ebbe670f60983a
-  data.tar.gz: 9bc77be32a4edf9480a8e13cdc40d5802747e1bc448a837a398db956229c0a1de638b28a666dea75c523302c787f4d87bfe5a3a0f0a102f5f4dadb3492ecc302
+  metadata.gz: c21ffd658ec663cc61c726a77a907e56bb69114ac1a016ccea7568ccf0b6faa180a4efade585009dbed2c526880fddef1dce724f1e724f0592ec1b52174ae287
+  data.tar.gz: 6337c61e5594a6e48bc2b2541afe9d0f944eeeabd6200091ac6f3b0459d60e31f216ac4ca5aaa51e5bc3c890eb17b1fd28fbdadce4d7b46c6308faa117a621de

data/.document

@@ -1,5 +1,5 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -1 +1 @@
---color
+--color

data/Gemfile

@@ -1,16 +1,16 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-gem 'bindata'
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-
-group :development do
-  gem 'awesome_print'  
-  gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", ">= 1.2.0"
-  gem "jeweler", "~> 1.8.4"
-  gem "simplecov", ">= 0"
-end
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'bindata'
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+group :development do
+  gem 'awesome_print'  
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.2.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -1,74 +1,74 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    addressable (2.3.5)
-    awesome_print (1.2.0)
-    bindata (2.1.0)
-    builder (3.2.2)
-    diff-lcs (1.1.3)
-    docile (1.1.1)
-    faraday (0.8.8)
-      multipart-post (~> 1.2.0)
-    git (1.2.6)
-    github_api (0.10.1)
-      addressable
-      faraday (~> 0.8.1)
-      hashie (>= 1.2)
-      multi_json (~> 1.4)
-      nokogiri (~> 1.5.2)
-      oauth2
-    hashie (2.0.5)
-    highline (1.6.20)
-    httpauth (0.2.0)
-    jeweler (1.8.8)
-      builder
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      github_api (= 0.10.1)
-      highline (>= 1.6.15)
-      nokogiri (= 1.5.10)
-      rake
-      rdoc
-    json (1.8.1)
-    jwt (0.1.8)
-      multi_json (>= 1.5)
-    multi_json (1.8.2)
-    multi_xml (0.5.5)
-    multipart-post (1.2.0)
-    nokogiri (1.5.10)
-    oauth2 (0.9.2)
-      faraday (~> 0.8)
-      httpauth (~> 0.2)
-      jwt (~> 0.1.4)
-      multi_json (~> 1.0)
-      multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.5.2)
-    rake (10.1.1)
-    rdoc (3.12.2)
-      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)
-    simplecov (0.8.2)
-      docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  awesome_print
-  bindata
-  bundler (>= 1.2.0)
-  jeweler (~> 1.8.4)
-  rdoc (~> 3.12)
-  rspec (~> 2.8.0)
-  simplecov
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    awesome_print (1.2.0)
+    bindata (2.1.0)
+    builder (3.2.2)
+    diff-lcs (1.1.3)
+    docile (1.1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.8.2)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (>= 1.8.2)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (>= 1.6.11)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      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)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bindata
+  bundler (>= 1.2.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov

data/LICENSE.txt

@@ -1,20 +1,20 @@
-Copyright (c) 2013 Vincent.Z ( zhu1230@gmail.com )
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2020 IP2Location ( support@ip2location.com )
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+[![Latest Stable Version](https://img.shields.io/gem/v/ip2location_ruby.svg)](https://rubygems.org/gems/ip2location_ruby)
+[![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, and usage type by IP address or hostname originates from.  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)
+
+# Usage
+You can check the **example.rb** file to learn more about usage.
+
+## BIN Database
+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. |
+| close | Close and clean up the file pointer. |
+| 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. |
+
+
+## Web Service
+Below is the description of the functions available in the **Web Service** lookup.
+
+| Function Name | Description |
+|---|---|
+| Constructor | Expect 2 input parameters:<ol><li>IP2Location API Key.</li><li>Package (WS1 - WS24)</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>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. |
+
+# Dependencies
+This library requires IP2Location BIN data file to function. You may download the BIN data file at
+* IP2Location LITE BIN Data (Free): https://lite.ip2location.com
+* IP2Location Commercial BIN Data (Comprehensive): https://www.ip2location.com
+
+An outdated BIN database was provided in the library for your testing. You are recommended to visit the above links to download the latest BIN database.
+
+You can also sign up for [IP2Location Web Service](https://www.ip2location.com/web-service/ip2location) to lookup by IP2Location API.
+
+# IPv4 BIN vs IPv6 BIN
+* Use the IPv4 BIN file if you just need to query IPv4 addresses.
+* Use the IPv6 BIN file if you need to query BOTH IPv4 and IPv6 addresses.
+
+# Support
+
+Email: support@ip2location.com  
+URL: [https://www.ip2location.com](https://www.ip2location.com)

data/Rakefile

@@ -1,49 +1,49 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "ip2location_ruby"
-  gem.homepage = "https://github.com/ip2location/ip2location-ruby"
-  gem.license = "MIT"
-  gem.summary = %Q{the ip2location ruby library}
-  gem.description = %Q{ip2location ruby library}
-  gem.email = "support@ip2location.com"
-  gem.authors = ["Vincent.Z"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "ip2location #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ip2location_ruby"
+  gem.homepage = "https://github.com/ip2location/ip2location-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{the ip2location ruby library}
+  gem.description = %Q{ip2location ruby library}
+  gem.email = "support@ip2location.com"
+  gem.authors = ["Vincent.Z"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ip2location #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -1 +1 @@
-8.0.1
+8.2.0

data/example.rb

@@ -0,0 +1,41 @@
+require 'ip2location_ruby'
+
+# BIN Database
+i2l = Ip2location.new.open("./data/IP2LOCATION-LITE-DB1.IPV6.BIN")
+record = i2l.get_all('8.8.8.8')
+
+print 'Country Code: ' + record['country_short'] + "\n"
+print 'Country Name: ' + record['country_long'] + "\n"
+print 'Region Name: ' + record['region'] + "\n"
+print 'City Name: ' + record['city'] + "\n"
+print 'Latitude: '
+print record['latitude']
+print "\n"
+print 'Longitude: '
+print record['longitude']
+print "\n"
+print 'ISP: ' + record['isp'] + "\n"
+print 'Domain: ' + record['domain'] + "\n"
+print 'Net Speed: ' + record['netspeed'] + "\n"
+print 'Area Code: ' + record['areacode'] + "\n"
+print 'IDD Code: ' + record['iddcode'] + "\n"
+print 'Time Zone: ' + record['timezone'] + "\n"
+print 'ZIP Code: ' + record['zipcode'] + "\n"
+print 'Weather Station Code: ' + record['weatherstationname'] + "\n"
+print 'Weather Station Name: ' + record['weatherstationcode'] + "\n"
+print 'MCC: ' + record['mcc'] + "\n"
+print 'MNC: ' + record['mnc'] + "\n"
+print 'Mobile Name: ' + record['mobilebrand'] + "\n"
+print 'Elevation: '
+print record['elevation']
+print "\n"
+print 'Usage Type: ' + record['usagetype'] + "\n"
+
+i2l.close()
+
+# Web Service
+ws = Ip2locationWebService.new('demo', 'WS24')
+record = ws.lookup('8.8.8.8', 'continent,country,region,city,geotargeting,country_groupings,time_zone_info', 'en')
+print record
+print "\n"
+print ws.get_credit()