Merge pull request #137 from unzerdev/develop

Develop

Author: Ryouzanpaku

.github/workflows/integration-tests.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.1'
+          php-version: '7.4'
       - name: Setup Apple Pay test certificate
         run: mkdir certs
       - run: echo "$APPLE_PAY_MERCHANT_ID_CERT" > certs/merchant_id.pem

.github/workflows/unit-tests.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1' ]
+        php: ['7.4', '8.0', '8.1', '8.2']
     name: PHP ${{ matrix.php }} unit tests
     steps:
       - uses: actions/checkout@v3

CHANGELOG.md

@@ -5,6 +5,27 @@ 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).
 
+## [3.0.0](https://github.com/unzerdev/php-sdk/compare/1.2.3.0..3.0.0)
+
+### Added
+
+*   Enable PHP version 8.2 in composer.json.
+*   Add paypage property to `Payment` class.
+*   Add class `\UnzerSDK\Resources\EmbeddedResources\CardTransactionData`.
+    Set as "card" field of additionalTransactionData    
+*   Add constants `\UnzerSDK\Constants\LiabilityShiftIndicator` for valid liability shift indicator values, relevant for card payment.
+    *   Charge and authorize transactions with card can contain that indicator in Api Response. (`CardTransactionData::$liability`)
+
+### Changed
+
+*   Switch SDK to 3-digit versioning. First digit, formerly representing API version gets omitted (1.3.0.0 -> 3.0.0).
+*   Add Type declaration to methods where applicable.
+*   Enable `Unzer::fetchPaymentRefund` and `Unzer::fetchPaymentReversal` to use resource ID as parameter.
+*   Raise minimum PHP version to 7.4 in composer.json
+*   Handling of additionalTransactionData:
+    *   `additionalTransactionData.card` from API responses will be mapped on `\UnzerSDK\Resources\EmbeddedResources\CardTransactionData` now.
+    *   Remove `paymentType` parameter of `\UnzerSDK\Traits\HasRecurrenceType::setRecurrenceType`, it will always be set for `card` field of `additionalTransactionData`.
+
 ## [1.2.3.0](https://github.com/unzerdev/php-sdk/compare/1.2.2.0..1.2.3.0)
 
 ### Changed

README.md

