Merge pull request #48 from programmatordev/OPA-48-improve-endpoints-methods-call

Improve endpoints methods call

Author: andrepimpao

README.md

@@ -47,7 +47,7 @@ $openWeatherMap = new OpenWeatherMap(
 );
 
 // Get current weather by coordinate (latitude, longitude)
-$currentWeather = $openWeatherMap->weather->getCurrent(50, 50);
+$currentWeather = $openWeatherMap->weather()->getCurrent(50, 50);
 // Show current temperature
 echo $currentWeather->getTemperature();
 ```

docs/01-usage.md

@@ -44,7 +44,7 @@ $openWeatherMap = new OpenWeatherMap(
 );
 
 // Get current weather by coordinate (latitude, longitude)
-$currentWeather = $openWeatherMap->weather->getCurrent(50, 50);
+$currentWeather = $openWeatherMap->weather()->getCurrent(50, 50);
 // Show current temperature
 echo $currentWeather->getTemperature();
 ```

docs/02-configuration.md

@@ -187,7 +187,7 @@ It is possible to change the cache duration per request:
 
 ```php
 // Response will be cached for 1 hour
-$currentWeather = $openWeatherMap->weather
+$currentWeather = $openWeatherMap->weather()
  ->withCacheTtl(3600)
  ->getCurrent(50, 50);
 ```
