PayumTW\Mypay\Api

Complexity

Total Complexity

21

Size/Duplication

Total Lines	315
Duplicated Lines	11.11 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

97.37%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	getApiEndpoint()	0	4	2
C	createTransaction()	0	123	9
A	getTransactionData()	0	16	1
A	refundTransaction()	18	18	1
A	cancelTransaction()	17	17	1
A	verifyHash()	0	4	1
A	doRequest()	0	21	4

<?php

namespace PayumTW\Mypay;

use LogicException;
use Http\Message\MessageFactory;
use Payum\Core\HttpClientInterface;
use Payum\Core\Exception\Http\HttpException;

class Api
{
    const NOTIFY_TOKEN_FIELD = 'echo_4';

    // 1  CREDITCARD  信用卡
    const CREDITCARD = 'CREDITCARD';
    // 2  RECHARGE  儲值卡
    const RECHARGE = 'RECHARGE';
    // 3  CSTORECODE  超商代碼
    const CSTORECODE = 'CSTORECODE';
    // 4  WEBATM  WEBATM
    const WEBATM = 'WEBATM';
    // 5  TELECOM  電信小額
    const TELECOM = 'TELECOM';
    // 6  E_COLLECTION  虛擬帳號
    const E_COLLECTION = 'E_COLLECTION';
    // 7  UNIONPAY  銀聯卡
    const UNIONPAY = 'UNIONPAY';
    // 8  SVC  點數卡
    const SVC = 'SVC';
    // 9  ABROAD  海外信用卡
    const ABROAD = 'ABROAD';
    // 10  ALIPAY  支付寶
    const ALIPAY = 'ALIPAY';
    // 11  SMARTPAY  Smart Pay
    const SMARTPAY = 'SMARTPAY';

    /**
     * @var \Payum\Core\HttpClientInterface
     */
    protected $client;

    /**
     * @var \Http\Message\MessageFactory
     */
    protected $messageFactory;

    /**
     * @var array
     */
    protected $options = [];

    /**
     * $encrypter.
     *
     * @var Encrypter
     */
    protected $encrypter;

    /**
     * @param array $options
     * @param \Payum\Core\HttpClientInterface $client
     * @param \Http\Message\MessageFactory $messageFactory
     * @param Encrypter $encrypter
     *
     * @throws \Payum\Core\Exception\InvalidArgumentException if an option is invalid
     */
    public function __construct(array $options, HttpClientInterface $client, MessageFactory $messageFactory, Encrypter $encrypter = null)
    {
        $this->options = $options;
        $this->client = $client;
        $this->messageFactory = $messageFactory;
        $this->encrypter = $encrypter ?: new Encrypter($this->options['key']);
    }

    /**
     * getApiEndpoint.
     *
     * @return string
     */
    public function getApiEndpoint()
    {
        return $this->options['sandbox'] === false ? 'https://mypay.tw/api/init' : 'https://pay.usecase.cc/api/init';
    }

