ApplicationGateway::getApplicationHistory() - Code Metrics - Inspection of "Update CHANGELOG.md" - PayBreak/paybreak-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 566a7e...82bd5d )

by Wojciech

created 2016-08-15 12:48 UTC

ApplicationGateway::getApplicationHistory() A

↳ Parent: ApplicationGateway

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	8
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	5
nc	1
nop	2
crap	1

<?php
/*
* This file is part of the PayBreak/basket package.
*
* (c) PayBreak <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace PayBreak\Sdk\Gateways;

use PayBreak\Sdk\Entities\ApplicationEntity;
use PayBreak\Sdk\SdkException;
use WNowicki\Generic\ApiClient\ErrorResponseException;

/**
 * Application Gateway
 *
 * @author WN
 * @package PayBreak\Sdk\Gateways
 */
class ApplicationGateway extends AbstractGateway
{
    /**
     * @author WN
     * @param int $id
     * @param string $token
     * @return ApplicationEntity
     * @throws SdkException
     */
    public function getApplication($id, $token)
    {
        return ApplicationEntity::make($this->fetchDocument('/v4/applications/' . $id, $token, 'Application'));
    }

    /**
     * @author WN
     * @param ApplicationEntity $application
     * @param string $token
     * @return ApplicationEntity
     * @throws SdkException
     */
    public function initialiseApplication(ApplicationEntity $application, $token)
    {
        $api = $this->getApiFactory()->makeApiClient($token);

        try {
            $response = $api->post('/v4/initialize-application', $application->toArray(true));

            $application->setId($response['application']);
            $application->setResumeUrl($response['url']);

            return $application;

        } catch (ErrorResponseException $e) {

            $this->logWarning('ApplicationGateway::initialiseApplication[' . $e->getCode() . ']: ' . $e->getMessage());
            throw new SdkException($e->getMessage());

        } catch (\Exception $e) {

            $this->logError('ApplicationGateway::initialiseApplication[' . $e->getCode() . ']: ' . $e->getMessage());
            throw new SdkException('Problem Initialising Application on Provider API');
        }
    }

    /**
     * @author WN
     * @param int $id
     * @param string $token
     * @return bool
     * @throws SdkException
     */
    public function fulfilApplication($id, $token)
    {
        return $this->requestAction('/v4/applications/' . $id . '/fulfil', [], $token);
    }

    /**
     * @param int $id
     * @param string $description
     * @param string $token
     * @return bool
     * @throws SdkException
     */
    public function cancelApplication($id, $description, $token)
    {
        return $this->requestAction(
            '/v4/applications/' . $id . '/request-cancellation',
            ['description' => $description],
            $token
        );
    }

    /**
     * @param $token
     * @return array
     * @throws SdkException
     */
    public function getPendingCancellations($installationId, $token)
    {
        return $this->fetchDocument(
            '/v4/installations/' . $installationId . '/applications',
            $token,
            'Pending Cancellations',
            ['pending-cancellations' => true]
        );
    }

    /**
     * Get Merchant Payments. Filter Params can accept
     * - since, until : (string - ISO8601 Date Part Only)
     * - count, offset : (int)
     *
     * @author SL
     * @param $application
     * @param $token
     * @param array $filterParams
     * @return array
     */
    public function getMerchantPayments($application, $token, array $filterParams = [])
    {
        return $this->fetchDocument(
            '/v4/applications/' . $application . '/merchant-payments',
            $token,
            'Merchant Payments',
            $filterParams
        );
    }

    /**
     * Add a Merchant Payment to the given application. Amount should be supplied in pence.
     *
     * @author SL
     * @param string $application
     * @param \DateTime $effectiveDate
     * @param int $amount
     * @param string $token
     * @return array
     */
    public function addMerchantPayment($application, \DateTime $effectiveDate, $amount, $token)
    {
        return $this->postDocument(
            '/v4/applications/' . $application . '/merchant-payments',
            [
                'amount' => $amount,
                'effective_date' => $effectiveDate->format('Y-m-d'),
            ],
            $token,
            'Add Merchant Payment'
        );
    }

    /**
     * @author EB
     * @param $installationId
     * @param $application
     * @param $token
     * @return array
     */
    public function getApplicationCreditInfo($installationId, $application, $token)
    {
        return $this->postDocument(
            'v4/installations/' . $installationId . '/applications/' . $application . '/get-credit-information',
            [],
            $token,
            'Application Credit Information'
        );
    }

    /**
     * Get application history
     *
     * @author SL
     * @param $application
     * @param $token
     * @return array
     */
    public function getApplicationHistory($application, $token)
    {
        return $this->fetchDocument(
            '/v4/applications/' . $application . '/status-history',
            $token,
            'Application Status History'
        );
    }

    /**
     * @author WN
     * @param string $action
     * @param array $data
     * @param string $token
     * @return bool
     * @throws SdkException
     */
    private function requestAction($action, $data, $token)
    {
        $this->postDocument($action, $data, $token, 'Application');
        return true;
    }
}


