Add back current uv index.

Author: cmfcmf

Cmfcmf/OpenWeatherMap.php

@@ -309,6 +309,27 @@ public function getWeatherHistory($query, \DateTime $start, $endOrCount = 1, $ty
         return new WeatherHistory($xml, $query);
     }
 
+    /**
+     * Returns the current uv index at the location you specified.
+     *
+     * @param float              $lat           The location's latitude.
+     * @param float              $lon           The location's longitude.
+     *
+     * @throws OpenWeatherMap\Exception  If OpenWeatherMap returns an error.
+     * @throws \InvalidArgumentException If an argument error occurs.
+     *
+     * @return UVIndex The uvi object.
+     *
+     * @api
+     */
+    public function getCurrentUVIndex($lat, $lon)
+    {
+        $answer = $this->getRawCurrentUVIndexData($lat, $lon);
+        $json = $this->parseJson($answer);
+
+        return new UVIndex($json);
+    }
+
     /**
      * Returns the uv index at date, time and location you specified.
      *
@@ -468,7 +489,30 @@ public function getRawWeatherHistory($query, \DateTime $start, $endOrCount = 1,
     }
 
     /**
-     * Directly returns the json string returned by OpenWeatherMap for the UVI data.
+     * Directly returns the json string returned by OpenWeatherMap for the current UV index data.
+     *
+     * @param float $lat                   The location's latitude.
+     * @param float $lon                   The location's longitude.
+     *
+     * @return bool|string Returns the fetched data.
+     *
+     * @api
+     */
+    public function getRawCurrentUVIndexData($lat, $lon)
+    {
+        if (!$this->apiKey) {
+            throw new \RuntimeException('Before using this method, you must set the api key using ->setApiKey()');
+        }
+        if (!is_float($lat) || !is_float($lon)) {
+            throw new \InvalidArgumentException('$lat and $lon must be floating point numbers');
+        }
+        $url = $this->buildUVIndexUrl($lat, $lon);
+
+        return $this->cacheOrFetchResult($url);
+    }
+
+    /**
+     * Directly returns the json string returned by OpenWeatherMap for the UV index data.
      *
      * @param float $lat                   The location's latitude.
      * @param float $lon                   The location's longitude.
@@ -572,36 +616,40 @@ private function buildUrl($query, $units, $lang, $appid, $mode, $url)
      *
      * @return string
      */
-    private function buildUVIndexUrl($lat, $lon, $dateTime, $timePrecision)
+    private function buildUVIndexUrl($lat, $lon, $dateTime = null, $timePrecision = null)
     {
-        $format = '\Z';
-        switch ($timePrecision) {
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'second':
-                $format = ':s' . $format;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'minute':
-                $format = ':i' . $format;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'hour':
-                $format = '\TH' . $format;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'day':
-                $format = '-d' . $format;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'month':
-                $format = '-m' . $format;
-            case 'year':
-                $format = 'Y' . $format;
-                break;
-            default:
-                throw new \InvalidArgumentException('$timePrecision is invalid.');
+        if ($dateTime !== null) {
+            $format = '\Z';
+            switch ($timePrecision) {
+                /** @noinspection PhpMissingBreakStatementInspection */
+                case 'second':
+                    $format = ':s' . $format;
+                /** @noinspection PhpMissingBreakStatementInspection */
+                case 'minute':
+                    $format = ':i' . $format;
+                /** @noinspection PhpMissingBreakStatementInspection */
+                case 'hour':
+                    $format = '\TH' . $format;
+                /** @noinspection PhpMissingBreakStatementInspection */
+                case 'day':
+                    $format = '-d' . $format;
+                /** @noinspection PhpMissingBreakStatementInspection */
+                case 'month':
+                    $format = '-m' . $format;
+                case 'year':
+                    $format = 'Y' . $format;
+                    break;
+                default:
+                    throw new \InvalidArgumentException('$timePrecision is invalid.');
+            }
+            // OWM only accepts UTC timezones.
+            $dateTime->setTimezone(new \DateTimeZone('UTC'));
+            $dateTime = $dateTime->format($format);
+        } else {
+            $dateTime = 'current';
         }
-        // OWM only accepts UTC timezones.
-        $dateTime->setTimezone(new \DateTimeZone('UTC'));
 
-        $url = sprintf($this->uvIndexUrl . '/%s,%s/%s.json?appid=%s', $lat, $lon, $dateTime->format($format), $this->apiKey);
-        return $url;
+        return sprintf($this->uvIndexUrl . '/%s,%s/%s.json?appid=%s', $lat, $lon, $dateTime, $this->apiKey);
     }
 
     /**

tests/Exceptions/OpenWeatherMapExceptionTest.php

@@ -119,13 +119,22 @@ public function testGetRawWeatherHistoryWithEndDateException()
 
     /**
      * @expectedException \InvalidArgumentException
-     * @dataProvider      uviExceptionDataProvider
+     * @dataProvider      uvIndexExceptionDataProvider
      */
     public function testGetRawUVIndexWithQueryErrorException($lat, $lon, $dateTime)
     {
         $this->owm->getRawUVIndexData($lat, $lon, $dateTime);
     }
 
+    /**
+     * @expectedException \InvalidArgumentException
+     * @dataProvider      currentUVIndexExceptionDataProvider
+     */
+    public function testGetRawCurrentUVIndexWithQueryErrorException($lat, $lon)
+    {
+        $this->owm->getRawCurrentUVIndexData($lat, $lon);
+    }
+
     /**
      * @expectedException \RuntimeException
      */
@@ -135,6 +144,15 @@ public function testGetRawUVIndexWithoutApiKey()
         $this->owm->getRawUVIndexData(1.1, 1.1, new \DateTime());
     }
 
+    /**
+     * @expectedException \RuntimeException
+     */
+    public function testGetRawCurrentUVIndexWithoutApiKey()
+    {
+        $this->owm->setApiKey(null);
+        $this->owm->getRawCurrentUVIndexData(1.1, 1.1);
+    }
+
     /**
      * @expectedException \InvalidArgumentException
      */
@@ -180,12 +198,21 @@ public function testParseJsonException()
         $method->invoke($this->owm, $answer);
     }
 
-    public function uviExceptionDataProvider()
+    public function uvIndexExceptionDataProvider()
     {
         return array(
             array('error-query-format', 'foo', new \DateTime()),
             array(5.4, 1.2, 'foo'),
             array(5.4, 12, 'foo'),
         );
     }
+
+    public function currentUVIndexExceptionDataProvider()
+    {
+        return array(
+            array('error-query-format', 'foo'),
+            array(5.4, 12),
+            array(5.4, '1.2'),
+        );
+    }
 }

tests/OpenWeatherMapTest.php

@@ -129,6 +129,13 @@ public function testGetWeatherForecast()
         $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\WeatherForecast', $maxDay);
     }
 
+    public function testGetCurrentUVIndex()
+    {
+        $owm = $this->openWeather;
+        $result = $owm->getCurrentUVIndex(40.7, -74.2);
+        $this->assertInstanceOf('\Cmfcmf\OpenWeatherMap\UVIndex', $result);
+    }
+
     public function testGetUVIndex()
     {
         $owm = $this->openWeather;