Fix/metar reading (#353)

* Fix reading of the METAR information for AviationWeather. Fix the DI * StyleCI fixes
nabeelio · Aug 8, 2019 · 5cafebe · 5cafebe
1 parent becf6c9
commit 5cafebe
Show file tree

Hide file tree

Showing 11 changed files with 122 additions and 101 deletions.
diff --git a/app/Console/Commands/DevCommands.php b/app/Console/Commands/DevCommands.php
@@ -7,6 +7,7 @@
 use App\Models\Airline;
 use App\Models\Pirep;
 use App\Models\User;
+use App\Services\AirportService;
 use App\Services\AwardService;
 use App\Services\DatabaseService;
 use Illuminate\Database\QueryException;
@@ -55,6 +56,7 @@ public function handle()
             'db-attrs'       => 'dbAttrs',
             'list-awards'    => 'listAwardClasses',
             'manual-insert'  => 'manualInsert',
+            'metar'          => 'getMetar',
             'reset-install'  => 'resetInstall',
             'xml-to-yaml'    => 'xmlToYaml',
         ];
@@ -187,6 +189,19 @@ protected function xmlToYaml()
         $this->info('Writing yaml to storage: '.$file_name);
     }
 
+    protected function getMetar(): void
+    {
+        $icao = $this->argument('param');
+        if (!$icao) {
+            $this->error('Enter an ICAO!');
+            exit();
+        }
+
+        $airportSvc = app(AirportService::class);
+        $metar = $airportSvc->getMetar($icao);
+        $this->info($metar->raw);
+    }
+
     /**
      * Insert the rows from the file, manually advancing each row
      */

diff --git a/app/Contracts/Metar.php b/app/Contracts/Metar.php
@@ -2,7 +2,6 @@
 
 namespace App\Contracts;
 
-use GuzzleHttp\Exception\GuzzleException;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Log;
 
