Payone\Core\Model\Methods\Ratepay\RatepayBase

Complexity

Total Complexity

22

Size/Duplication

Total Lines	279
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getPaymentSpecificParameters()	0	24	3
A	getPaymentSpecificDebitParameters()	0	4	1
A	isAvailable()	0	16	4
A	getPaymentSpecificCaptureParameters()	0	4	1
A	__construct()	0	27	1
A	getShopIdByQuote()	0	7	1
B	handleResponse()	0	17	7
A	assignData()	0	13	3
A	getShopIdByOrder()	0	7	1

<?php

/**
 * PAYONE Magento 2 Connector is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PAYONE Magento 2 Connector is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
 *
 * PHP version 5
 *
 * @category  Payone
 * @package   Payone_Magento2_Plugin
 * @author    FATCHIP GmbH <support@fatchip.de>
 * @copyright 2003 - 2020 Payone GmbH
 * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
 * @link      http://www.payone.de
 */

namespace Payone\Core\Model\Methods\Ratepay;

use Payone\Core\Model\Methods\Payolution\PayolutionBase;
use Payone\Core\Model\PayoneConfig;
use Payone\Core\Model\Methods\PayoneMethod;
use Magento\Sales\Model\Order;

The type Magento\Sales\Model\Order was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Framework\DataObject;

The type Magento\Framework\DataObject was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Base class for all Ratepay methods
 */
class RatepayBase extends PayoneMethod
{
    /* Payment method sub types */
    const METHOD_RATEPAY_SUBTYPE_INVOICE = 'RPV';
    const METHOD_RATEPAY_SUBTYPE_INSTALLMENT = 'RPS';
    const METHOD_RATEPAY_SUBTYPE_DEBIT = 'RPD';

    /**
     * Payone Ratepay helper
     *
     * @var \Payone\Core\Helper\Ratepay
     */
    protected $ratepayHelper;

    /**
     * Payone Api helper
     *
     * @var \Payone\Core\Helper\Api
     */
    protected $apiHelper;

    /**
     * Payment ban resource model
     *
     * @var \Payone\Core\Model\ResourceModel\PaymentBan
     */
    protected $paymentBan;

    /**
     * Clearingtype for PAYONE authorization request
     *
     * @var string
     */
    protected $sClearingtype = 'fnc';

    /**
     * Payment method group identifier
     *
     * @var string
     */
    protected $sGroupName = PayoneConfig::METHOD_GROUP_RATEPAY;

    /**
     * Info instructions block path
     *
     * @var string
     */
    protected $_infoBlockType = 'Payone\Core\Block\Info\ClearingReference';

    /**
     * Keys that need to be assigned to the additionalinformation fields
     *
     * @var array
     */
    protected $aAssignKeys = [
        'telephone',
        'dateofbirth',
    ];

    /**
     * Payment ban duration in hours
     *
     * @var int
     */
    protected $iBanDuration = 48;

