adjust changelog

CHANGELOG.md

@@ -4,18 +4,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://git.d3data.de/D3Private/linkmobility-php-client/compare/2.0.3...rel_2.x)
+## [Unreleased](https://git.d3data.de/D3Public/linkmobility-php-client/compare/2.1.0...rel_2.x)
 
-## [2.0.3](https://git.d3data.de/D3Private/linkmobility-php-client/compare/2.0.2...2.0.3) - 2022-12-26
+## [2.1.0](https://git.d3data.de/D3Public/linkmobility-php-client/compare/2.0.3...2.1.0) - 2022-12-26
+### Added
+- installable in PHP > 8.0
+- debug logger to log all comunications in debug mode (default Guzzle client only)
+- retry middleware to request again in defined error cases  (default Guzzle client only)
+
+### Fixed
+- missing getRecipientsList() in RecipientsListInterface
+
+### Deprecated
+- unused client argument in recipient list class
+
+### Removed 
+- unused ApiException class
+
+## [2.0.3](https://git.d3data.de/D3Public/linkmobility-php-client/compare/2.0.2...2.0.3) - 2022-12-26
 ### Changed
 - allow Guzzle v7.3 for more backward compatibility
 
-## [2.0.2](https://git.d3data.de/D3Private/linkmobility-php-client/compare/2.0.1...2.0.2) - 2022-07-28
+## [2.0.2](https://git.d3data.de/D3Public/linkmobility-php-client/compare/2.0.1...2.0.2) - 2022-07-28
 ### Changed
 - add support note
 - adjust readme
 
-## [2.0.1](https://git.d3data.de/D3Private/linkmobility-php-client/compare/2.0.0...2.0.1) - 2022-07-28
+## [2.0.1](https://git.d3data.de/D3Public/linkmobility-php-client/compare/2.0.0...2.0.1) - 2022-07-28
 ### Added
 - phpstan code checks
 
@@ -26,18 +41,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - wrong return type of LoggerHandler::getInstance
 
-## [2.0.0](https://git.d3data.de/D3Private/linkmobility-php-client/compare/1.3.0...2.0.0) - 2022-07-19
+## [2.0.0](https://git.d3data.de/D3Public/linkmobility-php-client/compare/1.3.0...2.0.0) - 2022-07-19
 ### Changed
 - adjust to PHP >= 7.3 and current dependency packages
 
-## [1.3.1](https://git.d3data.de/D3Private/linkmobility-php-client/compare/1.3.0...1.3.1) - 2022-07-28
+## [1.3.1](https://git.d3data.de/D3Public/linkmobility-php-client/compare/1.3.0...1.3.1) - 2022-07-28
 ### Changed
 - improve code quality
 
 ### Fixed
 - wrong return type of LoggerHandler::getInstance
 
-## [1.3.0](https://git.d3data.de/D3Private/linkmobility-php-client/compare/1.2.1...1.3.0) - 2022-07-18
+## [1.3.0](https://git.d3data.de/D3Public/linkmobility-php-client/compare/1.2.1...1.3.0) - 2022-07-18
 ### Added
 - tests added
 
@@ -45,12 +60,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - tests use generated example phone numbers
 - move recipient checks from list to recipient itself
 
-## [1.2.1](https://git.d3data.de/D3Private/linkmobility-php-client/compare/1.2.0...1.2.1) - 2022-07-15
+## [1.2.1](https://git.d3data.de/D3Public/linkmobility-php-client/compare/1.2.0...1.2.1) - 2022-07-15
 ### Changed
 - extend log messages
 - sanitize special phone number format before request
 
-## [1.2.0](https://git.d3data.de/D3Private/linkmobility-php-client/compare/1.1.0...1.2.0) - 2022-07-14
+## [1.2.0](https://git.d3data.de/D3Public/linkmobility-php-client/compare/1.1.0...1.2.0) - 2022-07-14
 ### Added
 - collect exception messages in a class
 - collect URI parts in a class
@@ -60,14 +75,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - assign sender address type only if sender is set
 - extract logger handler from client
 
-## [1.1.0](https://git.d3data.de/D3Private/linkmobility-php-client/compare/1.0.0...1.1.0) - 2022-07-13
+## [1.1.0](https://git.d3data.de/D3Public/linkmobility-php-client/compare/1.0.0...1.1.0) - 2022-07-13
 ### Added
 - make installable in PHP 8
 
 ### Removed
 - remove unused dependency
 
