#11 Add support for Sberbank fiscal part of api

composer.json

@@ -18,6 +18,7 @@
   ],
   "require": {
     "php": "^7.1",
+    "ext-json": "*",
     "omnipay/common": "v3.0.2"
   },
   "require-dev": {

src/Gateway.php

@@ -13,6 +13,7 @@
 use Omnipay\Sberbank\Message\GetLastOrdersForMerchantsRequest;
 use Omnipay\Sberbank\Message\OrderStatusRequest;
 use Omnipay\Sberbank\Message\PurchaseRequest;
+use Omnipay\Sberbank\Message\OrderReceiptStatusRequest;
 use Omnipay\Sberbank\Message\RefundRequest;
 use Omnipay\Sberbank\Message\UnBindCardRequest;
 use Omnipay\Sberbank\Message\UpdateSSLCardListRequest;
@@ -310,6 +311,27 @@ public function supportsExtendedOrderStatus()
         return method_exists($this, 'extendedOrderStatus');
     }
 
+    /**
+     * Receipt status request
+     *
+     * @param array $options
+     * @return RequestInterface
+     */
+    public function orderReceiptStatus(array $options = []): RequestInterface
+    {
+        return $this->createRequest(OrderReceiptStatusRequest::class, $options);
+    }
+
+    /**
+     * Supports receiptStatus
+     *
+     * @return boolean True if this gateway supports the orderReceiptStatus() method
+     */
+    public function supportsOrderReceiptStatus()
+    {
+        return method_exists($this, 'orderReceiptStatus');
+    }
+
     /**
      * Request to verify the involvement of the card in 3DS
      *

src/Message/AbstractRequest.php

@@ -193,14 +193,51 @@ public function sendData($data)
     public function specifyAdditionalParameters(array $data, array $additionalParams): array
     {
         foreach ($additionalParams as $param) {
-            $method = 'get' . ucfirst($param);
-            if (method_exists($this, $method)) {
-                $value = $this->{$method}();
-                if ($value) {
-                    $data[$param] = $value;
-                }
+            $value = $this->getParameterValue($param);
+            if ($value !== null) {
+                $data[$param] = $value;
             }
         }
+
         return $data;
     }
+
+    /**
+     * Add additional json encoded params to data
+     *
+     * @param array $data
+     * @param array $additionalParams
+     * @return array
+     */
+    public function specifyAdditionalJsonParameters(array $data, array $additionalParams): array
+    {
+        foreach ($additionalParams as $param) {
+            $value = $this->getParameterValue($param);
+            if ($value !== null) {
+                $data[$param] = json_encode($value);
+            }
+        }
+
+        return $data;
+    }
+
+    /**
+     * Get parameter value by name
+     *
+     * @param string $param
+     *
+     * @return mixed|null
+     */
+    protected function getParameterValue($param)
+    {
+        $method = 'get' . ucfirst($param);
+        if (method_exists($this, $method)) {
+            $value = $this->{$method}();
+            if ($value) {
+                return $value;
+            }
+        }
+
+        return null;
+    }
 }

src/Message/AuthorizeRequest.php

@@ -2,7 +2,9 @@
 
 namespace Omnipay\Sberbank\Message;
 
+use Fiscal\OFD\OrderInterface;
 use Omnipay\Common\Exception\RuntimeException;
