ip2location_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0021043a6e79782ab1e993c50bd4881c5cd4ae1694f67fa183fe1efc85abc84
+  data.tar.gz: 5c07387aa05f1b86caa919bc49ce2c9a0eb1c8f7dc3ffb74aea3828d88149d30
+SHA512:
+  metadata.gz: 11d3a754860a4bdeaafb21961beef16a3a69307be355a88e805c0516b616d945d4811cacd0b1a213a5864167dc90d311c90407467dcf568453f6ebc3b868c230
+  data.tar.gz: 521917ddebe83b99a9b66b317fc50f3430e6f574269c5879cc7a2ac1883fc0d706e6cd4754c602eb445428ecb46dcbaa001ee0ccb2cc19cb00604d1527679faf

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ip2location_rails.gemspec
+gemspec
+gem 'ip2location_ruby', ">= 8.7.3"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2023 - 2024 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,117 @@
+# IP2Location Ruby on Rails Library
+This is IP2Location Ruby on Rails 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.
+
+Supported IPv4 and IPv6 address.
+
+## INSTALLATION
+1. Add this lines to your application's Gemfile:
+```ruby
+gem 'ip2location_ruby'
+gem 'ip2location_rails'
+```
+2. Then execute it
+```bash
+$ bundle install
+```
+3. Open the preferred file in the `config/environments` directory. Add the following code to the chosen configuration file after the `Rails.application.configure do` line.
+```ruby
+config.ip2location_db_path = Rails.root.join('lib', 'assets', 'ip2location_rails', 'IP2LOCATION.BIN').to_s
+```
+
+## USAGE
+1. Download IP2Location BIN database
+    - IP2Location free LITE database at https://lite.ip2location.com
+    - IP2Location commercial database at https://www.ip2location.com
+2. Create a folder named as `ip2location_rails` in the `lib/assets` directory.
+3. Unzip and copy the BIN file into `lib/assets/ip2location_rails` folder.
+4. Rename the BIN file to **IP2LOCATION.BIN**.
+5. Create a **TestController** using the below command line
+```bash
+bin/rails generate controller Test index --skip-routes
+```
+6. Open the *app/controllers/test_controller.rb* in any text editor.
+7. Add the below lines into the controller file.
+```ruby
+require 'ip2location_rails'
+
+class TestController < ApplicationController
+  def index
+    location_service = Ip2locationRails.new('8.8.8.8')
+    @country_code = location_service.country_code
+    @country_name = location_service.country_name
+    @region = location_service.region
+    @city = location_service.city
+    @latitude = location_service.latitude
+    @longitude = location_service.longitude
+    @isp = location_service.isp
+    @domain = location_service.domain
+    @netspeed = location_service.netspeed
+    @area_code = location_service.areacode
+    @idd_code = location_service.iddcode
+    @time_zone = location_service.timezone
+    @zip_code = location_service.zipcode
+    @weather_station_name = location_service.weatherstationname
+    @weather_station_code = location_service.weatherstationcode
+    @mcc= location_service.mcc
+    @mnc = location_service.mnc
+    @mobile_brand = location_service.mobilebrand
+    @elevation = location_service.elevation
+    @usage_type = location_service.usagetype
+    @address_type = location_service.addresstype
+    @category = location_service.category
+    @district = location_service.district
+    @asn = location_service.asn
+    @as = location_service.as
+  end
+end
+```
+8. Open the *app/views/test/index.html.erb* in any text editor and add the below lines into it.
+```
+<p>Country Code: <%= @country_code %></p>
+<p>Country Name: <%= @country_name %></p>
+<p>Region Name: <%= @region %></p>
+<p>City Name: <%= @city %></p>
+<p>Latitude: <%= @latitude %></p>
+<p>Longitude: <%= @longitude %></p>
+<p>ISP Name: <%= @isp %></p>
+<p>Domain Name: <%= @domain %></p>
+<p>Net Speed: <%= @netspeed %></p>
+<p>Area Code: <%= @area_code %></p>
+<p>IDD Code: <%= @idd_code %></p>
+<p>Time Zone: <%= @time_zone %></p>
+<p>ZIP Code: <%= @zip_code %></p>
+<p>Weather Station Code: <%= @weather_station_name %></p>
+<p>Weather Station Name: <%= @weather_station_code %></p>
+<p>MCC: <%= @mcc %></p>
+<p>MNC: <%= @mnc %></p>
+<p>Mobile Carrier: <%= @mobile_brand %></p>
+<p>Elevation: <%= @elevation %></p>
+<p>Usage Type: <%= @usage_type %></p>
+<p>Address Type: <%= @address_type %></p>
+<p>Category: <%= @category %></p>
+<p>District: <%= @district %></p>
+<p>ASN: <%= @asn %></p>
+<p>AS: <%= @as %></p>
+```
+9. Add the following line into the *config/routes.rb* file after the `Rails.application.routes.draw do` line.
+```ruby
+get "/test", to: "test#index"
+```
+10. Restart your development server.
+```bash
+$ bin/rails server
+```
+11. Enter the URL <your domain>/test and run. You should see the information of **8.8.8.8** IP address.
+
+## 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
+
+## 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/ip2location_rails.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+    s.name = 'ip2location_rails'
+    s.version = '1.0.0'
+    s.required_ruby_version = '>= 2.5.0'
+    s.require_paths = ["lib"]
+    s.authors = ["ip2location"]
+    s.email = ["support@ip2location.com"]
+    s.description = "The official IP2Location Ruby on Rails 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.summary = "IP2Location Ruby on Rails library"
+    s.homepage = 'https://www.ip2location.com'
+    s.licenses = ["MIT"]
+    s.files = [
+        "LICENSE.txt",
+        "Gemfile",
+        "README.md",
+        "ip2location_rails.gemspec",
+        "lib/ip2location_rails.rb",
+    ]
+    s.add_runtime_dependency 'ip2location_ruby', '>= 8.7.3'
+end