    /**
     * Constructor
     *
     * @param \Magento\Framework\Model\Context                        $context
     * @param \Magento\Framework\Registry                             $registry
     * @param \Magento\Framework\Api\ExtensionAttributesFactory       $extensionFactory
     * @param \Magento\Framework\Api\AttributeValueFactory            $customAttrFactory
     * @param \Magento\Payment\Helper\Data                            $paymentData
     * @param \Magento\Framework\App\Config\ScopeConfigInterface      $scopeConfig
     * @param \Magento\Payment\Model\Method\Logger                    $logger
     * @param \Payone\Core\Helper\Toolkit                             $toolkitHelper
     * @param \Payone\Core\Helper\Shop                                $shopHelper
     * @param \Magento\Framework\Url                                  $url
     * @param \Magento\Checkout\Model\Session                         $checkoutSession
     * @param \Payone\Core\Model\Api\Request\Debit                    $debitRequest
     * @param \Payone\Core\Model\Api\Request\Capture                  $captureRequest
     * @param \Payone\Core\Model\Api\Request\Authorization            $authorizationRequest
     * @param \Payone\Core\Model\ResourceModel\SavedPaymentData       $savedPaymentData
     * @param \Payone\Core\Helper\Ratepay                             $ratepayHelper
     * @param \Payone\Core\Helper\Api                                 $apiHelper
     * @param \Payone\Core\Model\ResourceModel\PaymentBan             $paymentBan
     * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
     * @param \Magento\Framework\Data\Collection\AbstractDb           $resourceCollection
     * @param array                                                   $data
     */
    public function __construct(
        \Magento\Framework\Model\Context $context,

The type Magento\Framework\Model\Context was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Framework\Registry $registry,

The type Magento\Framework\Registry was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,

The type Magento\Framework\Api\ExtensionAttributesFactory was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Framework\Api\AttributeValueFactory $customAttrFactory,

The type Magento\Framework\Api\AttributeValueFactory was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Payment\Helper\Data $paymentData,

The type Magento\Payment\Helper\Data was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,

The type Magento\Framework\App\Config\ScopeConfigInterface was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Payment\Model\Method\Logger $logger,

The type Magento\Payment\Model\Method\Logger was not found. Maybe you did not declare it correctly or list all dependencies?

        \Payone\Core\Helper\Toolkit $toolkitHelper,
        \Payone\Core\Helper\Shop $shopHelper,
        \Magento\Framework\Url $url,

The type Magento\Framework\Url was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Checkout\Model\Session $checkoutSession,

The type Magento\Checkout\Model\Session was not found. Maybe you did not declare it correctly or list all dependencies?

        \Payone\Core\Model\Api\Request\Debit $debitRequest,
        \Payone\Core\Model\Api\Request\Capture $captureRequest,
        \Payone\Core\Model\Api\Request\Authorization $authorizationRequest,
        \Payone\Core\Model\ResourceModel\SavedPaymentData $savedPaymentData,
        \Payone\Core\Helper\Ratepay $ratepayHelper,
        \Payone\Core\Helper\Api $apiHelper,
        \Payone\Core\Model\ResourceModel\PaymentBan $paymentBan,
        \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,

The type Magento\Framework\Model\ResourceModel\AbstractResource was not found. Maybe you did not declare it correctly or list all dependencies?

        \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,

The type Magento\Framework\Data\Collection\AbstractDb was not found. Maybe you did not declare it correctly or list all dependencies?

        array $data = []
    ) {
        parent::__construct($context, $registry, $extensionFactory, $customAttrFactory, $paymentData, $scopeConfig, $logger, $toolkitHelper, $shopHelper, $url, $checkoutSession, $debitRequest, $captureRequest, $authorizationRequest, $savedPaymentData, $resource, $resourceCollection, $data);
        $this->ratepayHelper = $ratepayHelper;
        $this->apiHelper = $apiHelper;
        $this->paymentBan = $paymentBan;
    }

    /**
     * Add the checkout-form-data to the checkout session
     *
     * @param  DataObject $data
     * @return $this
     */
    public function assignData(DataObject $data)
    {
        parent::assignData($data);

        $oInfoInstance = $this->getInfoInstance();
        foreach ($this->aAssignKeys as $sKey) {
            $sData = $this->toolkitHelper->getAdditionalDataEntry($data, $sKey);
            if ($sData) {
                $oInfoInstance->setAdditionalInformation($sKey, $sData);
            }
        }

        return $this;
    }

    /**
     * Return parameters specific to this payment type
     *
     * @param  Order $oOrder
     * @return array
     */
    public function getPaymentSpecificParameters(Order $oOrder)
    {
        $aBaseParams = [
            'financingtype' => $this->getSubType(),
            'api_version' => '3.10',
            'add_paydata[customer_allow_credit_inquiry]' => 'yes',
            'add_paydata[device_token]' => $this->ratepayHelper->getRatepayDeviceFingerprintToken(),
            'add_paydata[merchant_consumer_id]' => $oOrder->getCustomerId(),
            'add_paydata[shop_id]' => $this->getShopIdByOrder($oOrder),
        ];

        $sBirthday = $this->getInfoInstance()->getAdditionalInformation('dateofbirth');
        if ($sBirthday) {
            $aBaseParams['birthday'] = $sBirthday;
        }

        $sTelephone = $this->getInfoInstance()->getAdditionalInformation('telephone');
        if ($sTelephone) {
            $aBaseParams['telephonenumber'] = $sTelephone;
        }

        $aSubTypeParams = $this->getSubTypeSpecificParameters($oOrder);
        $aParams = array_merge($aBaseParams, $aSubTypeParams);
        return $aParams;
    }

