First release

Author: ip2location

README.md

@@ -0,0 +1,76 @@
+# IP2Proxy Laravel Extension
+
+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.
+
+
+## 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
+    - IP2Proxy free LITE database at http://lite.ip2location.com
+    - IP2Proxy commercial database at http://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.
+
+
+## USAGE
+
+In this tutorial, we will show you on how to create a **TestController** to display the IP information.
+
+1. Create a **TestController** in Laravel using the below command line
+```
+php artisan make:controller TestController
+```
+2. Open the **app/Http/Controllers/TestController.php** in any text editor.
+3. Add the below lines into the controller file.
+```
+<?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(){
+        //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>';
+    }
+}
+```
+4. 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.
+
+## DEPENDENCIES (IP2PROXY BIN DATA FILE)
+
+This library requires IP2Proxy BIN data file to function. You may download the BIN data file at
+* IP2Proxy LITE BIN Data (Free): http://lite.ip2location.com
+* IP2Proxy Commercial BIN Data (Comprehensive): http://www.ip2location.com/proxy-database
+
+
+## SUPPORT
+
+Email: [email protected]
+
+Website: http://www.ip2location.com

composer.json

@@ -0,0 +1,27 @@
+{
+    "name": "ip2location/ip2proxy-laravel",
+    "description": "Allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.",
+    "license": "MIT",
+    "keywords": [
+        "laravel",
+        "laravel 5",
+        "IP2Proxy",
+        "proxy"
+    ],
+    "authors": [
+        {
+            "name": "IP2Location",
+            "email": "[email protected]"
+        }
+    ],
+    "minimum-stability": "stable",
+    "require": {
+        "php": ">=5.4",
+        "ip2location/ip2proxy-php": "1.*"
+    },
+    "autoload": {
+        "psr-4": {
+            "Ip2location\\IP2ProxyLaravel\\": "src/"
+        }
+    }
+}

license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 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.

phpunit.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="false"
+         bootstrap="../../../bootstrap/autoload.php"
+>
+    <testsuites>
+        <testsuite name="IP2ProxyLaravel Package Test Suite">
+            <directory>./tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/Config/ip2proxylaravel.php

@@ -0,0 +1,10 @@
+<?php
+return[
+
+    'ip2proxy' => [
+        'local' => [
+            'path' => database_path('ip2proxy/IP2PROXY.BIN'),
+        ],
+    ],
+
+];

src/Facade/IP2ProxyLaravel.php

@@ -0,0 +1,12 @@
+<?php
+namespace Ip2location\IP2ProxyLaravel\Facade;
+
+use Illuminate\Support\Facades\Facade;
+
+class IP2ProxyLaravel extends Facade
+{
+    protected static function getFacadeAccessor()
+    {
+        return 'ip2proxylaravel';
+    }
+}

src/IP2ProxyLaravel.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Ip2location\IP2ProxyLaravel;
+
+class IP2ProxyLaravel
+{
+
+    public function get($ip)
+    {
+        $db = new \IP2Proxy\Database()
+        $db->open($this->getDatabasePath(), \IP2Proxy\Database::FILE_IO);
+
+        $records = $db->getAll($ip);
+
+        $db->close();
+
+        return $records;
+    }
+
+    private function getDatabasePath()
+    {
+        return config('ip2proxylaravel.ip2proxy.local.path');
+    }
+
+}

src/IP2ProxyLaravelServiceProvider.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Ip2location\IP2ProxyLaravel;
+
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Foundation\AliasLoader;
+
+class IP2ProxyLaravelServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $this->app->bind('ip2proxylaravel', IP2ProxyLaravel::class);
+    }
+
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+		//Dynamically add IP2ProxyLaravel alias
+		AliasLoader::getInstance()->alias('IP2ProxyLaravel', 'Ip2location\IP2ProxyLaravel\Facade\IP2ProxyLaravel');
+		
+        $config = __DIR__.'/Config/ip2proxylaravel.php';
+
+        $this->publishes([
+            $config => config_path('ip2proxylaravel.php'),
+        ], 'config');
+
+        $this->mergeConfigFrom( $config, 'ip2proxylaravel');
+
+        // $this->app['ip2proxylaravel'] = $this->app->share(function($app){
+            // return new IP2ProxyLaravel;
+        // });
+    }
+}

tests/BasicTest.php

@@ -0,0 +1,16 @@
+<?php
+
+use Illuminate\Foundation\Testing\WithoutMiddleware;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+
+class BasicTest extends TestCase
+{
+
+    public function testGet()
+    {
+        $result = IP2ProxyLaravel::get('1.2.3.4');
+        $this->assertEquals($result['isProxy'], '1');
+    }
+
+}