PaymentsApiClient - Code Metrics - Inspection of "Version 2.9.0 autorelease" - payeverworldwide/sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f4feef...3322ef )

by payever

created 2021-03-17 14:18 UTC

PaymentsApiClient A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	511
Duplicated Lines	18.2 %

Coupling/Cohesion

Components	1
Dependencies	24

Importance

Changes

Metric	Value
wmc	40
lcom	1
cbo	24
dl	93
loc	511
rs	9.2
c	0
b	0
f	0

30 Methods

Rating	Name	Duplication	Size	Complexity
A	createPaymentRequest()	20	20	2
A	submitPaymentRequest()	21	21	2
A	retrievePaymentRequest()	0	13	1
A	listPaymentsRequest()	0	14	1
A	refundPaymentRequest()	0	17	1
A	authorizePaymentRequest()	14	14	2
A	remindPaymentRequest()	0	13	1
A	collectPaymentsRequest()	0	13	1
A	latePaymentsRequest()	0	13	1
A	shippingGoodsPaymentRequest()	16	16	2
A	cancelPaymentRequest()	0	13	1
A	retrieveApiCallRequest()	0	13	1
A	listPaymentOptionsRequest()	11	11	3
A	listPaymentOptionsWithVariantsRequest()	11	11	3
A	getTransactionRequest()	0	13	1
A	getCreatePaymentURL()	0	4	1
A	getSubmitPaymentURL()	0	4	1
A	getRetrievePaymentURL()	0	4	1
A	getListPaymentsURL()	0	4	1
A	getRefundPaymentURL()	0	4	1
A	getAuthorizePaymentURL()	0	4	1
A	getRemindPaymentURL()	0	4	1
A	getCollectPaymentsURL()	0	4	1
A	getLatePaymentsURL()	0	4	1
A	getShippingGoodsPaymentURL()	0	4	1
A	getCancelPaymentURL()	0	4	1
A	getRetrieveApiCallURL()	0	4	1
A	getListPaymentOptionsURL()	0	6	2
A	getListPaymentOptionsVariantsURL()	0	6	2
A	getTransactionURL()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like PaymentsApiClient often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use PaymentsApiClient, and based on these observations, apply Extract Interface, too.

<?php

/**
 * PHP version 5.4 and 7
 *
 * @category  Payments
 * @package   Payever\Payments
 * @author    payever GmbH <[email protected]>
 * @copyright 2017-2021 payever GmbH
 * @license   MIT <https://opensource.org/licenses/MIT>
 * @link      https://docs.payever.org/shopsystems/api/getting-started
 */

namespace Payever\ExternalIntegration\Payments;

use Payever\ExternalIntegration\Core\Authorization\OauthToken;
use Payever\ExternalIntegration\Core\CommonApiClient;
use Payever\ExternalIntegration\Core\Http\RequestBuilder;
use Payever\ExternalIntegration\Payments\Base\PaymentsApiClientInterface;
use Payever\ExternalIntegration\Payments\Http\RequestEntity\AuthorizePaymentRequest;
use Payever\ExternalIntegration\Payments\Http\RequestEntity\CreatePaymentRequest;
use Payever\ExternalIntegration\Payments\Http\RequestEntity\ListPaymentsRequest;
use Payever\ExternalIntegration\Payments\Http\RequestEntity\RefundPaymentRequest;
use Payever\ExternalIntegration\Payments\Http\RequestEntity\ShippingGoodsPaymentRequest;
use Payever\ExternalIntegration\Payments\Http\RequestEntity\SubmitPaymentRequest;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\AuthorizePaymentResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\CancelPaymentResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\CollectPaymentsResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\CreatePaymentResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\GetTransactionResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\LatePaymentsResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\ListPaymentOptionsResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\ListPaymentOptionsWithVariantsResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\ListPaymentsResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\RefundPaymentResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\RemindPaymentResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\RetrieveApiCallResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\RetrievePaymentResponse;
use Payever\ExternalIntegration\Payments\Http\ResponseEntity\ShippingGoodsPaymentResponse;

