added support for ip-api pro

Author: pulkit

.travis.yml

@@ -1,3 +1,4 @@
+sudo: false
 language: php
 
 php:

README.md

@@ -44,19 +44,38 @@ Next run `php artisan config:publish pulkitjalan/geoip` to publish the config fi
 
 ## Usage
 
-The geoip class takes a config array as the first parameter. Example:
+Supported Drivers: [maxmind](https://www.maxmind.com/) and [ip-api](http://ip-api.com/)
+
+The geoip class takes a config array as the first parameter or defaults to using the `ip-api` driver.
+
+Example:
 
 ```php
 <?php
 
 use PulkitJalan\GeoIP\GeoIP
 
-$config = ['driver' => 'ip-api'];
+$geoip = new GeoIP();
+$geoip->setIp('81.2.69.160'); // Optional
 
-$geoip = new GeoIP($config);
+$lat = $geoip->getLatitude(); // 51.5141
+$lon = $geoip->getLongitude(); // -3.1969
 ```
 
-Supported Drivers: [maxmind](https://www.maxmind.com/) and [ip-api](http://ip-api.com/)
+### IP-API
+
+To use the ip-api pro service you can set the options in your config.
+
+```php
+$config = [
+    'driver' => 'ip-api',
+    'ip-api' => [
+        'key' => 'YOUR IP-API KEY',
+    ],
+];
+```
+
+### Maxmind
 
 Maxmind support the database type and also web api type.
 
@@ -83,9 +102,9 @@ $config = [
 
 ### Laravel
 
-Just update the config file in `config/packages/pulkitjalan/geoip/config.php` to get the same effect.
+To use this package in Laravel, simply update the config file in `config/packages/pulkitjalan/geoip/config.php` to get the same effect.
 
-### Get Data
+### Methods
 
 Here are the avaliable methods to pull out the required information.
 

src/Drivers/IPApiDriver.php

@@ -7,6 +7,11 @@
 
 class IPApiDriver extends AbstractGeoIPDriver
 {
+    /**
+     * @var string
+     */
+    protected $key;
+
     /**
      * @var string
      */
@@ -24,7 +29,7 @@ public function __construct(array $config)
     {
         parent::__construct($config);
 
-        $this->requester = with(new Requester(new GuzzleClient()))->retry(2)->every(50);
+        $this->requester = $this->create();
     }
 
     /**
@@ -35,7 +40,7 @@ public function __construct(array $config)
      */
     public function get($ip)
     {
-        $data = $this->requester->url($this->baseUrl.$ip)->get()->json();
+        $data = $this->requester->url($this->getUrl($ip))->get()->json();
 
         if (array_get($data, 'status') === 'fail') {
             return [];
@@ -53,4 +58,24 @@ public function get($ip)
             'postalCode' => array_get($data, 'zip'),
         ];
     }
+
+    protected function getUrl($ip)
+    {
+        return $this->baseUrl.$ip.(($this->key) ? '?key='.$this->key : '');
+    }
+
+    /**
+     * Create the ip-api driver based on config
+     *
+     * @return mixed
+     */
+    protected function create()
+    {
+        if (array_get($this->config, 'key', false)) {
+            $this->baseUrl = 'http://pro.ip-api.com/json/';
+            $this->key = array_get($this->config, 'key');
+        }
+
+        return with(new Requester(new GuzzleClient()))->retry(2)->every(50);
+    }
 }

src/Exceptions/GeoIPException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace PulkitJalan\GeoIP\Exceptions;
+
+class GeoIPException extends \Exception
+{
+}

src/GeoIP.php

@@ -2,6 +2,8 @@
 
 namespace PulkitJalan\GeoIP;
 
+use PulkitJalan\GeoIP\Exceptions\GeoIPException;
+
 class GeoIP
 {
     /**
@@ -69,7 +71,7 @@ public function setIP($ip)
      */
     public function getIP()
     {
-        return ($this->ip) ?: array_get($_SERVER, 'HTTP_CLIENT_IP', array_get($_SERVER, 'HTTP_X_FORWARDED_FOR', array_get($_SERVER, 'HTTP_X_FORWARDED', array_get($_SERVER, 'HTTP_FORWARDED_FOR', array_get($_SERVER, 'HTTP_FORWARDED', array_get($_SERVER, 'REMOTE_ADDR'))))));
+        return ($this->ip) ?: array_get($_SERVER, 'HTTP_CLIENT_IP', array_get($_SERVER, 'HTTP_X_FORWARDED_FOR', array_get($_SERVER, 'HTTP_X_FORWARDED', array_get($_SERVER, 'HTTP_FORWARDED_FOR', array_get($_SERVER, 'HTTP_FORWARDED', array_get($_SERVER, 'REMOTE_ADDR', '127.0.0.1'))))));
     }
 
     /**
@@ -86,7 +88,12 @@ public function get($property = '')
         $data = array_get($this->store, $ip);
 
         if (!$data) {
-            $data = $this->getDriver()->get($ip);
+            try {
+                $data = $this->getDriver()->get($ip);
+            } catch (\Exception $e) {
+                throw new GeoIPException('Failed to get geoip data', 0, $e);
+            }
+
             $this->store[$ip] = $data;
         }
 

src/Laravel/config/config.php

@@ -22,7 +22,6 @@
         | Maxmind Database
         |--------------------------------------------------------------------------
         |
-        | Required with type 'database'
         | Example: app_path().'/database/maxmind/GeoLite2-City.mmdb'
         |
         */
@@ -32,11 +31,22 @@
         |--------------------------------------------------------------------------
         | Maxmind Web Service Info
         |--------------------------------------------------------------------------
-        |
-        | Required with type 'web'
-        |
         */
         'user_id' => '',
         'license_key' => '',
     ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | IP-API Driver
+    |--------------------------------------------------------------------------
+    */
+    'ip-api' => [
+        /*
+        |--------------------------------------------------------------------------
+        | IP-API Pro Service Key
+        |--------------------------------------------------------------------------
+        */
+        'key' => '',
+    ],
 ];

tests/GeoIPTest.php

@@ -78,9 +78,6 @@ public function testMaxmindWebApiException()
         $this->setExpectedException('PulkitJalan\GeoIP\Exceptions\InvalidCredentialsException');
 
         $geoip = new \PulkitJalan\GeoIP\GeoIP($config);
-        $geoip = $geoip->setIP($this->validIP);
-
-        $geoip->get();
     }
 
     public function testMaxmindWebApiAuthenticationException()
@@ -93,7 +90,7 @@ public function testMaxmindWebApiAuthenticationException()
             ],
         ];
 
-        $this->setExpectedException('GeoIp2\Exception\AuthenticationException');
+        $this->setExpectedException('PulkitJalan\GeoIP\Exceptions\GeoIPException');
 
         $geoip = new \PulkitJalan\GeoIP\GeoIP($config);
         $geoip = $geoip->setIP($this->validIP);
@@ -121,6 +118,23 @@ public function testMaxmindDatabase()
         $this->assertEquals($geoip->getCountry(), '');
     }
 
+    public function testIpApiProException()
+    {
+        $config = [
+            'driver' => 'ip-api',
+            'ip-api' => [
+                'key' => 'test',
+            ],
+        ];
+
+        $this->setExpectedException('PulkitJalan\GeoIP\Exceptions\GeoIPException');
+
+        $geoip = new \PulkitJalan\GeoIP\GeoIP($config);
+        $geoip = $geoip->setIP($this->validIP);
+
+        $this->assertEquals($geoip->getCountry(), '');
+    }
+
     public function testIpApi()
     {
         $config = [