-## [1.0.0](https://git.d3data.de/D3Private/linkmobility-php-client/releases/tag/1.0.0) - 2022-07-13
+## [1.0.0](https://git.d3data.de/D3Public/linkmobility-php-client/releases/tag/1.0.0) - 2022-07-13
 ### Added
 - initial implementation
   - SMS requests (text or binary)

README.en.md

@@ -18,8 +18,8 @@ composer require d3/linkmobility-php-client
 ```
 
 ```
-$client = new Client('personal accesstoken');
-$client->setLogger($logger);  // optional
+$client = new \D3\LinkmobilityClient\Client('personal accesstoken');
+\D3\LinkmobilityClient\LoggerHandler::getInstance()->setLogger($logger);  // optional
 $request = new D3\LinkmobilityClient\SMS\RequestFactory($message, $client)->getSmsRequest())
     ->addRecipient(new D3\LinkmobilityClient\ValueObject\Recipient('recipient number', 'DE'));
 $response = $client->request($request)

README.md

@@ -18,8 +18,8 @@ composer require d3/linkmobility-php-client
 ```
 
 ```
-$client = new Client('personal accesstoken');
-$client->setLogger($logger);  // optional
+$client = new \D3\LinkmobilityClient\Client('personal accesstoken');
+\D3\LinkmobilityClient\LoggerHandler::getInstance()->setLogger($logger);  // optional
 $request = new D3\LinkmobilityClient\SMS\RequestFactory($message, $client)->getSmsRequest())
     ->addRecipient(new D3\LinkmobilityClient\ValueObject\Recipient('recipient number', 'DE'));
 $response = $client->request($request)

Tests/ApiTestCase.php

@@ -31,7 +31,7 @@ abstract class ApiTestCase extends TestCase
      * @return mixed
      * @throws ReflectionException
      */
