Merge pull request #18 from iranl/extend-all-testing

Extend all testing

breaking262.md → breaking270.md

@@ -1,4 +1,4 @@
-# Breaking changes since 2.6.2
+# Breaking changes since 2.7.0
 Release ... added multiple new resources, but also broke several existing ones.
 
 Breaking changes are present in:

readme.md

@@ -21,7 +21,7 @@ composer require 'league/oauth2-client'
 ## Usage
 
 See [Usage](usage.md).
-For breaking changes since 2.6.2 see [Breaking Changes since 2.6.2](breaking262.md).
+For breaking changes since 2.7.0 see [Breaking Changes since 2.7.0](breaking270.md).
 
 ### Supported resources
 Not all resources from the Twinfield API are currently implemented. Feel free to create a pull request when you need

src/ApiConnectors/ApiOptions.php

@@ -0,0 +1,101 @@
+<?php
+
+namespace PhpTwinfield\ApiConnectors;
+
+final class ApiOptions
+{
+    private $retriableExceptionMessages = [
+        "SSL: Connection reset by peer",
+        "Your logon credentials are not valid anymore. Try to log on again."
+    ];
+
+    private $maxRetries = 3;
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    public function __construct(?array $messages = null, ?int $maxRetries = null)
+    {
+        if ($messages !== null) {
+            $this->validateMessages($messages);
+            $this->retriableExceptionMessages = $messages;
+        }
+        if ($maxRetries !== null) {
+            $this->validateMaxRetries($maxRetries);
+            $this->maxRetries = $maxRetries;
+        }
+    }
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    private function validateMaxRetries(int $maxRetries): void
+    {
+        if ($maxRetries < 0) {
+            throw new \InvalidArgumentException('The max retries should be a positive integer.');
+        }
+    }
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    private function validateMessages(array $messages): void
+    {
+        foreach ($messages as $key => $message) {
+            if (trim($message) === '') {
+                throw new \InvalidArgumentException(
+                    sprintf('The exception message should not be empty. Key: [%s]', $key)
+                );
+            }
+        }
+    }
+
+    /**
+     * @return array
+     */
+    public function getRetriableExceptionMessages(): array
+    {
+        return $this->retriableExceptionMessages;
+    }
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    public function setRetriableExceptionMessages(array $retriableExceptionMessages): ApiOptions
+    {
+        return new self(
+            $retriableExceptionMessages,
+            $this->maxRetries
+        );
+    }
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    public function addMessages(array $messages): ApiOptions
+    {
+        return new self(
+            array_merge($messages, $this->retriableExceptionMessages),
+            $this->maxRetries
+        );
+    }
+
+    /**
+     * @return int
+     */
+    public function getMaxRetries(): int
+    {
+        return $this->maxRetries;
+    }
+
+    /**
+     * @throws \InvalidArgumentException
+     */
+    public function setMaxRetries(int $maxRetries): ApiOptions
+    {
+        return new self(
+            $this->retriableExceptionMessages,
+            $maxRetries
+        );
+    }
+}

src/ApiConnectors/BaseApiConnector.php

@@ -19,34 +19,32 @@ abstract class BaseApiConnector implements LoggerAwareInterface
     use LoggerAwareTrait;
 
     /**
-     * Make sure to only add error messages for failure cases that caused the server not to accept / receive the
-     * request. Else the automatic retry will cause the request to be understood by the server twice.
-     *
-     * @var string[]
+     * @var AuthenticatedConnection
      */
-    private const RETRY_REQUEST_EXCEPTION_MESSAGES = [
-        "SSL: Connection reset by peer",
-        "Your logon credentials are not valid anymore. Try to log on again."
-    ];
+    private $connection;
 
     /**
      * @var int
      */
-    private const MAX_RETRIES = 3;
+    private $numRetries = 0;
 
     /**
-     * @var AuthenticatedConnection
+     * @var ApiOptions
      */
-    private $connection;
+    private $options;
 
     /**
-     * @var int
+     * @throws \InvalidArgumentException
      */
-    private $numRetries = 0;
-
-    public function __construct(AuthenticatedConnection $connection)
+    public function __construct(AuthenticatedConnection $connection, ?ApiOptions $options = null)
     {
         $this->connection = $connection;
+
+        if ($options === null) {
+            $this->options = new ApiOptions();
+        } else {
+            $this->options = $options;
+        }
     }
 
     /**
@@ -60,6 +58,11 @@ public function getConnection(): AuthenticatedConnection
         return $this->connection;
     }
 
+    public function getOptions(): ApiOptions
+    {
+        return $this->options;
+    }
+
     /**
      * @see sendXmlDocument()
      * @throws Exception
@@ -77,6 +80,7 @@ protected function getProcessXmlService(): ProcessXmlService
      * @param \DOMDocument $document
      * @return \PhpTwinfield\Response\Response
      * @throws Exception
+     * @throws \RuntimeException
      */
     public function sendXmlDocument(\DOMDocument $document) {
         $this->logSendingDocument($document);
@@ -96,13 +100,13 @@ public function sendXmlDocument(\DOMDocument $document) {
             $this->connection->resetClient(Services::PROCESSXML());
 
             /* For a given set of exception messages, always retry the request. */
-            foreach (self::RETRY_REQUEST_EXCEPTION_MESSAGES as $message) {
+            foreach ($this->getOptions()->getRetriableExceptionMessages() as $message) {
                 if (stripos($exception->getMessage(), $message) === false) {
                     continue;
                 }
                 $this->numRetries++;
 
-                if ($this->numRetries > self::MAX_RETRIES) {
+                if ($this->numRetries > $this->getOptions()->getMaxRetries()) {
                     break;
                 }
 

src/CustomerCreditManagement.php

@@ -34,6 +34,7 @@ class CustomerCreditManagement extends BaseObject
 
     public function __construct()
     {
+        $this->setBlocked(false);
         $this->setSendReminder(\PhpTwinfield\Enums\SendReminder::TRUE());
     }
 }

src/DomDocuments/CustomersDocument.php

@@ -105,7 +105,12 @@ public function addCustomer(Customer $customer)
         $creditManagementElement = $this->createElement('creditmanagement');
         $customerElement->appendChild($creditManagementElement);
 
-        $creditManagementElement->appendChild($this->createNodeWithTextContent('basecreditlimit', Util::formatMoney($creditManagement->getBaseCreditLimit())));
+        if ($creditManagement->getBaseCreditLimit() !== null) {
+            $creditManagementElement->appendChild($this->createNodeWithTextContent('basecreditlimit', Util::formatMoney($creditManagement->getBaseCreditLimit())));
+        } else {
+            $creditManagementElement->appendChild($this->createNodeWithTextContent('basecreditlimit', 0));
+        }
+
         $creditManagementElement->appendChild($this->createNodeWithTextContent('blocked', Util::formatBoolean($creditManagement->getBlocked())));
         $creditManagementElement->appendChild($this->createNodeWithTextContent('comment', $creditManagement->getComment()));
         $creditManagementElement->appendChild($this->createNodeWithTextContent('freetext1', Util::formatBoolean($creditManagement->getFreeText1())));

tests/IntegrationTests/resources/customerSendRequest.xml

@@ -26,8 +26,8 @@
             </collectmandate>
         </financials>
         <creditmanagement>
-            <basecreditlimit/>
-            <blocked/>
+            <basecreditlimit>0</basecreditlimit>
+            <blocked>false</blocked>
             <comment/>
             <freetext1/>
             <freetext2/>