Addresscheck::addScoreToSession() - Code Metrics - Inspection of "fix addresscheck api implementation" - PAYONE-GmbH/magento-2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#31)

by David

created 2017-02-07 15:56 UTC

Addresscheck::addScoreToSession() A

↳ Parent: Addresscheck

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
c	0
b	0
f	0
rs	9.6666
cc	2
eloc	6
nc	2
nop	2

<?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 <[email protected]>
 * @copyright 2003 - 2016 Payone GmbH
 * @license   <http://www.gnu.org/licenses/> GNU Lesser General Public License
 * @link      http://www.payone.de
 */

namespace Payone\Core\Service;

use Payone\Core\Model\Api\AddresscheckInterface;
use Payone\Core\Service\AddresscheckResponse;
use Magento\Quote\Api\Data\AddressInterface;

/**
 * Web API model for the PAYONE addresscheck
 */
class Addresscheck implements AddresscheckInterface
{
    /**
     * PAYONE addresscheck request model
     *
     * @var \Payone\Core\Model\Risk\Addresscheck
     */
    protected $addresscheck;

    /**
     * Factory for the response object
     *
     * @var \Payone\Core\Model\WebApi\AddresscheckResponseFactory
     */
    protected $responseFactory;

    /**
     * Checkout session object
     *
     * @var \Magento\Checkout\Model\Session
     */
    protected $checkoutSession;

    /**
     * Constructor
     *
     * @param \Payone\Core\Model\Risk\Addresscheck                  $addresscheck
     * @param \Payone\Core\Model\WebApi\AddresscheckResponseFactory $responseFactory
     * @param \Magento\Checkout\Model\Session                       $checkoutSession
     */
    public function __construct(
        \Payone\Core\Model\Risk\Addresscheck $addresscheck,
        \Payone\Core\Model\WebApi\AddresscheckResponseFactory $responseFactory,
        \Magento\Checkout\Model\Session $checkoutSession
    ) {
        $this->addresscheck = $addresscheck;
        $this->responseFactory = $responseFactory;
        $this->checkoutSession = $checkoutSession;
    }

    /**
     * Generate the confirm message from the given address
     *
     * @param  AddressInterface $addressData
     * @return string
     */
    protected function getConfirmMessage(AddressInterface $addressData)
    {
        $sMessage  = __('Address corrected. Please confirm.')."\n\n";
        $sMessage .= $addressData->getFirstname().' '.$addressData->getLastname()."\n";

        $mStreet = $addressData->getStreet();
        if (is_array($mStreet)) { // address can be string
            $sMessage .= $mStreet[0]."\n"; // add first line of address array
        } else {
            $sMessage .= $mStreet."\n"; // add string directly
        }
        $sMessage .= $addressData->getPostcode().' '.$addressData->getCity();

        return $sMessage;
    }

    /**
     * Add the score to the correct session variable
     *
     * @param  AddressInterface $oAddress
     * @param  bool             $blIsBillingAddress
     * @return void
     */
    protected function addScoreToSession(AddressInterface $oAddress, $blIsBillingAddress)
    {
        $sScore = $this->addresscheck->getScore($oAddress);
        if ($blIsBillingAddress === true) { // is billing address?
            $this->checkoutSession->setPayoneBillingAddresscheckScore($sScore);
        } else {
            $this->checkoutSession->setPayoneShippingAddresscheckScore($sScore);
        }
    }

    /**
     * Set error message if checkout is configured to stop on error or set success = true instead
     *
     * @param  AddresscheckResponse $oResponse
     * @return AddresscheckResponse
     */
    protected function handleErrorCase(AddresscheckResponse $oResponse)
    {
        $sHandleError = $this->addresscheck->getConfigParam('handle_response_error');
        if ($sHandleError == 'stop_checkout') {
            $oResponse->setData('errormessage', __($this->addresscheck->getErrorMessage())); // stop checkout with errormsg
        } elseif ($sHandleError == 'continue_checkout') {
            $oResponse->setData('success', true); // continue anyways
        }
        return $oResponse;
    }

    /**
     * Handle the response according to its return status
     *
     * @param  AddresscheckResponse $oResponse
     * @param  AddressInterface     $oAddress
     * @param  array                $aResponse
     * @return AddresscheckResponse
     */
    protected function handleResponse(AddresscheckResponse $oResponse, AddressInterface $oAddress, $aResponse)
    {
        if ($aResponse['status'] == 'VALID') { // data was checked successfully
            $oAddress = $this->addresscheck->correctAddress($oAddress);
            if ($this->addresscheck->isAddressCorrected() === true) { // was address changed?
                $oResponse->setData('correctedAddress', $oAddress);
                $oResponse->setData('confirmMessage', $this->getConfirmMessage($oAddress));
            }
            $oResponse->setData('success', true);
        } elseif ($aResponse['status'] == 'INVALID') { // given data invalid
            $oResponse->setData('errormessage', $this->addresscheck->getInvalidMessage($aResponse['customermessage']));
        } elseif ($aResponse['status'] == 'ERROR') { // an error occured in the API
            $oResponse = $this->handleErrorCase($oResponse);
        }
        return $oResponse;
    }