-    public function callMethod(object $object, string $methodName, array $arguments = [])
+    public function callMethod($object, string $methodName, array $arguments = [])
     {
         $class = new ReflectionClass($object);
         $method = $class->getMethod($methodName);
@@ -47,7 +47,7 @@ abstract class ApiTestCase extends TestCase
      * @param $value
      * @throws ReflectionException
      */
-    public function setValue(object $object, string $valueName, $value)
+    public function setValue($object, string $valueName, $value)
     {
         $reflection = new ReflectionClass($object);
         $property = $reflection->getProperty($valueName);
@@ -63,7 +63,7 @@ abstract class ApiTestCase extends TestCase
      * @return mixed
      * @throws ReflectionException
      */
-    public function getValue(object $object, string $valueName)
+    public function getValue($object, string $valueName)
     {
         $reflection = new ReflectionClass($object);
         $property = $reflection->getProperty($valueName);

Tests/ClientTest.php

@@ -17,7 +17,6 @@ namespace D3\LinkmobilityClient\Tests;
 
 use Assert\InvalidArgumentException;
 use D3\LinkmobilityClient\Client;
-use D3\LinkmobilityClient\Exceptions\ApiException;
 use D3\LinkmobilityClient\LoggerHandler;
 use D3\LinkmobilityClient\Request\RequestInterface;
 use D3\LinkmobilityClient\Response\Response;
@@ -27,11 +26,9 @@ use D3\LinkmobilityClient\Url\Url;
 use D3\LinkmobilityClient\Url\UrlInterface;
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\ClientInterface;
+use GuzzleHttp\Psr7\Response as GuzzleResponse;
 use PHPUnit\Framework\MockObject\MockObject;
-use Psr\Http\Message\ResponseInterface as MessageResponseInterface;
 use Psr\Http\Message\StreamInterface;
-use Psr\Log\AbstractLogger;
-use Psr\Log\LoggerInterface;
 use ReflectionException;
 
 class ClientTest extends ApiTestCase
@@ -100,6 +97,28 @@ class ClientTest extends ApiTestCase
         ];
     }
 
+    /**
+     * @test
+     * @throws ReflectionException
+     * @return void
+     * @covers \D3\LinkmobilityClient\Client::getDefaultClient
+     */
+    public function testGetDefaultClient()
+    {
+        /** @var Client|MockObject $sut */
+        $sut = $this->getMockBuilder(Client::class)
+            ->setConstructorArgs(['accessTokenFixture'])
+            ->getMock();
+
+        $this->assertInstanceOf(
+            GuzzleClient::class,
+            $this->callMethod(
+                $sut,
+                'getDefaultClient'
+            )
+        );
+    }
+
     /**
      * @test
      * @return void
@@ -173,41 +192,20 @@ class ClientTest extends ApiTestCase
 
     /**
      * @test
-     * @param $okStatus
      * @return void
      * @throws ReflectionException
-     * @dataProvider rawRequestDataProvider
      * @covers \D3\LinkmobilityClient\Client::rawRequest
      */
-    public function testRawRequest($okStatus)
+    public function testRawRequest()
     {
-        $statusCode = $okStatus ? '200' : '301';
-
         /** @var StreamInterface|MockObject $streamMock */
         $streamMock = $this->getMockBuilder(StreamInterface::class)
             ->getMock();
 
-        /** @var MessageResponseInterface|MockObject $responseMock */
-        $responseMock = $this->getMockBuilder(MessageResponseInterface::class)
-            ->onlyMethods([
-                'getStatusCode',
-                'getBody',
-                'withStatus',
-                'getReasonPhrase',
-                'getProtocolVersion',
-                'withProtocolVersion',
-                'getHeaders',
-                'hasHeader',
-                'getHeader',
-                'getHeaderLine',
-                'withHeader',
-                'withAddedHeader',
-                'withoutHeader',
-                'withBody',
-            ])
+        /** @var GuzzleResponse|MockObject $responseMock */
+        $responseMock = $this->getMockBuilder( GuzzleResponse::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $responseMock->expects($this->atLeastOnce())->method('getStatusCode')->willReturn($statusCode);
         $responseMock->expects($this->atLeastOnce())
             ->method('getBody')->willReturn($streamMock);
 
@@ -217,17 +215,6 @@ class ClientTest extends ApiTestCase
             ->getMock();
         $requestClientMock->expects($this->once())->method('request')->willReturn($responseMock);
 
-        /** @var LoggerInterface|MockObject $loggerMock */
-        $loggerMock = $this->getMockBuilder(AbstractLogger::class)
-            ->onlyMethods(['debug', 'error', 'log'])
-            ->getMock();
-
-        /** @var LoggerHandler|MockObject $loggerHandlerMock */
-        $loggerHandlerMock = $this->getMockBuilder(LoggerHandler::class)
-            ->onlyMethods(['getLogger'])
-            ->getMock();
-        $loggerHandlerMock->method('getLogger')->willReturn($loggerMock);
-
         /** @var Client|MockObject $clientMock */
         $clientMock = $this->getMockBuilder(Client::class)
             ->disableOriginalConstructor()
@@ -235,30 +222,14 @@ class ClientTest extends ApiTestCase
                 'getLoggerHandler',
             ])
             ->getMock();
-        $clientMock->expects($this->atLeastOnce())
-            ->method('getLoggerHandler')->willReturn($loggerHandlerMock);
         $this->setValue($clientMock, 'requestClient', $requestClientMock);
 
-        if (false === $okStatus) {
-            $this->expectException(ApiException::class);
-        }
         $this->assertSame(
             $responseMock,
             $this->callMethod($clientMock, 'rawRequest', ['myUrl'])
         );
     }
 
-    /**
-     * @return array
-     */
-    public function rawRequestDataProvider(): array
-    {
-        return [
-            'OK status' => [true],
-            'NOK status' => [false],
-        ];
-    }
-
     /**
      * @test
      * @return void
@@ -275,4 +246,38 @@ class ClientTest extends ApiTestCase
             )
         );
     }
+
+    /**
+     * @test
+     * @return void
+     * @throws \PHPUnit\Framework\ExpectationFailedException
+     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     * @covers \D3\LinkmobilityClient\Client::getLoggerMiddleware
+     */
+    public function testGetLoggerMiddleware()
+    {
+        $this->assertIsCallable(
+            $this->callMethod(
+                $this->api,
+                'getLoggerMiddleware'
+            )
+        );
+    }
+
+    /**
+     * @test
+     * @return void
+     * @throws \PHPUnit\Framework\ExpectationFailedException
+     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
+     * @covers \D3\LinkmobilityClient\Client::getRetryMiddleware
+     */
+    public function testGetRetryMiddleware()
+    {
+        $this->assertIsCallable(
+            $this->callMethod(
+                $this->api,
+                'getRetryMiddleware'
+            )
+        );
+    }
 }

Tests/README.md