data/lib/ip2location_rails.rb

@@ -0,0 +1,112 @@
+require 'ip2location_ruby'
+
+class Ip2locationRails
+    def initialize(ip_address)
+        @ip_address = ip_address
+        @i2l = Ip2location.new.open(Rails.configuration.ip2location_db_path)
+    end
+
+    def location
+        @i2l.get_all(@ip_address)
+    end
+
+    def country_code
+        location['country_short']
+    end
+
+    def country_name
+        location['country_long']
+    end
+
+    def region
+        location['region']
+    end
+
+    def city
+        location['city']
+    end
+
+    def latitude
+        location['latitude']
+    end
+
+    def longitude
+        location['longitude']
+    end
+
+    def isp
+        location['isp']
+    end
+
+    def domain
+        location['domain']
+    end
+
+    def netspeed
+        location['netspeed']
+    end
+
+    def areacode
+        location['areacode']
+    end
+
+    def iddcode
+        location['iddcode']
+    end
+
+    def timezone
+        location['timezone']
+    end
+
+    def zipcode
+        location['zipcode']
+    end
+
+    def weatherstationname
+        location['weatherstationname']
+    end
+
+    def weatherstationcode
+        location['weatherstationcode']
+    end
+
+    def mcc
+        location['mcc']
+    end
+
+    def mnc
+        location['mnc']
+    end
+
+    def mobilebrand
+        location['mobilebrand']
+    end
+
+    def elevation
+        location['elevation']
+    end
+
+    def usagetype
+        location['usagetype']
+    end
+
+    def addresstype
+        location['addresstype']
+    end
+
+    def category
+        location['category']
+    end
+
+    def district
+        location['district']
+    end
+
+    def asn
+        location['asn']
+    end
+
+    def as
+        location['as']
+    end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ip2location_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ip2location
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ip2location_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.7.3
+description: The official IP2Location Ruby on Rails 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.
+email:
+- support@ip2location.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- ip2location_rails.gemspec
+- lib/ip2location_rails.rb
+homepage: https://www.ip2location.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: IP2Location Ruby on Rails library
+test_files: []