    /**
     * Returns matching Ratepay shop id by given quote
     *
     * @param  \Magento\Quote\Api\Data\CartInterface $quote
     * @return string
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    protected function getShopIdByQuote(\Magento\Quote\Api\Data\CartInterface $quote)

The type Magento\Quote\Api\Data\CartInterface was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        $sCountryCode = $quote->getShippingAddress()->getCountryId();
        $sCurrency = $this->apiHelper->getCurrencyFromQuote($quote);
        $dGrandTotal = $this->apiHelper->getQuoteAmount($quote);

        return $this->ratepayHelper->getRatepayShopId($this->getCode(), $sCountryCode, $sCurrency, $dGrandTotal);
    }

    /**
     * Returns matching Ratepay shop id by given quote
     *
     * @param Order $oOrder
     * @return string
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    protected function getShopIdByOrder(Order $oOrder)
    {
        $sCountryCode = $oOrder->getShippingAddress()->getCountryId();
        $sCurrency = $this->apiHelper->getCurrencyFromOrder($oOrder);
        $dGrandTotal = $this->apiHelper->getOrderAmount($oOrder);

        return $this->ratepayHelper->getRatepayShopId($this->getCode(), $sCountryCode, $sCurrency, $dGrandTotal);
    }

    /**
     * Check whether payment method can be used
     *
     * @param \Magento\Quote\Api\Data\CartInterface|null $quote
     * @return bool
     */
    public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
    {
        $blParentReturn = parent::isAvailable($quote);
        if ($blParentReturn === false) {
            return false;
        }

        if ($quote === null) {
            $quote = $this->checkoutSession->getQuote();
        }

        if ($this->getShopIdByQuote($quote) === false) {

The condition $this->getShopIdByQuote($quote) === false is always false.

            return false;
        }

        return $blParentReturn;
    }

    /**
     * Perform certain actions with the response
     *
     * @param  array $aResponse
     * @param  Order $oOrder
     * @param  float $amount
     * @return array
     */
    protected function handleResponse($aResponse, Order $oOrder, $amount)
    {
        if (isset($aResponse['status']) && $aResponse['status'] == 'ERROR'
            && isset($aResponse['errorcode']) && $aResponse['errorcode'] == '307'
        ) {
            if (!empty($oOrder->getCustomerId())) {
                $this->paymentBan->addPaymentBan($this->getCode(), $oOrder->getCustomerId(), $this->iBanDuration);
            } else { // guest checkout
                $aBans = $this->checkoutSession->getPayonePaymentBans();
                if (!$aBans) {
                    $aBans = [];
                }
                $aBans[$this->getCode()] = $this->paymentBan->getBanEndDate($this->iBanDuration);
                $this->checkoutSession->setPayonePaymentBans($aBans);
            }
        }
        return $aResponse;
    }

    /**
     * Return capture parameters specific to this payment type
     *
     * @param  Order $oOrder
     * @return array
     */
    public function getPaymentSpecificCaptureParameters(Order $oOrder)
    {
        return [
            'add_paydata[shop_id]' => $oOrder->getPayoneRatepayShopId()
        ];
    }

    /**
     * Return debit parameters specific to this payment type
     *
     * @param  Order $oOrder
     * @return array
     */
    public function getPaymentSpecificDebitParameters(Order $oOrder)
    {
        return [
            'add_paydata[shop_id]' => $oOrder->getPayoneRatepayShopId()
        ];
    }
}