@@ -7,5 +7,5 @@ composer create-project -s dev --prefer-source [--repository '{"type": "vcs", "u
 # Run tests
 
 ```
-./vendor/bin/phpunit [--no-coverage]
+./vendor/bin/phpunit [--no-coverage] [--coverage-html=cov]
 ```

Tests/ValueObject/SmsBinaryMessageTest.php

@@ -15,9 +15,8 @@ declare(strict_types=1);
 
 namespace D3\LinkmobilityClient\Tests\ValueObject;
 
-use Assert\InvalidArgumentException;
-use D3\LinkmobilityClient\Tests\ApiTestCase;
 use D3\LinkmobilityClient\ValueObject\SmsBinaryMessage;
+use Phlib\SmsLength\Exception\InvalidArgumentException;
 use Phlib\SmsLength\SmsLength;
 use PHPUnit\Framework\MockObject\MockObject;
 use ReflectionException;
@@ -94,7 +93,7 @@ class SmsBinaryMessageTest extends SmsMessageAbstractTest
         if ($valid) {
             $smsLengthMock->expects($this->never())->method('validate')->willReturn(true);
         } else {
-            $smsLengthMock->expects($this->atLeastOnce())->method('validate')->willThrowException(new \Phlib\SmsLength\Exception\InvalidArgumentException());
+            $smsLengthMock->expects($this->atLeastOnce())->method('validate')->willThrowException(new InvalidArgumentException());
         }
 
         /** @var SmsBinaryMessage|MockObject $message */

Tests/ValueObject/SmsMessageAbstractTest.php

@@ -19,7 +19,6 @@ use Assert\InvalidArgumentException;
 use D3\LinkmobilityClient\Tests\ApiTestCase;
 use D3\LinkmobilityClient\ValueObject\SmsBinaryMessage;
 use Phlib\SmsLength\SmsLength;
-use PHPUnit\Framework\MockObject\MockObject;
 use ReflectionException;
 
 abstract class SmsMessageAbstractTest extends ApiTestCase

composer.json

@@ -21,12 +21,13 @@
       "GPL-3.0-or-later"
     ],
     "require": {
-        "php": "^7.3 || ~8.0.3",
+        "php": "^7.3 || ^8.0.3",
         "beberlei/assert": "^3.3",
         "guzzlehttp/guzzle": "^7.3",
         "psr/http-message": "~1.0",
         "phlib/sms-length": "^2.0",
         "giggsey/libphonenumber-for-php": "^8.12.50",
+        "caseyamcl/guzzle_retry_middleware": "^2.8",
         "ext-json": "*"
     },
     "require-dev": {

src/Client.php

@@ -15,13 +15,16 @@ declare(strict_types=1);
 
 namespace D3\LinkmobilityClient;
 
-use D3\LinkmobilityClient\Exceptions\ApiException;
-use D3\LinkmobilityClient\Exceptions\ExceptionMessages;
 use D3\LinkmobilityClient\Request\RequestInterface;
 use D3\LinkmobilityClient\Url\Url;
 use D3\LinkmobilityClient\Url\UrlInterface;
+use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\ClientInterface;
 use GuzzleHttp\Exception\GuzzleException;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\MessageFormatter;
+use GuzzleHttp\Middleware;
+use GuzzleRetry\GuzzleRetryMiddleware;
 use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface;
 
@@ -35,14 +38,28 @@ class Client
     {
         $this->accessToken = $accessToken;
         $this->apiUrl = $apiUrl ?: new Url();
-        $this->requestClient = $client ?: new \GuzzleHttp\Client([ 'base_uri' => $this->apiUrl->getBaseUri() ]);
+        $this->requestClient = $client ?: $this->getDefaultClient();
+    }
+
+    /**
+     * @return GuzzleClient
+     */
+    protected function getDefaultClient(): GuzzleClient
+    {
+        $handlerStack = HandlerStack::create();
+        $handlerStack->push($this->getLoggerMiddleware());
+        $handlerStack->push($this->getRetryMiddleware());
+
+        return new GuzzleClient( [
+            'base_uri'  => $this->apiUrl->getBaseUri(),
+            'handler'   => $handlerStack
+        ]);
     }
 
     /**
      * @param RequestInterface $request
      *
      * @return Response\ResponseInterface
-     * @throws ApiException
      * @throws GuzzleException
      * @throws InvalidArgumentException
      */
@@ -61,30 +78,14 @@ class Client
      * @param array  $options
      *
      * @return ResponseInterface
-     * @throws ApiException
      * @throws GuzzleException
      */
     protected function rawRequest($url, string $method = RequestInterface::METHOD_GET, array $options = []): ResponseInterface
     {
         $options['headers']['Authorization'] = 'Bearer '.$this->accessToken;
 
-        $this->getLoggerHandler()->getLogger()->debug('linkmobility request: '.$url, $options);
-
-        $response = $this->requestClient->request(
-            $method,
-            $url,
-            $options
-        );
-
-        if ($response->getStatusCode() != 200) {
-            $message = sprintf(ExceptionMessages::NOK_REQUEST_RETURN, $url, $response->getStatusCode());
-            $response->getBody()->rewind();
-            $this->getLoggerHandler()->getLogger()->error($message, [$response->getBody()->getContents()]);
-            throw new ApiException($message);
-        }
-
+        $response = $this->requestClient->request($method, $url, $options);
         $response->getBody()->rewind();
-        $this->getLoggerHandler()->getLogger()->debug('response', [$response->getBody()->getContents()]);
 
         return $response;
     }
@@ -96,4 +97,28 @@ class Client
     {
         return LoggerHandler::getInstance();
     }
+
+    /**
+     * @param string $loglevel
+     *
+     * @return callable
+     */
+    protected function getLoggerMiddleware(string $loglevel = 'debug'): callable
+    {
+        return Middleware::log(
+            $this->getLoggerHandler()->getLogger(),
+            new MessageFormatter(MessageFormatter::DEBUG),
+            $loglevel
+        );
+    }
+
+    /**
+     * @return callable
+     */
+    protected function getRetryMiddleware(): callable
+    {
+        return GuzzleRetryMiddleware::factory([
+            'max_retry_attempts' => 3
+        ]);
+    }
 }

