Merge pull request #62 from mpesari/phpstan

Install phpstan and fix some errors

.github/workflows/run-workflow.yaml

@@ -28,6 +28,14 @@ jobs:
       - name: Run linter
         run: composer lint
 
+      - name: Run phpstan
+        uses: php-actions/phpstan@v3.0.1
+        with:
+          php_version: ${{ matrix.php-version }}
+          version: 1.9.14
+          configuration: phpstan.neon
+          memory_limit: 256M
+
       - name: Run tests
         uses: php-actions/phpunit@v3.0.0
         with:

composer.json

@@ -23,6 +23,7 @@
         "squizlabs/php_codesniffer": "^3.6",
         "phpcompatibility/php-compatibility": "^9.3",
         "phpmd/phpmd": "^2.10",
+        "phpstan/phpstan": "1.9.14",
         "mockery/mockery": "^1.5",
         "guzzlehttp/guzzle": "^7.0|^6.0"
     },
@@ -33,6 +34,9 @@
         }
     },
     "scripts": {
+        "analyze": [
+            "vendor/bin/phpstan"
+        ],
         "post-install-cmd": "\"vendor/bin/phpcs\" --config-set installed_paths vendor/phpcompatibility/php-compatibility",
         "post-update-cmd" : "\"vendor/bin/phpcs\" --config-set installed_paths vendor/phpcompatibility/php-compatibility",
         "test": "\"vendor/bin/phpunit\"",

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+    level: 3
+    paths:
+        - src
+        - tests

src/Exception/ValidationException.php

@@ -10,22 +10,13 @@
 
 /**
  * Class ValidationException
- * This exception is a simple wrapper for
- * a Respect\Validation NestedValidationException instance.
  *
  * This exception holds the general expection message
  *
  * @package Paytrail\SDK\Exception
  */
 class ValidationException extends \Exception
 {
-    /**
-     * Holds the previous NestedValidationException instance.
-     *
-     * $var NestedValidationException
-     */
-    protected $previous;
-
     /**
      * Holds all error messages.
      *

src/Interfaces/AddressInterface.php

@@ -20,7 +20,7 @@
 interface AddressInterface
 {
     /**
-     * Validates with Respect\Validation library and throws exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Interfaces/CallbackUrlInterface.php

@@ -20,7 +20,7 @@
 interface CallbackUrlInterface
 {
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Interfaces/CommissionInterface.php

@@ -21,7 +21,7 @@
 interface CommissionInterface
 {
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Interfaces/CustomerInterface.php

@@ -20,7 +20,7 @@
 interface CustomerInterface
 {
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Interfaces/ItemInterface.php

@@ -20,7 +20,7 @@
 interface ItemInterface
 {
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */
@@ -36,7 +36,7 @@ public function getUnitPrice(): ?int;
     /**
      * Set the unit price.
      *
-     * @param int/null $unitPrice
+     * @param int|null $unitPrice
      * @return ItemInterface Return self to enable chaining.
      */
     public function setUnitPrice(?int $unitPrice): ItemInterface;
@@ -51,7 +51,7 @@ public function getUnits(): ?int;
     /**
      * Set the units.
      *
-     * @param int/null $units
+     * @param int|null $units
      * @return ItemInterface Return self to enable chaining.
      */
     public function setUnits(?int $units): ItemInterface;

src/Interfaces/PaymentRequestInterface.php

@@ -20,7 +20,7 @@
 interface PaymentRequestInterface
 {
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Model/Address.php

@@ -25,7 +25,7 @@ class Address implements \JsonSerializable, AddressInterface
     use JsonSerializable;
 
     /**
-     * Validates with Respect\Validation library and throws exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Model/CallbackUrl.php

@@ -25,7 +25,7 @@ class CallbackUrl implements \JsonSerializable, CallbackUrlInterface
     use JsonSerializable;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Model/Commission.php

@@ -89,8 +89,6 @@ public function setAmount(int $amount): Commission
 
     /**
      * The getter for the amount.
-     *
-     * @return string
      */
     public function getAmount(): int
     {

src/Model/Item.php

@@ -97,7 +97,7 @@ class Item implements \JsonSerializable, ItemInterface
      * Merchant ID for the item.
      * Required for Shop-in-Shop payments, do not use for normal payments.
      *
-     * @var int
+     * @var string|null
      */
     protected $merchant;
 
@@ -363,7 +363,7 @@ public function setCommission(?CommissionInterface $commission): ItemInterface
     }
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */
@@ -393,7 +393,7 @@ public function validate()
     }
 
     /**
-     * Validates shop-in-shop props with Respect\Validation library and throws an exception for invalid objects
+     * Validates shop-in-shop props and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Model/RefundItem.php

@@ -23,7 +23,7 @@ class RefundItem implements \JsonSerializable
     use JsonSerializable;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Model/Token/Customer.php

@@ -22,7 +22,7 @@ class Customer implements \JsonSerializable
     use ObjectPropertyConverter;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/PaytrailClient.php

@@ -44,6 +44,18 @@ protected function createHttpClient()
         $this->http_client = new RequestClient();
     }
 
+    /**
+     * A proxy for the Signature class' static method
+     * to be used via a client instance.
+     *
+     * @param array $response The response parameters.
+     * @param string $body The response body.
+     * @param string $signature The response signature key.
+     *
+     * @throws HmacException
+     */
+    abstract public function validateHmac(array $response = [], string $body = '', string $signature = '');
+
     /**
      * A wrapper for post requests.
      *
@@ -86,8 +98,11 @@ protected function post(
             $headers = $this->reduceHeaders($response->getHeaders());
             $this->validateHmac($headers, $body, $headers['signature'] ?? '');
         } else {
+            // @phpstan-ignore-next-line FIXME
             $mac = $this->calculateHmac($data->toArray());
+            // @phpstan-ignore-next-line FIXME
             $data->setSignature($mac);
+            // @phpstan-ignore-next-line FIXME
             $body = json_encode($data->toArray(), JSON_UNESCAPED_SLASHES);
 
             $response = $this->http_client->request('POST', $uri, [

src/Request/AbstractPaymentRequest.php

@@ -32,7 +32,7 @@ abstract class AbstractPaymentRequest implements \JsonSerializable, PaymentReque
     use JsonSerializable;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */
@@ -62,7 +62,7 @@ public function validate()
             });
 
             // Count the total amount of the payment.
