Gateway::get_available_payment_methods() - Code Metrics - Inspection of "Remove unused imports." - wp-pay-gateways/adyen - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( b1970e...b17856 )

by Reüel

created 2019-03-27 15:33 UTC

Gateway::get_available_payment_methods() A

↳ Parent: Gateway

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
eloc	12
nc	3
nop	0
dl	0
loc	21
ccs	0
cts	12
cp	0
crap	12
rs	9.8666
c	0
b	0
f	0

<?php
/**
 * Gateway
 *
 * @author    Pronamic <[email protected]>
 * @copyright 2005-2019 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Pay\Gateways\Adyen
 */

namespace Pronamic\WordPress\Pay\Gateways\Adyen;

use Exception;
use InvalidArgumentException;
use Locale;
use Pronamic\WordPress\Pay\Core\Gateway as Core_Gateway;
use Pronamic\WordPress\Pay\Core\PaymentMethods;
use Pronamic\WordPress\Pay\Core\Util as Core_Util;
use Pronamic\WordPress\Pay\Payments\Payment;
use Pronamic\WordPress\Pay\Plugin;
use WP_Error;

/**
 * Gateway
 *
 * @link https://github.com/adyenpayments/php/blob/master/generatepaymentform.php
 *
 * @author  Remco Tolsma
 * @version 1.0.0
 * @since   1.0.0
 */
class Gateway extends Core_Gateway {
	/**
	 * Slug of this gateway.
	 *
	 * @var string
	 */
	const SLUG = 'adyen';

	/**
	 * Web SDK version.
	 *
	 * @link https://docs.adyen.com/developers/checkout/web-sdk/release-notes-web-sdk
	 *
	 * @var string
	 */
	const SDK_VERSION = '1.9.2';

	/**
	 * Client.
	 *
	 * @var Client
	 */
	public $client;

	/**
	 * Constructs and initializes an Adyen gateway.
	 *
	 * @param Config $config Config.
	 */
	public function __construct( Config $config ) {
		parent::__construct( $config );

		$this->set_method( self::METHOD_HTTP_REDIRECT );
		$this->set_slug( self::SLUG );

		$this->client = new Client( $config );
	}

	/**
	 * Get supported payment methods
	 *
	 * @see Core_Gateway::get_supported_payment_methods()
	 */
	public function get_supported_payment_methods() {
		return array(
			PaymentMethods::BANCONTACT,
			PaymentMethods::CREDIT_CARD,
			PaymentMethods::DIRECT_DEBIT,
			PaymentMethods::GIROPAY,
			PaymentMethods::IDEAL,
			PaymentMethods::MAESTRO,
			PaymentMethods::SOFORT,
		);
	}

	/**
	 * Start.
	 *
	 * @see Plugin::start()
	 *
	 * @param Payment $payment Payment.
	 * @return void
	 */
	public function start( Payment $payment ) {
		// Amount.
		try {
			$amount = AmountTransformer::transform( $payment->get_total_amount() );
		} catch ( InvalidArgumentException $e ) {
			$this->error = new WP_Error( 'adyen_error', $e->getMessage() );

			return;
		}

		// Payment method type.
		$payment_method_type = PaymentMethodType::transform( $payment->get_method() );

		// Country.
		$locale = get_locale();

		$customer = $payment->get_customer();

		if ( null !== $customer ) {
			$locale = $customer->get_locale();
		}

		$locale = strval( $locale );

		$country_code = Locale::getRegion( $locale );

		/*
		 * API Integration
		 *
		 * @link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v41/payments
		 */
		$api_integration_payment_method_types = array(
			PaymentMethodType::IDEAL,
			PaymentMethodType::DIRECT_EBANKING,
		);

		if ( in_array( $payment_method_type, $api_integration_payment_method_types, true ) ) {
			$payment_method = new PaymentMethod( $payment_method_type );

			if ( PaymentMethodType::IDEAL === $payment_method_type ) {
				$payment_method = new PaymentMethodIDeal( $payment_method_type, $payment->get_issuer() );
			}

			// API integration.
			$payment_request = new PaymentRequest(
				$amount,
				$this->config->get_merchant_account(),
				strval( $payment->get_id() ),
				$payment->get_return_url(),
				$payment_method
			);

			$payment_request->set_country_code( $country_code );

			PaymentRequestHelper::complement( $payment, $payment_request );

			try {
				$payment_response = $this->client->create_payment( $payment_request );
			} catch ( Exception $e ) {
				$this->error = new WP_Error( 'adyen_error', $e->getMessage() );

				return;
			}

			$payment->set_transaction_id( $payment_response->get_psp_reference() );

			$redirect = $payment_response->get_redirect();

			if ( null !== $redirect ) {
				$payment->set_action_url( $redirect->get_url() );
			}
		}

		/*
		 * SDK Integration
		 *
		 * @link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v41/paymentSession
		 */
		$payment_session_request = new PaymentSessionRequest(
			$amount,
			$this->config->get_merchant_account(),
			strval( $payment->get_id() ),
			$payment->get_return_url(),
			$country_code
		);

		PaymentRequestHelper::complement( $payment, $payment_session_request );

		$payment_session_request->set_origin( home_url() );
		$payment_session_request->set_sdk_version( self::SDK_VERSION );

		if ( null !== $payment_method_type ) {
			$payment_session_request->set_allowed_payment_methods( array( $payment_method_type ) );
		}

		$payment_session_response = $this->client->create_payment_session( $payment_session_request );

		$payment->set_meta( 'adyen_sdk_version', self::SDK_VERSION );
		$payment->set_meta( 'adyen_payment_session', $payment_session_response->get_payment_session() );

		$payment->set_action_url( $payment->get_pay_redirect_url() );
	}