src/Exceptions/ApiException.php

@@ -1,20 +0,0 @@
-<?php
-
-/**
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- *
- * https://www.d3data.de
- *
- * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
- * @author    D3 Data Development - Daniel Seifert <support@shopmodule.com>
- * @link      https://www.oxidmodule.com
- */
-
-declare(strict_types=1);
-
-namespace D3\LinkmobilityClient\Exceptions;
-
-class ApiException extends LinkmobilityException
-{
-}

src/RecipientsList/RecipientsList.php

@@ -31,9 +31,15 @@ class RecipientsList implements RecipientsListInterface, Iterator
      */
     private $recipients = [];
 
-    public function __construct(Client $client)
+    /**
+     * @deprecated unused client parameter will remove
+     * @param Client|null $client
+     */
+    public function __construct(Client $client = null)
     {
-        $this->setClient($client);
+        if ($client) {
+            $this->setClient( $client );
+        }
     }
 
     /**
@@ -113,6 +119,7 @@ class RecipientsList implements RecipientsListInterface, Iterator
     }
 
     /**
+     * @deprecated
      * @return Client
      */
     public function getClient(): Client
@@ -121,6 +128,7 @@ class RecipientsList implements RecipientsListInterface, Iterator
     }
 
     /**
+     * @deprecated
      * @param Client $client
      *
      * @return RecipientsList

src/RecipientsList/RecipientsListInterface.php

@@ -20,6 +20,10 @@ use D3\LinkmobilityClient\ValueObject\Recipient;
 
 interface RecipientsListInterface
 {
+    /**
+     * @deprecated unused client parameter will remove
+     * @param Client $client
+     */
     public function __construct(Client $client);
 
     public function add(Recipient $recipient): RecipientsListInterface;
@@ -27,4 +31,6 @@ interface RecipientsListInterface
     public function clearRecipents(): RecipientsListInterface;
 
     public function getRecipients(): array;
+
+    public function getRecipientsList(): array;
 }

src/Request/Request.php

@@ -25,7 +25,6 @@ use D3\LinkmobilityClient\ValueObject\Recipient;
 use D3\LinkmobilityClient\ValueObject\Sender;
 use D3\LinkmobilityClient\ValueObject\SmsMessageAbstract;
 use D3\LinkmobilityClient\ValueObject\SmsMessageInterface;
-use D3\LinkmobilityClient\ValueObject\StringValueObject;
 use GuzzleHttp\RequestOptions;
 use InvalidArgumentException;
 

src/Request/RequestInterface.php

@@ -24,6 +24,7 @@ use D3\LinkmobilityClient\Response\ResponseInterface as LMResponseInterface;
 
 interface RequestInterface
 {
+    // @codeCoverageIgnoreStart
     public const METHOD_GET = 'GET';
     public const METHOD_POST = 'POST';
     public const METHOD_PUT = 'PUT';
@@ -42,6 +43,7 @@ interface RequestInterface
     public const SENDERADDRESSTYPE_INTERNATIONAL = 'international';
     public const SENDERADDRESSTYPE_ALPHANUMERIC = 'alphanumeric';
     public const SENDERADDRESSTYPE_SHORTCODE = 'shortcode';
+    // @codeCoverageIgnoreEnd
 
     /**
      * @param SmsMessageInterface $message