add support note

# Conflicts:
#	CHANGELOG.md

CHANGELOG.md

@@ -1,48 +1,66 @@
 # Changelog
+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).
 
-## 2.0.0.0 (2022-07-19)
+## [Unreleased](https://git.d3data.de/D3Private/linkmobility-php-client/compare/2.0.1...rel_2.x)
 
+## [2.0.1](https://git.d3data.de/D3Private/linkmobility-php-client/compare/2.0.0...2.0.1) - 2022-07-28
+### Added
+- phpstan code checks
+
+### Changed
+- improve changelog
+- improve code quality
+
+### 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
+### 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
+### Changed
+- improve code quality
 
-## 1.3.0.0 (2022-07-18)
+### Fixed
+- wrong return type of LoggerHandler::getInstance
 
-- tests use generated example phone numbers
-- move recipient checks from list to recipient itself
+## [1.3.0](https://git.d3data.de/D3Private/linkmobility-php-client/compare/1.2.1...1.3.0) - 2022-07-18
+### Added
 - tests added
 
----
-
-## 1.2.1.0 (2022-07-15)
+### Changed
+- 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
+### Changed
 - extend log messages
 - sanitize special phone number format before request
 
----
-
-## 1.2.0.0 (2022-07-14)
-
-- make sender number optional
-- assign sender address type only if sender is set
+## [1.2.0](https://git.d3data.de/D3Private/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
+
+### Changed
+- make sender number optional
+- assign sender address type only if sender is set
 - extract logger handler from client
 
----
-
-## 1.1.0.0 (2022-07-13)
-
+## [1.1.0](https://git.d3data.de/D3Private/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.0 (2022-07-13)
-
+## [1.0.0](https://git.d3data.de/D3Private/linkmobility-php-client/releases/tag/1.0.0) - 2022-07-13
+### Added
 - initial implementation
   - SMS requests (text or binary)
   - SMS responses
-  - recipient managing
+  - recipient managing

README.en.md

@@ -39,6 +39,12 @@ If you have a suggestion that would make this better, please fork the repo and c
 - Push to the Branch (git push origin feature/AmazingFeature)
 - Open a Pull Request
 