+use Omnipay\Sberbank\Util\FiscalOFDAdapter;
 
 /**
  * Class AuthorizeRequest
@@ -32,13 +34,21 @@ public function getData()
             'pageView',
             'clientId',
             'merchantLogin',
-            'jsonParams',
             'sessionTimeoutSecs',
             'expirationDate',
-            'bindingId'
+            'bindingId',
+            'taxSystem'
+        ];
+
+        $additionalJsonParams = [
+            'jsonParams',
+            'orderBundle',
         ];
 
-        return $this->specifyAdditionalParameters($data, $additionalParams);
+        return array_merge(
+            $this->specifyAdditionalParameters($data, $additionalParams),
+            $this->specifyAdditionalJsonParameters($data, $additionalJsonParams)
+        );
     }
 
     /**
@@ -229,6 +239,47 @@ public function setBindingId($value)
         return $this->setParameter('bindingId', $value);
     }
 
+    /**
+     * @return array|null
+     */
+    public function getOrderBundle()
+    {
+        return $this->getParameter('orderBundle');
+    }
+
+    /**
+     * @param OrderInterface|array|null $value
+     *
+     * @return \Omnipay\Common\Message\AbstractRequest
+     * @throws \Omnipay\Common\Exception\RuntimeException
+     */
+    public function setOrderBundle($value)
+    {
+        if(interface_exists('Fiscal\\OFD\\OrderInterface') && $value instanceof OrderInterface) {
+            $adapter = new FiscalOFDAdapter($value);
+            $value = $adapter->getOrderBundle();
+        }
+        return $this->setParameter('orderBundle', $value);
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getTaxSystem()
+    {
+        return $this->getParameter('taxSystem');
+    }
+
+    /**
+     * @param int $value
+     * @return \Omnipay\Common\Message\AbstractRequest
+     * @throws \Omnipay\Common\Exception\RuntimeException
+     */
+    public function setTaxSystem($value)
+    {
+        return $this->setParameter('taxSystem', $value);
+    }
+
     /**
      * @param mixed $data
      * @return object|\Omnipay\Common\Message\ResponseInterface

src/Message/CaptureRequest.php

@@ -2,8 +2,13 @@
 
 namespace Omnipay\Sberbank\Message;
 
+use Fiscal\OFD\OrderInterface;
+use Fiscal\OFD\OrderItemInterface;
+use Omnipay\Sberbank\Util\FiscalOFDAdapter;
+
 /**
  * Class CaptureRequest
+ *
  * @package Omnipay\Sberbank\Message
  */
 class CaptureRequest extends AbstractRequest
@@ -21,7 +26,11 @@ public function getData()
             'amount' => $this->getAmountInteger(),
         ];
 
-        return $data;
+        $additionalJsonParams = [
+            'depositItems',
+        ];
+
+        return $this->specifyAdditionalJsonParameters($data, $additionalJsonParams);
     }
 
     /**
@@ -31,4 +40,27 @@ public function getMethod()
     {
         return 'deposit.do';
     }
+
+    /**
+     * @return array|null
+     */
+    public function getDepositItems()
+    {
+        return $this->getParameter('depositItems');
+    }
+
+    /**
+     * @param OrderInterface|array|null $value
+     *
+     * @return \Omnipay\Common\Message\AbstractRequest
+     * @throws \Omnipay\Common\Exception\RuntimeException
+     */
+    public function setDepositItems($value)
+    {
+        if(interface_exists('Fiscal\\OFD\\OrderInterface') && $value instanceof OrderInterface) {
+            $adapter = new FiscalOFDAdapter($value);
+            $value = $adapter->getDepositItems();
+        }
+        return $this->setParameter('depositItems', $value);
+    }
 }

src/Message/OrderReceiptStatusRequest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Omnipay\Sberbank\Message;
+
+
+use Omnipay\Common\Exception\InvalidRequestException;
+
+class OrderReceiptStatusRequest extends AbstractRequest
+{
+    /**
+     * @return array|mixed
+     * @throws \Omnipay\Common\Exception\InvalidRequestException
+     */
+    public function getData()
+    {
+        if (!$this->getOrderId() && !$this->getOrderNumber()) {
+            throw new InvalidRequestException('You must specify one of the parameters - orderId or orderNumber');
+        }
+
+        return $this->specifyAdditionalParameters([], ['orderId', 'orderNumber', 'language', 'uuid']);
+    }
+
+    /**
+     * @return string
+     */
+    public function getMethod()
+    {
+        return 'getReceiptStatus.do';
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getOrderNumber()
+    {
+        return $this->getParameter('orderNumber');
+    }
+
+    /**
+     * @param $value
+     * @return \Omnipay\Common\Message\AbstractRequest
+     */
+    public function setOrderNumber($value)
+    {
+        return $this->setParameter('orderNumber', $value);
+    }
+
+    /**
+     * Get receipt ID in the fiscalizer
+     *
+     * @return string
+     */
+    public function getUuid()
+    {
+        return $this->getParameter('uuid');
+    }
+
+    /**
+     * Set receipt ID in the fiscalizer
+     *
+     * @param string $value
+     *
+     * @return OrderReceiptStatusRequest
+     */
+    public function setUuid($value)
+    {
+        return $this->setParameter('uuid', $value);
+    }
+}