	/**
	 * Payment redirect.
	 *
	 * @param Payment $payment Payment.
	 *
	 * @return void
	 */
	public function payment_redirect( Payment $payment ) {
		$sdk_version     = $payment->get_meta( 'adyen_sdk_version' );
		$payment_session = $payment->get_meta( 'adyen_payment_session' );

		if ( empty( $sdk_version ) || empty( $payment_session ) ) {
			return;
		}

		$url = sprintf(
			'https://checkoutshopper-%s.adyen.com/checkoutshopper/assets/js/sdk/checkoutSDK.%s.min.js',
			( self::MODE_TEST === $payment->get_mode() ? 'test' : 'live' ),
			$sdk_version
		);

		wp_register_script(
			'pronamic-pay-adyen-checkout',
			$url,
			array(
				'jquery',
			),
			$sdk_version,
			false
		);

		wp_localize_script(
			'pronamic-pay-adyen-checkout',
			'pronamicPayAdyenCheckout',
			array(
				'paymentsResultUrl' => rest_url( Integration::REST_ROUTE_NAMESPACE . '/payments/result/' . $payment->config_id ),
				'paymentReturnUrl'  => $payment->get_return_url(),
				'paymentSession'    => $payment_session,
				'configObject'      => array(
					'context' => ( self::MODE_TEST === $payment->get_mode() ? 'test' : 'live' ),
				),
			)
		);

		// No cache.
		Core_Util::no_cache();

		require __DIR__ . '/../views/checkout.php';

		exit;
	}

	/**
	 * Update status of the specified payment.
	 *
	 * @param Payment $payment Payment.
	 *
	 * @return void
	 */
	public function update_status( Payment $payment ) {
		// Process payload on return.
		if ( ! filter_has_var( INPUT_GET, 'payload' ) ) {
			return;
		}

		$payload = filter_input( INPUT_GET, 'payload', FILTER_SANITIZE_STRING );

		$payment_result_request = new PaymentResultRequest( $payload );

		try {
			$payment_result_response = $this->client->get_payment_result( $payment_result_request );

			PaymentResultHelper::update_payment( $payment, $payment_result_response );
		} catch ( Exception $e ) {
			$note = sprintf(
				'%1$s %2$s',
				__( 'Error getting payment result:', 'pronamic_ideal' ),
				$e->getMessage()
			);

			$payment->add_note( $note );
		}
	}

	/**
	 * Get available payment methods.
	 *
	 * @see Core_Gateway::get_available_payment_methods()
	 */
	public function get_available_payment_methods() {
		$core_payment_methods = array();

		try {
			$payment_methods_response = $this->client->get_payment_methods();
		} catch ( Exception $e ) {
			$this->error = new WP_Error( 'adyen_error', $e->getMessage() );

			return $core_payment_methods;
		}

		foreach ( $payment_methods_response->get_payment_methods() as $payment_method ) {
			$core_payment_method = PaymentMethodType::to_wp( $payment_method->get_type() );

			$core_payment_methods[] = $core_payment_method;
		}

		$core_payment_methods = array_filter( $core_payment_methods );
		$core_payment_methods = array_unique( $core_payment_methods );

		return $core_payment_methods;
	}

