CC-2016/v2-customer (#204)

* [CC-2016] Add customerV2 resource.

* [CC-2016] Identify customer version based on ID.

* [CC-2016] Identify customer version based on ID.

Author: Ryouzanpaku

src/Apis/PaymentApiConfigBearerAuth.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace UnzerSDK\Apis;
+
+use UnzerSDK\Apis\Constants\AuthorizationMethods;
+
+
+/**
+ * Config for Payment API (PAPI) with bearer authentication.
+ */
+class PaymentApiConfigBearerAuth extends PaymentApiConfig
+{
+    public static function getAuthorizationMethod(): string
+    {
+        return AuthorizationMethods::BEARER;
+    }
+}

src/Interfaces/ResourceServiceInterface.php

@@ -30,7 +30,7 @@
 interface ResourceServiceInterface
 {
     /**
-     * Retrieves an Payout resource via the API using the corresponding Payment or paymentId.
+     * Retrieves a Payout resource via the API using the corresponding Payment or paymentId.
      * The Payout resource can not be fetched using its id since they are unique only within the Payment.
      * A Payment can have zero or one Payouts.
      *
@@ -162,7 +162,7 @@ public function createBasket(Basket $basket): Basket;
     public function fetchBasket($basket): Basket;
 
     /**
-     * Update the a basket resource with the given basket object (id must be set).
+     * Update a basket resource with the given basket object (id must be set).
      *
      * @param Basket $basket
      *
@@ -195,12 +195,12 @@ public function createPaymentType(BasePaymentType $paymentType): BasePaymentType
      * @return BasePaymentType|AbstractUnzerResource The updated PaymentType object.
      *
      * @throws UnzerApiException An UnzerApiException is thrown if there is an error returned on API-request.
-     * @throws RuntimeException  A RuntimeException is thrown when there is a error while using the SDK.
+     * @throws RuntimeException  A RuntimeException is thrown when there is an error while using the SDK.
      */
     public function updatePaymentType(BasePaymentType $paymentType): BasePaymentType;
 
     /**
-     * Fetch the payment type with the given Id from the API.
+     * Fetch the payment type with the given ID from the API.
      *
      * @param string $typeId
      *
@@ -257,7 +257,7 @@ public function fetchCustomer($customer): Customer;
      * @throws UnzerApiException An UnzerApiException is thrown if there is an error returned on API-request.
      * @throws RuntimeException  A RuntimeException is thrown when there is an error while using the SDK.
      */
-    public function fetchCustomerByExtCustomerId(string $customerId): Customer;
+    public function fetchCustomerByExtCustomerId(string $customerId, int $version): Customer;
 
     /**
      * Update and return a Customer object via API.
@@ -325,8 +325,8 @@ public function fetchCharge(Charge $charge): Charge;
      * Fetch a chargeback object by combination of payment id, chargeback id and charge id.
      * Chargeback ids are not unique to a merchant but to the payment.
      *
-     * @param Payment|string $payment      The payment object or payment id to fetch the authorization from.
-     * @param string         $chargebackId The id of the chargeback to fetch.
+     * @param string $paymentId The payment object or payment id to fetch the authorization from.
+     * @param string $chargebackId The id of the chargeback to fetch.
      *
      * @return Chargeback|AbstractUnzerResource The fetched chargeback.
      *

src/Resources/CustomerFactory.php

@@ -6,6 +6,7 @@
 use UnzerSDK\Constants\CompanyRegistrationTypes;
 use UnzerSDK\Resources\EmbeddedResources\Address;
 use UnzerSDK\Resources\EmbeddedResources\CompanyInfo;
+use UnzerSDK\Resources\V2\Customer as CustomerV2;
 
 /**
  * Creates the different Customer objects.
@@ -15,6 +16,18 @@
  */
 class CustomerFactory
 {
+    private static int $version = 1;
+
+    public static function setVersion(int $version): void
+    {
+        self::$version = $version;
+    }
+
+    public static function getVersion(): int
+    {
+        return self::$version;
+    }
+
     /**
      * Creates a local Customer object for B2C transactions.
      * Please use Unzer::createCustomer(...) to create the customer resource on the API side.
@@ -26,7 +39,7 @@ class CustomerFactory
      */
     public static function createCustomer(string $firstname, string $lastname): Customer
     {
-        return (new Customer())->setFirstname($firstname)->setLastname($lastname);
+        return self::getCustomer()->setFirstname($firstname)->setLastname($lastname);
     }
 
     /**
@@ -58,7 +71,7 @@ public static function createNotRegisteredB2bCustomer(
             ->setFunction('OWNER')
             ->setCommercialSector($commercialSector);
 
-        return (new Customer())
+        return self::getCustomer()
             ->setFirstname($firstname)
             ->setLastname($lastname)
             ->setBirthDate($birthDate)
@@ -89,9 +102,17 @@ public static function createRegisteredB2bCustomer(
             ->setCommercialRegisterNumber($commercialRegisterNumber)
             ->setCommercialSector($commercialSector);
 
-        return (new Customer())
+        return self::getCustomer()
             ->setCompany($company)
             ->setBillingAddress($billingAddress)
             ->setCompanyInfo($companyInfo);
     }
+
+    /**
+     * @return Customer
+     */
+    protected static function getCustomer(): Customer
+    {
+        return (self::$version == 2) ? new CustomerV2() : new Customer();
+    }
 }

src/Resources/V2/Customer.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace UnzerSDK\Resources\V2;
+
+use UnzerSDK\Apis\PaymentApiConfigBearerAuth;
+use UnzerSDK\Resources\Customer as CustomerV1;
+
+class Customer extends CustomerV1
+{
+    public function getApiVersion(): string
+    {
+        return "v2";
+    }
+
+    public function getApiConfig(): string
+    {
+        return PaymentApiConfigBearerAuth::class;
+    }
+
+
+}

src/Services/IdService.php

@@ -3,7 +3,6 @@
 namespace UnzerSDK\Services;
 
 use RuntimeException;
-
 use function count;
 
 /**
@@ -22,7 +21,7 @@ class IdService
      *
      * @param string $url
      * @param string $idString
-     * @param bool   $onlyLast
+     * @param bool $onlyLast
      *
      * @return string
      *
@@ -31,7 +30,7 @@ class IdService
     public static function getResourceIdFromUrl(string $url, string $idString, bool $onlyLast = false): string
     {
         $matches = [];
-        $pattern = '/\/([s|p]{1}-' . $idString . '-[a-z\d]+)\/?' . ($onlyLast ? '$' : '') . '/';
+        $pattern = '/\/([s|p]{1}-' . $idString . '-[a-z\d-]+)\/?' . ($onlyLast ? '$' : '') . '/';
         preg_match($pattern, $url, $matches);
 
         if (count($matches) < 2) {
@@ -76,7 +75,7 @@ public static function isPaymentChargeback(string $url): string
      *
      * @param string $url
      * @param string $idString
-     * @param bool   $onlyLast
+     * @param bool $onlyLast
      *
      * @return string|null
      */
@@ -117,4 +116,10 @@ public static function getResourceTypeFromIdString(string $typeId): ?string
 
         return $typeIdString;
     }
+
+    public static function isUUDIResource(string $id): bool
+    {
+        preg_match('/^[sp]-([a-z]{3}|p24)-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/', $id, $matches);
+        return count($matches) > 0;
+    }
 }

