tests: added one call resource tests

andrepimpao · andrepimpao · commit 724c5c0745b0 · 2024-05-13T12:17:12.000+01:00
diff --git a/src/Entity/AirPollution/AirPollutionData.php b/src/Entity/AirPollution/AirPollutionData.php
@@ -38,6 +38,9 @@ public function __construct(array $data)
         $this->ammonia = $data['components']['nh3'];
     }
 
+    /**
+     * DateTime in UTC
+     */
     public function getDateTime(): \DateTimeImmutable
     {
         return $this->dateTime;
diff --git a/src/Entity/Location.php b/src/Entity/Location.php
@@ -115,11 +115,17 @@ public function getTimezone(): ?Timezone
         return $this->timezone;
     }
 
+    /**
+     * Sunrise date in UTC
+     */
     public function getSunriseAt(): ?\DateTimeImmutable
     {
         return $this->sunriseAt;
     }
 
+    /**
+     * Sunset date in UTC
+     */
     public function getSunsetAt(): ?\DateTimeImmutable
     {
         return $this->sunsetAt;
diff --git a/src/Entity/OneCall/BaseWeather.php b/src/Entity/OneCall/BaseWeather.php
@@ -51,6 +51,9 @@ public function __construct(array $data)
         $this->snowVolume = $data['snow']['1h'] ?? $data['snow']['3h'] ?? $data['snow'] ?? null;
     }
 
+    /**
+     * DateTime in UTC
+     */
     public function getDateTime(): \DateTimeImmutable
     {
         return $this->dateTime;
diff --git a/src/Entity/OneCall/DayData.php b/src/Entity/OneCall/DayData.php
@@ -62,21 +62,33 @@ public function getMoonPhase(): MoonPhase
         return $this->moonPhase;
     }
 
+    /**
+     * Moonrise date in UTC
+     */
     public function getMoonriseAt(): \DateTimeImmutable
     {
         return $this->moonriseAt;
     }
 
+    /**
+     * Moonset date in UTC
+     */
     public function getMoonsetAt(): \DateTimeImmutable
     {
         return $this->moonsetAt;
     }
 
+    /**
+     * Sunrise date in UTC
+     */
     public function getSunriseAt(): \DateTimeImmutable
     {
         return $this->sunriseAt;
     }
 
+    /**
+     * Sunset date in UTC
+     */
     public function getSunsetAt(): \DateTimeImmutable
     {
         return $this->sunsetAt;
diff --git a/src/Entity/OneCall/MinuteData.php b/src/Entity/OneCall/MinuteData.php
@@ -14,6 +14,9 @@ public function __construct(array $data)
         $this->precipitation = $data['precipitation'];
     }
 
+    /**
+     * DateTime in UTC
+     */
     public function getDateTime(): \DateTimeImmutable
     {
         return $this->dateTime;
diff --git a/src/Entity/OneCall/WeatherData.php b/src/Entity/OneCall/WeatherData.php
@@ -46,11 +46,17 @@ public function getVisibility(): ?int
         return $this->visibility;
     }
 
+    /**
+     * Sunrise date in UTC
+     */
     public function getSunriseAt(): ?\DateTimeImmutable
     {
         return $this->sunriseAt;
     }
 
+    /**
+     * Sunset date in UTC
+     */
     public function getSunsetAt(): ?\DateTimeImmutable
     {
         return $this->sunsetAt;
diff --git a/src/Entity/OneCall/WeatherSummary.php b/src/Entity/OneCall/WeatherSummary.php
@@ -70,6 +70,9 @@ public function getTimezone(): Timezone
         return $this->timezone;
     }
 
+    /**
+     * DateTime in UTC
+     */
     public function getDateTime(): \DateTimeImmutable
     {
         return $this->dateTime;
diff --git a/src/Entity/Weather/WeatherData.php b/src/Entity/Weather/WeatherData.php
@@ -61,6 +61,9 @@ public function __construct(array $data)
         $this->snowVolume = $data['snow']['1h'] ?? $data['snow']['3h'] ?? null;
     }
 
