Update to use HTTP discovery with PSR-17 and PSR-18

Author: danmichaelo

CHANGELOG.md

@@ -12,8 +12,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 
-- Updated [scriptotek/marc](https://github.com/scriptotek/php-marc/) to version 2.0.
+- Update [scriptotek/marc](https://github.com/scriptotek/php-marc/) to version 2.0.
   Please see [the corresponding CHANGELOG](https://github.com/scriptotek/php-marc/blob/master/CHANGELOG.md#200---2018-10-23) for information about changes that might break your app if you work with MARC records.
+- Update from HTTPlug to PSR-17/PSR-18 HTTP discovery.
+  Note that a HTTP factory implementation is now required.
+  Run `composer require http-interop/http-factory-guzzle` to add a HTTP Factory for Guzzle
 
 ### Fixed
 

README.md

@@ -46,21 +46,17 @@ Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
 
 ## Install using Composer
 
-Make sure you have [Composer](https://getcomposer.org) installed, then run
+Use [Composer](https://getcomposer.org) to install sru-client with a HTTP library such as Guzzle:
 
 ```bash
-composer require scriptotek/alma-client
+composer require scriptotek/alma-client php-http/guzzle6-adapter http-interop/http-factory-guzzle
 ```
 
-in your project directory to get the latest stable version of the package. You
-also need a HTTP library. Php-alma-client uses
-[HTTPlug discovery](http://php-http.readthedocs.io/en/latest/discovery.html) in
-order to not depend on one specific library. If you don't already have a HTTP
-library installed, try Guzzle:
-
-```bash
-composer require php-http/guzzle6-adapter
-```
+We use [HTTP discovery](https://github.com/http-interop/http-factory-discovery) to discover
+[HTTP client](https://packagist.org/providers/psr/http-client-implementation) and
+[HTTP factory](https://packagist.org/providers/psr/http-factory-implementation) implementations,
+so Guzzle can be swapped with any other
+[PSR-17](https://www.php-fig.org/psr/psr-17/)/[PSR-18](https://www.php-fig.org/psr/psr-18/)-compatible library.
 
 ## Initializing a client
 

composer.json

@@ -7,26 +7,24 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
-        "php" : ">=5.6",
+        "php" : ">=7.0",
         "ext-json": "*",
         "scriptotek/marc": "^2.0 || dev-master",
         "danmichaelo/quitesimplexmlelement": "^1.0",
-        "scriptotek/sru-client": "^0.6",
+        "scriptotek/sru-client": "^0.7",
         "psr/http-message": "^1.0",
-        "php-http/client-implementation": "^1.0",
-        "php-http/httplug": "^1.1 || ^2.0",
-        "php-http/message-factory": "^1.0",
-        "php-http/discovery": "^1.0",
-        "php-http/client-common": "^1.5"
+        "psr/http-client-implementation": "^1.0",
+        "psr/http-factory-implementation": "^1.0",
+        "http-interop/http-factory-discovery": "^1.4",
+        "php-http/client-common": "^1.9 || ^2.0"
     },
     "require-dev": {
         "phpspec/phpspec": "^3.4 || ^4.0 || ^5.0",
         "bossa/phpspec2-expect": "^2.1 || ^3.0",
         "wp-cli/php-cli-tools": "^0.11.1",
         "php-http/mock-client": "^1.0",
-        "php-http/message": "^1.0",
-        "guzzlehttp/psr7": "^1.0",
         "php-http/guzzle6-adapter": "^1.1 || ^2.0",
+        "http-interop/http-factory-guzzle": "^1.0",
         "squizlabs/php_codesniffer": "^3.3"
     },
     "license": "MIT",

spec/ClientSpec.php

@@ -3,7 +3,6 @@
 namespace spec\Scriptotek\Alma;
 
 use GuzzleHttp\Psr7\Response;
-use Http\Client\Common\Exception\ClientErrorException;
 use Http\Client\Common\Exception\ServerErrorException;
 use Http\Mock\Client as MockHttp;
 use PhpSpec\ObjectBehavior;
@@ -124,16 +123,14 @@ public function it_can_get_redirect_locations()
         $this->getRedirectLocation('/')->shouldBe('http://test.test');
     }
 
-    public function it_processes_json_error_responses(ClientErrorException $exception)
+    public function it_processes_json_error_responses()
     {
-        $exception->getResponse()->willReturn(new Response(
-            400,
-            ['Content-Type' => 'application/json;charset=utf-8'],
-            SpecHelper::getDummyData('error_response.json', false)
-        ));
-
         $http = $this->let();
-        $http->addException($exception->getWrappedObject());
+
+        $exception = SpecHelper::makeExceptionResponse(
+            SpecHelper::getDummyData('error_response.json', false)
+        );
+        $http->addException($exception);
 
         $this->shouldThrow(new RequestFailed(
             'Mandatory field is missing: library',
@@ -143,16 +140,16 @@ public function it_processes_json_error_responses(ClientErrorException $exceptio
         expect($http->getRequests())->toHaveCount(1);
     }
 
-    public function it_processes_xml_error_responses(ClientErrorException $exception)
+    public function it_processes_xml_error_responses()
     {
-        $exception->getResponse()->willReturn(new Response(
-            400,
-            ['Content-Type' => 'application/xml;charset=utf-8'],
-            SpecHelper::getDummyData('error_response.xml', false)
-        ));
-
         $http = $this->let();
-        $http->addException($exception->getWrappedObject());
+
+        $exception = SpecHelper::makeExceptionResponse(
+            SpecHelper::getDummyData('error_response.xml', false),
+            400,
+            'application/xml;charset=utf-8'
+        );
+        $http->addException($exception);
 
         $this->shouldThrow(new RequestFailed(
             'Mandatory field is missing: library',
@@ -162,68 +159,67 @@ public function it_processes_xml_error_responses(ClientErrorException $exception
         expect($http->getRequests())->toHaveCount(1);
     }
 
-    public function it_can_throw_resource_not_found(ClientErrorException $exception)
+    public function it_can_throw_resource_not_found()
     {
-        $exception->getResponse()->willReturn(new Response(
-            400,
-            ['Content-Type' => 'application/json;charset=utf-8'],
-            SpecHelper::getDummyData('item_barcode_error_response.json', false)
-        ));
-
         $http = $this->let();
-        $http->addException($exception->getWrappedObject());
+
+        $exception = SpecHelper::makeExceptionResponse(
+            SpecHelper::getDummyData('item_barcode_error_response.json', false)
+        );
+        $http->addException($exception);
 
         $this->shouldThrow(new ResourceNotFound('No items found for barcode 123.', '401689'))
             ->during('getJSON', ['/items/123']);
 
         expect($http->getRequests())->toHaveCount(1);
     }
 
-    public function it_can_throw_resource_not_found_for_500_errors_too(ServerErrorException $exception)
+    public function it_can_throw_resource_not_found_for_500_errors_too()
     {
+        $http = $this->let();
+
         // For Analytics reports, Alma will return 500, not 4xx
-        $exception->getResponse()->willReturn(new Response(
+        $exception = SpecHelper::makeExceptionResponse(
+            SpecHelper::getDummyData('report_not_found_response.xml', false),
             500,
-            ['Content-Type' => 'application/xml;charset=utf-8'],
-            SpecHelper::getDummyData('report_not_found_response.xml', false)
-        ));
-
-        $http = $this->let();
-        $http->addException($exception->getWrappedObject());
+            'application/xml;charset=utf-8',
+            ServerErrorException::class
+        );
+        $http->addException($exception);
 
         $this->shouldThrow(new ResourceNotFound('Path not found (/test/path)', 'INTERNAL_SERVER_ERROR'))
             ->during('getXML', ['/analytics/reports', ['path' => '/test/path']]);
 
         expect($http->getRequests())->toHaveCount(1);
     }
 
-    public function it_can_throw_invalid_api_key(ClientErrorException $exception)
+    public function it_can_throw_invalid_api_key()
     {
-        $exception->getResponse()->willReturn(new Response(
-            400,
-            ['Content-Type' => 'text/plain;charset=UTF-8'],
-            'Invalid API Key'
-        ));
-
         $http = $this->let();
-        $http->addException($exception->getWrappedObject());
+
+        $exception = SpecHelper::makeExceptionResponse(
+            'Invalid API Key',
+            400,
+            'text/plain;charset=UTF-8'
+        );
+        $http->addException($exception);
 
         $this->shouldThrow(new InvalidApiKey('Invalid API Key', 0))
            ->during('getJSON', ['/items/123']);
 
         expect($http->getRequests())->toHaveCount(1);
     }
 
-    public function it_will_retry_when_reaching_rate_limit(ClientErrorException $exception)
+    public function it_will_retry_when_reaching_rate_limit()
     {
-        $exception->getResponse()->willReturn(new Response(
-            400,
-            ['Content-Type' => 'application/json;charset=utf-8'],
-            SpecHelper::getDummyData('per_second_threshold_error_response.json', false)
-        ));
-
         $http = $this->let();
-        $http->addException($exception->getWrappedObject());
+
+        $exception = SpecHelper::makeExceptionResponse(
+            SpecHelper::getDummyData('per_second_threshold_error_response.json', false),
+            400,
+            'application/json;charset=utf-8'
+        );
+        $http->addException($exception);
 
         $this->getJSON('/items/123');
 

spec/Electronic/CollectionSpec.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace spec\Scriptotek\Alma\Electronic;
+
+use PhpSpec\ObjectBehavior;
+use Scriptotek\Alma\Electronic\Collection;
+use Scriptotek\Alma\Client as AlmaClient;
+use spec\Scriptotek\Alma\SpecHelper;
+
+class CollectionSpec extends ObjectBehavior
+{
+    public function let(AlmaClient $client)
+    {
+        $collection_id = '123';
+        $this->beConstructedWith($client, $collection_id);
+    }
+
+    protected function expectRequest($client)
+    {
+        $client->getJSON('/electronic/e-collections/123')
+            ->shouldBeCalled()
+            ->willReturn(SpecHelper::getDummyData('e-collection_response.json'));
+    }
+
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(Collection::class);
+    }
+}

spec/SpecHelper.php

@@ -3,6 +3,10 @@
 namespace spec\Scriptotek\Alma;
 
 use Danmichaelo\QuiteSimpleXMLElement\QuiteSimpleXMLElement;
+use function GuzzleHttp\Psr7\stream_for;
+use Http\Client\Common\Exception\ClientErrorException;
+use Http\Factory\Guzzle\RequestFactory;
+use Http\Factory\Guzzle\ResponseFactory;
 use Prophecy\Argument;
 
 class SpecHelper
@@ -30,4 +34,25 @@ public static function expectNoRequests($client)
         $client->getXML(Argument::any(), Argument::any())
             ->shouldNotBeCalled();
     }
+
+    public static function makeExceptionResponse(
+        $body,
+        $code = 400,
+        $contentType = 'application/json;charset=utf-8',
+        $cls = ClientErrorException::class
+    )
+    {
+        $requestFactory = new RequestFactory();
+        $responseFactory = new ResponseFactory();
+
+        return new $cls(
+            'Error 400',
+            $requestFactory->createRequest('GET', ''),
+            $responseFactory->createResponse($code, 'Bad Request')
+                ->withHeader('Content-Type', $contentType)
+                ->withBody(stream_for($body))
+        );
+
+
+    }
 }

spec/Users/UsersSpec.php

@@ -2,11 +2,14 @@
 
 namespace spec\Scriptotek\Alma\Users;
 
+use Http\Mock\Client as MockHttp;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 use Scriptotek\Alma\Client as AlmaClient;
+use Scriptotek\Alma\Exception\RequestFailed;
 use Scriptotek\Alma\Users\User;
 use Scriptotek\Alma\Users\Users;
+use Scriptotek\Alma\Zones;
 use spec\Scriptotek\Alma\SpecHelper;
 
 class UsersSpec extends ObjectBehavior