Added IP2Proxy web service

Author: ip2location

README.md

@@ -4,65 +4,115 @@
 
 IP2Proxy Laravel extension enables the user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.
 
+*Note: This extension works in Laravel 6, Laravel 7 and Laravel 8.*
+
 
 ## INSTALLATION
 
 1. Run the command: `composer require ip2location/ip2proxy-laravel` to download the package into the Laravel platform.
 2. Edit `config/app.php` and add the below line in 'providers' section:  
 `Ip2location\IP2ProxyLaravel\IP2ProxyLaravelServiceProvider::class,`
 3. Then publish the config file by:  
-`php artisan vendor:publish --provider=Ip2location\IP2ProxyLaravel\IP2ProxyLaravelServiceProvider --force`
-4. Download IP2Proxy BIN database
+`php artisan vendor:publish --provider='Ip2location\IP2ProxyLaravel\IP2ProxyLaravelServiceProvider' --force`
+
+## USAGE
+
+IP2Proxy Laravel extension is able to query the IP address proxy information from either BIN database or web service. This section will explain how to use this extension to query from BIN database and web service.
+
+### BIN DATABASE
+
+1. Download IP2Proxy BIN database
     - IP2Proxy free LITE database at https://lite.ip2location.com
     - IP2Proxy commercial database at https://www.ip2location.com/proxy-database
-5. Create a folder named as `ip2proxy` in the `database` directory.
-6. Unzip and copy the BIN file into `database/ip2proxy/` folder. 
-7. Rename the BIN file to IP2PROXY.BIN.
+2. To use IP2Proxy databases, create a folder named as `ip2proxy` in the `database` directory.
+3. Unzip and copy the BIN file into `database/ip2proxy/` folder. 
+4. Rename the BIN file to IP2PROXY.BIN.
+5. Create a **TestController** in Laravel using the below command line
+```
+php artisan make:controller TestController
+```
+6. Open the **app/Http/Controllers/TestController.php** in any text editor.
+7. To use IP2Proxy databases, add the below lines into the controller file
+```php
+<?php
 
+namespace App\Http\Controllers;
 
-## USAGE
+use Illuminate\Http\Request;
+use IP2ProxyLaravel;            //use IP2ProxyLaravel class
 
-In this tutorial, we will show you on how to create a **TestController** to display the IP information.
+class TestController extends Controller
+{
+    //Create a lookup function for display
+    public function lookup(){
+        //Try query the geolocation information of 1.2.3.4 IP address
+        $records = IP2ProxyLaravel::get('1.2.3.4', 'bin');
+
+        echo '<p><strong>IP Address: </strong>' . $records['ipAddress'] . '</p>';
+        echo '<p><strong>IP Number: </strong>' . $records['ipNumber'] . '</p>';
+        echo '<p><strong>IP Version: </strong>' . $records['ipVersion'] . '</p>';
+        echo '<p><strong>Country Code: </strong>' . $records['countryCode'] . '</p>';
+        echo '<p><strong>Country: </strong>' . $records['countryName'] . '</p>';
+        echo '<p><strong>State: </strong>' . $records['regionName'] . '</p>';
+        echo '<p><strong>City: </strong>' . $records['cityName'] . '</p>';
+        echo '<p><strong>Proxy Type: </strong>' . $records['proxyType'] . '</p>';
+        echo '<p><strong>Is Proxy: </strong>' . $records['isProxy'] . '</p>';
+        echo '<p><strong>ISP: </strong>' . $records['isp'] . '</p>';
+    }
+}
+```
+8. Add the following line into the *routes/web.php* file.
+```
+Route::get('test', 'TestController@lookup');
+```
+9. Enter the URL <your domain>/public/test and run. You should see the information of **1.2.3.4** IP address.
 
-1. Create a **TestController** in Laravel using the below command line
+### WEB SERVICE
+
+1. To use IP2Proxy Web Service, create a new file called "site_vars.php" in `config` directory.
+2. In the site_vars.php, save the following contents:
+```php
+<?php
+return [
+    'IP2ProxyAPIKey' => 'your_api_key', // Required. Your IP2Proxy API key.
+    'IP2ProxyPackage' => 'PX1', // Required. Choose the package you would like to use.
+    'IP2ProxyUsessl' => false, // Optional. Use https or http.
+];
 ```
-php artisan make:controller TestController
+3. Create a **TestController** in Laravel using the below command line
 ```
-2. Open the **app/Http/Controllers/TestController.php** in any text editor.
-3. Add the below lines into the controller file.
+php artisan make:controller TestController
 ```
