Issue #64 lower PHP requirement a notch

Author: judgej

README.md

@@ -122,7 +122,7 @@ $client = new Client();
 // on which is installed. You can explictly create the PSR-7 factory instead and pass that in
 // as a third parameter when creating Request\CreateSessionKey.
 
-$keyResponse = $client->sendRequest($keyRequest->message());
+$keyResponse = $client->sendRequest($keyRequest->createHttpRequest());
 
 // Capture the result in our local response model.
 // Use the ResponseFactory to automatically choose the correct message class.
@@ -169,7 +169,7 @@ $cardIdentifierRequest = new CreateCardIdentifier(
 // Send the PSR-7 message.
 // The same error handling as shown earlier can be used.
 
-$cardIdentifierResponse = $client->sendRequest($cardIdentifierRequest->message());
+$cardIdentifierResponse = $client->sendRequest($cardIdentifierRequest->createHttpRequest());
 
 // Grab the result as a local model.
 // If all is well, we will have a Resposne\CardIdentifier that will be valid for use
@@ -293,7 +293,7 @@ $paymentRequest = new CreatePayment(
 
 // Send it to Sage Pay.
 
-$paymentResponse = $client->sendRequest($paymentRequest->message());
+$paymentResponse = $client->sendRequest($paymentRequest->createHttpRequest());
 
 // Assuming we got no exceptions, extract the response details.
 
@@ -348,7 +348,7 @@ $transaction_result = new Request\FetchTransaction(
 
 // Send it to Sage Pay.
 
-$response = $client->sendRequest($transaction_result->message());
+$response = $client->sendRequest($transaction_result->createHttpRequest());
 
 // Assuming no exceptions, this gives you the payment or repeat payment record.
 // But do check for errors in the usual way (i.e. you could get an error collection here).
@@ -514,7 +514,7 @@ Handling the 3D Secure result involves two steps:
 
     // Send to Sage Pay and get the final 3D Secure result.
 
-    $response = $client->send($request->message());
+    $response = $client->send($request->createHttpRequest());
     $secure3dResponse = ResponseFactory::fromHttpResponse($response);
 
     // This will be the result. We are looking for `Authenticated` or similar.
@@ -560,7 +560,7 @@ reported as still being an issue.
 
     // Send the request for the transaction to Sage Pay.
 
-    $response = $client->sendRequest($transactionResult->message());
+    $response = $client->sendRequest($transactionResult->createHttpRequest());
 
     // We should now have the payment, repeat payment, or an error collection.
 
@@ -610,7 +610,7 @@ $securityCode = new LinkSecurityCode(
 // The result will be a `Response\NoContent` if all is well.
 
 $securityCodeResponse = ResponseFactory::fromHttpResponse(
-    $client->sendRequest($securityCode->message())
+    $client->sendRequest($securityCode->createHttpRequest())
 );
 
 // Should check for errors here:

composer.json

@@ -2,7 +2,7 @@
     "name": "academe/opayo-pi",
     "license": "MIT",
     "type": "library",
-    "description": "A library to handle the message content and structure for the Opayo Pi (ne Sage Pay Integration) payment gateway",
+    "description": "A library to handle the message content and structure for the Opayo Pi (was Sage Pay Integration) payment gateway",
     "keywords": [
         "gateway",
         "merchant",
@@ -19,10 +19,10 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "^7.3|^8.0",
         "shrikeh/teapot": "^1.0|^2.0",
         "psr/http-message": "^1.0",
-        "alcohol/iso4217": "^4.0"
+        "alcohol/iso4217": "^3.0|^4.0"
     },
     "suggest": {
         "moneyphp/money": "^3.0",

src/Factory/DiactorosFactory.php

@@ -5,6 +5,8 @@
 /**
  * Zend Diactoros Factory for creating PSR-7 objects.
  * Requires zendframework/zend-diactoros:~1.3
+ * 
+ * @deprecated 3.0.0 abandoned some time ago https://github.com/zendframework/zend-diactoros
  */
 
 use Psr\Http\Message\StreamInterface;
@@ -27,7 +29,7 @@ class DiactorosFactory implements RequestFactoryInterface
     public function jsonRequest($method, $uri, array $headers = [], $body = null, $protocolVersion = '1.1')
     {
         // If we are sending a JSON body, then the recipient needs to know.
-        $headers['Content-type'] = 'application/json';
+        $headers['Content-Type'] = 'application/json';
 
         // If the body is not already a stream or string of some sort, then JSON encode it for streaming.
         if (! is_string($body) && ! $body instanceof StreamInterface && gettype($body) != 'resource') {

src/Factory/GuzzleFactory.php

@@ -5,6 +5,8 @@
 /**
  * Guzzle Factory for creating PSR-7 objects.
  * Requires guzzlehttp/guzzle:~6.0
+ * 
+ * @deprecated use any PSR-17 factory instead
  */
 
 use Psr\Http\Message\StreamInterface;
@@ -17,6 +19,7 @@ class GuzzleFactory implements RequestFactoryInterface
     /**
      * Return a new GuzzleHttp\Psr7\Request object.
      * The body is to be sent as a JSON request.
+     * 
      * @param null|string $method
      * @param UriInterface|null|string $uri
      * @param array $headers
@@ -27,15 +30,18 @@ class GuzzleFactory implements RequestFactoryInterface
     public function jsonRequest($method, $uri, array $headers = [], $body = null, $protocolVersion = '1.1')
     {
         // If we are sending a JSON body, then the recipient needs to know.
-        $headers['Content-type'] = 'application/json';
+
+        $headers['Content-Type'] = 'application/json';
 
         // If the body is already a stream or string of some sort, then it is
         // assumed to already be a JSON stream.
+
         if (! is_string($body) && ! $body instanceof StreamInterface && gettype($body) != 'resource') {
             $body = json_encode($body);
         }
 
         // Guzzle will accept the body as a string and generate a stream from it.
+
         return new Request(
             $method,
             $uri,

src/Request/AbstractRequest.php

@@ -13,9 +13,12 @@
 use Academe\Opayo\Pi\Factory\FactoryInterface;
 use Academe\Opayo\Pi\Factory\DiactorosFactory;
 use Academe\Opayo\Pi\Factory\GuzzleFactory;
+use Academe\Opayo\Pi\Factory\RequestFactoryInterface;
 use UnexpectedValueException;
 use JsonSerializable;
 use Exception;
+// use Psr\Http\Message\RequestFactoryInterface;
+use Psr\Http\Message\RequestInterface;
 
 abstract class AbstractRequest extends AbstractMessage implements JsonSerializable
 {
@@ -36,7 +39,7 @@ abstract class AbstractRequest extends AbstractMessage implements JsonSerializab
     protected $resource_path = [];
 
     /**
-     * @var string Most messages are sent as POST requests, so this is the default
+     * @var string Most messages are sent with the POST method, so this is the default
      */
     protected $method = 'POST';
 
@@ -122,7 +125,7 @@ public function getResourcePath()
     }
 
     /**
-     * @returns string The full URL of this resource
+     * @returns string The fully qualified URL of this resource
      */
     public function getUrl()
     {
@@ -163,6 +166,9 @@ protected function getBasicAuthHeaders()
     }
 
     /**
+     * TODO: can we use the PSR-17 Psr\Http\Message\RequestFactoryInterface
+     * instead of our custom factory?
+     * 
      * @param RequestFactoryInterface $factory
      * @return $this
      */
@@ -185,11 +191,12 @@ protected function withFactory(RequestFactoryInterface $factory)
     /**
      * Get the PSR-7 factory.
      * Create a factory if none supplied and relevant libraries are installed.
+     * 
      * @param bool $exception
-     * @return DiactorosFactory|GuzzleFactory
+     * @return RequestFactoryInterface for example DiactorosFactory or GuzzleFactory
      * @throws Exception
      */
-    public function getFactory($exception = false)
+    public function getFactory($exception = false): RequestFactoryInterface
     {
         if (!isset($this->factory) && GuzzleFactory::isSupported()) {
             // If the GuzzleFactory is supported (relevant Guzzle package is
@@ -218,13 +225,17 @@ public function getFactory($exception = false)
 
     /**
      * Return as a PSR-7 request message.
+     * TODO: Use a PSR-17 factory to create the basic request, then add the
+     * headers and body to that.
+     * 
      * @return \Psr\Http\Message\RequestInterface
      * @throws Exception
      */
-    public function createHttpRequest()
+    public function createHttpRequest(): RequestInterface
     {
         // If the data is protected from accidental serialisation, then
         // pull it out through the protected method.
+
         if (method_exists($this, 'jsonSerializePeek')) {
             $body = json_encode($this->jsonSerializePeek());
         } else {
@@ -239,16 +250,9 @@ public function createHttpRequest()
         );
     }
 
-    /**
-     * @deprecated Use more appropriately named createHttpRequest()
-     */
-    public function message()
-    {
-        return $this->createHttpRequest();
-    }
-
     /**
      * Set various flags - anything with a setFoo() method.
+     * 
      * @param array $options
      * @return $this
      */
@@ -270,6 +274,7 @@ protected function setOptions(array $options = [])
 
     /**
      * Set various flags - anything with a setFoo() method.
+     * 
      * @param array $options
      * @return AbstractRequest
      */