+## Support
+
+If you have any questions about the *messaging service* and its *contracts*, please contact the [LINK Mobility Team](https://www.linkmobility.de/kontakt).
+
+For *technical inquiries* you will find the contact options in the [composer.json](composer.json).
+
 ## License
 (status: 2022-07-13)
 

README.md

@@ -39,6 +39,12 @@ Wenn Sie eine Verbesserungsvorschlag haben, legen Sie einen Fork des Respoitorie
 - Übertragen Sie den Branch (git push origin feature/AmazingFeature)
 - Öffnen Sie einen Pull Request
 
+## Support
+
+Bei Fragen zum *Messaging Service* und dessen *Verträgen* kontaktieren Sie bitte das [LINK Mobility Team](https://www.linkmobility.de/kontakt).
+
+Zu *technischen Anfragen* finden Sie die Kontaktmöglichkeiten in der [composer.json](composer.json).
+
 ## Lizenz
 (Stand: 13.07.2022)
 

Tests/Request/AbstractRequest.php

@@ -89,13 +89,10 @@ abstract class AbstractRequest extends ApiTestCase
         $requestMock->expects($this->atLeastOnce())->method('setMessage')->with($this->equalTo($messageMock))->willReturnSelf();
         $requestMock->expects($this->atLeastOnce())->method('setClient')->with($this->equalTo($clientMock))->willReturnSelf();
 
-        $this->assertInstanceOf(
-            Request::class,
-            $this->callMethod(
-                $requestMock,
-                '__construct',
-                [$messageMock, $clientMock]
-            )
+        $this->callMethod(
+            $requestMock,
+            '__construct',
+            [$messageMock, $clientMock]
         );
     }
 

Tests/Response/AbstractResponse.php

@@ -86,7 +86,7 @@ abstract class AbstractResponse extends ApiTestCase
      */
     protected function checkProperties($expected, $propertyName, $methodName)
     {
-        /** @var Response $response */
+        /** @var Response|MockObject $responseMock */
         $responseMock = $this->getMockBuilder($this->testClassName)
             ->disableOriginalConstructor()
             ->onlyMethods(['getContent'])

Tests/ValueObject/RecipientTest.php

@@ -149,7 +149,7 @@ class RecipientTest extends ApiTestCase
     }
 
     /**
-     * @return string[][]
+     * @return array[]
      */
     public function constructInvalidDataProvider(): array
     {

Tests/ValueObject/SenderTest.php

@@ -29,7 +29,7 @@ use ReflectionException;
 
 class SenderTest extends ApiTestCase
 {
-    /** @var Sender */
+    /** @var Sender|MockObject */
     public $sender;
 
     private $phoneNumberFixture;
@@ -48,7 +48,6 @@ class SenderTest extends ApiTestCase
         $example = $phoneUtil->getExampleNumberForType($this->phoneCountryFixture, PhoneNumberType::MOBILE);
         $this->phoneNumberFixture = $phoneUtil->format($example, PhoneNumberFormat::NATIONAL);
 
-        /** @var Sender|MockObject sender */
         $this->sender = new Sender($this->phoneNumberFixture, $this->phoneCountryFixture);
     }
 
@@ -159,7 +158,7 @@ class SenderTest extends ApiTestCase
     }
 
     /**
-     * @return string[][]
+     * @return array[]
      */
     public function constructInvalidDataProvider(): array
     {

Tests/ValueObject/SmsBinaryMessageTest.php

@@ -22,7 +22,7 @@ use Phlib\SmsLength\SmsLength;
 use PHPUnit\Framework\MockObject\MockObject;
 use ReflectionException;
 
-class SmsBinaryMessageTest extends ApiTestCase
+class SmsBinaryMessageTest extends SmsMessageAbstractTest
 {
     /** @var SmsBinaryMessage */
     public $message;
@@ -39,21 +39,12 @@ class SmsBinaryMessageTest extends ApiTestCase
         $this->message = new SmsBinaryMessage($this->messageFixture);
     }
 
-    /**
-     * @return void
-     */
-    public function tearDown(): void
-    {
-        parent::tearDown();
-
-        unset($this->message);
-    }
-
     /**
      * @test
      * @return void
      * @throws ReflectionException
      * @covers \D3\LinkmobilityClient\ValueObject\SmsBinaryMessage::__construct
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::__construct
      */
     public function testConstructValid()
     {
@@ -91,6 +82,7 @@ class SmsBinaryMessageTest extends ApiTestCase
      * @throws ReflectionException
      * @dataProvider constructInvalidDataProvider
      * @covers \D3\LinkmobilityClient\ValueObject\SmsBinaryMessage::__construct
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::__construct
      */
     public function testConstructInvalid($binaryMessage, $valid, $expectedException)
     {
@@ -124,37 +116,11 @@ class SmsBinaryMessageTest extends ApiTestCase
         );
     }
 
-    /**
-     * @return string[][]
-     */
-    public function constructInvalidDataProvider(): array
-    {
-        return [
-            'empty message'          => ['', true, InvalidArgumentException::class],
-            'invalid sms message'    => ['abc', false, \Phlib\SmsLength\Exception\InvalidArgumentException::class],
-        ];
-    }
-
-    /**
-     * @test
-     * @throws ReflectionException
-     * @covers \D3\LinkmobilityClient\ValueObject\SmsBinaryMessage::getSmsLength
-     */
-    public function testGetSmsLengthInstance()
-    {
-        $this->assertInstanceOf(
-            SmsLength::class,
-            $this->callMethod(
-                $this->message,
-                'getSmsLength'
-            )
-        );
-    }
-
     /**
      * @test
      * @throws ReflectionException
      * @covers \D3\LinkmobilityClient\ValueObject\SmsBinaryMessage::chunkCount
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::chunkCount
      */
     public function testGetChunkCount()
     {
@@ -170,9 +136,9 @@ class SmsBinaryMessageTest extends ApiTestCase
 
         /** @var SmsBinaryMessage|MockObject $message */
         $message = $this->getMockBuilder(SmsBinaryMessage::class)
-                        ->onlyMethods(['getSmsLength'])
-                        ->disableOriginalConstructor()
-                        ->getMock();
+            ->onlyMethods(['getSmsLength'])
+            ->disableOriginalConstructor()
+            ->getMock();
         $message->method('getSmsLength')->willReturn($smsLengthMock);
 
         $this->assertSame(
@@ -188,6 +154,7 @@ class SmsBinaryMessageTest extends ApiTestCase
      * @test
      * @throws ReflectionException
      * @covers \D3\LinkmobilityClient\ValueObject\SmsBinaryMessage::length
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::length
      */
     public function testGetSize()
     {

Tests/ValueObject/SmsMessageAbstractTest.php

@@ -0,0 +1,66 @@
+<?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\Tests\ValueObject;
+
+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
+{
+    public $message;
+
+    /**
+     * @return void
+     */
+    public function tearDown(): void
+    {
+        parent::tearDown();
+
+        unset($this->message);
+    }
+
+    /**
+     * @return array[]
+     */
+    public function constructInvalidDataProvider(): array
+    {
+        return [
+            'empty message'          => ['', true, InvalidArgumentException::class],
+            'invalid sms message'    => ['abc', false, \Phlib\SmsLength\Exception\InvalidArgumentException::class],
+        ];
+    }
+
+    /**
+     * @test
+     * @throws ReflectionException
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsBinaryMessage::getSmsLength
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsTextMessage::getSmsLength
+     */
+    public function testGetSmsLengthInstance()
+    {
+        $this->assertInstanceOf(
+            SmsLength::class,
+            $this->callMethod(
+                $this->message,
+                'getSmsLength'
+            )
+        );
+    }
+}

Tests/ValueObject/SmsTextMessageTest.php

@@ -21,7 +21,7 @@ use Phlib\SmsLength\SmsLength;
 use PHPUnit\Framework\MockObject\MockObject;
 use ReflectionException;
 
-class SmsTextMessageTest extends SmsBinaryMessageTest
+class SmsTextMessageTest extends SmsMessageAbstractTest
 {
     /** @var SmsTextMessage */
     public $message;
@@ -43,6 +43,7 @@ class SmsTextMessageTest extends SmsBinaryMessageTest
      * @return void
      * @throws ReflectionException
      * @covers \D3\LinkmobilityClient\ValueObject\SmsTextMessage::__construct
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::__construct
      */
     public function testConstructValid()
     {
@@ -80,6 +81,7 @@ class SmsTextMessageTest extends SmsBinaryMessageTest
      * @throws ReflectionException
      * @dataProvider constructInvalidDataProvider
      * @covers \D3\LinkmobilityClient\ValueObject\SmsTextMessage::__construct
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::__construct
      */
     public function testConstructInvalid($binaryMessage, $valid, $expectedException)
     {
@@ -112,4 +114,104 @@ class SmsTextMessageTest extends SmsBinaryMessageTest
             )
         );
     }
+
+    /**
+     * @test
+     * @throws ReflectionException
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsTextMessage::chunkCount
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::chunkCount
+     */
+    public function testGetChunkCount()
+    {
+        $expected = 2;
+
+        /** @var SmsLength|MockObject $smsLengthMock */
+        $smsLengthMock = $this->getMockBuilder(SmsLength::class)
+            ->onlyMethods(['getMessageCount', 'validate'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $smsLengthMock->expects($this->once())->method('getMessageCount')->willReturn($expected);
+        $smsLengthMock->method('validate')->willReturn(true);
+
+        /** @var SmsTextMessage|MockObject $message */
+        $message = $this->getMockBuilder(SmsTextMessage::class)
+            ->onlyMethods(['getSmsLength'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $message->method('getSmsLength')->willReturn($smsLengthMock);
+
+        $this->assertSame(
+            $expected,
+            $this->callMethod(
+                $message,
+                'chunkCount'
+            )
+        );
+    }
+
+    /**
+     * @test
+     * @throws ReflectionException
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsTextMessage::length
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::length
+     */
+    public function testGetSize()
+    {
+        $expected = 55;
+
+        /** @var SmsLength|MockObject $smsLengthMock */
+        $smsLengthMock = $this->getMockBuilder(SmsLength::class)
+            ->onlyMethods(['getSize', 'validate'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $smsLengthMock->expects($this->once())->method('getSize')->willReturn($expected);
+        $smsLengthMock->method('validate')->willReturn(true);
+
+        /** @var SmsTextMessage|MockObject $message */
+        $message = $this->getMockBuilder(SmsTextMessage::class)
+            ->onlyMethods(['getSmsLength'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $message->method('getSmsLength')->willReturn($smsLengthMock);
+
+        $this->assertSame(
+            $expected,
+            $this->callMethod(
+                $message,
+                'length'
+            )
+        );
+    }
+
+    /**
+     * @test
+     * @throws ReflectionException
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsTextMessage::getMessageContent
+     * @covers \D3\LinkmobilityClient\ValueObject\SmsMessageAbstract::getMessageContent
+     */
+    public function testGetMessageContent()
+    {
+        /** @var SmsLength|MockObject $smsLengthMock */
+        $smsLengthMock = $this->getMockBuilder(SmsLength::class)
+            ->onlyMethods(['validate'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $smsLengthMock->method('validate')->willReturn(true);
+
+        /** @var SmsTextMessage|MockObject $message */
+        $message = $this->getMockBuilder(SmsTextMessage::class)
+            ->onlyMethods(['getSmsLength'])
+            ->disableOriginalConstructor()
+            ->getMock();
+        $message->method('getSmsLength')->willReturn($smsLengthMock);
+        $message->__construct($this->messageFixture);
+
+        $this->assertSame(
+            'testMessage',
+            $this->callMethod(
+                $message,
+                'getMessageContent'
+            )
+        );
+    }
 }

Tests/ValueObject/ValueObjectTest.php

@@ -26,11 +26,13 @@ use ReflectionException;
 
 class ValueObjectTest extends ApiTestCase
 {
+    /** @var ValueObject|MockObject */
+    public $value;
+
     public function setUp(): void
     {
         parent::setUp();
 
-        /** @var ValueObject|MockObject value */
         $this->value = $this->getMockBuilder(ValueObject::class)
             ->disableOriginalConstructor()
             ->getMock();

composer.json

@@ -21,7 +21,7 @@
       "GPL-3.0-or-later"
     ],
     "require": {
-        "php": "^7.3 || ^8.0",
+        "php": "^7.3 || ~8.0.3",
         "beberlei/assert": "^3.3",
         "guzzlehttp/guzzle": "^7.4",
         "psr/http-message": "~1.0",
@@ -30,9 +30,10 @@
         "ext-json": "*"
     },
     "require-dev": {
-        "php": "^7.4",
+        "php": "^7.4 || ~8.0.3",
         "phpunit/phpunit" : "^9.5",
-        "friendsofphp/php-cs-fixer": "^3.9"
+        "friendsofphp/php-cs-fixer": "^3.9",
+        "phpstan/phpstan": "^1.8"
     },
     "autoload": {
         "psr-4": {
@@ -41,8 +42,9 @@
         }
     },
     "scripts": {
-        "test": "phpunit",
+        "test": "./vendor/bin/phpunit",
         "check-style": "./vendor/bin/php-cs-fixer fix --verbose --dry-run",
-        "fix-style": "./vendor/bin/php-cs-fixer fix --verbose"
+        "fix-style": "./vendor/bin/php-cs-fixer fix --verbose",
+        "check-code": "./vendor/bin/phpstan analyse -c phpstan.neon --no-progress --ansi"
     }
 }

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    paths:
+        - src
+        - Tests
+    level: 5
+    phpVersion: 70300

src/LoggerHandler.php

@@ -20,10 +20,14 @@ use Psr\Log\NullLogger;
 
 class LoggerHandler
 {
+    /** @var LoggerHandler */
     private static $instance = null;
     private $logger;
 
-    public static function getInstance(): ?LoggerHandler
+    /**
+     * @return LoggerHandler
+     */
+    public static function getInstance(): LoggerHandler
     {
         if (self::$instance === null) {
             self::$instance = new self();
@@ -38,7 +42,7 @@ class LoggerHandler
     }
 
     /**
-     * @param mixed $logger
+     * @param LoggerInterface $logger
      */
     public function setLogger(LoggerInterface $logger)
     {

src/Request/Request.php

@@ -107,7 +107,7 @@ abstract class Request implements RequestInterface
     private $test = false;
 
     /**
-     * @var bool
+     * @var int
      */
     private $maxSmsPerMessage = 0;
 
@@ -119,8 +119,6 @@ abstract class Request implements RequestInterface
         $this->recipientsList = new RecipientsList($client);
         $this->setMessage($message);
         $this->setClient($client);
-
-        return $this;
     }
 
     /**
@@ -207,11 +205,11 @@ abstract class Request implements RequestInterface
     }
 
     /**
-     * @param StringValueObject $message
+     * @param SmsMessageInterface $message
      *
      * @return $this
      */
-    public function setMessage(StringValueObject $message): Request
+    public function setMessage(SmsMessageInterface $message): Request
     {
         $this->message = $message;
 
@@ -422,7 +420,7 @@ abstract class Request implements RequestInterface
     }
 
     /**
-     * @return bool|null
+     * @return bool
      */
     public function doSendAsFlashSms(): bool
     {

src/Request/RequestInterface.php

@@ -16,6 +16,7 @@ declare(strict_types=1);
 namespace D3\LinkmobilityClient\Request;
 
 use D3\LinkmobilityClient\Client;
+use D3\LinkmobilityClient\RecipientsList\RecipientsListInterface;
 use D3\LinkmobilityClient\ValueObject\SmsMessageInterface;
 use InvalidArgumentException;
 use Psr\Http\Message\ResponseInterface as PsrResponseInterface;
@@ -42,9 +43,18 @@ interface RequestInterface
     public const SENDERADDRESSTYPE_ALPHANUMERIC = 'alphanumeric';
     public const SENDERADDRESSTYPE_SHORTCODE = 'shortcode';
 
+    /**
+     * @param SmsMessageInterface $message
+     * @param Client              $client
+     */
     public function __construct(SmsMessageInterface $message, Client $client);
 
-    public function setMethod(string $method);
+    /**
+     * @param string $method
+     *
+     * @return Request
+     */
+    public function setMethod(string $method): Request;
 
     /**
      * Must return the HTTP verb for this request, i.e. GET, POST, PUT
@@ -53,6 +63,18 @@ interface RequestInterface
      */
     public function getMethod(): string;
 
+    /**
+     * @param bool $test
+     *
+     * @return Request
+     */
+    public function setTestMode(bool $test): Request;
+
+    /**
+     * @return bool
+     */
+    public function getTestMode(): bool;
+
     /**
      * Must return the URI for the request with a leading slash, i.e. /messages.json
      *
@@ -81,6 +103,11 @@ interface RequestInterface
      */
     public function getResponseInstance(PsrResponseInterface $rawResponse): LMResponseInterface;
 
+    /**
+     * @return RecipientsListInterface
+     */
+    public function getRecipientsList(): RecipientsListInterface;
+
     /**
      * Must return the options for this request. If there are none, return [] (empty array)
      *