@@ -12,23 +11,15 @@
 abstract class Metar
 {
     /**
-     * Implement retrieving the METAR- Return the string
-     * Needs to be protected, since this shouldn't be
-     * directly called. Call `get_metar($icao)` instead
+     * Implement retrieving the METAR - return the METAR string. Needs to be protected,
+     * since this shouldn't be directly called. Call `get_metar($icao)` instead
      *
      * @param $icao
      *
      * @return mixed
      */
     abstract protected function metar($icao): string;
 
-    /**
-     * @param $icao
-     *
-     * @return string
-     */
-    //abstract protected function taf($icao): string;
-
     /**
      * Download the METAR, wrap in caching
      *
@@ -41,17 +32,23 @@ public function get_metar($icao): string
         $cache = config('cache.keys.WEATHER_LOOKUP');
         $key = $cache['key'].$icao;
 
-        $raw_metar = Cache::remember($key, $cache['time'], function () use ($icao) {
-            try {
-                return $this->metar($icao);
-            } catch (GuzzleException $e) {
-                Log::error('Error getting METAR: '.$e->getMessage(), $e->getTrace());
-                return '';
-            } catch (\Exception $e) {
-                Log::error('Error getting METAR: '.$e->getMessage(), $e->getTrace());
-                return '';
+        if (Cache::has($key)) {
+            $raw_metar = Cache::get($key);
+            if ($raw_metar !== '') {
+                return $raw_metar;
             }
-        });
+        }
+
+        try {
+            $raw_metar = $this->metar($icao);
+        } catch (\Exception $e) {
+            Log::error('Error getting METAR: '.$e->getMessage(), $e->getTrace());
+            return '';
+        }
+
+        if ($raw_metar !== '') {
+            Cache::put($key, $raw_metar, $cache['time']);
+        }
 
         return $raw_metar;
     }

diff --git a/app/Providers/WeatherServiceProvider.php b/app/Providers/WeatherServiceProvider.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Providers;
+
+use App\Contracts\Metar;
+use Illuminate\Support\ServiceProvider;
+
+class WeatherServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        $this->app->bind(
+            Metar::class,
+            config('phpvms.metar')
+        );
+    }
+}
diff --git a/app/Services/AirportService.php b/app/Services/AirportService.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Services;
+
+use App\Contracts\Metar as MetarProvider;
+use App\Contracts\Service;
+use App\Support\Metar;
+
+/**
+ * Class AnalyticsService
+ */
+class AirportService extends Service
+{
+    private $metarProvider;
+
+    public function __construct(
+        MetarProvider $metarProvider
+    ) {
+        $this->metarProvider = $metarProvider;
+    }
+
+    /**
+     * Return the METAR for a given airport
+     *
+     * @param $icao
+     *
+     * @return Metar|null
+     */
+    public function getMetar($icao): Metar
+    {
+        $metar = null;
+        $wind = null;
+        $raw_metar = $this->metarProvider->get_metar($icao);
+
+        if ($raw_metar && $raw_metar !== '') {
+            return new Metar($raw_metar);
+        }
+
+        return null;
+    }
+}
diff --git a/app/Services/Metar/AviationWeather.php b/app/Services/Metar/AviationWeather.php
@@ -3,8 +3,7 @@
 namespace App\Services\Metar;
 
 use App\Contracts\Metar;
-use App\Support\Http;
-use Illuminate\Support\Facades\Cache;
+use App\Support\HttpClient;
 use Illuminate\Support\Facades\Log;
 
 /**
@@ -17,35 +16,39 @@ class AviationWeather extends Metar
         .'dataSource=metars&requestType=retrieve&format=xml&hoursBeforeNow=3'
         .'&mostRecent=true&fields=raw_text&stationString=';
 
+    private $httpClient;
+
+    public function __construct(HttpClient $httpClient)
+    {
+        $this->httpClient = $httpClient;
+    }
+
     /**
      * Implement the METAR - Return the string
      *
      * @param $icao
      *
+     * @throws \Exception
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     *
      * @return string
      */
     protected function metar($icao): string
     {
-        $metar = Cache::remember(
-            config('cache.keys.WEATHER_LOOKUP.key').$icao,
-            config('cache.keys.WEATHER_LOOKUP.time'),
-            function () use ($icao) {
-                $url = static::METAR_URL.$icao;
-
-                try {
-                    $res = Http::get($url, []);
-                    $xml = simplexml_load_string($res);
-                    if (\count($xml->data->METAR->raw_text) === 0) {
-                        return '';
-                    }
-                    return $xml->data->METAR->raw_text->__toString();
-                } catch (\Exception $e) {
-                    Log::error('Error reading METAR: '.$e->getMessage());
-                    return '';
-                }
+        $url = static::METAR_URL.$icao;
+
+        try {
+            $res = $this->httpClient->get($url, []);
+            $xml = simplexml_load_string($res);
+            if (\count($xml->data->METAR->raw_text) === 0) {
+                return '';
             }
-        );
 
-        return $metar;
+            return $xml->data->METAR->raw_text->__toString();
+        } catch (\Exception $e) {
+            Log::error('Error reading METAR: '.$e->getMessage());
+
+            throw $e;
+        }
     }
 }
diff --git a/app/Support/Http.php b/app/Support/Http.php
diff --git a/app/Support/HttpClient.php b/app/Support/HttpClient.php
@@ -2,7 +2,7 @@
 
 namespace App\Support;
 
-use GuzzleHttp\Client;
+use GuzzleHttp\Client as GuzzleClient;
 
 /**
  * Helper for HTTP stuff
@@ -12,7 +12,7 @@ class HttpClient
     private $httpClient;
 
     public function __construct(
-        Client $httpClient
+        GuzzleClient $httpClient
     ) {
         $this->httpClient = $httpClient;
     }

diff --git a/app/Support/Metar.php b/app/Support/Metar.php
@@ -310,7 +310,7 @@ class Metar implements \ArrayAccess
     /*
      * Other variables.
      */
-    private $raw;
+    public $raw;
 
     private $raw_parts = [];
 

diff --git a/app/Widgets/Weather.php b/app/Widgets/Weather.php
@@ -3,7 +3,7 @@
 namespace App\Widgets;
 
 use App\Contracts\Widget;
-use App\Support\Metar;
+use App\Services\AirportService;
 
 /**
  * This is a widget for the 3rd party CheckWX service
@@ -14,26 +14,13 @@ class Weather extends Widget
         'icao' => null,
     ];
 
-    public const URL = 'https://avwx.rest/api/metar/';
-
     /**
      * Attempt to get the data from the CheckWX API
      */
     public function run()
     {
-        /**
-         * @var \App\Contracts\Metar
-         */
-        $klass = config('phpvms.metar');
-        $metar_class = new $klass();
-
-        $metar = null;
-        $wind = null;
-        $raw_metar = $metar_class->get_metar($this->config['icao']);
-
-        if ($raw_metar && $raw_metar !== '') {
-            $metar = new Metar($raw_metar);
-        }
+        $airportSvc = app(AirportService::class);
+        $metar = $airportSvc->getMetar($this->config['icao']);
 
         return view('widgets.weather', [
             'config'    => $this->config,

diff --git a/config/app.php b/config/app.php
@@ -87,6 +87,7 @@
         App\Providers\vaCentralServiceProvider::class,
         App\Providers\ExtendedTimezonelistProvider::class,
         App\Providers\MeasurementsProvider::class,
+        App\Providers\WeatherServiceProvider::class,
     ],
 
     'aliases' => [

diff --git a/tests/VersionTest.php b/tests/VersionTest.php
@@ -24,7 +24,6 @@ public function testGreaterThanVersionStrings(): void
             '7.0.0-beta'   => '7.0.0-alpha',
             '7.0.0-beta.1' => '7.0.0-beta',
             '7.0.0-beta.2' => '7.0.0-beta.1',
-            '7.0.0-beta.1' => '7.0.0-alpha',
         ];
 
         $versionSvc = app(VersionService::class);