Merge pull request #67 from unzerdev/develop

Ryouzanpaku · web-flow · commit 4184b4083567 · 2022-01-27T12:29:30.000+01:00
Develop
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,18 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [1.1.4.2](https://github.com/unzerdev/php-sdk/compare/1.1.4.1..1.1.4.2)
+### Added
+*   Enable PHP 8.1 compatibility.
+### Changed
+* Fix an issue that can cause an exception when fetching a payment that contained a "cancel-authorize" transaction even though the payment has no authorization transaction.
+* Update broken documentation links in readme.
+* Several minor improvements.
+
 ## [1.1.4.1](https://github.com/unzerdev/php-sdk/compare/1.1.4.0..1.1.4.1)
 ### Added
-* Added Apple Pay example.
+*   Added Apple Pay example.
 
 ### Changed
 * Adjust `cancelAmount` logic to work properly with Invoice Secured payments.
@@ -17,9 +26,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 *   Enable recurrence type to be set for `charge`, `authorize` and `activateRecurringPayment` methods.
 
 ### Changed
-* Enable recurring examples (card paypal)to trigger subsequent transaction from success page.
-* Enable card recurring example to use recurrence type.
-* Several minor improvements.
+*   Enable recurring examples (card paypal)to trigger subsequent transaction from success page.
+*   Enable card recurring example to use recurrence type.
+*   Several minor improvements.
 
 ## [1.1.3.0](https://github.com/unzerdev/php-sdk/compare/1.1.2.0..1.1.3.0)
 ### Added
@@ -70,9 +79,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 *   Rebranding of the SDK.
 *   Removed payment type string from URL when fetching a payment type resource.
 *   Replace payment methods guaranteed/factoring by secured payment methods, i.e.:
-    *   `InvoiceGuaranteed` and `InvoiceFactoring` replaced by `InvoiceSecured`
-    *   `SepaDirectDebitGuaranteed` replaced by `SepaDirectDebitSecured`
-    *   `HirePurchaseDirectDebit` replaced by `InstallmentSecured`
+    *   `InvoiceGuaranteed` and `InvoiceFactoring` replaced by `InvoiceSecured`.
+    *   `SepaDirectDebitGuaranteed` replaced by `SepaDirectDebitSecured`.
+    *   `HirePurchaseDirectDebit` replaced by `InstallmentSecured`.
     *   Basket is now mandatory for all those payment types above.
 *   Added mapping of old payment type ids to the new payment type resources.
 *   Constant in `\UnzerSDK\Constants\ApiResponseCodes` got renamed:
diff --git a/README.md b/README.md
@@ -4,18 +4,19 @@
 [![PHP 7.3](https://img.shields.io/badge/php-7.3-blue.svg)](http://www.php.net)
 [![PHP 7.4](https://img.shields.io/badge/php-7.4-blue.svg)](http://www.php.net)
 [![PHP 8.0](https://img.shields.io/badge/php-8.0-blue.svg)](http://www.php.net)
+[![PHP 8.1](https://img.shields.io/badge/php-8.1-blue.svg)](http://www.php.net)
 
-![Logo](https://dev.unzer.com/wp-content/uploads/2020/09/Unzer__PrimaryLogo_Raspberry_RGB.png)
+![Logo](unzer_logo.svg)
 
 # Unzer php-sdk
 This SDK provides for an easy way to connect to the Unzer Rest API.
 
 Please refer to the following documentation for installation instructions and usage information.
 
-*   [API Documentation](https://docs.unzer.com/overview)
-*   [PHP SDK Documentation](https://docs.unzer.com/integrate/php-sdk)
-*   [How to use the examples](https://docs.unzer.com/integrate/php-sdk/example-implementations)
-*   [Debugging](https://docs.unzer.com/integrate/php-sdk/logging-and-debugging)
+*   [API Documentation](https://docs.unzer.com)
+*   [PHP SDK Documentation](https://docs.unzer.com/server-side-integration/php-sdk-integration)
+*   [How to use the examples](https://docs.unzer.com/server-side-integration/php-sdk-integration/php-example-implementation)
+*   [Debugging](https://docs.unzer.com/server-side-integration/php-sdk-integration/php-error-handling/#debug-log)
 
 ## Supported payment types
 *   Alipay
@@ -53,3 +54,6 @@ For any issues or questions please get in touch with our support team.
 ### Phone
 * DE: [+49 6221 43101-00](tel:+4962214310100)
 * AT: [+43 1 513 66 33 669](tel:+4315136633669)
+
+### Twitter
+[@UnzerTech](https://twitter.com/UnzerTech)
diff --git a/composer.json b/composer.json
@@ -4,7 +4,7 @@
   "minimum-stability": "stable",
   "license": "Apache-2.0",
   "require": {
-    "php": "~7.1.0|~7.2.0|~7.3.0|~7.4.0|~8.0.0",
+    "php": "~7.1.0|~7.2.0|~7.3.0|~7.4.0|~8.0.0|~8.1.0",
     "ext-json": "*"
   },
   "require-dev": {
diff --git a/examples/PayPal/index.php b/examples/PayPal/index.php
@@ -47,8 +47,8 @@
 <body style="margin: 70px 70px 0;">
 <h3>Example data:</h3>
 <ul>
-    <li>Username: paypal-customer@heidelpay.de</li>
-    <li>Password: heidelpay</li>
+    <li>Username: paypal-buyer@unzer.com</li>
+    <li>Password: unzer1234</li>
 </ul>
 <strong>Attention:</strong> We recommend to create your own PayPal test account <a href="https://developer.paypal.com" target="_blank">here</a>.
 
diff --git a/examples/PayPalRecurring/index.php b/examples/PayPalRecurring/index.php
@@ -47,8 +47,8 @@
 <body style="margin: 70px 70px 0;">
 <h3>Example data:</h3>
 <ul>
-    <li>Username: paypal-customer@heidelpay.de</li>
-    <li>Password: heidelpay</li>
+    <li>Username: paypal-buyer@unzer.com</li>
+    <li>Password: unzer1234</li>
 </ul>
 <strong>Attention:</strong> We recommend to create your own PayPal test account <a href="https://developer.paypal.com" target="_blank">here</a>.
 
diff --git a/src/Resources/Payment.php b/src/Resources/Payment.php
@@ -851,15 +851,15 @@ private function updateChargeTransaction($transaction): void
     private function updateReversalTransaction($transaction): void
     {
         $transactionId = IdService::getResourceIdFromUrl($transaction->url, IdStrings::CANCEL);
-        $authorization = $this->getAuthorization(true);
-        if (!$authorization instanceof Authorization) {
-            throw new RuntimeException('The Authorization object can not be found.');
+        $initialTransaction = $this->getInitialTransaction(true);
+        if (!$initialTransaction instanceof Authorization && !$initialTransaction instanceof Charge) {
+            throw new RuntimeException('The initial transaction object (Authorize or Charge) can not be found.');
         }
 
-        $cancellation = $authorization->getCancellation($transactionId, true);
+        $cancellation = $initialTransaction->getCancellation($transactionId, true);
         if (!$cancellation instanceof Cancellation) {
             $cancellation = (new Cancellation())->setPayment($this)->setId($transactionId);
-            $authorization->addCancellation($cancellation);
+            $initialTransaction->addCancellation($cancellation);
         }
 
         $cancellation->handleResponse($transaction);
diff --git a/src/Resources/Recurring.php b/src/Resources/Recurring.php
@@ -24,6 +24,7 @@
  */
 namespace UnzerSDK\Resources;
 
+use UnzerSDK\Adapter\HttpAdapterInterface;
 use UnzerSDK\Traits\HasAdditionalTransactionData;
 use UnzerSDK\Traits\HasCustomerMessage;
 use UnzerSDK\Traits\HasDate;
diff --git a/src/Resources/TransactionTypes/Shipment.php b/src/Resources/TransactionTypes/Shipment.php
@@ -24,6 +24,7 @@
  */
 namespace UnzerSDK\Resources\TransactionTypes;
 
+use UnzerSDK\Adapter\HttpAdapterInterface;
 use UnzerSDK\Traits\HasInvoiceId;
 
 class Shipment extends AbstractTransactionType
diff --git a/src/Resources/Webhook.php b/src/Resources/Webhook.php
@@ -24,6 +24,8 @@
  */
 namespace UnzerSDK\Resources;
 
+use UnzerSDK\Adapter\HttpAdapterInterface;
+
 class Webhook extends AbstractUnzerResource
 {
     /** @var string $url */
diff --git a/src/Services/HttpService.php b/src/Services/HttpService.php
@@ -218,12 +218,16 @@ public function debugLog(
         $authHeader[1] = ValueService::maskValue($authHeader[1]);
         $headers['Authorization'] = implode(' ', $authHeader);
 
+        // log request
         $unzerObj->debugLog($httpMethod . ': ' . $url);
         $writingOperations = [HttpAdapterInterface::REQUEST_POST, HttpAdapterInterface::REQUEST_PUT];
         $unzerObj->debugLog('Headers: ' . json_encode($headers, JSON_UNESCAPED_SLASHES));
         if (in_array($httpMethod, $writingOperations, true)) {
             $unzerObj->debugLog('Request: ' . $payload);
         }
+
+        // log response
+        $response = $response ?? '';
         $unzerObj->debugLog(
             'Response: (' . $responseCode . ') ' .
             json_encode(json_decode($response, false), JSON_UNESCAPED_SLASHES)
diff --git a/src/Services/IdService.php b/src/Services/IdService.php
@@ -89,8 +89,12 @@ public static function getLastResourceIdFromUrlString($url): ?string
      *
      * @return string|null
      */
-    public static function getResourceTypeFromIdString($typeId): ?string
+    public static function getResourceTypeFromIdString(?string $typeId): ?string
     {
+        if ($typeId === null) {
+            return null;
+        }
+
         $typeIdString = null;
 
         $typeIdParts = [];
diff --git a/src/Unzer.php b/src/Unzer.php
@@ -63,7 +63,7 @@ class Unzer implements UnzerParentInterface, PaymentServiceInterface, ResourceSe
     public const BASE_URL = 'api.unzer.com';
     public const API_VERSION = 'v1';
     public const SDK_TYPE = 'UnzerPHP';
-    public const SDK_VERSION = '1.1.4.1';
+    public const SDK_VERSION = '1.1.4.2';
 
     /** @var string $key */
     private $key;
@@ -102,7 +102,7 @@ class Unzer implements UnzerParentInterface, PaymentServiceInterface, ResourceSe
      *
      * @throws RuntimeException A RuntimeException will be thrown if the key is not of type private.
      */
-    public function __construct($key, $locale = null)
+    public function __construct($key, $locale = '')
     {
         $this->setKey($key);
         $this->setLocale($locale);
@@ -166,6 +166,10 @@ public function getLocale(): ?string
      */
     public function setLocale($locale): Unzer
     {
+        if ($locale === null) {
+            return $this;
+        }
+
         $this->locale = str_replace('_', '-', $locale);
         return $this;
     }
@@ -929,7 +933,7 @@ public function initPayPageAuthorize(
 
     //</editor-fold>
 
-    //<editor-fold desc="HInstallment Secured">
+    //<editor-fold desc="Installment Secured">
 
     /**
      * {@inheritDoc}
diff --git a/src/Validators/PrivateKeyValidator.php b/src/Validators/PrivateKeyValidator.php
@@ -38,6 +38,9 @@ class PrivateKeyValidator
     public static function validate($key): bool
     {
         $match = [];
+        if ($key === null) {
+            return false;
+        }
         preg_match('/^[sp]-priv-[a-zA-Z0-9]+/', $key, $match);
         return count($match) > 0;
     }
diff --git a/src/Validators/PublicKeyValidator.php b/src/Validators/PublicKeyValidator.php
@@ -38,6 +38,9 @@ class PublicKeyValidator
     public static function validate($key): bool
     {
         $match = [];
+        if ($key === null) {
+            return false;
+        }
         preg_match('/^[sp]-pub-[a-zA-Z0-9]+/', $key, $match);
         return count($match) > 0;
     }
diff --git a/test/unit/Resources/AbstractUnzerResourceTest.php b/test/unit/Resources/AbstractUnzerResourceTest.php
@@ -188,7 +188,7 @@ public function fetchPaymentContainsNoTypeNameInUri(AbstractUnzerResource $resou
 
     /**
      * Verify that installment plans use the correct path for fetching. Special case, fetching Instalmentplans contains
-     * hinstallment-secured as parent resource that should appear in resource path.
+     * Installment-secured as parent resource that should appear in resource path.
      *
      * @test
      */
diff --git a/test/unit/Resources/PaymentTest.php b/test/unit/Resources/PaymentTest.php
@@ -26,8 +26,10 @@
  */
 namespace UnzerSDK\test\unit\Resources;
 
+use PHPUnit\Framework\MockObject\MockObject;
+use RuntimeException;
+use stdClass;
 use UnzerSDK\Constants\PaymentState;
-use UnzerSDK\Unzer;
 use UnzerSDK\Resources\Basket;
 use UnzerSDK\Resources\Customer;
 use UnzerSDK\Resources\CustomerFactory;
@@ -43,9 +45,7 @@
 use UnzerSDK\Resources\TransactionTypes\Shipment;
 use UnzerSDK\Services\ResourceService;
 use UnzerSDK\test\BasePaymentTest;
-use PHPUnit\Framework\MockObject\MockObject;
-use RuntimeException;
-use stdClass;
+use UnzerSDK\Unzer;
 
 class PaymentTest extends BasePaymentTest
 {
@@ -595,6 +595,53 @@ public function getAndSetCurrencyShouldPropagateToTheAmountObject(): void
         $this->assertEquals('MyTestGetCurrency', $payment->getCurrency());
     }
 
+    /**
+     * Verify that a payment that contains a cancel-authorize transaction can be fetched, even though no authorize
+     * transaction exists. Can occur when canceling via Insights.
+     *
+     * @test
+     */
+    public function cancelAuthorizeOnInvoiceShouldBeHandledCorrectly(): void
+    {
+        $resourceServiceMock = $this->getMockBuilder(ResourceService::class)
+            ->disableOriginalConstructor()->setMethods(['getResource'])->getMock();
+        /** @noinspection PhpParamsInspection */
+
+        /** @var ResourceService $resourceServiceMock */
+        $unzerObj = (new Unzer('s-priv-123'))->setResourceService($resourceServiceMock);
+        $payment = new Payment();
+        $payment->setParentResource($unzerObj);
+
+        $response = (object)[
+            "id" => "s-pay-666",
+            "state" => (object)["id" => 1, "name" => "completed"],
+            "currency" => "EUR",
+            "transactions" => [
+                (object)["date" => "2021-11-17 11:47:07",
+                    "type" => "charge",
+                    "status" => "pending",
+                    "url" => "https://api.unzer.com/v1/payments/s-pay-666/charges/s-chg-1", "amount" => "14.9900"
+                ],
+                (object)[
+                    "date" => "2021-11-17 11:48:52",
+                    "type" => "shipment", "status" => "success",
+                    "url" => "https://api.unzer.com/v1/payments/s-pay-666/shipments/s-shp-1",
+                    "amount" => "14.9900"],
+                (object)["date" => "2021-11-17 11:48:52",
+                    "type" => "cancel-authorize",
+                    "status" => "success",
+                    "url" => "https://api.unzer.com/v1/payments/s-pay-666/charges/s-chg-1/cancels/s-cnl-1",
+                    "amount" => "10.0000"]
+            ]
+        ];
+        $payment->handleResponse($response);
+        $this->assertNull($payment->getAuthorization());
+        /** @var Charge $initialCharge */
+        $initialCharge = $payment->getCharges()[0];
+
+        $this->assertCount(1, $initialCharge->getCancellations());
+    }
+
     //<editor-fold desc="Handle Response Tests">
 
     /**
@@ -976,7 +1023,7 @@ public function handleResponseShouldThrowExceptionIfAnAuthorizeToAReversalDoesNo
         $response->transactions = [$cancellation];
 
         $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('The Authorization object can not be found.');
+        $this->expectExceptionMessage('The initial transaction object (Authorize or Charge) can not be found.');
         $payment->handleResponse($response);
     }
 
diff --git a/unzer_logo.svg b/unzer_logo.svg

Original file line number	Diff line number	Diff line change
`@@ -851,15 +851,15 @@ private function updateChargeTransaction($transaction): void`
`851`	`851`	`private function updateReversalTransaction($transaction): void`
`852`	`852`	`{`
`853`	`853`	`$transactionId = IdService::getResourceIdFromUrl($transaction->url, IdStrings::CANCEL);`
`854`		`- $authorization = $this->getAuthorization(true);`
`855`		`- if (!$authorization instanceof Authorization) {`
`856`		`- throw new RuntimeException('The Authorization object can not be found.');`
	`854`	`+ $initialTransaction = $this->getInitialTransaction(true);`
	`855`	`+ if (!$initialTransaction instanceof Authorization && !$initialTransaction instanceof Charge) {`
	`856`	`+ throw new RuntimeException('The initial transaction object (Authorize or Charge) can not be found.');`
`857`	`857`	`}`
`858`	`858`
`859`		`- $cancellation = $authorization->getCancellation($transactionId, true);`
	`859`	`+ $cancellation = $initialTransaction->getCancellation($transactionId, true);`
`860`	`860`	`if (!$cancellation instanceof Cancellation) {`
`861`	`861`	`$cancellation = (new Cancellation())->setPayment($this)->setId($transactionId);`
`862`		`- $authorization->addCancellation($cancellation);`
	`862`	`+ $initialTransaction->addCancellation($cancellation);`
`863`	`863`	`}`
`864`	`864`
`865`	`865`	`$cancellation->handleResponse($transaction);`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@`
`24`	`24`	`*/`
`25`	`25`	`namespace UnzerSDK\Resources;`
`26`	`26`
	`27`	`+use UnzerSDK\Adapter\HttpAdapterInterface;`
	`28`	`+`
`27`	`29`	`class Webhook extends AbstractUnzerResource`
`28`	`30`	`{`
`29`	`31`	`/** @var string $url */`