+    /**
+     * DateTime in UTC
+     */
     public function getDateTime(): \DateTimeImmutable
     {
         return $this->dateTime;
diff --git a/src/Resource/AirPollutionResource.php b/src/Resource/AirPollutionResource.php
@@ -11,6 +11,8 @@
 class AirPollutionResource extends Resource
 {
     /**
+     * Get access to current air pollution data
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
@@ -31,6 +33,8 @@ public function getCurrent(float $latitude, float $longitude): AirPollution
     }
 
     /**
+     * Get access to air pollution forecast data
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
@@ -51,6 +55,8 @@ public function getForecast(float $latitude, float $longitude): AirPollutionColl
     }
 
     /**
+     * Get access to historical air pollution data
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
diff --git a/src/Resource/GeocodingResource.php b/src/Resource/GeocodingResource.php
@@ -16,6 +16,8 @@ class GeocodingResource extends Resource
     private const NUM_RESULTS = 5;
 
     /**
+     * Get geographical coordinates (latitude, longitude) by using the name of the location (city name or area name)
+     *
      * @return Location[]
      * @throws ValidationException
      * @throws ClientExceptionInterface
@@ -38,6 +40,8 @@ public function getByLocationName(string $locationName, int $numResults = self::
     }
 
     /**
+     * Get geographical coordinates (latitude, longitude) by using the zip/postal code
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
@@ -58,6 +62,8 @@ public function getByZipCode(string $zipCode, string $countryCode): ZipLocation
     }
 
     /**
+     * Get name of the location (city name or area name) by using geographical coordinates (latitude, longitude)
+     *
      * @return Location[]
      * @throws ValidationException
      * @throws ClientExceptionInterface
diff --git a/src/Resource/OneCallResource.php b/src/Resource/OneCallResource.php
@@ -4,7 +4,6 @@
 
 use ProgrammatorDev\Api\Method;
 use ProgrammatorDev\OpenWeatherMap\Entity\OneCall\Weather;
-use ProgrammatorDev\OpenWeatherMap\Entity\OneCall\WeatherData;
 use ProgrammatorDev\OpenWeatherMap\Entity\OneCall\WeatherMoment;
 use ProgrammatorDev\OpenWeatherMap\Entity\OneCall\WeatherSummary;
 use ProgrammatorDev\OpenWeatherMap\Resource\Util\LanguageTrait;
@@ -18,6 +17,9 @@ class OneCallResource extends Resource
     use UnitSystemTrait;
 
     /**
+     * Get access to current weather, minute forecast for 1 hour, hourly forecast for 48 hours,
+     * daily forecast for 8 days and government weather alerts
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
@@ -38,10 +40,12 @@ public function getWeather(float $latitude, float $longitude): Weather
     }
 
     /**
+     * Get access to weather data for any datetime
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
-    public function getWeatherByDateTime(float $latitude, float $longitude, \DateTimeInterface $dateTime): WeatherMoment
+    public function getWeatherByDate(float $latitude, float $longitude, \DateTimeInterface $dateTime): WeatherMoment
     {
         $this->validateCoordinate($latitude, $longitude);
 
@@ -61,6 +65,8 @@ public function getWeatherByDateTime(float $latitude, float $longitude, \DateTim
     }
 
     /**
+     * Get access to aggregated weather data for a particular date
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
diff --git a/src/Resource/WeatherResource.php b/src/Resource/WeatherResource.php
@@ -18,6 +18,8 @@ class WeatherResource extends Resource
     private const NUM_RESULTS = 40;
 
     /**
+     * Get access to current weather data
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
@@ -38,6 +40,8 @@ public function getCurrent(float $latitude, float $longitude): Weather
     }
 
     /**
+     * Get access to 5-day weather forecast data with 3-hour steps
+     *
      * @throws ValidationException
      * @throws ClientExceptionInterface
      */
diff --git a/src/Test/MockResponse.php b/src/Test/MockResponse.php
diff --git a/tests/Integration/OneCallResourceTest.php b/tests/Integration/OneCallResourceTest.php
@@ -0,0 +1,58 @@
+<?php
+
+namespace ProgrammatorDev\OpenWeatherMap\Test\Integration;
+
+use ProgrammatorDev\OpenWeatherMap\Entity\OneCall\Weather;
+use ProgrammatorDev\OpenWeatherMap\Entity\OneCall\WeatherMoment;
+use ProgrammatorDev\OpenWeatherMap\Entity\OneCall\WeatherSummary;
+use ProgrammatorDev\OpenWeatherMap\Test\AbstractTest;
+use ProgrammatorDev\OpenWeatherMap\Test\MockResponse;
+use ProgrammatorDev\OpenWeatherMap\Test\Util\TestValidationExceptionTrait;
+use ProgrammatorDev\OpenWeatherMap\Test\Util\TestItemResponseTrait;
+
+class OneCallResourceTest extends AbstractTest
+{
+    use TestItemResponseTrait;
+    use TestValidationExceptionTrait;
+
+    public static function provideItemResponseData(): \Generator
+    {
+        yield 'get weather' => [
+            Weather::class,
+            MockResponse::ONE_CALL_WEATHER,
+            'oneCall',
+            'getWeather',
+            [50, 50]
+        ];
+        yield 'get weather by date' => [
+            WeatherMoment::class,
+            MockResponse::ONE_CALL_TIMEMACHINE,
+            'oneCall',
+            'getWeatherByDate',
+            [50, 50, new \DateTime()]
+        ];
+        yield 'get weather summary by date' => [
+            WeatherSummary::class,
+            MockResponse::ONE_CALL_DAY_SUMMARY,
+            'oneCall',
+            'getWeatherSummaryByDate',
+            [50, 50, new \DateTime()]
+        ];
+    }
+
+    public static function provideValidationExceptionData(): \Generator
+    {
+        yield 'get weather, latitude lower than -90' => ['oneCall', 'getWeather', [-91, 50]];
+        yield 'get weather, latitude greater than 90' => ['oneCall', 'getWeather', [91, 50]];
+        yield 'get weather, longitude lower than -180' => ['oneCall', 'getWeather', [50, -181]];
+        yield 'get weather, longitude greater than 180' => ['oneCall', 'getWeather', [50, 181]];
+        yield 'get weather by date, latitude lower than -90' => ['oneCall', 'getWeatherByDate', [-91, 50, new \DateTime()]];
+        yield 'get weather by date, latitude greater than 90' => ['oneCall', 'getWeatherByDate', [91, 50, new \DateTime()]];
+        yield 'get weather by date, longitude lower than -180' => ['oneCall', 'getWeatherByDate', [50, -181, new \DateTime()]];
+        yield 'get weather by date, longitude greater than 180' => ['oneCall', 'getWeatherByDate', [50, 181, new \DateTime()]];
+        yield 'get weather summary by date, latitude lower than -90' => ['oneCall', 'getWeatherSummaryByDate', [-91, 50, new \DateTime()]];
+        yield 'get weather summary by date, latitude greater than 90' => ['oneCall', 'getWeatherSummaryByDate', [91, 50, new \DateTime()]];
+        yield 'get weather summary by date, longitude lower than -180' => ['oneCall', 'getWeatherSummaryByDate', [50, -181, new \DateTime()]];
+        yield 'get weather summary by date, longitude greater than 180' => ['oneCall', 'getWeatherSummaryByDate', [50, 181, new \DateTime()]];
+    }
+}
diff --git a/tests/Integration/OpenWeatherMapTest.php b/tests/Integration/OpenWeatherMapTest.php
@@ -4,13 +4,15 @@
 
 use ProgrammatorDev\OpenWeatherMap\Resource\AirPollutionResource;
 use ProgrammatorDev\OpenWeatherMap\Resource\GeocodingResource;
+use ProgrammatorDev\OpenWeatherMap\Resource\OneCallResource;
 use ProgrammatorDev\OpenWeatherMap\Resource\WeatherResource;
 use ProgrammatorDev\OpenWeatherMap\Test\AbstractTest;
 
 class OpenWeatherMapTest extends AbstractTest
 {
     public function testMethods()
     {
+        $this->assertInstanceOf(OneCallResource::class, $this->api->oneCall());
         $this->assertInstanceOf(WeatherResource::class, $this->api->weather());
         $this->assertInstanceOf(AirPollutionResource::class, $this->api->airPollution());
         $this->assertInstanceOf(GeocodingResource::class, $this->api->geocoding());

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,9 @@ public function __construct(array $data)`
`38`	`38`	`$this->ammonia = $data['components']['nh3'];`
`39`	`39`	`}`
`40`	`40`
	`41`	`+ /**`
	`42`	`+ * DateTime in UTC`
	`43`	`+ */`
`41`	`44`	`public function getDateTime(): \DateTimeImmutable`
`42`	`45`	`{`
`43`	`46`	`return $this->dateTime;`
Original file line number	Diff line number	Diff line change
`@@ -115,11 +115,17 @@ public function getTimezone(): ?Timezone`
`115`	`115`	`return $this->timezone;`
`116`	`116`	`}`
`117`	`117`
	`118`	`+ /**`
	`119`	`+ * Sunrise date in UTC`
	`120`	`+ */`
`118`	`121`	`public function getSunriseAt(): ?\DateTimeImmutable`
`119`	`122`	`{`
`120`	`123`	`return $this->sunriseAt;`
`121`	`124`	`}`
`122`	`125`
	`126`	`+ /**`
	`127`	`+ * Sunset date in UTC`
	`128`	`+ */`
`123`	`129`	`public function getSunsetAt(): ?\DateTimeImmutable`
`124`	`130`	`{`
`125`	`131`	`return $this->sunsetAt;`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,9 @@ public function __construct(array $data)`
`51`	`51`	`$this->snowVolume = $data['snow']['1h'] ?? $data['snow']['3h'] ?? $data['snow'] ?? null;`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ /**`
	`55`	`+ * DateTime in UTC`
	`56`	`+ */`
`54`	`57`	`public function getDateTime(): \DateTimeImmutable`
`55`	`58`	`{`
`56`	`59`	`return $this->dateTime;`
Original file line number	Diff line number	Diff line change
`@@ -62,21 +62,33 @@ public function getMoonPhase(): MoonPhase`
`62`	`62`	`return $this->moonPhase;`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ /**`
	`66`	`+ * Moonrise date in UTC`
	`67`	`+ */`
`65`	`68`	`public function getMoonriseAt(): \DateTimeImmutable`
`66`	`69`	`{`
`67`	`70`	`return $this->moonriseAt;`
`68`	`71`	`}`
`69`	`72`
	`73`	`+ /**`
	`74`	`+ * Moonset date in UTC`
	`75`	`+ */`
`70`	`76`	`public function getMoonsetAt(): \DateTimeImmutable`
`71`	`77`	`{`
`72`	`78`	`return $this->moonsetAt;`
`73`	`79`	`}`
`74`	`80`
	`81`	`+ /**`
	`82`	`+ * Sunrise date in UTC`
	`83`	`+ */`
`75`	`84`	`public function getSunriseAt(): \DateTimeImmutable`
`76`	`85`	`{`
`77`	`86`	`return $this->sunriseAt;`
`78`	`87`	`}`
`79`	`88`
	`89`	`+ /**`
	`90`	`+ * Sunset date in UTC`
	`91`	`+ */`
`80`	`92`	`public function getSunsetAt(): \DateTimeImmutable`
`81`	`93`	`{`
`82`	`94`	`return $this->sunsetAt;`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@ public function __construct(array $data)`
`14`	`14`	`$this->precipitation = $data['precipitation'];`
`15`	`15`	`}`
`16`	`16`
	`17`	`+ /**`
	`18`	`+ * DateTime in UTC`
	`19`	`+ */`
`17`	`20`	`public function getDateTime(): \DateTimeImmutable`
`18`	`21`	`{`
`19`	`22`	`return $this->dateTime;`
Original file line number	Diff line number	Diff line change
`@@ -46,11 +46,17 @@ public function getVisibility(): ?int`
`46`	`46`	`return $this->visibility;`
`47`	`47`	`}`
`48`	`48`
	`49`	`+ /**`
	`50`	`+ * Sunrise date in UTC`
	`51`	`+ */`
`49`	`52`	`public function getSunriseAt(): ?\DateTimeImmutable`
`50`	`53`	`{`
`51`	`54`	`return $this->sunriseAt;`
`52`	`55`	`}`
`53`	`56`
	`57`	`+ /**`
	`58`	`+ * Sunset date in UTC`
	`59`	`+ */`
`54`	`60`	`public function getSunsetAt(): ?\DateTimeImmutable`
`55`	`61`	`{`
`56`	`62`	`return $this->sunsetAt;`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,9 @@ public function getTimezone(): Timezone`
`70`	`70`	`return $this->timezone;`
`71`	`71`	`}`
`72`	`72`
	`73`	`+ /**`
	`74`	`+ * DateTime in UTC`
	`75`	`+ */`
`73`	`76`	`public function getDateTime(): \DateTimeImmutable`
`74`	`77`	`{`
`75`	`78`	`return $this->dateTime;`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,9 @@ public function __construct(array $data)`
`61`	`61`	`$this->snowVolume = $data['snow']['1h'] ?? $data['snow']['3h'] ?? null;`
`62`	`62`	`}`
`63`	`63`
	`64`	`+ /**`
	`65`	`+ * DateTime in UTC`
	`66`	`+ */`
`64`	`67`	`public function getDateTime(): \DateTimeImmutable`
`65`	`68`	`{`
`66`	`69`	`return $this->dateTime;`