    /**
     * createTransaction.
     *
     * @param array $params
     * @return array
     */
    public function createTransaction(array $params)
    {
        $supportedParams = [
            // 次特店商務代號  必要  必要
            'store_uid' => $this->options['store_uid'],
            // 消費者帳號(請代入於貴特店中該消費者登記的帳號)  必要  必要
            'user_id' => null,
            // 消費者姓名(請代入於貴特店中該消費者登記的名稱)
            'user_name' => null,
            // 消費者真實姓名
            'user_real_name' => null,
            // 消費者帳單地址
            'user_address' => null,
            // 消費者身份證字號
            'user_sn' => null,
            // 消費者家用電話(白天電話)
            'user_phone' => null,
            // 行動電話國碼(預設886)​
            'user_cellphone_code' => '886',
            // 消費者行動電話
            'user_cellphone' => null,
            // 消費者 E­Mail
            'user_email' => null,
            // 消費者生日(格式為 YYYYMMDD，如 20090916)
            'user_birthday' => null,
            // 訂單總金額(如為定期定額付費，此為一期的金額) = 物品 之總價加總 ­ 折價  必要  必要
            'cost' => null,
            // 預設交易幣別
            'currency' => 'TWD',
            // 訂單編號(訂單編號建議不要重覆)  必要  必要
            'order_id' => null,
            // 消費者來源 IP  必要  必要
            'ip' => $this->options['ip'],
            // 訂單內物品數  必要
            'item' => null,
            /*
             * 定期定額付費，期數單位：
             * W 為每週定期一次扣款；
             * M 為每月定期一次扣款；
             * S 為每季定期
             * 一次扣款。如未使用到定期定額付費，不需傳此參數
             */
            'regular' => null,
            // 總期數(如為 12 期即代入 12，如果為不限期數，請代入  0，如非定期定額付費，不需傳此參數
            'regular_total' => null,
            // 1.定期定額式付費編號 2.定期分期式付費編號
            'group_id' => null,
            // 票券總產生張數
            'voucher_total_count' => null,
            // 物品總金額
            'voucher_total_price ' => null,
            // 票券物品數
            'voucher_item' => null,
            // 預選付費方法，如 pfn=CREDITCARD 即為信用卡付 費。多種類型可用逗號隔開，其他參數請參照附錄一。  必要  必要
            'pfn' => static::CREDITCARD,
            // 交易成功後的轉址(若動態網址可以使用此方式傳遞)
            'success_returl' => null,
            // 交易失敗後的轉址(若動態網址可以使用此方式傳遞)
            'failure_returl' => null,
            // 折價(​數值帶負數​)
            'discount' => null,
            // 當pfn=CSTORECODE或 E_COLLECTION時，此為自訂有效使 用天數，否則以系統設定為預設有效天數
            'limit_pay_days' => null,
            // 運費,
            'shipping_fee' => null,
            // 啟用快速結帳
            'enable_quickpay' => 1,
            // 啟用電子錢包
            'enable_ewallet' => 0,
            // 消費者完成電子錢包卡號綁定後 ，直接使用本參數，系統會自動 從綁定卡號扣款 若使用本參數，pfn將自動限制為 信用卡與海外信用卡兩種交易(虛 擬卡號在消費者啟用電子錢包時 ，會背景告知相關資訊，
            'virtual_pan' => null,
            // 1.支付頁面模式，mypay顯示結果 (預設) 2.背景發動扣款(直接回傳交易回 報參數)
            'ewallet_type' => 1,
            // 定期扣款起扣日(若未指定日期， 或小於今日則將判為當日扣)
            'regular_first_charge_date' => null,
            // 1網路交易(預設)/2實體交易
            'transaction_type' => null,
            // 國內信用卡分期限定顯示期數(且必須服務商與 支付頁面設定有支援)
            'creditcard_installment' => null,
            // 無卡支付商品名稱代碼
            'cardless_code' => null,
            // 1: 應稅 2:零稅率 3: 免稅
            'invoice_ratetype' => null,
        ];

        $supportedItemParams = ['id', 'name', 'cost', 'amount'];
        if (isset($params['items']) === true) {
            $params['item'] = count($params['items']);
            $total = 0;
            foreach ($params['items'] as $key => $item) {
                if (empty($item['cost']) === true) {
                    $item['cost'] = $item['price'];
                }
                if (empty($item['amount']) === true) {
                    $item['amount'] = $item['quantity'];
                }
                foreach ($supportedItemParams as $name) {
                    $params['i_'.$key.'_'.$name] = $item[$name];
                }
                $params['i_'.$key.'_total'] = $item['cost'] * $item['amount'];
                $total += $params['i_'.$key.'_total'];
            }
            if (empty($params['cost'])) {
                $params['cost'] = $total;
            }
        }

        // 將 i_,v_,echo_ 開頭加入 $supportedParams
        foreach ($params as $key => $value) {
            if (preg_match('/(i|v|echo)_\d+/', $key)) {
                $supportedParams[$key] = null;
            }
        }

        $params = array_filter(array_replace(
            $supportedParams,
            array_intersect_key($params, $supportedParams)
        ));

        return $this->doRequest(
            $this->encrypter->encryptRequest($this->options['store_uid'], $params, 'api/orders')
        );
    }

    /**
     * getTransactionData.
     *
     * @param array $params
     * @return array
     */
    public function getTransactionData(array $params)
    {
        $supportedParams = [
            'uid' => null,
            'key' => null,
        ];

        $params = array_filter(array_replace(
            $supportedParams,
            array_intersect_key($params, $supportedParams)
        ));

        return $this->doRequest(
            $this->encrypter->encryptRequest($this->options['store_uid'], $params, 'api/queryorder')
        );
    }

    /**
     * refundTransaction.
     *
     * @param array $params
     * @return array
     */
    public function refundTransaction(array $params)

This method seems to be duplicated in your project.

    {
        $supportedParams = [
            'store_uid' => $this->options['store_uid'],
            'uid' => null,
            'key' => null,
            'cost' => null,
        ];

        $params = array_filter(array_replace(
            $supportedParams,
            array_intersect_key($params, $supportedParams)
        ));

        return $this->doRequest(
            $this->encrypter->encryptRequest($this->options['store_uid'], $params, 'api/refund')
        );
    }

    /**
     * cancelTransaction.
     *
     * @param array $params
     * @return array
     */
    public function cancelTransaction(array $params)

This method seems to be duplicated in your project.

    {
        $supportedParams = [
            'store_uid' => $this->options['store_uid'],
            'uid' => null,
            'key' => null,
        ];

        $params = array_filter(array_replace(
            $supportedParams,
            array_intersect_key($params, $supportedParams)
        ));

        return $this->doRequest(
            $this->encrypter->encryptRequest($this->options['store_uid'], $params, 'api/refundcancel')
        );
    }

    /**
     * verifyHash.
     *
     * @param array $params
     * @param array $details
     * @return bool
     */
    public function verifyHash(array $params, $details)
    {
        return $params['key'] === $details['key'];
    }

    /**
     * @param array $fields
     * @return array
     */
    protected function doRequest(array $fields)
    {
        $request = $this->messageFactory->createRequest('POST', $this->getApiEndpoint(), [
            'Content-Type' => 'application/x-www-form-urlencoded',
        ], http_build_query($fields));

        $response = $this->client->send($request);

        $statusCode = $response->getStatusCode();
        if (false === ($statusCode >= 200 && $statusCode < 300)) {
            throw HttpException::factory($request, $response);
        }

        $body = $response->getBody()->getContents();
        $content = json_decode($body, true);
        if (null === $content) {
            throw new LogicException("Response content is not valid json: \n\n{$body}");
        }

        return $content;
    }
}