	/**
	 * Get issuers.
	 *
	 * @see Pronamic_WP_Pay_Gateway::get_issuers()
	 * @return array
	 */
	public function get_issuers() {
		$issuers = array();

		try {
			$payment_methods_response = $this->client->get_payment_methods();
		} catch ( Exception $e ) {
			$this->error = new WP_Error( 'adyen_error', $e->getMessage() );

			return $issuers;
		}

		$payment_methods = $payment_methods_response->get_payment_methods();

		// Limit to iDEAL payment methods.
		$payment_methods = array_filter(
			$payment_methods,
			/**
			 * Check if payment method is iDEAL.
			 *
			 * @param PaymentMethod $payment_method Payment method.
			 * @return boolean True if payment method is iDEAL, false otherwise.
			 */
			function( $payment_method ) {
				return ( PaymentMethodType::IDEAL === $payment_method->get_type() );
			}
		);

		foreach ( $payment_methods as $payment_method ) {
			$details = $payment_method->get_details();

			if ( is_array( $details ) ) {
				foreach ( $details as $detail ) {
					if ( 'issuer' === $detail->key && 'select' === $detail->type ) {
						foreach ( $detail->items as $item ) {
							$issuers[ $item->id ] = $item->name;
						}
					}
				}
			}
		}

		if ( empty( $issuers ) ) {
			return $issuers;
		}

		return array(
			array(
				'options' => $issuers,
			),
		);
	}
}