-            $items_total = array_reduce($this->getItems(), function ($carry = 0, ?Item $item = null) {
+            $items_total = array_reduce($this->getItems(), function ($carry = 0, ?ItemInterface $item = null) {
                 if ($item === null) {
                     return $carry;
                 }
@@ -156,42 +156,42 @@ public function validate()
     /**
      * Array of items.
      *
-     * @var Item[]
+     * @var ItemInterface[]
      */
     protected $items;
 
     /**
      * Customer information.
      *
-     * @var Customer
+     * @var CustomerInterface
      */
     protected $customer;
 
     /**
      * Delivery address.
      *
-     * @var Address
+     * @var AddressInterface
      */
     protected $deliveryAddress;
 
     /**
      * Invoicing address.
      *
-     * @var Address
+     * @var AddressInterface
      */
     protected $invoicingAddress;
 
     /**
      * Where to redirect browser after a payment is paid or cancelled.
      *
-     * @var CallbackUrl;
+     * @var CallbackUrlInterface
      */
     protected $redirectUrls;
 
     /**
      * Which url to ping after this payment is paid or cancelled.
      *
-     * @var CallbackUrl;
+     * @var CallbackUrlInterface
      */
     protected $callbackUrls;
 

src/Request/AddCardFormRequest.php

@@ -52,7 +52,7 @@ class AddCardFormRequest implements \JsonSerializable
     protected $signature;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Request/CitPaymentRequest.php

@@ -24,7 +24,7 @@ class CitPaymentRequest extends AbstractPaymentRequest implements TokenPaymentRe
     protected $token;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Request/EmailRefundRequest.php

@@ -25,9 +25,8 @@ class EmailRefundRequest extends RefundRequest
     protected $email;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
-     * @throws NestedValidationException Thrown when the validate() fails.
      * @throws ValidationException
      */
     public function validate()

src/Request/GetTokenRequest.php

@@ -22,7 +22,7 @@ class GetTokenRequest implements \JsonSerializable
     protected $checkoutTokenizationId;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Request/MitPaymentRequest.php

@@ -24,7 +24,7 @@ class MitPaymentRequest extends AbstractPaymentRequest implements TokenPaymentRe
     protected $token;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Request/PaymentStatusRequest.php

@@ -19,7 +19,7 @@ class PaymentStatusRequest
     protected $transactionId;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */

src/Request/RefundRequest.php

@@ -23,7 +23,7 @@ class RefundRequest implements \JsonSerializable
     use JsonSerializable;
 
     /**
-     * Validates with Respect\Validation library and throws an exception for invalid objects
+     * Validates properties and throws an exception for invalid values
      *
      * @throws ValidationException
      */
@@ -96,21 +96,21 @@ public function validate()
     /**
      * Refund recipient email address.
      *
-     * @var $mail
+     * @var string|null $email
      */
     protected $email;
 
     /**
      * Merchant unique identifier for the refund.
      *
-     * @var $refundStamp
+     * @var string|null $refundStamp
      */
     protected $refundStamp;
 
     /**
      * Refund reference.
      *
-     * @var $refundReference
+     * @var string|null $refundReference
      */
     protected $refundReference;