1		<?php
2		/*
3		* This file is part of the PayBreak/basket package.
4		*
5		* (c) PayBreak <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace PayBreak\Sdk\Gateways;
12
13		use PayBreak\Sdk\Entities\ApplicationEntity;
14		use PayBreak\Sdk\SdkException;
15		use WNowicki\Generic\ApiClient\ErrorResponseException;
16
17		/**
18		* Application Gateway
19		*
20		* @author WN
21		* @package PayBreak\Sdk\Gateways
22		*/
23		class ApplicationGateway extends AbstractGateway
24		{
25		/**
26		* @author WN
27		* @param int $id
28		* @param string $token
29		* @return ApplicationEntity
30		* @throws SdkException
31		*/
32	2	public function getApplication($id, $token)
33		{
34	2	return ApplicationEntity::make($this->fetchDocument('/v4/applications/' . $id, $token, 'Application'));
35		}
36
37		/**
38		* @author WN
39		* @param ApplicationEntity $application
40		* @param string $token
41		* @return ApplicationEntity
42		* @throws SdkException
43		*/
44	6	public function initialiseApplication(ApplicationEntity $application, $token)
45		{
46	6	$api = $this->getApiFactory()->makeApiClient($token);
47
48		try {
49	6	$response = $api->post('/v4/initialize-application', $application->toArray(true));
50
51	2	$application->setId($response['application']);
52	2	$application->setResumeUrl($response['url']);
53
54	2	return $application;
55
56	4	} catch (ErrorResponseException $e) {
57
58	2	$this->logWarning('ApplicationGateway::initialiseApplication[' . $e->getCode() . ']: ' . $e->getMessage());
59	2	throw new SdkException($e->getMessage());
60
61	2	} catch (\Exception $e) {
62
63	2	$this->logError('ApplicationGateway::initialiseApplication[' . $e->getCode() . ']: ' . $e->getMessage());
64	2	throw new SdkException('Problem Initialising Application on Provider API');
65		}
66		}
67
68		/**
69		* @author WN
70		* @param int $id
71		* @param string $token
72		* @return bool
73		* @throws SdkException
74		*/
75	2	public function fulfilApplication($id, $token)
76		{
77	2	return $this->requestAction('/v4/applications/' . $id . '/fulfil', [], $token);
78		}
79
80		/**
81		* @param int $id
82		* @param string $description
83		* @param string $token
84		* @return bool
85		* @throws SdkException
86		*/
87	2	public function cancelApplication($id, $description, $token)
88		{
89	2	return $this->requestAction(
90	2	'/v4/applications/' . $id . '/request-cancellation',
91	2	['description' => $description],
92		$token
93	2	);
94		}
95
96		/**
97		* @param $token
98		* @return array
99		* @throws SdkException
100		*/
101	2	public function getPendingCancellations($installationId, $token)
102		{
103	2	return $this->fetchDocument(
104	2	'/v4/installations/' . $installationId . '/applications',
105	2	$token,
106	2	'Pending Cancellations',
107	2	['pending-cancellations' => true]
108	2	);
109		}
110
111		/**
112		* Get Merchant Payments. Filter Params can accept
113		* - since, until : (string - ISO8601 Date Part Only)
114		* - count, offset : (int)
115		*
116		* @author SL
117		* @param $application
118		* @param $token
119		* @param array $filterParams
120		* @return array
121		*/
122	2	public function getMerchantPayments($application, $token, array $filterParams = [])
123		{
124	2	return $this->fetchDocument(
125	2	'/v4/applications/' . $application . '/merchant-payments',
126	2	$token,
127	2	'Merchant Payments',
128		$filterParams
129	2	);
130		}
131
132		/**
133		* Add a Merchant Payment to the given application. Amount should be supplied in pence.
134		*
135		* @author SL
136		* @param string $application
137		* @param \DateTime $effectiveDate
138		* @param int $amount
139		* @param string $token
140		* @return array
141		*/
142	2	public function addMerchantPayment($application, \DateTime $effectiveDate, $amount, $token)
143		{
144	2	return $this->postDocument(
145	2	'/v4/applications/' . $application . '/merchant-payments',
146		[
147	2	'amount' => $amount,
148	2	'effective_date' => $effectiveDate->format('Y-m-d'),
149	2	],
150	2	$token,
151		'Add Merchant Payment'
152	2	);
153		}
154
155		/**
156		* @author EB
157		* @param $installationId
158		* @param $application
159		* @param $token
160		* @return array
161		*/
162	2	public function getApplicationCreditInfo($installationId, $application, $token)
163		{
164	2	return $this->postDocument(
165	2	'v4/installations/' . $installationId . '/applications/' . $application . '/get-credit-information',
166	2	[],
167	2	$token,
168		'Application Credit Information'
169	2	);
170		}
171
172		/**
173		* Get application history
174		*
175		* @author SL
176		* @param $application
177		* @param $token
178		* @return array
179		*/
180	2	public function getApplicationHistory($application, $token)
181		{
182	2	return $this->fetchDocument(
183	2	'/v4/applications/' . $application . '/status-history',
184	2	$token,
185		'Application Status History'
186	2	);
187		}
188
189		/**
190		* @author WN
191		* @param string $action
192		* @param array $data
193		* @param string $token
194		* @return bool
195		* @throws SdkException
196		*/
197	4	private function requestAction($action, $data, $token)
198		{
199	4	$this->postDocument($action, $data, $token, 'Application');
200	4	return true;
201		}
202		}
203

PayBreak / paybreak-sdk-php

Push — master ( 566a7e...82bd5d )

ApplicationGateway::getApplicationHistory() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like