Use PSR-17 and PSR-18 for HTTP calls

Author: cmfcmf

.travis.yml

@@ -11,14 +11,14 @@ matrix:
     - php: 7.1
     - php: 7.0
     - php: 5.6
-    - php: 5.5
-    - php: 5.4
-    - php: 5.3
-      dist: precise
   fast_finish: true
   allow_failures:
     - php: nightly
 
+cache:
+  directories:
+    - "$HOME/.composer/cache"
+
 before_install:
   - phpenv config-rm xdebug.ini || echo "xdebug not available"
   - INI_FILE=~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
@@ -28,7 +28,7 @@ before_install:
 install:
   # Use composer update instead of composer install to install a working set of
   # dependencies on all PHP versions.
-  - composer update
+  - composer update --prefer-dist --prefer-stable
 
 script:
   - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.xml

Cmfcmf/OpenWeatherMap.php

@@ -21,12 +21,11 @@
 use Cmfcmf\OpenWeatherMap\UVIndex;
 use Cmfcmf\OpenWeatherMap\CurrentWeatherGroup;
 use Cmfcmf\OpenWeatherMap\Exception as OWMException;
-use Cmfcmf\OpenWeatherMap\Fetcher\CurlFetcher;
-use Cmfcmf\OpenWeatherMap\Fetcher\FetcherInterface;
-use Cmfcmf\OpenWeatherMap\Fetcher\FileGetContentsFetcher;
 use Cmfcmf\OpenWeatherMap\WeatherForecast;
 use Cmfcmf\OpenWeatherMap\WeatherHistory;
 use Psr\Cache\CacheItemPoolInterface;
+use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\RequestFactoryInterface;
 
 /**
  * Main class for the OpenWeatherMap-PHP-API. Only use this class.
@@ -89,9 +88,14 @@ class OpenWeatherMap
     private $wasCached = false;
 
     /**
-     * @var FetcherInterface The url fetcher.
+     * @var ClientInterface
      */
-    private $fetcher;
+    private $httpClient;
+
+    /**
+     * @var RequestFactoryInterface
+     */
+    private $httpRequestFactory;
 
     /**
      * @var string
@@ -101,37 +105,31 @@ class OpenWeatherMap
     /**
      * Constructs the OpenWeatherMap object.
      *
-     * @param string                      $apiKey  The OpenWeatherMap API key. Required.
-     * @param null|FetcherInterface       $fetcher The interface to fetch the data from OpenWeatherMap. Defaults to
-     *                                             CurlFetcher() if cURL is available. Otherwise defaults to
-     *                                             FileGetContentsFetcher() using 'file_get_contents()'.
-     * @param null|CacheItemPoolInterface $cache   If set to null, caching is disabled. Otherwise this must be
-     *                                             a PSR 16-compatible cache instance.
-     * @param int                         $ttl     How long weather data shall be cached. Defaults to 10 minutes.
-     *                                             Only used if $cache is not null.
+     * @param string                      $apiKey             The OpenWeatherMap API key. Required.
+     * @param ClientInterface             $httpClient         A PSR-18 compatible HTTP client implementation.
+     * @param RequestFactoryInterface     $httpRequestFactory A PSR-17 compatbile HTTP request factory implementation.
+     * @param null|CacheItemPoolInterface $cache              If set to null, caching is disabled. Otherwise this must be
+     *                                                        a PSR 16-compatible cache instance.
+     * @param int                         $ttl                How long weather data shall be cached. Defaults to 10 minutes.
+     *                                                        Only used if $cache is not null.
      *
      * @api
      */
-    public function __construct($apiKey, $fetcher = null, $cache = null, $ttl = 600)
+    public function __construct($apiKey, $httpClient, $httpRequestFactory, $cache = null, $ttl = 600)
     {
         if (!is_string($apiKey) || empty($apiKey)) {
             throw new \InvalidArgumentException("You must provide an API key.");
         }
 
-        if ($cache !== null && !($cache instanceof CacheItemPoolInterface)) {
-            throw new \InvalidArgumentException('The cache class must implement the \Psr\Cache\CacheItemPoolInterface!');
-        }
         if (!is_numeric($ttl)) {
-            throw new \InvalidArgumentException('$seconds must be numeric.');
-        }
-        if (!isset($fetcher)) {
-            $fetcher = (function_exists('curl_version')) ? new CurlFetcher() : new FileGetContentsFetcher();
+            throw new \InvalidArgumentException('$ttl must be numeric.');
         }
 
         $this->apiKey = $apiKey;
+        $this->httpClient = $httpClient;
+        $this->httpRequestFactory = $httpRequestFactory;
         $this->cache = $cache;
         $this->ttl = $ttl;
-        $this->fetcher = $fetcher;
     }
 
     /**
@@ -581,13 +579,17 @@ private function cacheOrFetchResult($url)
                 $this->wasCached = true;
                 return $item->get();
             }
+        }
+
+        $result = $this->httpClient
+            ->sendRequest($this->httpRequestFactory->createRequest("GET", $url))
+            ->getBody()
+            ->getContents();
 
-            $result = $this->fetcher->fetch($url);
+        if ($this->cache !== null) {
             $item->set($result);
             $item->expiresAfter($this->ttl);
             $this->cache->save($item);
-        } else {
-            $result = $this->fetcher->fetch($url);
         }
         $this->wasCached = false;
 

Cmfcmf/OpenWeatherMap/Fetcher/CurlFetcher.php

@@ -16,6 +16,8 @@
  */
 use Cmfcmf\OpenWeatherMap;
 use Cmfcmf\OpenWeatherMap\Exception as OWMException;