/**
 * Class represents Payever Payments API Connector
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class PaymentsApiClient extends CommonApiClient implements PaymentsApiClientInterface
{
    const SUB_URL_CREATE_PAYMENT = 'api/payment';
    const SUB_URL_CREATE_PAYMENT_SUBMIT = 'api/payment/submit';
    const SUB_URL_RETRIEVE_PAYMENT = 'api/payment/%s';
    const SUB_URL_LIST_PAYMENTS = 'api/payment';
    const SUB_URL_REFUND_PAYMENT = 'api/payment/refund/%s';
    const SUB_URL_AUTHORIZE_PAYMENT = 'api/payment/authorize/%s';
    const SUB_URL_REMIND_PAYMENT = 'api/payment/remind/%s';
    const SUB_URL_COLLECT_PAYMENTS = 'api/payment/collect/%s';
    const SUB_URL_LATE_PAYMENTS = 'api/payment/late-payment/%s';
    const SUB_URL_SHIPPING_GOODS_PAYMENT = 'api/payment/shipping-goods/%s';
    const SUB_URL_CANCEL_PAYMENT = 'api/payment/cancel/%s';
    const SUB_URL_RETRIEVE_API_CALL = 'api/%s';
    const SUB_URL_LIST_PAYMENT_OPTIONS = 'api/shop/%s/payment-options/%s';
    const SUB_URL_LIST_PAYMENT_OPTIONS_VARIANTS = 'api/shop/%s/payment-options/variants/%s';
    const SUB_URL_TRANSACTION = 'api/rest/v1/transactions/%s';

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function createPaymentRequest(CreatePaymentRequest $createPaymentRequest)

    {
        $this->configuration->assertLoaded();

        if (!$createPaymentRequest->getChannel()) {
            $createPaymentRequest->setChannel(
                $this->configuration->getChannelSet()
            );
        }

        $request = RequestBuilder::post($this->getCreatePaymentURL())
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_CREATE_PAYMENT)->getAuthorizationString()
            )
            ->setRequestEntity($createPaymentRequest)
            ->setResponseEntity(new CreatePaymentResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function submitPaymentRequest(SubmitPaymentRequest $submitPaymentRequest)

    {
        $this->configuration->assertLoaded();

        if (!$submitPaymentRequest->getChannel()) {
            $submitPaymentRequest->setChannel(
                $this->configuration->getChannelSet()
            );
        }

        $request = RequestBuilder::post($this->getSubmitPaymentURL())
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_CREATE_PAYMENT)->getAuthorizationString()
            )
            ->contentTypeIsJson()
            ->setRequestEntity($submitPaymentRequest)
            ->setResponseEntity(new RetrievePaymentResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function retrievePaymentRequest($paymentId)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::get($this->getRetrievePaymentURL($paymentId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_INFO)->getAuthorizationString()
            )
            ->setResponseEntity(new RetrievePaymentResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function listPaymentsRequest(ListPaymentsRequest $listPaymentsRequest)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::get($this->getListPaymentsURL())
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setRequestEntity($listPaymentsRequest)
            ->setResponseEntity(new ListPaymentsResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function refundPaymentRequest($paymentId, $amount)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::post($this->getRefundPaymentURL($paymentId))
            ->setParams([
                'amount' => $amount,
            ])
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setRequestEntity(new RefundPaymentRequest())
            ->setResponseEntity(new RefundPaymentResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function authorizePaymentRequest($paymentId, AuthorizePaymentRequest $paymentRequest = null)

    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::post($this->getAuthorizePaymentURL($paymentId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setRequestEntity($paymentRequest ?: new AuthorizePaymentRequest())
            ->setResponseEntity(new AuthorizePaymentResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     *
     * @deprecated This request is only available for Santander DE Invoice and not used anywhere
     */
    public function remindPaymentRequest($paymentId)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::post($this->getRemindPaymentURL($paymentId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setResponseEntity(new RemindPaymentResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     *
     * @deprecated This request is only available for Santander DE Invoice and not used anywhere
     */
    public function collectPaymentsRequest($paymentId)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::post($this->getCollectPaymentsURL($paymentId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setResponseEntity(new CollectPaymentsResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     *
     * @deprecated This request is only available for Santander DE Invoice and not used anywhere
     */
    public function latePaymentsRequest($paymentId)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::post($this->getLatePaymentsURL($paymentId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setResponseEntity(new LatePaymentsResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function shippingGoodsPaymentRequest(

        $paymentId,
        ShippingGoodsPaymentRequest $paymentRequest = null
    ) {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::post($this->getShippingGoodsPaymentURL($paymentId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setRequestEntity($paymentRequest ?: new ShippingGoodsPaymentRequest())
            ->setResponseEntity(new ShippingGoodsPaymentResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function cancelPaymentRequest($paymentId)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::post($this->getCancelPaymentURL($paymentId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setResponseEntity(new CancelPaymentResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function retrieveApiCallRequest($callId)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::get($this->getRetrieveApiCallURL($callId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setResponseEntity(new RetrieveApiCallResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function listPaymentOptionsRequest($params = [], $businessUuid = '', $channel = '')

    {
        $businessUuid = $businessUuid ?: $this->getConfiguration()->getBusinessUuid();
        $channel = $channel ?: $this->getConfiguration()->getChannelSet();

        $request = RequestBuilder::get($this->getListPaymentOptionsURL($businessUuid, $channel, $params))
            ->setResponseEntity(new ListPaymentOptionsResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function listPaymentOptionsWithVariantsRequest($params = [], $businessUuid = '', $channel = '')

    {
        $businessUuid = $businessUuid ?: $this->getConfiguration()->getBusinessUuid();
        $channel = $channel ?: $this->getConfiguration()->getChannelSet();

        $request = RequestBuilder::get($this->getListPaymentOptionsVariantsURL($businessUuid, $channel, $params))
            ->setResponseEntity(new ListPaymentOptionsWithVariantsResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \Exception
     */
    public function getTransactionRequest($paymentId)
    {
        $this->configuration->assertLoaded();

        $request = RequestBuilder::get($this->getTransactionURL($paymentId))
            ->addRawHeader(
                $this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
            )
            ->setResponseEntity(new GetTransactionResponse())
            ->build();

        return $this->getHttpClient()->execute($request);
    }

    /**
     * Returns URL for Create Payment path
     *
     * @return string
     */
    protected function getCreatePaymentURL()
    {
        return $this->getBaseUrl() . self::SUB_URL_CREATE_PAYMENT;
    }

    /**
     * Returns URL for Submit Payment path
     *
     * @return string
     */
    protected function getSubmitPaymentURL()
    {
        return $this->getBaseUrl() . self::SUB_URL_CREATE_PAYMENT_SUBMIT;
    }

    /**
     * Returns URL for Retrieve Payment path
     *
     * @param string $paymentId
     *
     * @return string
     */
    protected function getRetrievePaymentURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_RETRIEVE_PAYMENT, $paymentId);
    }

    /**
     * Returns URL for List Payments path
     *
     * @return string
     */
    protected function getListPaymentsURL()
    {
        return $this->getBaseUrl() . self::SUB_URL_LIST_PAYMENTS;
    }

    /**
     * Returns URL for Refund Payment path
     *
     * @param string $paymentId
     *
     * @return string
     */
    protected function getRefundPaymentURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_REFUND_PAYMENT, $paymentId);
    }

    /**
     * Returns URL for Authorize Payment path
     *
     * @param string $paymentId
     *
     * @return string
     */
    protected function getAuthorizePaymentURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_AUTHORIZE_PAYMENT, $paymentId);
    }

    /**
     * Returns URL for Remind Payment path
     *
     * @param string $paymentId
     *
     * @return string
     */
    protected function getRemindPaymentURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_REMIND_PAYMENT, $paymentId);
    }

    /**
     * Returns URL for Collect Payment path
     *
     * @param string $paymentId
     *
     * @return string
     */
    protected function getCollectPaymentsURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_COLLECT_PAYMENTS, $paymentId);
    }

    /**
     * Returns URL for Late Payments path
     *
     * @param string $paymentId
     *
     * @return string
     */
    protected function getLatePaymentsURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_LATE_PAYMENTS, $paymentId);
    }

    /**
     * Returns URL for Shipping Goods Payment path
     *
     * @param string $paymentId
     *
     * @return string
     */
    protected function getShippingGoodsPaymentURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_SHIPPING_GOODS_PAYMENT, $paymentId);
    }

    /**
     * Returns URL for Cancel Payment path
     *
     * @param string $paymentId
     *
     * @return string
     */
    protected function getCancelPaymentURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_CANCEL_PAYMENT, $paymentId);
    }

    /**
     * Returns URL for Retrieve API Call path
     *
     * @param string $callId
     *
     * @return string
     */
    protected function getRetrieveApiCallURL($callId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_RETRIEVE_API_CALL, $callId);
    }

    /**
     * Returns URL for Available Payment Options path
     *
     * @param string $businessUuid
     * @param string $channel
     * @param array $params
     *
     * @return string
     */
    protected function getListPaymentOptionsURL($businessUuid, $channel, $params = [])
    {
        return $this->getBaseUrl()
            . sprintf(self::SUB_URL_LIST_PAYMENT_OPTIONS, $businessUuid, $channel)
            . (empty($params) ? '' : '?' . http_build_query($params));
    }

    /**
     * Returns URL for Available Payment Options request
     *
     * @param string $businessUuid
     * @param string $channel
     * @param array $params
     *
     * @return string
     */
    protected function getListPaymentOptionsVariantsURL($businessUuid, $channel, $params = [])
    {
        return $this->getBaseUrl()
            . sprintf(self::SUB_URL_LIST_PAYMENT_OPTIONS_VARIANTS, $businessUuid, $channel)
            . (empty($params) ? '' : '?' . http_build_query($params));
    }

    /**
     * Returns URL to Transaction path
     *
     * @param int $paymentId
     *
     * @return string
     */
    protected function getTransactionURL($paymentId)
    {
        return $this->getBaseUrl() . sprintf(self::SUB_URL_TRANSACTION, $paymentId);
    }
}


1		<?php
2
3		/**
4		* PHP version 5.4 and 7
5		*
6		* @category Payments
7		* @package Payever\Payments
8		* @author payever GmbH <[email protected]>
9		* @copyright 2017-2021 payever GmbH
10		* @license MIT <https://opensource.org/licenses/MIT>
11		* @link https://docs.payever.org/shopsystems/api/getting-started
12		*/
13
14		namespace Payever\ExternalIntegration\Payments;
15
16		use Payever\ExternalIntegration\Core\Authorization\OauthToken;
17		use Payever\ExternalIntegration\Core\CommonApiClient;
18		use Payever\ExternalIntegration\Core\Http\RequestBuilder;
19		use Payever\ExternalIntegration\Payments\Base\PaymentsApiClientInterface;
20		use Payever\ExternalIntegration\Payments\Http\RequestEntity\AuthorizePaymentRequest;
21		use Payever\ExternalIntegration\Payments\Http\RequestEntity\CreatePaymentRequest;
22		use Payever\ExternalIntegration\Payments\Http\RequestEntity\ListPaymentsRequest;
23		use Payever\ExternalIntegration\Payments\Http\RequestEntity\RefundPaymentRequest;
24		use Payever\ExternalIntegration\Payments\Http\RequestEntity\ShippingGoodsPaymentRequest;
25		use Payever\ExternalIntegration\Payments\Http\RequestEntity\SubmitPaymentRequest;
26		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\AuthorizePaymentResponse;
27		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\CancelPaymentResponse;
28		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\CollectPaymentsResponse;
29		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\CreatePaymentResponse;
30		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\GetTransactionResponse;
31		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\LatePaymentsResponse;
32		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\ListPaymentOptionsResponse;
33		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\ListPaymentOptionsWithVariantsResponse;
34		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\ListPaymentsResponse;
35		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\RefundPaymentResponse;
36		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\RemindPaymentResponse;
37		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\RetrieveApiCallResponse;
38		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\RetrievePaymentResponse;
39		use Payever\ExternalIntegration\Payments\Http\ResponseEntity\ShippingGoodsPaymentResponse;
40
41		/**
42		* Class represents Payever Payments API Connector
43		* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
44		* @SuppressWarnings(PHPMD.TooManyPublicMethods)
45		*/
46		class PaymentsApiClient extends CommonApiClient implements PaymentsApiClientInterface
47		{
48		const SUB_URL_CREATE_PAYMENT = 'api/payment';
49		const SUB_URL_CREATE_PAYMENT_SUBMIT = 'api/payment/submit';
50		const SUB_URL_RETRIEVE_PAYMENT = 'api/payment/%s';
51		const SUB_URL_LIST_PAYMENTS = 'api/payment';
52		const SUB_URL_REFUND_PAYMENT = 'api/payment/refund/%s';
53		const SUB_URL_AUTHORIZE_PAYMENT = 'api/payment/authorize/%s';
54		const SUB_URL_REMIND_PAYMENT = 'api/payment/remind/%s';
55		const SUB_URL_COLLECT_PAYMENTS = 'api/payment/collect/%s';
56		const SUB_URL_LATE_PAYMENTS = 'api/payment/late-payment/%s';
57		const SUB_URL_SHIPPING_GOODS_PAYMENT = 'api/payment/shipping-goods/%s';
58		const SUB_URL_CANCEL_PAYMENT = 'api/payment/cancel/%s';
59		const SUB_URL_RETRIEVE_API_CALL = 'api/%s';
60		const SUB_URL_LIST_PAYMENT_OPTIONS = 'api/shop/%s/payment-options/%s';
61		const SUB_URL_LIST_PAYMENT_OPTIONS_VARIANTS = 'api/shop/%s/payment-options/variants/%s';
62		const SUB_URL_TRANSACTION = 'api/rest/v1/transactions/%s';
63
64		/**
65		* {@inheritdoc}
66		*
67		* @throws \Exception
68		*/
69	View Code Duplication	public function createPaymentRequest(CreatePaymentRequest $createPaymentRequest)
		0 ignored issues – show Duplication introduced 2021-03-17 14:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
70		{
71		$this->configuration->assertLoaded();
72
73		if (!$createPaymentRequest->getChannel()) {
74		$createPaymentRequest->setChannel(
75		$this->configuration->getChannelSet()
76		);
77		}
78
79		$request = RequestBuilder::post($this->getCreatePaymentURL())
80		->addRawHeader(
81		$this->getToken(OauthToken::SCOPE_CREATE_PAYMENT)->getAuthorizationString()
82		)
83		->setRequestEntity($createPaymentRequest)
84		->setResponseEntity(new CreatePaymentResponse())
85		->build();
86
87		return $this->getHttpClient()->execute($request);
88		}
89
90		/**
91		* {@inheritdoc}
92		*
93		* @throws \Exception
94		*/
95	View Code Duplication	public function submitPaymentRequest(SubmitPaymentRequest $submitPaymentRequest)
		0 ignored issues – show Duplication introduced 2021-03-17 14:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
96		{
97		$this->configuration->assertLoaded();
98
99		if (!$submitPaymentRequest->getChannel()) {
100		$submitPaymentRequest->setChannel(
101		$this->configuration->getChannelSet()
102		);
103		}
104
105		$request = RequestBuilder::post($this->getSubmitPaymentURL())
106		->addRawHeader(
107		$this->getToken(OauthToken::SCOPE_CREATE_PAYMENT)->getAuthorizationString()
108		)
109		->contentTypeIsJson()
110		->setRequestEntity($submitPaymentRequest)
111		->setResponseEntity(new RetrievePaymentResponse())
112		->build();
113
114		return $this->getHttpClient()->execute($request);
115		}
116
117		/**
118		* {@inheritdoc}
119		*
120		* @throws \Exception
121		*/
122		public function retrievePaymentRequest($paymentId)
123		{
124		$this->configuration->assertLoaded();
125
126		$request = RequestBuilder::get($this->getRetrievePaymentURL($paymentId))
127		->addRawHeader(
128		$this->getToken(OauthToken::SCOPE_PAYMENT_INFO)->getAuthorizationString()
129		)
130		->setResponseEntity(new RetrievePaymentResponse())
131		->build();
132
133		return $this->getHttpClient()->execute($request);
134		}
135
136		/**
137		* {@inheritdoc}
138		*
139		* @throws \Exception
140		*/
141		public function listPaymentsRequest(ListPaymentsRequest $listPaymentsRequest)
142		{
143		$this->configuration->assertLoaded();
144
145		$request = RequestBuilder::get($this->getListPaymentsURL())
146		->addRawHeader(
147		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
148		)
149		->setRequestEntity($listPaymentsRequest)
150		->setResponseEntity(new ListPaymentsResponse())
151		->build();
152
153		return $this->getHttpClient()->execute($request);
154		}
155
156		/**
157		* {@inheritdoc}
158		*
159		* @throws \Exception
160		*/
161		public function refundPaymentRequest($paymentId, $amount)
162		{
163		$this->configuration->assertLoaded();
164
165		$request = RequestBuilder::post($this->getRefundPaymentURL($paymentId))
166		->setParams([
167		'amount' => $amount,
168		])
169		->addRawHeader(
170		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
171		)
172		->setRequestEntity(new RefundPaymentRequest())
173		->setResponseEntity(new RefundPaymentResponse())
174		->build();
175
176		return $this->getHttpClient()->execute($request);
177		}
178
179		/**
180		* {@inheritdoc}
181		*
182		* @throws \Exception
183		*/
184	View Code Duplication	public function authorizePaymentRequest($paymentId, AuthorizePaymentRequest $paymentRequest = null)
		0 ignored issues – show Duplication introduced 2021-03-17 14:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
185		{
186		$this->configuration->assertLoaded();
187
188		$request = RequestBuilder::post($this->getAuthorizePaymentURL($paymentId))
189		->addRawHeader(
190		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
191		)
192		->setRequestEntity($paymentRequest ?: new AuthorizePaymentRequest())
193		->setResponseEntity(new AuthorizePaymentResponse())
194		->build();
195
196		return $this->getHttpClient()->execute($request);
197		}
198
199		/**
200		* {@inheritdoc}
201		*
202		* @throws \Exception
203		*
204		* @deprecated This request is only available for Santander DE Invoice and not used anywhere
205		*/
206		public function remindPaymentRequest($paymentId)
207		{
208		$this->configuration->assertLoaded();
209
210		$request = RequestBuilder::post($this->getRemindPaymentURL($paymentId))
211		->addRawHeader(
212		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
213		)
214		->setResponseEntity(new RemindPaymentResponse())
215		->build();
216
217		return $this->getHttpClient()->execute($request);
218		}
219
220		/**
221		* {@inheritdoc}
222		*
223		* @throws \Exception
224		*
225		* @deprecated This request is only available for Santander DE Invoice and not used anywhere
226		*/
227		public function collectPaymentsRequest($paymentId)
228		{
229		$this->configuration->assertLoaded();
230
231		$request = RequestBuilder::post($this->getCollectPaymentsURL($paymentId))
232		->addRawHeader(
233		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
234		)
235		->setResponseEntity(new CollectPaymentsResponse())
236		->build();
237
238		return $this->getHttpClient()->execute($request);
239		}
240
241		/**
242		* {@inheritdoc}
243		*
244		* @throws \Exception
245		*
246		* @deprecated This request is only available for Santander DE Invoice and not used anywhere
247		*/
248		public function latePaymentsRequest($paymentId)
249		{
250		$this->configuration->assertLoaded();
251
252		$request = RequestBuilder::post($this->getLatePaymentsURL($paymentId))
253		->addRawHeader(
254		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
255		)
256		->setResponseEntity(new LatePaymentsResponse())
257		->build();
258
259		return $this->getHttpClient()->execute($request);
260		}
261
262		/**
263		* {@inheritdoc}
264		*
265		* @throws \Exception
266		*/
267	View Code Duplication	public function shippingGoodsPaymentRequest(
		0 ignored issues – show Duplication introduced 2021-03-17 14:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
268		$paymentId,
269		ShippingGoodsPaymentRequest $paymentRequest = null
270		) {
271		$this->configuration->assertLoaded();
272
273		$request = RequestBuilder::post($this->getShippingGoodsPaymentURL($paymentId))
274		->addRawHeader(
275		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
276		)
277		->setRequestEntity($paymentRequest ?: new ShippingGoodsPaymentRequest())
278		->setResponseEntity(new ShippingGoodsPaymentResponse())
279		->build();
280
281		return $this->getHttpClient()->execute($request);
282		}
283
284		/**
285		* {@inheritdoc}
286		*
287		* @throws \Exception
288		*/
289		public function cancelPaymentRequest($paymentId)
290		{
291		$this->configuration->assertLoaded();
292
293		$request = RequestBuilder::post($this->getCancelPaymentURL($paymentId))
294		->addRawHeader(
295		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
296		)
297		->setResponseEntity(new CancelPaymentResponse())
298		->build();
299
300		return $this->getHttpClient()->execute($request);
301		}
302
303		/**
304		* {@inheritdoc}
305		*
306		* @throws \Exception
307		*/
308		public function retrieveApiCallRequest($callId)
309		{
310		$this->configuration->assertLoaded();
311
312		$request = RequestBuilder::get($this->getRetrieveApiCallURL($callId))
313		->addRawHeader(
314		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
315		)
316		->setResponseEntity(new RetrieveApiCallResponse())
317		->build();
318
319		return $this->getHttpClient()->execute($request);
320		}
321
322		/**
323		* {@inheritdoc}
324		*
325		* @throws \Exception
326		*/
327	View Code Duplication	public function listPaymentOptionsRequest($params = [], $businessUuid = '', $channel = '')
		0 ignored issues – show Duplication introduced 2021-03-17 14:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
328		{
329		$businessUuid = $businessUuid ?: $this->getConfiguration()->getBusinessUuid();
330		$channel = $channel ?: $this->getConfiguration()->getChannelSet();
331
332		$request = RequestBuilder::get($this->getListPaymentOptionsURL($businessUuid, $channel, $params))
333		->setResponseEntity(new ListPaymentOptionsResponse())
334		->build();
335
336		return $this->getHttpClient()->execute($request);
337		}
338
339		/**
340		* {@inheritdoc}
341		*
342		* @throws \Exception
343		*/
344	View Code Duplication	public function listPaymentOptionsWithVariantsRequest($params = [], $businessUuid = '', $channel = '')
		0 ignored issues – show Duplication introduced 2021-03-17 14:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
345		{
346		$businessUuid = $businessUuid ?: $this->getConfiguration()->getBusinessUuid();
347		$channel = $channel ?: $this->getConfiguration()->getChannelSet();
348
349		$request = RequestBuilder::get($this->getListPaymentOptionsVariantsURL($businessUuid, $channel, $params))
350		->setResponseEntity(new ListPaymentOptionsWithVariantsResponse())
351		->build();
352
353		return $this->getHttpClient()->execute($request);
354		}
355
356		/**
357		* {@inheritdoc}
358		*
359		* @throws \Exception
360		*/
361		public function getTransactionRequest($paymentId)
362		{
363		$this->configuration->assertLoaded();
364
365		$request = RequestBuilder::get($this->getTransactionURL($paymentId))
366		->addRawHeader(
367		$this->getToken(OauthToken::SCOPE_PAYMENT_ACTIONS)->getAuthorizationString()
368		)
369		->setResponseEntity(new GetTransactionResponse())
370		->build();
371
372		return $this->getHttpClient()->execute($request);
373		}
374
375		/**
376		* Returns URL for Create Payment path
377		*
378		* @return string
379		*/
380		protected function getCreatePaymentURL()
381		{
382		return $this->getBaseUrl() . self::SUB_URL_CREATE_PAYMENT;
383		}
384
385		/**
386		* Returns URL for Submit Payment path
387		*
388		* @return string
389		*/
390		protected function getSubmitPaymentURL()
391		{
392		return $this->getBaseUrl() . self::SUB_URL_CREATE_PAYMENT_SUBMIT;
393		}
394
395		/**
396		* Returns URL for Retrieve Payment path
397		*
398		* @param string $paymentId
399		*
400		* @return string
401		*/
402		protected function getRetrievePaymentURL($paymentId)
403		{
404		return $this->getBaseUrl() . sprintf(self::SUB_URL_RETRIEVE_PAYMENT, $paymentId);
405		}
406
407		/**
408		* Returns URL for List Payments path
409		*
410		* @return string
411		*/
412		protected function getListPaymentsURL()
413		{
414		return $this->getBaseUrl() . self::SUB_URL_LIST_PAYMENTS;
415		}
416
417		/**
418		* Returns URL for Refund Payment path
419		*
420		* @param string $paymentId
421		*
422		* @return string
423		*/
424		protected function getRefundPaymentURL($paymentId)
425		{
426		return $this->getBaseUrl() . sprintf(self::SUB_URL_REFUND_PAYMENT, $paymentId);
427		}
428
429		/**
430		* Returns URL for Authorize Payment path
431		*
432		* @param string $paymentId
433		*
434		* @return string
435		*/
436		protected function getAuthorizePaymentURL($paymentId)
437		{
438		return $this->getBaseUrl() . sprintf(self::SUB_URL_AUTHORIZE_PAYMENT, $paymentId);
439		}
440
441		/**
442		* Returns URL for Remind Payment path
443		*
444		* @param string $paymentId
445		*
446		* @return string
447		*/
448		protected function getRemindPaymentURL($paymentId)
449		{
450		return $this->getBaseUrl() . sprintf(self::SUB_URL_REMIND_PAYMENT, $paymentId);
451		}
452
453		/**
454		* Returns URL for Collect Payment path
455		*
456		* @param string $paymentId
457		*
458		* @return string
459		*/
460		protected function getCollectPaymentsURL($paymentId)
461		{
462		return $this->getBaseUrl() . sprintf(self::SUB_URL_COLLECT_PAYMENTS, $paymentId);
463		}
464
465		/**
466		* Returns URL for Late Payments path
467		*
468		* @param string $paymentId
469		*
470		* @return string
471		*/
472		protected function getLatePaymentsURL($paymentId)
473		{
474		return $this->getBaseUrl() . sprintf(self::SUB_URL_LATE_PAYMENTS, $paymentId);
475		}
476
477		/**
478		* Returns URL for Shipping Goods Payment path
479		*
480		* @param string $paymentId
481		*
482		* @return string
483		*/
484		protected function getShippingGoodsPaymentURL($paymentId)
485		{
486		return $this->getBaseUrl() . sprintf(self::SUB_URL_SHIPPING_GOODS_PAYMENT, $paymentId);
487		}
488
489		/**
490		* Returns URL for Cancel Payment path
491		*
492		* @param string $paymentId
493		*
494		* @return string
495		*/
496		protected function getCancelPaymentURL($paymentId)
497		{
498		return $this->getBaseUrl() . sprintf(self::SUB_URL_CANCEL_PAYMENT, $paymentId);
499		}
500
501		/**
502		* Returns URL for Retrieve API Call path
503		*
504		* @param string $callId
505		*
506		* @return string
507		*/
508		protected function getRetrieveApiCallURL($callId)
509		{
510		return $this->getBaseUrl() . sprintf(self::SUB_URL_RETRIEVE_API_CALL, $callId);
511		}
512
513		/**
514		* Returns URL for Available Payment Options path
515		*
516		* @param string $businessUuid
517		* @param string $channel
518		* @param array $params
519		*
520		* @return string
521		*/
522		protected function getListPaymentOptionsURL($businessUuid, $channel, $params = [])
523		{
524		return $this->getBaseUrl()
525		. sprintf(self::SUB_URL_LIST_PAYMENT_OPTIONS, $businessUuid, $channel)
526		. (empty($params) ? '' : '?' . http_build_query($params));
527		}
528
529		/**
530		* Returns URL for Available Payment Options request
531		*
532		* @param string $businessUuid
533		* @param string $channel
534		* @param array $params
535		*
536		* @return string
537		*/
538		protected function getListPaymentOptionsVariantsURL($businessUuid, $channel, $params = [])
539		{
540		return $this->getBaseUrl()
541		. sprintf(self::SUB_URL_LIST_PAYMENT_OPTIONS_VARIANTS, $businessUuid, $channel)
542		. (empty($params) ? '' : '?' . http_build_query($params));
543		}
544
545		/**
546		* Returns URL to Transaction path
547		*
548		* @param int $paymentId
549		*
550		* @return string
551		*/
552		protected function getTransactionURL($paymentId)
553		{
554		return $this->getBaseUrl() . sprintf(self::SUB_URL_TRANSACTION, $paymentId);
555		}
556		}
557

payeverworldwide / sdk-php