added telize driver

Author: pulkitjalan

README.md

@@ -10,7 +10,15 @@ GeoIP
 [![Latest Version](http://img.shields.io/packagist/v/pulkitjalan/geoip.svg?style=flat-square)](https://packagist.org/packages/pulkitjalan/geoip)
 [![Total Downloads](https://img.shields.io/packagist/dt/pulkitjalan/geoip.svg?style=flat-square)](https://packagist.org/packages/pulkitjalan/geoip)
 
-This package requires PHP >= 5.4
+## Supported Drivers ([Services](#services))
+
+* [IP-API](http://ip-api.com/)
+* [Telize](http://www.telize.com/)
+* [Maxmind](https://www.maxmind.com/)
+
+## Requirements
+
+* PHP >= 5.4
 
 ## Installation
 
@@ -44,8 +52,6 @@ Next run `php artisan config:publish pulkitjalan/geoip` to publish the config fi
 
 ## Usage
 
-Supported Drivers: [ip-api](http://ip-api.com/) and [maxmind](https://www.maxmind.com/)
-
 The geoip class takes a config array as the first parameter or defaults to using the `ip-api` driver.
 
 Example:
@@ -61,7 +67,7 @@ $lat = $geoip->getLatitude(); // 51.5141
 $lon = $geoip->getLongitude(); // -3.1969
 ```
 
-### IP-API
+#### IP-API
 
 To use the ip-api pro service you can set the options in your config.
 
@@ -78,7 +84,22 @@ $config = [
 ];
 ```
 
-### Maxmind
+#### Telize
+
+To use the telize as the driver set the config, can also use https instead by setting `secure` to `true`.
+
+Secure Example:
+```php
+$config = [
+    'driver' => 'telize',
+    'telize' => [
+        // optionally set secure (https) connection (default: false)
+        'secure' => true
+    ],
+];
+```
+
+#### Maxmind
 
 Maxmind support the database type and also web api type.
 
@@ -107,19 +128,19 @@ $config = [
 
 To use this package in Laravel, simply update the config file in `config/packages/pulkitjalan/geoip/config.php` to get the same effect.
 
-### Methods
-
-Here are the avaliable methods to pull out the required information.
+### Available Methods
 
-Set IP (Optional)
+GeoIP will try to determin the ip using the following http headers: `HTTP_CLIENT_IP`, `HTTP_X_FORWARDED_FOR`, `HTTP_X_FORWARDED`, `HTTP_FORWARDED_FOR`, `HTTP_FORWARDED`, `REMOTE_ADDR` in this order. Optionally use the `setIp` method to set it.
 
 ```php
-$geoip->setIP('127.0.0.1');
+$geoip->setIp('127.0.0.1');
 
 // Laravel
-GeoIP::setIP('127.0.0.1');
+GeoIP::setIp('127.0.0.1');
 ```
 
+There are a number of available methods to pull out the required information. All methods will return an empty string if data is unavailable.
+
 Get latitude
 
 ```php
@@ -134,7 +155,7 @@ Get longitude
 ```php
 $geoip->getLongitude();
 
-//Laravel
+// Laravel
 GeoIP::getLongitude();
 ```
 
@@ -143,7 +164,7 @@ Get city
 ```php
 $geoip->getCity();
 
-//Laravel
+// Laravel
 GeoIP::getCity();
 ```
 
@@ -152,7 +173,7 @@ Get country
 ```php
 $geoip->getCountry();
 
-//Laravel
+// Laravel
 GeoIP::getCountry();
 ```
 
@@ -161,7 +182,7 @@ Get country code
 ```php
 $geoip->getCountryCode();
 
-//Laravel
+// Laravel
 GeoIP::getCountryCode();
 ```
 
@@ -170,7 +191,7 @@ Get region
 ```php
 $geoip->getRegion();
 
-//Laravel
+// Laravel
 GeoIP::getRegion();
 ```
 
@@ -179,7 +200,7 @@ Get region code
 ```php
 $geoip->getRegionCode();
 
-//Laravel
+// Laravel
 GeoIP::getRegionCode();
 ```
 
@@ -188,7 +209,7 @@ Get postal code
 ```php
 $geoip->getPostalCode();
 
-//Laravel
+// Laravel
 GeoIP::getPostalCode();
 ```
 
@@ -197,22 +218,31 @@ Get timezone
 ```php
 $geoip->getTimezone();
 
-//Laravel
+// Laravel
 GeoIP::getTimezone();
 ```
 
+Get isp (not supported on all drivers)
+
+```php
+$geoip->getIsp();
+
+// Laravel
+GeoIP::getIsp();
+```
+
 Get all geo information
 
 ```php
 $geoip->get(); // returns array
 
-//Laravel
+// Laravel
 GeoIP::get(); // returns array
 ```
 
 ### Update Database
 
-There is an update command avaliable to help with updating and installing a local geoip database. The following will download and install/update the database file to `/path/to/database.mmdb`.
+There is an update command available to help with updating and installing a local geoip database. The following will download and install/update the database file to `/path/to/database.mmdb`.
 
 ```php
 <?php
@@ -236,10 +266,14 @@ Once you have registered the service provider, you can use the command `php arta
 
 ## Services
 
-### IP-API
+#### IP-API
 
 IP-API is a free (or paid) service that can also be used instead of the database file or the paid maxmind service. They do have some limitations on the free service so please have a look at the [docs](http://ip-api.com/docs/) first.
 
-### Maxmind
+#### Telize
+
+Telize is a free service that can be used as an alternative. It currently has no limitations.
+
+#### Maxmind
 
 You can use the free database from maxmind or their web api service. You can download the free database service [here](http://dev.maxmind.com/geoip/geoip2/geolite2/) or enter your `user id` and `license key` in the config.

src/Drivers/AbstractGeoIPDriver.php

@@ -2,19 +2,29 @@
 
 namespace PulkitJalan\GeoIP\Drivers;
 
+use GuzzleHttp\Client as GuzzleClient;
+use PulkitJalan\Requester\Requester;
+
 abstract class AbstractGeoIPDriver
 {
     /**
      * @var array
      */
     protected $config;
 
+    /**
+     * @var \PulkitJalan\Requester\Requester
+     */
+    protected $requester;
+
     /**
      * @param array $config
      */
     public function __construct(array $config)
     {
         $this->config = $config;
+
+        $this->requester = with(new Requester(new GuzzleClient()))->retry(2)->every(50);
     }
 
     /**

src/Drivers/IPApiDriver.php

@@ -2,36 +2,8 @@
 
 namespace PulkitJalan\GeoIP\Drivers;
 
-use GuzzleHttp\Client as GuzzleClient;
-use PulkitJalan\Requester\Requester;
-
 class IPApiDriver extends AbstractGeoIPDriver
 {
-    /**
-     * @var string
-     */
-    protected $key;
-
-    /**
-     * @var string
-     */
-    protected $baseUrl = 'http://ip-api.com/json/';
-
-    /**
-     * @var \PulkitJalan\Requester\Requester
-     */
-    protected $requester;
-
-    /**
-     * @param array $config
-     */
-    public function __construct(array $config)
-    {
-        parent::__construct($config);
-
-        $this->requester = $this->create();
-    }
-
     /**
      * Get array of data using ip-api
      *
@@ -56,31 +28,36 @@ public function get($ip)
             'regionCode' => array_get($data, 'regionName'),
             'timezone' => array_get($data, 'timezone'),
             'postalCode' => array_get($data, 'zip'),
+            'organization' => array_get($data, 'org'),
+            'isp' => array_get($data, 'isp'),
         ];
     }
 
-    protected function getUrl($ip)
-    {
-        return $this->baseUrl.$ip.(($this->key) ? '?key='.$this->key : '');
-    }
-
     /**
-     * Create the ip-api driver based on config
+     * Get the ip-api url add key and
+     * change base url if pro user
      *
-     * @return mixed
+     * @param  string $ip
+     * @return string
      */
-    protected function create()
+    protected function getUrl($ip)
     {
         $protocol = 'http:';
         if (array_get($this->config, 'secure', false)) {
             $protocol = 'https:';
         }
 
+        // default to free service
+        // free service does not support https
+        $baseUrl = 'http://ip-api.com/json/';
+        $key = '';
+
+        // if key is set change to pro service
         if (array_get($this->config, 'key', false)) {
-            $this->baseUrl = $protocol.'://pro.ip-api.com/json/';
-            $this->key = array_get($this->config, 'key');
+            $baseUrl = $protocol.'//pro.ip-api.com/json/';
+            $key = array_get($this->config, 'key');
         }
 
-        return with(new Requester(new GuzzleClient()))->retry(2)->every(50);
+        return $baseUrl.$ip.(($key) ? '?key='.$key : '');
     }
 }

src/Drivers/MaxmindDriver.php

@@ -60,10 +60,12 @@ public function get($ip)
      */
     protected function create()
     {
+        // if user_id and license_key are set then use the web service
         if (array_get($this->config, 'user_id', false)) {
             return $this->createWebClient();
         }
 
+        // if database file is set then use database service
         if (array_get($this->config, 'database', false)) {
             return $this->createDatabase();
         }
@@ -105,10 +107,11 @@ protected function createDatabase()
             throw new InvalidCredentialsException();
         }
 
+        // catch maxmind exception and throw geoip exception
         try {
             return new Reader($database);
         } catch (\MaxMind\Db\Reader\InvalidDatabaseException $e) {
-            throw new InvalidDatabaseException($e->getMessage());
+            throw new InvalidDatabaseException($e->getMessage(), $e->getCode(), $e);
         }
     }
 }

src/Drivers/TelizeDriver.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace PulkitJalan\GeoIP\Drivers;
+
+use GuzzleHttp\Exception\RequestException;
+
+class TelizeDriver extends AbstractGeoIPDriver
+{
+    /**
+     * Get array of data using telize
+     *
+     * @param  string $ip
+     * @return array
+     */
+    public function get($ip)
+    {
+        try {
+            $data = $this->requester->url($this->getUrl($ip))->get()->json();
+        } catch (RequestException $e) {
+            return [];
+        }
+
+        return [
+            'city' => array_get($data, 'city'),
+            'country' => array_get($data, 'country'),
+            'countryCode' => array_get($data, 'country_code'),
+            'latitude' => array_get($data, 'latitude'),
+            'longitude' => array_get($data, 'longitude'),
+            'region' => array_get($data, 'region'),
+            'regionCode' => array_get($data, 'region_code'),
+            'timezone' => array_get($data, 'timezone'),
+            'postalCode' => array_get($data, 'postal_code'),
+            'isp' => array_get($data, 'isp'),
+        ];
+    }
+
+    /**
+     * Get the telize url
+     *
+     * @param  string $ip
+     * @return string
+     */
+    protected function getUrl($ip)
+    {
+        $protocol = 'http:';
+        if (array_get($this->config, 'secure', false)) {
+            $protocol = 'https:';
+        }
+
+        $baseUrl = $protocol.'//www.telize.com/geoip/';
+
+        return $baseUrl.$ip;
+    }
+}