src/Services/ResourceService.php

@@ -58,6 +58,7 @@
 use UnzerSDK\Resources\TransactionTypes\Chargeback;
 use UnzerSDK\Resources\TransactionTypes\Payout;
 use UnzerSDK\Resources\TransactionTypes\Shipment;
+use UnzerSDK\Resources\V2\Customer as CustomerV2;
 use UnzerSDK\Resources\V2\Paypage as PaypageV2;
 use UnzerSDK\Traits\CanRecur;
 use UnzerSDK\Unzer;
@@ -119,8 +120,8 @@ public function send(
         string                $httpMethod = HttpAdapterInterface::REQUEST_GET,
         string                $apiVersion = Unzer::API_VERSION
     ): stdClass {
-        $configClass = $resource->getApiConfig();
-        if (!$resource instanceof Token && $configClass::getAuthorizationMethod() === AuthorizationMethods::BEARER) {
+        $apiConfig = $resource->getApiConfig();
+        if (!$resource instanceof Token && $apiConfig::getAuthorizationMethod() === AuthorizationMethods::BEARER) {
             $this->unzer->prepareJwtToken();
         }
 
@@ -648,7 +649,9 @@ public function fetchCustomer($customer): Customer
         $customerObject = $customer;
 
         if (is_string($customer)) {
-            $customerObject = (new Customer())->setId($customer);
+            $isUUID = IdService::isUUDIResource($customer);
+            $customerObject = $isUUID ? new CustomerV2() : new Customer();
+            $customerObject->setId($customer);
         }
 
         $this->fetchResource($customerObject->setParentResource($this->unzer));
@@ -658,7 +661,7 @@ public function fetchCustomer($customer): Customer
     /**
      * {@inheritDoc}
      */
-    public function fetchCustomerByExtCustomerId(string $customerId): Customer
+    public function fetchCustomerByExtCustomerId(string $customerId, int $version = 1): Customer
     {
         $customerObject = (new Customer())->setCustomerId($customerId);
         $this->fetchResource($customerObject->setParentResource($this->unzer));

src/Unzer.php

@@ -485,9 +485,9 @@ public function fetchCustomer($customer): Customer
     /**
      * {@inheritDoc}
      */
-    public function fetchCustomerByExtCustomerId(string $customerId): Customer
+    public function fetchCustomerByExtCustomerId(string $customerId, int $version = 1): Customer
     {
-        return $this->resourceService->fetchCustomerByExtCustomerId($customerId);
+        return $this->resourceService->fetchCustomerByExtCustomerId($customerId, $version);
     }
 
     /**