    /**
     * Send addresscheck request and handle the response object
     *
     * @param  AddresscheckResponse $oResponse
     * @param  AddressInterface     $oAddress
     * @param  bool                 $blIsBillingAddress
     * @return AddresscheckResponse
     */
    protected function handleAddresscheck(
        AddresscheckResponse $oResponse,
        AddressInterface $oAddress,
        $blIsBillingAddress
    ) {
        $aResponse = $this->addresscheck->getResponse($oAddress, $blIsBillingAddress);
        if (is_array($aResponse)) { // is a real response existing?
            $this->addScoreToSession($oAddress, $blIsBillingAddress);
            $oResponse = $this->handleResponse($oResponse, $oAddress, $aResponse);
        } elseif ($aResponse === true) { // check lifetime still valid, set success to true
            $oResponse->setData('success', true);
        }
        return $oResponse;
    }

    /**
     * PAYONE addresscheck
     * The full class-paths must be given here otherwise the Magento 2 WebApi
     * cant handle this with its fake type system!
     *
     * @param  \Magento\Quote\Api\Data\AddressInterface $addressData
     * @param  bool $isBillingAddress
     * @param  bool $isVirtual
     * @param  double $dTotal
     * @return \Payone\Core\Model\WebApi\AddresscheckResponse
     */
    public function checkAddress(\Magento\Quote\Api\Data\AddressInterface $addressData, $isBillingAddress, $isVirtual, $dTotal)
    {
        $oResponse = $this->responseFactory->create();
        $oResponse->setData('success', false); // set success to false as default, set to true later if true
        if ($this->addresscheck->isCheckNeededForQuote($isBillingAddress, $isVirtual, $dTotal)) {
            $oResponse = $this->handleAddresscheck($oResponse, $addressData, $isBillingAddress);
        }
        return $oResponse;
    }
}


