Use HTTPlug

Author: danmichaelo

README.md

@@ -24,6 +24,16 @@ composer require scriptotek/php-sru-client
 
 in your project directory to get the latest stable version of the package.
 
+**You also need a HTTP library**. If you're not already using one in your project,
+just add Guzzle:
+
+```bash
+composer require php-http/guzzle6-adapter
+```
+
+[HTTPlug discovery](http://php-http.readthedocs.io/en/latest/discovery.html) is
+used in order to not depend on a specific library.
+
 ## Configuring the client
 
 ```php
@@ -113,17 +123,15 @@ You can view it at [scriptotek.github.io/php-sru-client](//scriptotek.github.io/
 
 ## Laravel 5 integration
 
-In the $providers array add the service providers for this package:
+Add the service provider to the `'providers'` array in `config/app.php`:
 
     Scriptotek\Sru\Providers\SruServiceProvider::class,
 
-Add the facade of this package to the `$aliases` array:
+Optionally, add the facade to the `'aliases'` array in the same file:
 
-    'SruClient' => Scriptotek\Sru\Facades\SruClient::class,
+    'SruClient'      => Scriptotek\Sru\Facades\SruClient::class,
 
-Publish configuration in Laravel 5:
+To create the configuration file `config/sru.php`:
 
     $ php artisan vendor:publish --provider="Scriptotek\Sru\Providers\SruServiceProvider"
 
-The configuration file is copied to `config/sru.php`.
-

composer.json

@@ -5,14 +5,21 @@
     "homepage": "http://github.com/scriptotek/sru-client",
     "keywords": ["sru"],
     "require": {
-        "php" : "^5.5 || ^7.0",
-        "guzzlehttp/guzzle": "~6.0",
-        "danmichaelo/quitesimplexmlelement": ">=0.4.2"
+        "php" : "^5.6 || ^7.0",
+        "danmichaelo/quitesimplexmlelement": ">=0.4.2",
+         "php-http/client-implementation": "^1.0",
+         "php-http/httplug": "^1.1",
+         "php-http/message-factory": "^1.0",
+         "php-http/discovery": "^1.0",
+         "php-http/client-common": "^1.5"
     },
     "require-dev": {
         "phpunit/phpunit": "^4.8|^5.5",
         "sami/sami": "^3.3",
-        "mockery/mockery": "^0.9"
+        "php-http/mock-client": "^1.0",
+        "php-http/message": "^1.0",
+        "guzzlehttp/psr7": "^1.0",
+        "php-http/guzzle6-adapter": "^1.1"
     },
     "license": "MIT",
     "authors": [

src/Client.php

@@ -1,6 +1,13 @@
 <?php namespace Scriptotek\Sru;
 
-use GuzzleHttp\Client as HttpClient;
+use Http\Client\Common\Plugin\AuthenticationPlugin;
+use Http\Client\Common\PluginClient;
+use Http\Client\HttpClient;
+use Http\Discovery\HttpClientDiscovery;
+use Http\Client\Common\Plugin\ErrorPlugin;
+use Http\Discovery\MessageFactoryDiscovery;
+use Http\Message\Authentication\BasicAuth;
+use Http\Message\MessageFactory;
 
 /**
  * SRU client
@@ -10,6 +17,9 @@ class Client
     /** @var HttpClient */
     protected $httpClient;
 
+    /** @var MessageFactory */
+    protected $messageFactory;
+
     /** @var string SRU service base URL */
     protected $url;
 
@@ -38,15 +48,22 @@ class Client
     /**
      * Create a new client
      *
-     * @param string $url Base URL to the SRU service
-     * @param array $options Associative array of options
-     * @param HttpClient $httpClient
+     * @param string              $url     Base URL to the SRU service
+     * @param array               $options Associative array of options
+     * @param HttpClient          $httpClient
+     * @param MessageFactory|null $messageFactory
+     * @throws \ErrorException
      */
-    public function __construct($url, $options = null, $httpClient = null)
-    {
+    public function __construct(
+        $url,
+        $options = null,
+        HttpClient $httpClient = null,
+        MessageFactory $messageFactory = null
+    ) {
         $this->url = $url;
         $options = $options ?: array();
-        $this->httpClient = $httpClient ?: new HttpClient;
+
+        $plugins = [new ErrorPlugin()];
 
         $this->schema = isset($options['schema'])
             ? $options['schema']
@@ -60,13 +77,17 @@ public function __construct($url, $options = null, $httpClient = null)
             ? $options['user-agent']
             : null;
 
-        $this->credentials = isset($options['credentials'])
-            ? $options['credentials']
-            : null;
+        if (isset($options['credentials'])) {
+            $authentication = new BasicAuth($options['credentials'][0], $options['credentials'][1]);
+            $plugins[] = new AuthenticationPlugin($authentication);
+        }
 
-        $this->proxy = isset($options['proxy'])
-            ? $options['proxy']
-            : null;
+        if (isset($options['proxy'])) {
+            throw new\ErrorException('Not supported');
+        }
+
+        $this->httpClient = new PluginClient($httpClient ?: HttpClientDiscovery::find(), $plugins);
+        $this->messageFactory = $messageFactory ?: MessageFactoryDiscovery::find();
     }
 
     /**
@@ -106,24 +127,16 @@ public function urlTo($cql, $start = 1, $count = 10, $extraParams = array())
      *
      * @return array
      */
-    public function getHttpOptions()
+    public function getHttpHeaders()
     {
         $headers = array(
             'Accept' => 'application/xml'
         );
         if ($this->userAgent) {
             $headers['User-Agent'] = $this->userAgent;
         }
-        $options = array(
-            'headers' => $headers
-        );
-        if ($this->credentials) {
-            $options['auth'] = $this->credentials;
-        }
-        if ($this->proxy) {
-            $options['proxy'] = $this->proxy;
-        }
-        return $options;
+
+        return $headers;
     }
 
     /**
@@ -139,10 +152,7 @@ public function getHttpOptions()
     public function search($cql, $start = 1, $count = 10, $extraParams = array())
     {
         $url = $this->urlTo($cql, $start, $count, $extraParams);
-        $options = $this->getHttpOptions();
-
-        $response = $this->httpClient->get($url, $options);
-        $body = (string) $response->getBody();
+        $body = $this->request('GET', $url);
 
         return new SearchRetrieveResponse($body, $this);
     }
@@ -200,11 +210,22 @@ public function explain()
             'operation' => 'explain',
             'version' => $this->version,
         ));
-        $options = $this->getHttpOptions();
 
-        $response = $this->httpClient->get($url, $options);
-        $body = (string) $response->getBody();
+        $body = $this->request('GET', $url);
 
         return new ExplainResponse($body, $this);
     }
+
+    /**
+     * @param string $method
+     * @param string $url
+     * @return string
+     */
+    public function request($method, $url)
+    {
+        $request = $this->messageFactory->createRequest($method, $url, $this->getHttpHeaders());
+        $response = $this->httpClient->sendRequest($request);
+
+        return (string) $response->getBody();
+    }
 }

src/Records.php

@@ -1,7 +1,5 @@
 <?php namespace Scriptotek\Sru;
 
-use GuzzleHttp\Client as HttpClient;
-
 /**
  * When iterating, methods are called in the following order:
  *
@@ -20,9 +18,6 @@
  */
 class Records implements \Iterator
 {
-    /** @var HttpClient */
-    protected $httpClient;
-
     private $position;
     private $count;
     private $extraParams;
@@ -39,15 +34,13 @@ class Records implements \Iterator
      * @param Client $client SRU client reference (optional)
      * @param int $count Number of records to request per request
      * @param array $extraParams Extra GET parameters
-     * @param mixed $httpClient A http client
      */
-    public function __construct($cql, Client $client, $count = 10, $extraParams = array(), $httpClient = null)
+    public function __construct($cql, Client $client, $count = 10, $extraParams = array())
     {
         $this->position = 1;
         $this->count = $count; // number of records per request
         $this->extraParams = $extraParams;
         $this->cql = $cql;
-        $this->httpClient = $httpClient ?: new HttpClient;
         $this->client = $client;
         $this->fetchMore();
     }
@@ -68,10 +61,7 @@ public function numberOfRecords()
     private function fetchMore()
     {
         $url = $this->client->urlTo($this->cql, $this->position, $this->count, $this->extraParams);
-        $options = $this->client->getHttpOptions();
-
-        $response = $this->httpClient->get($url, $options);
-        $body = (string) $response->getBody();
+        $body = $this->client->request('GET', $url);
         $this->lastResponse = new SearchRetrieveResponse($body);
         $this->data = $this->lastResponse->records;