✨ Add custom exception on configuration issue

Author: Pythagus

src/Console/Update.php

@@ -5,6 +5,7 @@
 namespace InteractionDesignFoundation\GeoIP\Console;
 
 use Illuminate\Console\Command;
+use InteractionDesignFoundation\GeoIP\Exceptions\MissingConfigurationException;
 
 class Update extends Command
 {
@@ -41,7 +42,13 @@ public function handle()
     public function fire()
     {
         // Get default service
-        $service = app('geoip')->getService();
+        try {
+            $service = app('geoip')->getService();
+        } catch(MissingConfigurationException $e) {
+            $this->components->error($e->getMessage()) ;
+            
+            return static::FAILURE ;
+        }
 
         // Ensure the selected service supports updating
         if (method_exists($service, 'update') === false) {

src/Exceptions/MissingConfigurationException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace InteractionDesignFoundation\GeoIP\Exceptions;
+
+use RuntimeException;
+
+class MissingConfigurationException extends RuntimeException {
+
+}

src/Services/AbstractService.php

@@ -7,6 +7,7 @@
 use InteractionDesignFoundation\GeoIP\Location;
 use Illuminate\Support\Arr;
 use InteractionDesignFoundation\GeoIP\Contracts\ServiceInterface;
+use InteractionDesignFoundation\GeoIP\Exceptions\MissingConfigurationException;
 
 abstract class AbstractService implements ServiceInterface
 {
@@ -56,4 +57,28 @@ public function config($key, $default = null)
     {
         return Arr::get($this->config, $key, $default);
     }
+
+    /**
+     * This method ensures that the given key was filled
+     * by the user, so that the service can be called without
+     * errors raised linked to missing configuration.
+     * 
+     * @param string|string[] $key
+     * @return void
+     */
+    public function ensureConfigurationParameterDefined($keys) {
+        // Be able to accept a string and an array of strings.
+        $keys = is_string($keys) ? [$keys] : $keys ;
+
+        foreach($keys as $key) {
+            $config = $this->config($key) ;
+
+            // If the config is not defined / is empty.
+            if(empty($config)) {
+                $service = (new \ReflectionClass($this))->getShortName() ;
+                
+                throw new MissingConfigurationException("Missing '$key' parameter (service: $service)") ;
+            }
+        }
+    }
 }

src/Services/IPData.php

@@ -24,6 +24,8 @@ class IPData extends AbstractService
      */
     public function boot()
     {
+        $this->ensureConfigurationParameterDefined('key') ;
+
         $this->client = new HttpClient([
             'base_uri' => 'https://api.ipdata.co/',
             'query' => [

src/Services/IPFinder.php

@@ -22,6 +22,8 @@ class IPFinder extends AbstractService
      */
     public function boot()
     {
+        $this->ensureConfigurationParameterDefined('key') ;
+        
         $this->client = new HttpClient([
             'base_uri' => 'https://api.ipfinder.io/v1/',
             'headers' => [

src/Services/MaxMindDatabase.php

@@ -24,6 +24,8 @@ class MaxMindDatabase extends AbstractService
      */
     public function boot()
     {
+        $this->ensureConfigurationParameterDefined('database_path') ;
+
         $path = $this->config('database_path');
         assert(is_string($path), 'Invalid "database_path" config value');
 

src/Services/MaxMindWebService.php

@@ -24,6 +24,8 @@ class MaxMindWebService extends AbstractService
      */
     public function boot()
     {
+        $this->ensureConfigurationParameterDefined(['user_id', 'license_key']) ;
+
         $this->client = new Client(
             $this->config('user_id'),
             $this->config('license_key'),