+use Http\Factory\Guzzle\RequestFactory;
+use Http\Adapter\Guzzle6\Client as GuzzleAdapter;
 
 require_once __DIR__ . '/bootstrap.php';
 
@@ -32,8 +34,12 @@
 // Units (can be 'metric' or 'imperial' [default]):
 $units = 'metric';
 
-// Get OpenWeatherMap object
-$owm = new OpenWeatherMap($myApiKey);
+// You can use every PSR-17 compatible HTTP request factory
+// and every PSR-18 compatible HTTP client.
+$httpRequestFactory = new RequestFactory();
+$httpClient = GuzzleAdapter::createWithConfig([]);
+
+$owm = new OpenWeatherMap($myApiKey, $httpClient, $httpRequestFactory);
 
 // Example 1: Get current temperature in Berlin.
 $weather = $owm->getWeather('Berlin', $units, $lang);

Cmfcmf/OpenWeatherMap/Fetcher/FetcherInterface.php

@@ -15,6 +15,8 @@
  * @see http://openweathermap.org/appid
  */
 use Cmfcmf\OpenWeatherMap;
+use Http\Factory\Guzzle\RequestFactory;
+use Http\Adapter\Guzzle6\Client as GuzzleAdapter;
 
 require_once __DIR__ . '/bootstrap.php';
 
@@ -31,8 +33,12 @@
 // Units (can be 'metric' or 'imperial' [default]):
 $units = 'metric';
 
-// Get OpenWeatherMap object. Don't use caching (take a look into Example_Cache.php to see how it works).
-$owm = new OpenWeatherMap($myApiKey);
+// You can use every PSR-17 compatible HTTP request factory
+// and every PSR-18 compatible HTTP client.
+$httpRequestFactory = new RequestFactory();
+$httpClient = GuzzleAdapter::createWithConfig([]);
+
+$owm = new OpenWeatherMap($myApiKey, $httpClient, $httpRequestFactory);
 
 // Example 1: Get current uv index in Berlin.
 $uvIndex = $owm->getCurrentUVIndex(52.520008, 13.404954);

Cmfcmf/OpenWeatherMap/Fetcher/FileGetContentsFetcher.php

@@ -16,6 +16,8 @@
  */
 
 use Cmfcmf\OpenWeatherMap;
+use Http\Factory\Guzzle\RequestFactory;
+use Http\Adapter\Guzzle6\Client as GuzzleAdapter;
 
 require_once __DIR__ . '/bootstrap.php';
 
@@ -25,8 +27,12 @@
 // Units (can be 'metric' or 'imperial' [default]):
 $units = 'metric';
 
-// Get OpenWeatherMap object. Don't use caching (take a look into Example_Cache.php to see how it works).
-$owm = new OpenWeatherMap($myApiKey);
+// You can use every PSR-17 compatible HTTP request factory
+// and every PSR-18 compatible HTTP client.
+$httpRequestFactory = new RequestFactory();
+$httpClient = GuzzleAdapter::createWithConfig([]);
+
+$owm = new OpenWeatherMap($myApiKey, $httpClient, $httpRequestFactory);
 
 // Example 1: Get forecast for the next 5 days for Berlin.
 $forecast = $owm->getWeatherForecast('Berlin', $units, $lang, '', 5);

Examples/CurrentWeather.php

@@ -15,6 +15,8 @@
  * @see http://openweathermap.org/appid
  */
 use Cmfcmf\OpenWeatherMap;
+use Http\Factory\Guzzle\RequestFactory;
+use Http\Adapter\Guzzle6\Client as GuzzleAdapter;
 
 require_once __DIR__ . '/bootstrap.php';
 
@@ -24,8 +26,12 @@
 // Units (can be 'metric' or 'imperial' [default]):
 $units = 'metric';
 
-// Get OpenWeatherMap object. Don't use caching (take a look into Example_Cache.php to see how it works).
-$owm = new OpenWeatherMap($myApiKey);
+// You can use every PSR-17 compatible HTTP request factory
+// and every PSR-18 compatible HTTP client.
+$httpRequestFactory = new RequestFactory();
+$httpClient = GuzzleAdapter::createWithConfig([]);
+
+$owm = new OpenWeatherMap($myApiKey, $httpClient, $httpRequestFactory);
 
 // Example 1: Get hourly weather history between 2014-01-01 and today.
 $history = $owm->getWeatherHistory('Berlin', new \DateTime('2014-01-01'), new \DateTime('now'), 'hour', $units, $lang);