added an update command to help with updates

Author: pulkitjalan

README.md

@@ -10,7 +10,7 @@ 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
+This package requires PHP >= 5.4
 
 ## Installation
 
@@ -81,6 +81,8 @@ $config = [
 ];
 ```
 
+### Get Data
+
 Here are the avaliable methods to pull out the required information.
 
 Set IP (Optional)
@@ -149,6 +151,26 @@ Get all geo information
 $geoip->get();
 ```
 
+### 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`.
+
+```php
+<?php
+
+use PulkitJalan\GeoIP\GeoIPUpdater
+
+$config = [
+    'driver' => 'maxmind',
+    'maxmind' => [
+        'database' => '/path/to/database.mmdb',
+    ],
+];
+
+$geoipUpdater = new GeoIPUpdater($config);
+$geoipUpdater->update();
+```
+
 ## Services
 
 ### Maxmind

composer.json

@@ -22,7 +22,10 @@
     "autoload": {
         "psr-4": {
             "PulkitJalan\\GeoIP\\": "src"
-        }
+        },
+        "files": [
+            "helpers.php"
+        ]
     },
     "minimum-stability": "stable"
 }

helpers.php

@@ -0,0 +1,31 @@
+<?php
+
+if (!function_exists('gzdecode')) {
+    /**
+     * gzdecode function
+     */
+    function gzdecode($data)
+    {
+        do {
+            $tempName = uniqid('temp ');
+        } while (file_exists($tempName));
+
+        if (file_put_contents($tempName, $data)) {
+            try {
+                ob_start();
+                @readgzfile($tempName);
+                $uncompressed = ob_get_clean();
+            } catch (Exception $e) {
+                $ex = $e;
+            }
+
+            unlink($tempName);
+
+            if (isset($ex)) {
+                throw $ex;
+            }
+
+            return $uncompressed;
+        }
+    }
+}

src/Drivers/IPApiDriver.php

@@ -17,6 +17,9 @@ class IPApiDriver extends AbstractGeoIPDriver
      */
     protected $requester;
 
+    /**
+     * @param array $config
+     */
     public function __construct(array $config)
     {
         parent::__construct($config);

src/GeoIPUpdater.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace PulkitJalan\GeoIP;
+
+use GuzzleHttp\Client as GuzzleClient;
+use PulkitJalan\Requester\Requester;
+
+class GeoIPUpdater
+{
+    /**
+     * @var string
+     */
+    protected $maxmindUrl = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz';
+
+    /**
+     * @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);
+    }
+
+    /**
+     * Main update function
+     *
+     * @return bool|string
+     */
+    public function update()
+    {
+        if (array_get($this->config, 'maxmind.database', false)) {
+            return $this->updateMaxmindDatabase();
+        }
+
+        return false;
+    }
+
+    /**
+     * Update function for maxmind database
+     *
+     * @return string
+     */
+    protected function updateMaxmindDatabase()
+    {
+        $database = array_get($this->config, 'maxmind.database', '/tmp/GeoLite2-City.mmdb');
+
+        $file = $this->requester->url($this->maxmindUrl)->get()->getBody();
+
+        file_put_contents($database, gzdecode($file));
+
+        return $database;
+    }
+}

src/Laravel/Console/UpdateCommand.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace PulkitJalan\GeoIP\Laravel\Console;
+
+use Illuminate\Console\Command;
+use PulkitJalan\GeoIP\GeoIPUpdater;
+
+class UpdateCommand extends Command
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'geoip:update';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Update geoip database files to the latest version';
+
+    /**
+     * @var \PulkitJalan\GeoIP\GeoIPUpdater
+     */
+    protected $geoIPUpdater;
+
+    /**
+     * Create a new console command instance.
+     *
+     * @param Config $config
+     */
+    public function __construct(array $config)
+    {
+        parent::__construct();
+
+        $this->geoIPUpdater = new GeoIPUpdater($config);
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function fire()
+    {
+        $result = $this->geoIPUpdater->update();
+
+        if (!$result) {
+            $this->error('Update failed!');
+
+            return;
+        }
+
+        $this->info('New update file ('.$result.') installed.');
+    }
+}

src/Laravel/GeoIPServiceProvider.php

@@ -2,7 +2,9 @@
 
 namespace PulkitJalan\GeoIP\Laravel;
 
+use PulkitJalan\GeoIP\Laravel\Console\UpdateCommand;
 use Illuminate\Support\ServiceProvider;
+use PulkitJalan\GeoIP\GeoIP;
 
 class GeoIPServiceProvider extends ServiceProvider
 {
@@ -32,18 +34,44 @@ public function register()
     {
         $this->app->config->package('pulkitjalan/geoip', realpath(__DIR__.'/config'), 'geoip');
 
+        $this->registerGeoIP();
+
+        $this->registerUpdateCommand();
+    }
+
+    /**
+     * Register the main geoip wrapper
+     *
+     * @return void
+     */
+    protected function registerGeoIP()
+    {
         $this->app['geoip'] = $this->app->share(function ($app) {
             return new GeoIP($app->config->get('geoip::config'));
         });
     }
 
+    /**
+     * Register the geoip update console command.
+     *
+     * @return void
+     */
+    protected function registerUpdateCommand()
+    {
+        $this->app['command.geoip.update'] = $this->app->share(function ($app) {
+            return new UpdateCommand($app->config->get('geoip::config'));
+        });
+
+        $this->commands(array('command.geoip.update'));
+    }
+
     /**
      * Get the services provided by the provider.
      *
      * @return string[]
      */
     public function provides()
     {
-        return ['geoip', 'PulkitJalan\GeoIP\GeoIP'];
+        return ['geoip', 'command.geoip.update', 'PulkitJalan\GeoIP\GeoIP'];
     }
 }

tests/GeoIPTest.php

@@ -52,6 +52,20 @@ public function testMaxmindDatabaseException()
         $geoip = new \PulkitJalan\GeoIP\GeoIP($config);
     }
 
+    public function testMaxmindInvalidDatabaseException()
+    {
+        $config = [
+            'driver' => 'maxmind',
+            'maxmind' => [
+                'database' => __FILE__,
+            ],
+        ];
+
+        $this->setExpectedException('MaxMind\Db\Reader\InvalidDatabaseException');
+
+        $geoip = new \PulkitJalan\GeoIP\GeoIP($config);
+    }
+
     public function testMaxmindWebApiException()
     {
         $config = [

tests/GeoIPUpdaterTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace PulkitJalan\GeoIP\Tests;
+
+use PHPUnit_Framework_TestCase;
+use Mockery;
+
+class GeoIPUpdaterTest extends PHPUnit_Framework_TestCase
+{
+    public function tearDown()
+    {
+        Mockery::close();
+    }
+
+    public function testNoUpdate()
+    {
+        $geoipUpdater = new \PulkitJalan\GeoIP\GeoIPUpdater([]);
+
+        $this->assertFalse($geoipUpdater->update());
+    }
+
+    public function testMaxmindUpdater()
+    {
+        $database = __DIR__.'/data/GeoLite2-City.mmdb';
+        $config = [
+            'driver' => 'maxmind',
+            'maxmind' => [
+                'database' => $database,
+            ],
+        ];
+
+        $geoipUpdater = new \PulkitJalan\GeoIP\GeoIPUpdater($config);
+
+        $this->assertEquals($geoipUpdater->update(), $database);
+
+        unlink($database);
+    }
+}