wp-pay-gateways / ing-kassa-compleet

src/Client.php

<?php
/**
 * Client.
 *
 * @author    Pronamic <info@pronamic.eu>
 * @copyright 2005-2019 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Pay\Gateways\ING\KassaCompleet
 */

namespace Pronamic\WordPress\Pay\Gateways\ING\KassaCompleet;

use Pronamic\WordPress\Pay\Core\XML\Security;
use WP_Error;

/**
 * Title: ING Kassa Compleet client
 * Description:
 * Copyright: 2005-2019 Pronamic
 * Company: Pronamic
 *
 * @author  Reüel van der Steege
 * @version 2.0.0
 * @since   1.0.0
 */
class Client {
	/**
	 * ING Kasse Compleet API endpoint URL
	 *
	 * @var string url
	 */
	const API_URL = 'https://api.kassacompleet.nl/v1/';

	/**
	 * API Key
	 *
	 * @var string
	 */
	private $api_key;

	/**
	 * Error
	 *
	 * @var WP_Error
	 */
	private $error;

	/**
	 * Constructs and initalize an ING Kassa Compleet client object
	 *
	 * @param string $api_key API key.
	 */
	public function __construct( $api_key ) {
		$this->api_key = $api_key;
	}

	/**
	 * Error
	 *
	 * @return WP_Error
	 */
	public function get_error() {
		return $this->error;
	}

	/**
	 * Send request with the specified action and parameters
	 *
	 * @param string $endpoint API endpoint.
	 * @param string $method   HTTP method to use for request.
	 * @param array  $data     Data to send.
	 *
	 * @return array|WP_Error
	 */
	private function send_request( $endpoint, $method = 'POST', array $data = array() ) {
		$url = self::API_URL . $endpoint;

		$headers = array(
			'Authorization' => 'Basic ' . base64_encode( $this->api_key . ':' ),
		);

		if ( is_array( $data ) && ! empty( $data ) ) {
			$data = wp_json_encode( $data );

			$headers['Content-Type'] = 'application/json';
		}

		$return = wp_remote_request(
			$url,
			array(
				'method'  => $method,
				'headers' => $headers,
				'body'    => $data,
			)
		);

		return $return;
	}

	/**
	 * Create order.
	 *
	 * @param OrderRequest $request Order request.
	 *
	 * @return array|mixed|object|null
	 */
	public function create_order( OrderRequest $request ) {
		$result = null;

		$data = $request->get_array();

		$response = $this->send_request( 'orders/', 'POST', $data );

		if ( is_wp_error( $response ) ) {
			$this->error = $response;

It seems like $response can also be of type array. However, the property $error is declared as type WP_Error. Maybe add an additional type check?

			return $result;
		}

		$response_code = wp_remote_retrieve_response_code( $response );

It seems like $response can also be of type WP_Error; however, parameter $response of wp_remote_retrieve_response_code() does only seem to accept array, maybe add an additional type check?

		$body = wp_remote_retrieve_body( $response );

It seems like $response can also be of type WP_Error; however, parameter $response of wp_remote_retrieve_body() does only seem to accept array, maybe add an additional type check?

		// NULL is returned if the json cannot be decoded or if the encoded data is deeper than the recursion limit.
		$ing_result = json_decode( $body );

		if ( 201 === $response_code ) {
			if ( $ing_result && 'error' === $ing_result->status ) {
				$error_msg = $ing_result->transactions[0]->reason;
				$error     = $ing_result->transactions[0];
			} else {
				$result = $ing_result;
			}
		} else {
			$error_msg = '';
			$error     = '';

			if ( $ing_result ) {
				$error_msg = $ing_result->error->value;
				$error     = $ing_result->error;
			}

			if ( 401 === $response_code ) {
				// The default error message for an unauthorized API call does not mention the API key in any way.
				$error_msg .= ' Please check the API key.';
			}
		}

		if ( isset( $error_msg, $error ) ) {
			$this->error = new WP_Error( 'ing_kassa_compleet_error', $error_msg, $error );
		}

		return $result;
	}

	/**
	 * Get order.
	 *
	 * @param string $order_id Order ID.
	 *
	 * @return array|mixed|object|null
	 */
	public function get_order( $order_id ) {
		$result = null;

		$response = $this->send_request( 'orders/' . $order_id . '/', 'GET' );

		if ( is_wp_error( $response ) ) {
			$this->error = $response;

It seems like $response can also be of type array. However, the property $error is declared as type WP_Error. Maybe add an additional type check?

			return $result;
		}

		$response_code = wp_remote_retrieve_response_code( $response );

It seems like $response can also be of type WP_Error; however, parameter $response of wp_remote_retrieve_response_code() does only seem to accept array, maybe add an additional type check?

		if ( 200 === $response_code ) {
			$body = wp_remote_retrieve_body( $response );

It seems like $response can also be of type WP_Error; however, parameter $response of wp_remote_retrieve_body() does only seem to accept array, maybe add an additional type check?

			// NULL is returned if the json cannot be decoded or if the encoded data is deeper than the recursion limit.
			$result = json_decode( $body );
		}

		return $result;
	}

	/**
	 * Get issuers.
	 *
	 * @return array|bool
	 */
	public function get_issuers() {
		$issuers = false;

		$response = $this->send_request( 'ideal/issuers/', 'GET' );

		if ( is_wp_error( $response ) ) {
			$this->error = $response;

It seems like $response can also be of type array. However, the property $error is declared as type WP_Error. Maybe add an additional type check?

			return $issuers;
		}

		$response_code = wp_remote_retrieve_response_code( $response );

It seems like $response can also be of type WP_Error; however, parameter $response of wp_remote_retrieve_response_code() does only seem to accept array, maybe add an additional type check?

		if ( 200 === $response_code ) {
			$body = wp_remote_retrieve_body( $response );

It seems like $response can also be of type WP_Error; however, parameter $response of wp_remote_retrieve_body() does only seem to accept array, maybe add an additional type check?

			// NULL is returned if the json cannot be decoded or if the encoded data is deeper than the recursion limit.
			$result = json_decode( $body );

			if ( null !== $result ) {
				$issuers = array();

				foreach ( $result as $issuer ) {
					$id   = Security::filter( $issuer->id );
					$name = Security::filter( $issuer->name );

					$issuers[ $id ] = $name;
				}
			}
		} else {
			$body = wp_remote_retrieve_body( $response );

			$ing_result = json_decode( $body );

			$error_msg = $ing_result->error->value;

			if ( 401 === $response_code ) {
				// An unauthorized API call has nothing to do with the browser of the user in our case, remove to prevent confusion.
				$error_msg = str_replace( "You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.", '', $error_msg );

				// The default error message for an unauthorized API call does not mention the API key in any way.
				$error_msg .= ' Please check the API key.';
			}

			$this->error = new WP_Error( 'ing_kassa_compleet_error', $error_msg, $ing_result->error );
		}

		return $issuers;
	}
}