+4. Open the **app/Http/Controllers/TestController.php** in any text editor.
+5. To use IP2Proxy Web Service, add the below lines into the controller file.
+```php
 <?php
 
 namespace App\Http\Controllers;
 
 use Illuminate\Http\Request;
+
 use IP2ProxyLaravel;            //use IP2ProxyLaravel class
 
 class TestController extends Controller
 {
     //Create a lookup function for display
-        public function lookup(){
+    public function lookup(){
         //Try query the geolocation information of 1.2.3.4 IP address
-        $record = IP2ProxyLaravel::get('1.2.3.4');
-
-        echo '<p><strong>IP Address: </strong>' . $record['ipAddress'] . '</p>';
-        echo '<p><strong>IP Number: </strong>' . $record['ipNumber'] . '</p>';
-        echo '<p><strong>IP Version: </strong>' . $record['ipVersion'] . '</p>';
-        echo '<p><strong>Country Code: </strong>' . $record['countryCode'] . '</p>';
-        echo '<p><strong>Country: </strong>' . $record['countryName'] . '</p>';
-        echo '<p><strong>State: </strong>' . $record['regionName'] . '</p>';
-        echo '<p><strong>City: </strong>' . $record['cityName'] . '</p>';
-        echo '<p><strong>Proxy Type: </strong>' . $record['proxyType'] . '</p>';
-        echo '<p><strong>Is Proxy: </strong>' . $record['isProxy'] . '</p>';
-        echo '<p><strong>ISP: </strong>' . $record['isp'] . '</p>';
+        $records = IP2ProxyLaravel::get('1.2.3.4', 'ws');
+
+        echo '<pre>';
+        print_r($records);
+        echo '</pre>';
     }
 }
+
 ```
-4. Add the following line into the *routes/web.php* file.
+6. Add the following line into the *routes/web.php* file.
 ```
 Route::get('test', 'TestController@lookup');
 ```
-5. Enter the URL <your domain>/public/test and run. You should see the information of **1.2.3.4** IP address.
+7. Enter the URL <your domain>/public/test and run. You should see the information of **1.2.3.4*** IP address.
 
 ## DEPENDENCIES (IP2PROXY BIN DATA FILE)
 

composer.json

@@ -17,7 +17,7 @@
     "minimum-stability": "stable",
     "require": {
         "php": ">=5.4",
-        "ip2location/ip2proxy-php": "1.*"
+        "ip2location/ip2proxy-php": ">=4"
     },
     "autoload": {
         "psr-4": {

src/IP2ProxyLaravel.php

@@ -4,22 +4,36 @@
 
 class IP2ProxyLaravel
 {
-
-    public function get($ip)
+    private function load($mode)
     {
-        $db = new \IP2Proxy\Database();
-        $db->open($this->getDatabasePath(), \IP2Proxy\Database::FILE_IO);
-
-        $records = $db->getAll($ip);
-
-        $db->close();
-
-        return $records;
+        if ($mode == 'bin')
+        {
+            $this->$db = new \IP2Proxy\Database($this->getDatabasePath(), \IP2PROXY\Database::FILE_IO);
+        } else if ($mode == 'ws')
+        {
+            $apikey = \Config::get('site_vars.IP2ProxyAPIKey');
+            $package = (null !== \Config::get('site_vars.IP2ProxyPackage')) ? \Config::get('site_vars.IP2ProxyPackage') : 'PX1';
+            $ssl = (null !== \Config::get('site_vars.IP2ProxyUsessl')) ? \Config::get('site_vars.IP2ProxyUsessl') : false;
+            $this->ws = new \IP2Proxy\WebService($apikey, $package, $ssl);
+        }
     }
 
     private function getDatabasePath()
     {
         return config('ip2proxylaravel.ip2proxy.local.path');
     }
 
+    public function get($ip, $mode = 'bin')
+    {
+        $this->load($mode);
+        if ($mode == 'bin')
+        {
+            $records = $this->db->lookup($ip, \IP2PROXY\Database::ALL);
+        } else if ($mode == 'ws')
+        {
+            $records = $this->ws->lookup($ip);
+        }
+        return $records;
+    }
+
 }

src/IP2ProxyLaravelServiceProvider.php

@@ -24,9 +24,9 @@ public function boot()
      */
     public function register()
     {
-		//Dynamically add IP2ProxyLaravel alias
-		AliasLoader::getInstance()->alias('IP2ProxyLaravel', 'Ip2location\IP2ProxyLaravel\Facade\IP2ProxyLaravel');
-		
+        //Dynamically add IP2ProxyLaravel alias
+        AliasLoader::getInstance()->alias('IP2ProxyLaravel', 'Ip2location\IP2ProxyLaravel\Facade\IP2ProxyLaravel');
+
         $config = __DIR__.'/Config/ip2proxylaravel.php';
 
         $this->publishes([