1		<?php
2		/**
3		* Gateway
4		*
5		* @author Pronamic <[email protected]>
6		* @copyright 2005-2019 Pronamic
7		* @license GPL-3.0-or-later
8		* @package Pronamic\WordPress\Pay\Gateways\Adyen
9		*/
10
11		namespace Pronamic\WordPress\Pay\Gateways\Adyen;
12
13		use Exception;
14		use InvalidArgumentException;
15		use Locale;
16		use Pronamic\WordPress\Pay\Core\Gateway as Core_Gateway;
17		use Pronamic\WordPress\Pay\Core\PaymentMethods;
18		use Pronamic\WordPress\Pay\Core\Util as Core_Util;
19		use Pronamic\WordPress\Pay\Payments\Payment;
20		use Pronamic\WordPress\Pay\Plugin;
21		use WP_Error;
22
23		/**
24		* Gateway
25		*
26		* @link https://github.com/adyenpayments/php/blob/master/generatepaymentform.php
27		*
28		* @author Remco Tolsma
29		* @version 1.0.0
30		* @since 1.0.0
31		*/
32		class Gateway extends Core_Gateway {
33		/**
34		* Slug of this gateway.
35		*
36		* @var string
37		*/
38		const SLUG = 'adyen';
39
40		/**
41		* Web SDK version.
42		*
43		* @link https://docs.adyen.com/developers/checkout/web-sdk/release-notes-web-sdk
44		*
45		* @var string
46		*/
47		const SDK_VERSION = '1.9.2';
48
49		/**
50		* Client.
51		*
52		* @var Client
53		*/
54		public $client;
55
56		/**
57		* Constructs and initializes an Adyen gateway.
58		*
59		* @param Config $config Config.
60		*/
61	2	public function __construct( Config $config ) {
62	2	parent::__construct( $config );
63
64	2	$this->set_method( self::METHOD_HTTP_REDIRECT );
65	2	$this->set_slug( self::SLUG );
66
67	2	$this->client = new Client( $config );
68	2	}
69
70		/**
71		* Get supported payment methods
72		*
73		* @see Core_Gateway::get_supported_payment_methods()
74		*/
75	1	public function get_supported_payment_methods() {
76		return array(
77	1	PaymentMethods::BANCONTACT,
78	1	PaymentMethods::CREDIT_CARD,
79	1	PaymentMethods::DIRECT_DEBIT,
80	1	PaymentMethods::GIROPAY,
81	1	PaymentMethods::IDEAL,
82	1	PaymentMethods::MAESTRO,
83	1	PaymentMethods::SOFORT,
84		);
85		}
86
87		/**
88		* Start.
89		*
90		* @see Plugin::start()
91		*
92		* @param Payment $payment Payment.
93		* @return void
94		*/
95		public function start( Payment $payment ) {
96		// Amount.
97		try {
98		$amount = AmountTransformer::transform( $payment->get_total_amount() );
99		} catch ( InvalidArgumentException $e ) {
100		$this->error = new WP_Error( 'adyen_error', $e->getMessage() );
101
102		return;
103		}
104
105		// Payment method type.
106		$payment_method_type = PaymentMethodType::transform( $payment->get_method() );
107
108		// Country.
109		$locale = get_locale();
110
111		$customer = $payment->get_customer();
112
113		if ( null !== $customer ) {
114		$locale = $customer->get_locale();
115		}
116
117		$locale = strval( $locale );
118
119		$country_code = Locale::getRegion( $locale );
120
121		/*
122		* API Integration
123		*
124		* @link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v41/payments
125		*/
126		$api_integration_payment_method_types = array(
127		PaymentMethodType::IDEAL,
128		PaymentMethodType::DIRECT_EBANKING,
129		);
130
131		if ( in_array( $payment_method_type, $api_integration_payment_method_types, true ) ) {
132		$payment_method = new PaymentMethod( $payment_method_type );
133
134		if ( PaymentMethodType::IDEAL === $payment_method_type ) {
135		$payment_method = new PaymentMethodIDeal( $payment_method_type, $payment->get_issuer() );
136		}
137
138		// API integration.
139		$payment_request = new PaymentRequest(
140		$amount,
141		$this->config->get_merchant_account(),
142		strval( $payment->get_id() ),
143		$payment->get_return_url(),
144		$payment_method
145		);
146
147		$payment_request->set_country_code( $country_code );
148
149		PaymentRequestHelper::complement( $payment, $payment_request );
150
151		try {
152		$payment_response = $this->client->create_payment( $payment_request );
153		} catch ( Exception $e ) {
154		$this->error = new WP_Error( 'adyen_error', $e->getMessage() );
155
156		return;
157		}
158
159		$payment->set_transaction_id( $payment_response->get_psp_reference() );
160
161		$redirect = $payment_response->get_redirect();
162
163		if ( null !== $redirect ) {
164		$payment->set_action_url( $redirect->get_url() );
165		}
166		}
167
168		/*
169		* SDK Integration
170		*
171		* @link https://docs.adyen.com/api-explorer/#/PaymentSetupAndVerificationService/v41/paymentSession
172		*/
173		$payment_session_request = new PaymentSessionRequest(
174		$amount,
175		$this->config->get_merchant_account(),
176		strval( $payment->get_id() ),
177		$payment->get_return_url(),
178		$country_code
179		);
180
181		PaymentRequestHelper::complement( $payment, $payment_session_request );
182
183		$payment_session_request->set_origin( home_url() );
184		$payment_session_request->set_sdk_version( self::SDK_VERSION );
185
186		if ( null !== $payment_method_type ) {
187		$payment_session_request->set_allowed_payment_methods( array( $payment_method_type ) );
188		}
189
190		$payment_session_response = $this->client->create_payment_session( $payment_session_request );
191
192		$payment->set_meta( 'adyen_sdk_version', self::SDK_VERSION );
193		$payment->set_meta( 'adyen_payment_session', $payment_session_response->get_payment_session() );
194
195		$payment->set_action_url( $payment->get_pay_redirect_url() );
196		}
197
198		/**
199		* Payment redirect.
200		*
201		* @param Payment $payment Payment.
202		*
203		* @return void
204		*/
205		public function payment_redirect( Payment $payment ) {
206		$sdk_version = $payment->get_meta( 'adyen_sdk_version' );
207		$payment_session = $payment->get_meta( 'adyen_payment_session' );
208
209		if ( empty( $sdk_version ) \|\| empty( $payment_session ) ) {
210		return;
211		}
212
213		$url = sprintf(
214		'https://checkoutshopper-%s.adyen.com/checkoutshopper/assets/js/sdk/checkoutSDK.%s.min.js',
215		( self::MODE_TEST === $payment->get_mode() ? 'test' : 'live' ),
216		$sdk_version
217		);
218
219		wp_register_script(
220		'pronamic-pay-adyen-checkout',
221		$url,
222		array(
223		'jquery',
224		),
225		$sdk_version,
226		false
227		);
228
229		wp_localize_script(
230		'pronamic-pay-adyen-checkout',
231		'pronamicPayAdyenCheckout',
232		array(
233		'paymentsResultUrl' => rest_url( Integration::REST_ROUTE_NAMESPACE . '/payments/result/' . $payment->config_id ),
234		'paymentReturnUrl' => $payment->get_return_url(),
235		'paymentSession' => $payment_session,
236		'configObject' => array(
237		'context' => ( self::MODE_TEST === $payment->get_mode() ? 'test' : 'live' ),
238		),
239		)
240		);
241
242		// No cache.
243		Core_Util::no_cache();
244
245		require __DIR__ . '/../views/checkout.php';
246
247		exit;
248		}
249
250		/**
251		* Update status of the specified payment.
252		*
253		* @param Payment $payment Payment.
254		*
255		* @return void
256		*/
257		public function update_status( Payment $payment ) {
258		// Process payload on return.
259		if ( ! filter_has_var( INPUT_GET, 'payload' ) ) {
260		return;
261		}
262
263		$payload = filter_input( INPUT_GET, 'payload', FILTER_SANITIZE_STRING );
264
265		$payment_result_request = new PaymentResultRequest( $payload );
266
267		try {
268		$payment_result_response = $this->client->get_payment_result( $payment_result_request );
269
270		PaymentResultHelper::update_payment( $payment, $payment_result_response );
271		} catch ( Exception $e ) {
272		$note = sprintf(
273		'%1$s %2$s',
274		__( 'Error getting payment result:', 'pronamic_ideal' ),
275		$e->getMessage()
276		);
277
278		$payment->add_note( $note );
279		}
280		}
281
282		/**
283		* Get available payment methods.
284		*
285		* @see Core_Gateway::get_available_payment_methods()
286		*/
287		public function get_available_payment_methods() {
288		$core_payment_methods = array();
289
290		try {
291		$payment_methods_response = $this->client->get_payment_methods();
292		} catch ( Exception $e ) {
293		$this->error = new WP_Error( 'adyen_error', $e->getMessage() );
294
295		return $core_payment_methods;
296		}
297
298		foreach ( $payment_methods_response->get_payment_methods() as $payment_method ) {
299		$core_payment_method = PaymentMethodType::to_wp( $payment_method->get_type() );
300
301		$core_payment_methods[] = $core_payment_method;
302		}
303
304		$core_payment_methods = array_filter( $core_payment_methods );
305		$core_payment_methods = array_unique( $core_payment_methods );
306
307		return $core_payment_methods;
308		}
309
310		/**
311		* Get issuers.
312		*
313		* @see Pronamic_WP_Pay_Gateway::get_issuers()
314		* @return array
315		*/
316		public function get_issuers() {
317		$issuers = array();
318
319		try {
320		$payment_methods_response = $this->client->get_payment_methods();
321		} catch ( Exception $e ) {
322		$this->error = new WP_Error( 'adyen_error', $e->getMessage() );
323
324		return $issuers;
325		}
326
327		$payment_methods = $payment_methods_response->get_payment_methods();
328
329		// Limit to iDEAL payment methods.
330		$payment_methods = array_filter(
331		$payment_methods,
332		/**
333		* Check if payment method is iDEAL.
334		*
335		* @param PaymentMethod $payment_method Payment method.
336		* @return boolean True if payment method is iDEAL, false otherwise.
337		*/
338		function( $payment_method ) {
339		return ( PaymentMethodType::IDEAL === $payment_method->get_type() );
340		}
341		);
342
343		foreach ( $payment_methods as $payment_method ) {
344		$details = $payment_method->get_details();
345
346		if ( is_array( $details ) ) {
347		foreach ( $details as $detail ) {
348		if ( 'issuer' === $detail->key && 'select' === $detail->type ) {
349		foreach ( $detail->items as $item ) {
350		$issuers[ $item->id ] = $item->name;
351		}
352		}
353		}
354		}
355		}
356
357		if ( empty( $issuers ) ) {
358		return $issuers;
359		}
360
361		return array(
362		array(
363		'options' => $issuers,
364		),
365		);
366		}
367		}
368

wp-pay-gateways / adyen

Push — develop ( b1970e...b17856 )

Gateway::get_available_payment_methods() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like