@@ -244,20 +244,20 @@ $openWeatherMap = new OpenWeatherMap(
 
 // Using applicationKey as an example,
 // but getters and setters are available for all options
-$openWeatherMap->config->getApplicationKey();
-$openWeatherMap->config->setApplicationKey('newappkey');
+$openWeatherMap->config()->getApplicationKey();
+$openWeatherMap->config()->setApplicationKey('newappkey');
 ```
 
 Just take into account that any change will affect any subsequent request globally:
 
 ```php
 // Using default 'metric' unit system
-$openWeatherMap->weather->getCurrent(50, 50); 
+$openWeatherMap->weather()->getCurrent(50, 50); 
 
 // Set new unit system
-$openWeatherMap->config->setUnitSystem(UnitSystem::IMPERIAL);
+$openWeatherMap->config()->setUnitSystem(UnitSystem::IMPERIAL);
 
 // Using 'imperial' unit system
-$openWeatherMap->weather->getCurrent(50, 50);
-$openWeatherMap->weather->getForecast(50, 50);
+$openWeatherMap->weather()->getCurrent(50, 50);
+$openWeatherMap->weather()->getForecast(50, 50);
 ```

docs/03-supported-apis.md

@@ -36,7 +36,7 @@ Get current and forecast (minutely, hourly and daily) weather data.
 Returns a [`OneCall`](05-objects.md#onecall) object:
 
 ```php
-$weather = $openWeatherMap->oneCall->getWeather(50, 50);
+$weather = $openWeatherMap->oneCall()->getWeather(50, 50);
 
 echo $weather->getCurrent()->getTemperature();
 ```
@@ -52,7 +52,7 @@ Get weather data from a single moment in the past.
 Returns a [`WeatherLocation`](05-objects.md#weatherlocation) object:
 
 ```php
-$weather = $openWeatherMap->oneCall->getHistoryMoment(50, 50, new \DateTime('2023-01-01 12:00:00'));
+$weather = $openWeatherMap->oneCall()->getHistoryMoment(50, 50, new \DateTime('2023-01-01 12:00:00'));
 
 echo $weather->getTemperature();
 ```
@@ -68,7 +68,7 @@ Get aggregated weather data from a single day in the past.
 Returns a [`WeatherAggregate`](05-objects.md#weatheraggregate) object:
 
 ```php
-$weather = $openWeatherMap->oneCall->getHistoryAggregate(50, 50, new \DateTime('1985-07-19'));
+$weather = $openWeatherMap->oneCall()->getHistoryAggregate(50, 50, new \DateTime('1985-07-19'));
 
 echo $weather->getTemperature();
 ```
@@ -86,7 +86,7 @@ Get current weather data.
 Returns a [`WeatherLocation`](05-objects.md#weatherlocation-1) object:
 
 ```php
-$weather = $openWeatherMap->weather->getCurrent(50, 50);
+$weather = $openWeatherMap->weather()->getCurrent(50, 50);
 
 echo $weather->getTemperature();
 ```
@@ -104,7 +104,7 @@ Returns a [`WeatherLocationList`](05-objects.md#weatherlocationlist) object:
 ```php
 // Since it returns 3-hour steps,
 // passing 8 as the numResults means it will return results for the next 24 hours
-$weatherForecast = $openWeatherMap->weather->getForecast(50, 50, 8);
+$weatherForecast = $openWeatherMap->weather()->getForecast(50, 50, 8);
 
 foreach ($weatherForecast->getList() as $weather) {
  echo $weather->getDateTime()->format('Y-m-d H:i:s');
@@ -125,7 +125,7 @@ Get current air pollution data.
 Returns a [`AirPollutionLocation`](05-objects.md#airpollutionlocation) object:
 
 ```php
-$airPollution = $openWeatherMap->airPollution->getCurrent(50, 50);
+$airPollution = $openWeatherMap->airPollution()->getCurrent(50, 50);
 
 echo $airPollution->getAirQuality()->getQualitativeName();
 echo $airPollution->getCarbonMonoxide();
@@ -142,7 +142,7 @@ Get air pollution forecast data per 1-hour for the next 24 hours.
 Returns a [`AirPollutionLocationList`](05-objects.md#airpollutionlocationlist) object:
 
 ```php
-$airPollutionForecast = $openWeatherMap->airPollution->getForecast(50, 50);
+$airPollutionForecast = $openWeatherMap->airPollution()->getForecast(50, 50);
 
 foreach ($airPollutionForecast->getList() as $airPollution) {
  echo $airPollution->getDateTime()->format('Y-m-d H:i:s');
@@ -164,7 +164,7 @@ Returns a [`AirPollutionLocationList`](05-objects.md#airpollutionlocationlist) o
 ```php
 $startDate = new \DateTime('-7 days'); // 7 days ago
 $endDate = new \DateTime('-6 days'); // 6 days ago
-$airPollutionHistory = $openWeatherMap->airPollution->getHistory(50, 50, $startDate, $endDate);
+$airPollutionHistory = $openWeatherMap->airPollution()->getHistory(50, 50, $startDate, $endDate);
 
 foreach ($airPollutionHistory->getList() as $airPollution) {
  echo $airPollution->getDateTime()->format('Y-m-d H:i:s');
@@ -189,7 +189,7 @@ Get locations data by location name.
 Returns an array of [`Location`](05-objects.md#location) objects:
 
 ```php
-$locations = $openWeatherMap->geocoding->getByLocationName('lisbon');
+$locations = $openWeatherMap->geocoding()->getByLocationName('lisbon');
 
 foreach ($locations as $location) {
  echo $location->getName();
@@ -208,7 +208,7 @@ Get location data by zip/post code.
 Returns a [`ZipCodeLocation`](05-objects.md#zipcodelocation) object:
 
 ```php
-$location = $openWeatherMap->geocoding->getByZipCode('1000-001', 'pt');
+$location = $openWeatherMap->geocoding()->getByZipCode('1000-001', 'pt');
 
 echo $location->getName();
 ```
@@ -227,7 +227,7 @@ Get locations data by coordinate.
 Returns an array of [`Location`](05-objects.md#location) objects:
 
 ```php
-$locations = $openWeatherMap->geocoding->getByCoordinate(50, 50);
+$locations = $openWeatherMap->geocoding()->getByCoordinate(50, 50);
 
 foreach ($locations as $location) {
  echo $location->getName();
@@ -251,7 +251,7 @@ Only available for [`OneCall`](#one-call) and [`Weather`](#weather) APIs.
 use ProgrammatorDev\OpenWeatherMap\UnitSystem\UnitSystem;
 
 // Uses 'imperial' unit system for this request alone
-$openWeatherMap->weather
+$openWeatherMap->weather()
  ->withUnitSystem(UnitSystem::IMPERIAL)
  ->getCurrent(50, 50);
 ```
@@ -270,7 +270,7 @@ Only available for [`OneCall`](#one-call) and [`Weather`](#weather) APIs.
 use ProgrammatorDev\OpenWeatherMap\Language\Language
 
 // Uses 'pt' language for this request alone
-$openWeatherMap->weather
+$openWeatherMap->weather()
  ->withLanguage(Language::PORTUGUESE)
  ->getCurrent(50, 50);
 ```
@@ -296,7 +296,7 @@ Available for all APIs if `cache` is enabled in the [configuration](02-configura
 use ProgrammatorDev\OpenWeatherMap\Language\Language
 
 // Cache will be saved for 1 hour for this request alone
-$openWeatherMap->weather
+$openWeatherMap->weather()
  ->withCacheTtl(3600)
  ->getCurrent(50, 50);
 ```

docs/04-error-handling.md

@@ -15,9 +15,9 @@ use ProgrammatorDev\OpenWeatherMap\Exception\UnauthorizedException;
 use ProgrammatorDev\OpenWeatherMap\Exception\UnexpectedErrorException;
 
 try {
- $location = $openWeatherMap->geocoding->getByZipCode('1000-001', 'pt');
+ $location = $openWeatherMap->geocoding()->getByZipCode('1000-001', 'pt');
 
- $weather = $openWeatherMap->oneCall->getWeather(
+ $weather = $openWeatherMap->oneCall()->getWeather(
  $location->getCoordinate()->getLatitude(),
  $location->getCoordinate()->getLongitude()
  );
@@ -57,9 +57,9 @@ To catch all API errors with a single exception, `ApiErrorException` is availabl
 use ProgrammatorDev\OpenWeatherMap\Exception\ApiErrorException;
 
 try {
- $location = $openWeatherMap->geocoding->getByZipCode('1000-001', 'pt');
+ $location = $openWeatherMap->geocoding()->getByZipCode('1000-001', 'pt');
 
- $weather = $openWeatherMap->oneCall->getWeather(
+ $weather = $openWeatherMap->oneCall()->getWeather(
  $location->getCoordinate()->getLatitude(),
  $location->getCoordinate()->getLongitude()
  );
@@ -80,7 +80,7 @@ use ProgrammatorDev\YetAnotherPhpValidator\Exception\ValidationException;
 
 try {
  // An invalid latitude value is given
- $weather = $openWeatherMap->weather->getCurrent(999, 50);
+ $weather = $openWeatherMap->weather()->getCurrent(999, 50);
 }
 catch (ValidationException $exception) {
  // Should print:

src/Endpoint/AbstractEndpoint.php

@@ -42,7 +42,7 @@ class AbstractEndpoint
 
  public function __construct(protected OpenWeatherMap $api)
  {
- $this->config = $this->api->config;
+ $this->config = $this->api->config();
 
  $this->httpClientBuilder = $this->config->getHttpClientBuilder();
  $this->cache = $this->config->getCache();

src/OpenWeatherMap.php

@@ -9,19 +9,30 @@
 
 class OpenWeatherMap
 {
- public OneCallEndpoint $oneCall;
+ public function __construct(private readonly Config $config) {}
 
- public WeatherEndpoint $weather;
+ public function config(): Config
+ {
+ return $this->config;
+ }
 
- public AirPollutionEndpoint $airPollution;
+ public function oneCall(): OneCallEndpoint
+ {
+ return new OneCallEndpoint($this);
+ }
 
- public GeocodingEndpoint $geocoding;
+ public function weather(): WeatherEndpoint
+ {
+ return new WeatherEndpoint($this);
+ }
+
+ public function airPollution(): AirPollutionEndpoint
+ {
+ return new AirPollutionEndpoint($this);
+ }
 
- public function __construct(public readonly Config $config)
+ public function geocoding(): GeocodingEndpoint
  {
- $this->oneCall = new OneCallEndpoint($this);
- $this->weather = new WeatherEndpoint($this);
- $this->airPollution = new AirPollutionEndpoint($this);
- $this->geocoding = new GeocodingEndpoint($this);
+ return new GeocodingEndpoint($this);
  }
 }

tests/AbstractEndpointTest.php

@@ -20,7 +20,7 @@ public function testAbstractEndpointWithCache()
  $cache->expects($this->once())->method('save');
 
  $api = $this->givenApi();
- $api->config->setCache($cache);
+ $api->config()->setCache($cache);
 
  $this->mockSendRequest($api);
  }
@@ -35,7 +35,7 @@ public function testAbstractEndpointWithLogger()
  $logger->expects($this->atLeastOnce())->method('info');
 
  $api = $this->givenApi();
- $api->config->setLogger($logger);
+ $api->config()->setLogger($logger);
 
  $this->mockSendRequest($api);
  }

tests/AirPollutionEndpointTest.php

@@ -25,15 +25,15 @@ public function testAirPollutionGetCurrent()
  )
  );
 
- $response = $this->givenApi()->airPollution->getCurrent(50, 50);
+ $response = $this->givenApi()->airPollution()->getCurrent(50, 50);
  $this->assertCurrentResponse($response);
  }
 
  #[DataProviderExternal(InvalidParamDataProvider::class, 'provideInvalidCoordinateData')]
  public function testAirPollutionGetCurrentWithInvalidCoordinate(float $latitude, float $longitude, string $expectedException)
  {
  $this->expectException($expectedException);
- $this->givenApi()->airPollution->getCurrent($latitude, $longitude);
+ $this->givenApi()->airPollution()->getCurrent($latitude, $longitude);
  }
 
  // --- FORECAST ---
@@ -47,15 +47,15 @@ public function testAirPollutionGetForecast()
  )
  );
 
- $response = $this->givenApi()->airPollution->getForecast(50, 50);
+ $response = $this->givenApi()->airPollution()->getForecast(50, 50);
  $this->assertForecastResponse($response);
  }
 
  #[DataProviderExternal(InvalidParamDataProvider::class, 'provideInvalidCoordinateData')]
  public function testAirPollutionGetForecastWithInvalidCoordinate(float $latitude, float $longitude, string $expectedException)
  {
  $this->expectException($expectedException);
- $this->givenApi()->airPollution->getForecast($latitude, $longitude);
+ $this->givenApi()->airPollution()->getForecast($latitude, $longitude);
  }
 
  // --- HISTORY ---
@@ -71,7 +71,7 @@ public function testAirPollutionGetHistory()
 
  $utcTimezone = new \DateTimeZone('UTC');
 
- $response = $this->givenApi()->airPollution->getHistory(
+ $response = $this->givenApi()->airPollution()->getHistory(
  50,
  50,
  new \DateTimeImmutable('-5 days', $utcTimezone),
@@ -88,7 +88,7 @@ public function testAirPollutionGetHistoryWithInvalidCoordinate(float $latitude,
  $startDate = new \DateTimeImmutable('-5 days');
  $endDate = new \DateTimeImmutable('-4 days');
 
- $this->givenApi()->airPollution->getHistory($latitude, $longitude, $startDate, $endDate);
+ $this->givenApi()->airPollution()->getHistory($latitude, $longitude, $startDate, $endDate);
  }
 
  #[DataProviderExternal(InvalidParamDataProvider::class, 'provideInvalidPastDateData')]
@@ -98,7 +98,7 @@ public function testAirPollutionGetHistoryWithInvalidPastStartDate(
  )
  {
  $this->expectException($expectedException);
- $this->givenApi()->airPollution->getHistory(
+ $this->givenApi()->airPollution()->getHistory(
  50,
  50,
  $startDate,
@@ -113,7 +113,7 @@ public function testAirPollutionGetHistoryWithInvalidPastEndDate(
  )
  {
  $this->expectException($expectedException);
- $this->givenApi()->airPollution->getHistory(
+ $this->givenApi()->airPollution()->getHistory(
  50,
  50,
  new \DateTimeImmutable('-5 days', new \DateTimeZone('UTC')),
@@ -129,7 +129,7 @@ public function testAirPollutionGetHistoryWithInvalidDateRange(
  )
  {
  $this->expectException($expectedException);
- $this->givenApi()->airPollution->getHistory(50, 50, $startDate, $endDate);
+ $this->givenApi()->airPollution()->getHistory(50, 50, $startDate, $endDate);
  }
 
  // --- ASSERT METHODS EXIST ---

tests/ApiErrorTest.php

@@ -24,7 +24,7 @@ public function testApiError(int $statusCode, string $expectedException)
  );
 
  $this->expectException($expectedException);
- $this->givenApi()->weather->getCurrent(38.7077507, -9.1365919);
+ $this->givenApi()->weather()->getCurrent(38.7077507, -9.1365919);
  }
 
  public static function provideApiErrorData(): \Generator