@@ -1,10 +1,8 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/unzerdev/php-sdk.svg?style=flat-square)](https://packagist.org/packages/unzerdev/php-sdk)
-[![PHP 7.1](https://img.shields.io/badge/php-7.1-blue.svg)](http://www.php.net)
-[![PHP 7.2](https://img.shields.io/badge/php-7.2-blue.svg)](http://www.php.net)
-[![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)
+[![PHP 8.2](https://img.shields.io/badge/php-8.2-blue.svg)](http://www.php.net)
 
 ![Logo](unzer_logo.svg)
 
@@ -57,4 +55,4 @@ For any issues or questions please get in touch with our support team.
 * AT: [+43 1 513 66 33 669](tel:+4315136633669)
 
 ### Twitter
-[@UnzerTech](https://twitter.com/UnzerTech)
+[@UnzerTech](https://twitter.com/UnzerTech)

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|~8.1.0",
+    "php": "~7.4.0|~8.0.0|~8.1.0|~8.2.0",
     "ext-json": "*"
   },
   "require-dev": {

examples/Constants.php

@@ -28,6 +28,7 @@
 
 const EXAMPLE_BASE_FOLDER = UNZER_PAPI_URL . UNZER_PAPI_FOLDER;
 define('SUCCESS_URL', EXAMPLE_BASE_FOLDER . 'Success.php');
+define('CREATE_URL', EXAMPLE_BASE_FOLDER . 'Create.php');
 define('PENDING_URL', EXAMPLE_BASE_FOLDER . 'Pending.php');
 define('FAILURE_URL', EXAMPLE_BASE_FOLDER . 'Failure.php');
 define('RETURN_CONTROLLER_URL', EXAMPLE_BASE_FOLDER . 'ReturnController.php');

examples/Create.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * This is the success page for the example payments.
+ *
+ * Copyright (C) 2020 - today Unzer E-Com GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @link  https://docs.unzer.com/
+ *
+ * @package  UnzerSDK\examples
+ */
+
+require_once __DIR__ . '/Constants.php';
+
+session_start();
+
+$additionalPaymentInformation = $_SESSION['additionalPaymentInformation'] ?? null;
+$shortId = $_SESSION['ShortId'] ?? null;
+$paymentId = $_SESSION['PaymentId'] ?? null;
+$paymentTypeId = $_SESSION['PaymentTypeId'] ?? null;
+$isAuthorizeTransaction = $_SESSION['isAuthorizeTransaction'] ?? false;
+
+?>
+
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <title>Unzer UI Examples</title>
+
+        <link rel="stylesheet" href="https://static.unzer.com/v1/unzer.css" />
+    </head>
+    <body>
+        <h1 id="result">Create</h1>
+        <p>
+            The payment is in create state, meaning the Payment page was not used for a payment yet.<br>
+            The payment also stays in this state when the customer clicked the "Back to merchant" button or closed the browser tab.<br>
+            It is still active and could be used by the customer for the current payment.<br>
+        <?php
+        echo  'Paypage-URL: <a href="' . $_SESSION['paypageId'] . '">Payment page</a>';
+
+        if (!empty($additionalPaymentInformation)) {
+            echo $additionalPaymentInformation;
+        }
+
+        if ($shortId !== null) {
+            $defaultTransactionMessage = '<p>Please look for ShortId ' . $shortId . ' in Unzer Insights to see the transaction.</p>';
+            $paylaterTransactionMessage = '<p>Please use the "descriptor" to look for the transaction in the Unzer Pay Later Merchant Portal.</p>';
+            echo preg_match('/[\d]{4}.[\d]{4}.[\d]{4}/', $shortId) ? $defaultTransactionMessage : $paylaterTransactionMessage;
+        }
+        $paymentId = $_SESSION['PaymentId'] ?? null;
+        if ($paymentId !== null) {
+            echo '<p>The PaymentId is \'' . $paymentId . '\'.</p>';
+        }
+
+        if ($paymentTypeId !== null) {
+                echo    '<p>The TypeId for the recurring payment is \'' . $paymentTypeId . '\'. You can use it
+                            now for subsequent transactions.</p>
+                            <form id="payment-form" class="unzerUI form" action="' . RECURRING_PAYMENT_CONTROLLER_URL . '" method="post">
+                                <input type="hidden" name="payment_type_id" value="' . $paymentTypeId . ' ">
+                                <div class="fields inline">
+                                    <div class="field">
+                                        <button class="unzerUI primary button fluid" id="submit-button" type="submit">Charge payment type again.</button>
+                                    </div>
+                                </div>
+                            </form>';
+            }
+        ?>
+        </p>
+        <p><a href=".">start again</a></p>
+    </body>
+</html>

examples/ReturnController.php

@@ -54,10 +54,11 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
 
 // Retrieve the paymentId you remembered within the Controller
 if (!isset($_SESSION['PaymentId'])) {
-    redirect(FAILURE_URL, 'The payment id is missing.', $clientMessage);
+    $merchantMessage = 'The payment id is missing.';
 }
 $paymentId = $_SESSION['PaymentId'];
 
+$redirectUrl = FAILURE_URL;
 // Catch API errors, write the message to your log and show the ClientMessage to the client.
 try {
     // Create an Unzer object using your private key and register a debug handler if you want to.
@@ -77,8 +78,18 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
         // The payment process has been successful.
         // You show the success page.
         // Goods can be shipped.
-        redirect(SUCCESS_URL);
-    } elseif ($payment->isPending()) {
+        $redirectUrl = SUCCESS_URL;
+    }
+
+    if ($payment->isCreate()) {
+        // The payment is in create state, meaning the customer clicked the "Back to Merchant" button.
+        // The Payment page was not used for a payment yet.
+        // It is still active and could be used by the customer for the current payment.
+        $_SESSION['paypageId'] = $payment->getPayPage()->getRedirectUrl();
+        $redirectUrl = CREATE_URL;
+    }
+
+    if ($payment->isPending()) {
         if ($transaction->isSuccess() || $transaction->isResumed()) {
             if ($transaction instanceof Authorization) {
                 // Payment is ready to be captured.
@@ -91,26 +102,26 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
             // In any case:
             // * You can show the success page.
             // * You can set order status to pending payment
-            redirect(SUCCESS_URL);
+            $redirectUrl = SUCCESS_URL;
         } elseif ($transaction->isPending()) {
+            // In cases of a redirect to an external service (e.g. 3D secure, PayPal, etc) it sometimes takes time for
+            // the payment to update it's status after redirect into shop.
+            // In this case the payment and the transaction are pending at first and change to cancel or success later.
+
+            // Use the webhooks feature to stay informed about changes of payment and transaction (e.g. cancel, success)
+            // then you can handle the states as shown above in transaction->isSuccess() branch.
+            $redirectUrl = PENDING_URL;
 
             // The initial transaction of invoice types will not change to success but stay pending.
             $paymentType = $payment->getPaymentType();
             if ($paymentType instanceof Prepayment || $paymentType->isInvoiceType()) {
                 // Awaiting payment by the customer.
                 // Goods can be shipped immediately except for Prepayment type.
-                redirect(SUCCESS_URL);
+                $redirectUrl = SUCCESS_URL;
             }
-
-            // In cases of a redirect to an external service (e.g. 3D secure, PayPal, etc) it sometimes takes time for
-            // the payment to update it's status after redirect into shop.
-            // In this case the payment and the transaction are pending at first and change to cancel or success later.
-
-            // Use the webhooks feature to stay informed about changes of payment and transaction (e.g. cancel, success)
-            // then you can handle the states as shown above in transaction->isSuccess() branch.
-            redirect(PENDING_URL);
         }
     }
+
     // If the payment is neither success nor pending something went wrong.
     // In this case do not create the order or cancel it if you already did.
     // Redirect to an error page in your shop and show a message if you want.
@@ -122,11 +133,11 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
         $clientMessage = $transaction->getMessage()->getCustomer();
     }
 } catch (UnzerApiException $e) {
+    // Write the merchant message to your log.
+    // Show the client message to the customer (it is localized).
     $merchantMessage = $e->getMerchantMessage();
     $clientMessage = $e->getClientMessage();
 } catch (RuntimeException $e) {
     $merchantMessage = $e->getMessage();
 }
-// Write the merchant message to your log.
-// Show the client message to the customer (it is localized).
-redirect(FAILURE_URL, $merchantMessage, $clientMessage);
+redirect($redirectUrl, $merchantMessage, $clientMessage);

src/Adapter/CurlAdapter.php

@@ -49,7 +49,7 @@ public function __construct()
     /**
      * {@inheritDoc}
      */
-    public function init($url, $payload = null, $httpMethod = HttpAdapterInterface::REQUEST_GET): void
+    public function init(string $url, string $payload = null, string $httpMethod = HttpAdapterInterface::REQUEST_GET): void
     {
         $timeout = EnvironmentService::getTimeout();
         $curlVerbose = EnvironmentService::isCurlVerbose();

src/Adapter/HttpAdapterInterface.php

@@ -35,11 +35,11 @@ interface HttpAdapterInterface
     /**
      * Initializes the request.
      *
-     * @param string $url        The full url to connect to.
-     * @param string $payload    Json encoded payload string.
-     * @param string $httpMethod The Http method to perform.
+     * @param string      $url        The full url to connect to.
+     * @param string|null $payload    Json encoded payload string.
+     * @param string      $httpMethod The Http method to perform.
      */
-    public function init($url, $payload = null, $httpMethod = HttpAdapterInterface::REQUEST_GET): void;
+    public function init(string $url, string $payload = null, string $httpMethod = HttpAdapterInterface::REQUEST_GET): void;
 
     /**
      * Executes the request and returns the response.