1			<?php
2
3			/**
4			* PAYONE Magento 2 Connector is free software: you can redistribute it and/or modify
5			* it under the terms of the GNU Lesser General Public License as published by
6			* the Free Software Foundation, either version 3 of the License, or
7			* (at your option) any later version.
8			*
9			* PAYONE Magento 2 Connector is distributed in the hope that it will be useful,
10			* but WITHOUT ANY WARRANTY; without even the implied warranty of
11			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12			* GNU Lesser General Public License for more details.
13			*
14			* You should have received a copy of the GNU Lesser General Public License
15			* along with PAYONE Magento 2 Connector. If not, see <http://www.gnu.org/licenses/>.
16			*
17			* PHP version 5
18			*
19			* @category Payone
20			* @package Payone_Magento2_Plugin
21			* @author FATCHIP GmbH <[email protected]>
22			* @copyright 2003 - 2016 Payone GmbH
23			* @license <http://www.gnu.org/licenses/> GNU Lesser General Public License
24			* @link http://www.payone.de
25			*/
26
27			namespace Payone\Core\Service;
28
29			use Payone\Core\Model\Api\AddresscheckInterface;
30			use Payone\Core\Service\AddresscheckResponse;
31			use Magento\Quote\Api\Data\AddressInterface;
32
33			/**
34			* Web API model for the PAYONE addresscheck
35			*/
36			class Addresscheck implements AddresscheckInterface
37			{
38			/**
39			* PAYONE addresscheck request model
40			*
41			* @var \Payone\Core\Model\Risk\Addresscheck
42			*/
43			protected $addresscheck;
44
45			/**
46			* Factory for the response object
47			*
48			* @var \Payone\Core\Model\WebApi\AddresscheckResponseFactory
49			*/
50			protected $responseFactory;
51
52			/**
53			* Checkout session object
54			*
55			* @var \Magento\Checkout\Model\Session
56			*/
57			protected $checkoutSession;
58
59			/**
60			* Constructor
61			*
62			* @param \Payone\Core\Model\Risk\Addresscheck $addresscheck
63			* @param \Payone\Core\Model\WebApi\AddresscheckResponseFactory $responseFactory
64			* @param \Magento\Checkout\Model\Session $checkoutSession
65			*/
66			public function __construct(
67			\Payone\Core\Model\Risk\Addresscheck $addresscheck,
68			\Payone\Core\Model\WebApi\AddresscheckResponseFactory $responseFactory,
69			\Magento\Checkout\Model\Session $checkoutSession
70			) {
71			$this->addresscheck = $addresscheck;
72			$this->responseFactory = $responseFactory;
73			$this->checkoutSession = $checkoutSession;
74			}
75
76			/**
77			* Generate the confirm message from the given address
78			*
79			* @param AddressInterface $addressData
80			* @return string
81			*/
82			protected function getConfirmMessage(AddressInterface $addressData)
83			{
84			$sMessage = __('Address corrected. Please confirm.')."\n\n";
85			$sMessage .= $addressData->getFirstname().' '.$addressData->getLastname()."\n";
86
87			$mStreet = $addressData->getStreet();
88			if (is_array($mStreet)) { // address can be string
89			$sMessage .= $mStreet[0]."\n"; // add first line of address array
90			} else {
91			$sMessage .= $mStreet."\n"; // add string directly
92			}
93			$sMessage .= $addressData->getPostcode().' '.$addressData->getCity();
94
95			return $sMessage;
96			}
97
98			/**
99			* Add the score to the correct session variable
100			*
101			* @param AddressInterface $oAddress
102			* @param bool $blIsBillingAddress
103			* @return void
104			*/
105			protected function addScoreToSession(AddressInterface $oAddress, $blIsBillingAddress)
106			{
107			$sScore = $this->addresscheck->getScore($oAddress);
108			if ($blIsBillingAddress === true) { // is billing address?
109			$this->checkoutSession->setPayoneBillingAddresscheckScore($sScore);
110			} else {
111			$this->checkoutSession->setPayoneShippingAddresscheckScore($sScore);
112			}
113			}
114
115			/**
116			* Set error message if checkout is configured to stop on error or set success = true instead
117			*
118			* @param AddresscheckResponse $oResponse
119			* @return AddresscheckResponse
120			*/
121			protected function handleErrorCase(AddresscheckResponse $oResponse)
122			{
123			$sHandleError = $this->addresscheck->getConfigParam('handle_response_error');
124			if ($sHandleError == 'stop_checkout') {
125			$oResponse->setData('errormessage', __($this->addresscheck->getErrorMessage())); // stop checkout with errormsg
126			} elseif ($sHandleError == 'continue_checkout') {
127			$oResponse->setData('success', true); // continue anyways
128			}
129			return $oResponse;
130			}
131
132			/**
133			* Handle the response according to its return status
134			*
135			* @param AddresscheckResponse $oResponse
136			* @param AddressInterface $oAddress
137			* @param array $aResponse
138			* @return AddresscheckResponse
139			*/
140			protected function handleResponse(AddresscheckResponse $oResponse, AddressInterface $oAddress, $aResponse)
141			{
142			if ($aResponse['status'] == 'VALID') { // data was checked successfully
143			$oAddress = $this->addresscheck->correctAddress($oAddress);
144			if ($this->addresscheck->isAddressCorrected() === true) { // was address changed?
145			$oResponse->setData('correctedAddress', $oAddress);
146			$oResponse->setData('confirmMessage', $this->getConfirmMessage($oAddress));
147			}
148			$oResponse->setData('success', true);
149			} elseif ($aResponse['status'] == 'INVALID') { // given data invalid
150			$oResponse->setData('errormessage', $this->addresscheck->getInvalidMessage($aResponse['customermessage']));
151			} elseif ($aResponse['status'] == 'ERROR') { // an error occured in the API
152			$oResponse = $this->handleErrorCase($oResponse);
153			}
154			return $oResponse;
155			}
156
157			/**
158			* Send addresscheck request and handle the response object
159			*
160			* @param AddresscheckResponse $oResponse
161			* @param AddressInterface $oAddress
162			* @param bool $blIsBillingAddress
163			* @return AddresscheckResponse
164			*/
165			protected function handleAddresscheck(
166			AddresscheckResponse $oResponse,
167			AddressInterface $oAddress,
168			$blIsBillingAddress
169			) {
170			$aResponse = $this->addresscheck->getResponse($oAddress, $blIsBillingAddress);
171			if (is_array($aResponse)) { // is a real response existing?
172			$this->addScoreToSession($oAddress, $blIsBillingAddress);
173			$oResponse = $this->handleResponse($oResponse, $oAddress, $aResponse);
174			} elseif ($aResponse === true) { // check lifetime still valid, set success to true
175			$oResponse->setData('success', true);
176			}
177			return $oResponse;
178			}
179
180			/**
181			* PAYONE addresscheck
182			* The full class-paths must be given here otherwise the Magento 2 WebApi
183			* cant handle this with its fake type system!
184			*
185			* @param \Magento\Quote\Api\Data\AddressInterface $addressData
186			* @param bool $isBillingAddress
187			* @param bool $isVirtual
188			* @param double $dTotal
189			* @return \Payone\Core\Model\WebApi\AddresscheckResponse
190			*/
191			public function checkAddress(\Magento\Quote\Api\Data\AddressInterface $addressData, $isBillingAddress, $isVirtual, $dTotal)
192			{
193			$oResponse = $this->responseFactory->create();
194			$oResponse->setData('success', false); // set success to false as default, set to true later if true
195			if ($this->addresscheck->isCheckNeededForQuote($isBillingAddress, $isVirtual, $dTotal)) {
196			$oResponse = $this->handleAddresscheck($oResponse, $addressData, $isBillingAddress);
197			}
198			return $oResponse;
199			}
200			}
201

PAYONE-GmbH / magento-2

Pull Request — master (#31)

Addresscheck::addScoreToSession() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like