ip2proxy_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cecab9d7489f099dba3ad64fa7438deefb56faf7ab6cde65ccd7671a57f9fb4
+  data.tar.gz: c5cb514d16e736a38a2f2d522c456f6ea48bb8aea372f7e42a078cb07f454d23
+SHA512:
+  metadata.gz: 952b3e2a65850d6eb35d0ff8245f05e3df0b8eabcf480618c4d8e645ee7369da0462fdce4ac9b51578fbb885c0d7a138ad4e1c1b70909ee12c362436753f624a
+  data.tar.gz: b5cbe1acf3c4835475403a315ede9a43a3239456540d5c5424df6f4a907538e5480962242c0c455abc323d463b6b298007a06362a9b144279f7df370d4711248

data/Gemfile

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

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,89 @@
+# IP2Proxy Ruby on Rails Library
+This IP2Proxy Ruby on Rails library allows user to reverse search of IP address to detect VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges, residential proxies, consumer privacy networks, and enterprise private networks using IP2Proxy BIN database. Other information available includes proxy type, country, state, city, ISP, domain name, usage type, AS number, AS name, threats, last seen date and provider names. It lookup the proxy IP address from **IP2Proxy BIN Data** file.
+
+## INSTALLATION
+1. Add this lines to your application's Gemfile:
+```ruby
+gem 'ip2proxy_ruby'
+gem 'ip2proxy_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.ip2proxy_db_path = Rails.root.join('lib', 'assets', 'ip2proxy_rails', 'IP2PROXY.BIN').to_s
+```
+
+## USAGE
+1. Download IP2Proxy BIN database
+    - IP2Proxy LITE database at https://lite.ip2location.com
+    - IP2Proxy Commercial database at https://www.ip2location.com/proxy-database
+2. Create a folder named as `ip2proxy_rails` in the `lib/assets` directory.
+3. Unzip and copy the BIN file into `lib/assets/ip2proxy_rails` folder.
+4. Rename the BIN file to **IP2PROXY.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 'ip2proxy_rails'
+
+class TestController < ApplicationController
+  def index
+    proxy_service = Ip2proxyRails.new('1.2.3.4')
+    @is_proxy = proxy_service.is_proxy
+    @proxy_type = proxy_service.proxy_type
+    @country_code = proxy_service.country_code
+    @country_name = proxy_service.country_name
+    @region = proxy_service.region
+    @city = proxy_service.city
+    @isp = proxy_service.isp
+    @domain = proxy_service.domain
+    @usage_type = proxy_service.usagetype
+    @asn = proxy_service.asn
+    @as = proxy_service.as
+    @last_seen = proxy_service.last_seen
+    @threat = proxy_service.threat
+    @provider = proxy_service.provider
+  end
+end
+```
+8. Open the *app/views/test/index.html.erb* in any text editor and add the below lines into it.
+```
+<p>is Proxy: <%= @is_proxy %></p>
+<p>Proxy Type: <%= @proxy_type %></p>
+<p>Country Code: <%= @country_code %></p>
+<p>Country Name: <%= @country_name %></p>
+<p>Region Name: <%= @region %></p>
+<p>City Name: <%= @city %></p>
+<p>ISP Name: <%= @isp %></p>
+<p>Domain Name: <%= @domain %></p>
+<p>Usage Type: <%= @usage_type %></p>
+<p>ASN: <%= @asn %></p>
+<p>AS: <%= @as %></p>
+<p>Last Seen: <%= @last_seen %></p>
+<p>Threat: <%= @threat %></p>
+<p>Provider: <%= @provider %></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 proxy information of **1.2.3.4** IP address.
+
+## Dependencies
+This library requires IP2Proxy BIN data file to function. You may download the BIN data file at
+* IP2Proxy LITE BIN Data (Free): https://lite.ip2location.com
+* IP2Proxy Commercial BIN Data (Comprehensive): https://www.ip2location.com/proxy-database
+
+## Support
+Email: support@ip2location.com
+URL: [https://www.ip2location.com](https://www.ip2location.com)

data/ip2proxy_rails.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+    s.name = 'ip2proxy_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 = "This IP2Proxy Ruby on Rails library allows user to reverse search of IP address to detect VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges, residential proxies, consumer privacy networks, and enterprise private networks using IP2Proxy BIN database. Other information available includes proxy type, country, state, city, ISP, domain name, usage type, AS number, AS name, threats, last seen date and provider names. It lookup the proxy IP address from IP2Proxy BIN Data file."
+    s.summary = "IP2Proxy Ruby on Rails library"
+    s.homepage = 'https://www.ip2location.com'
+    s.licenses = ["MIT"]
+    s.files = [
+        "LICENSE.txt",
+        "Gemfile",
+        "README.md",
+        "ip2proxy_rails.gemspec",
+        "lib/ip2proxy_rails.rb",
+    ]
+    s.add_runtime_dependency 'ip2proxy_ruby', '>= 3.3.1'
+end

data/lib/ip2proxy_rails.rb

@@ -0,0 +1,68 @@
+require 'ip2proxy_ruby'
+
+class Ip2proxyRails
+    def initialize(ip_address)
+        @ip_address = ip_address
+        @i2p = Ip2proxy.new.open(Rails.configuration.ip2proxy_db_path)
+    end
+
+    def proxy
+        @i2p.get_all(@ip_address)
+    end
+
+    def is_proxy
+        proxy['is_proxy'].to_s
+    end
+
+    def proxy_type
+        proxy['proxy_type']
+    end
+
+    def country_code
+        proxy['country_short']
+    end
+
+    def country_name
+        proxy['country_long']
+    end
+
+    def region
+        proxy['region']
+    end
+
+    def city
+        proxy['city']
+    end
+
+    def isp
+        proxy['isp']
+    end
+
+    def domain
+        proxy['domain']
+    end
+
+    def usagetype
+        proxy['usagetype']
+    end
+
+    def asn
+        proxy['asn']
+    end
+
+    def as
+        proxy['as']
+    end
+
+    def last_seen
+        proxy['last_seen']
+    end
+
+    def threat
+        proxy['threat']
+    end
+
+    def provider
+        proxy['provider']
+    end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: ip2proxy_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: ip2proxy_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+description: This IP2Proxy Ruby on Rails library allows user to reverse search of
+  IP address to detect VPN servers, open proxies, web proxies, Tor exit nodes, search
+  engine robots, data center ranges, residential proxies, consumer privacy networks,
+  and enterprise private networks using IP2Proxy BIN database. Other information available
+  includes proxy type, country, state, city, ISP, domain name, usage type, AS number,
+  AS name, threats, last seen date and provider names. It lookup the proxy IP address
+  from IP2Proxy BIN Data file.
+email:
+- support@ip2location.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- ip2proxy_rails.gemspec
+- lib/ip2proxy_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: IP2Proxy Ruby on Rails library
+test_files: []