updated readme

Author: pulkitjalan

README.md

@@ -12,7 +12,7 @@ GeoIP
 
 ## Supported Drivers ([Services](#services))
 
-* [FreeGeoIP](https://freegeoip.net/)
+* [IPStack](https://ipstack.com/)
 * [IP-API](http://ip-api.com/)
 * [Maxmind](https://www.maxmind.com/)
 * [Telize](https://market.mashape.com/fcambus/telize/)
@@ -23,16 +23,12 @@ GeoIP
 
 ## Installation
 
-Install via composer - edit your `composer.json` to require the package.
+Install via composer
 
-```js
-"require": {
-    "pulkitjalan/geoip": "2.*"
-}
+```bash
+composer require pulkitjalan/geoip
 ```
 
-Then run `composer update` in your terminal to pull it in.
-
 ### Laravel
 
 There is a Laravel service provider and facade available.
@@ -72,27 +68,16 @@ $lat = $geoip->getLatitude(); // 51.5141
 $lon = $geoip->getLongitude(); // -3.1969
 ```
 
-#### FreeGeoIP
+#### IPStack
 
-To use the freegeoip as the driver set the config.
+To use the ipstack as the driver set the config.
 
 Example:
 ```php
 $config = [
-    'driver' => 'freegeoip',
-    'freegeoip' => [
-        'secure' => true,
-    ],
-];
-```
-
-Custom install example:
-```php
-$config = [
-    'driver' => 'freegeoip',
-    'freegeoip' => [
-        'url' => 'freegeoip.example.com', // or with a port (freegeoip.example.com:8080)
-        'secure' => true, // or false
+    'driver' => 'ipstack',
+    'ipstack' => [
+        'key' => 'YOUR IPSTACK KEY',
     ],
 ];
 ```
@@ -107,9 +92,6 @@ $config = [
     'driver' => 'ip-api',
     'ip-api' => [
         'key' => 'YOUR IP-API KEY',
-
-        // optionally set secure (https) connection (default: false)
-        'secure' => true
     ],
 ];
 ```
@@ -148,7 +130,7 @@ Example:
 $config = [
     'driver' => 'telize',
     'telize' => [
-        'key' => 'YOUR IP-API KEY',
+        'key' => 'YOUR TELIZE KEY',
     ],
 ];
 ```
@@ -300,13 +282,13 @@ $geoipUpdater->update();
 
 ### Laravel
 
-Once you have registered the service provider, you can use the command `php artisan geoip:update`
+Once you have registered the service provider (supports auto discovery), you can use the command `php artisan geoip:update`
 
 ## Services
 
-#### FreeGeoIP
+#### IPStack
 
-Freegeoip is a free service that can also be used instead of the database file or the paid maxmind service. They do have some limitations so please have a look at the [website](https://freegeoip.net/) first. You can also run a [custom install](https://github.com/fiorix/freegeoip) and use that instead.
+IPStack offers a JSON IP and GeoIP REST API allowing to get a visitor IP address and to query location information from any IP address.
 
 #### IP-API
 

src/Drivers/IPApiDriver.php

@@ -54,19 +54,14 @@ public function getRaw($ip)
      */
     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)) {
-            $baseUrl = $protocol.'//pro.ip-api.com/json/';
+            $baseUrl = 'https://pro.ip-api.com/json/';
             $key = array_get($this->config, 'key');
         }
 

src/config/config.php

@@ -50,17 +50,6 @@
         |
         */
         'key' => env('GEOIP_IPAPI_KEY'),
-
-        /*
-        |--------------------------------------------------------------------------
-        | IP-API Secure connection
-        |--------------------------------------------------------------------------
-        |
-        | Use http or https
-        | Only applicable with the Pro service
-        |
-        */
-        'secure' => env('GEOIP_IPAPI_SECURE', true),
     ],
 
     /*

tests/GeoIPTest.php

@@ -48,7 +48,7 @@ public function test_maxmind_exception()
     public function test_maxmind_database_exception()
     {
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
                 'database' => __DIR__.'/data/GeoIP2-City.mmdb',
             ],
@@ -62,7 +62,7 @@ public function test_maxmind_database_exception()
     public function test_maxmind_invalid_database_exception()
     {
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
                 'database' => __FILE__,
             ],
@@ -76,7 +76,7 @@ public function test_maxmind_invalid_database_exception()
     public function test_maxmind_web_api_exception()
     {
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
                 'user_id' => 'test',
             ],
@@ -90,9 +90,9 @@ public function test_maxmind_web_api_exception()
     public function test_maxmind_web_api_authentication_exception()
     {
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
-                'user_id'     => 'test',
+                'user_id' => 'test',
                 'license_key' => 'test',
             ],
         ];
@@ -108,9 +108,9 @@ public function test_maxmind_web_api_authentication_exception()
     public function test_maxmind_web_api_authentication_exception_getRaw()
     {
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
-                'user_id'     => 'test',
+                'user_id' => 'test',
                 'license_key' => 'test',
             ],
         ];
@@ -182,7 +182,7 @@ public function test_ipstack_exception_without_key()
     public function test_maxmind_database()
     {
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
                 'database' => __DIR__.'/data/GeoIP2-City-Test.mmdb',
             ],
@@ -217,8 +217,7 @@ public function test_ip_api_pro_exception()
         $config = [
             'driver' => 'ip-api',
             'ip-api' => [
-                'key'    => 'test',
-                'secure' => true,
+                'key' => 'test',
             ],
         ];
 
@@ -235,8 +234,7 @@ public function test_ip_api_pro_exception_getRaw()
         $config = [
             'driver' => 'ip-api',
             'ip-api' => [
-                'key'    => 'test',
-                'secure' => true,
+                'key' => 'test',
             ],
         ];
 

tests/GeoIPUpdaterTest.php

@@ -24,7 +24,7 @@ public function test_maxmind_updater()
     {
         $database = __DIR__.'/data/GeoLite2-City.mmdb';
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
                 'database' => $database,
             ],
@@ -41,10 +41,10 @@ public function test_maxmind_updater_invalid_url()
     {
         $database = __DIR__.'/data/GeoLite2-City.mmdb';
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
                 'database' => $database,
-                'download' => 'http://example.com/maxmind_database.mmdb.gz'
+                'download' => 'http://example.com/maxmind_database.mmdb.gz',
             ],
         ];
 
@@ -57,7 +57,7 @@ public function test_maxmind_updater_dir_not_exist()
     {
         $database = __DIR__.'/data/new_dir/GeoLite2-City.mmdb';
         $config = [
-            'driver'  => 'maxmind',
+            'driver' => 'maxmind',
             'maxmind' => [
                 'database' => $database,
             ],