TestCuTdApi.php

<?php

use PHPUnit\Framework\TestCase;

/**
 * Unit test for the cutd_list() api. cutd_list() allows usage of a single trusted ID
 * or an array of trusted id's, other functions accessing it nuke/ don't use the
 * input of $_POST['trustedids'].
 *
 * ************************* NOTE TO TEST LIVE CONNECTION  **************************
 * This will require one modification: your HCUticket cookie for www4. The HCUticket
 * value can be obtained by viewing your logged in cookies in the browser or doing
 * a D & D of $_COOKIE somewhere (after logging into www4.) Place the resulting
 * value in the "your_cookie" property below.
 * **********************************************************************************
 */
class TestCuTdApi extends TestCase
{
  /**
   * @var string to test the actual curl connection, log in to www4 and get your
   * HCUticket cookie value from your browser. All tests fail without it.
   */
  protected $your_cookie = '';

  /**
   * @var string Only use to test live curl connection. Can be changed to your local
   * docker IP if you like.
   */
  protected $url = 'http://www4.homecu.net/hcuadm/CuVendorListApi.prg';

  /**
   * Test API, single trust ID, empty Cu.
   * @return void
   */
  public function test_has_results_with_single_trust_id_and_empty_cu()
  {
    $post  = [
      'Cu' => '',
      'trustedid' => 'IPAY_V3'
    ];
    // Use this to actually post.
    //$this->runAssertions($post);

    $result = $this->singleTrustIdEmptyCuResult();
    $this->assertArrayHasKey('status', $result);
    $this->assertArrayHasKey('data', $result);
  }

  /**
   * Test API, single trust ID and SCRUBCU.
   * @return void
   */
  public function test_has_results_with_single_trust_id_and_has_cu()
  {
    $post  = [
      'Cu' => 'SCRUBCU',
      'trustedid' => 'IPAY_V3'
    ];
    // Use this to actually post.
    //$this->runAssertions($post);

    $result = $this->singleTrustIdScrubCuResult();
    $this->assertArrayHasKey('status', $result);
    $this->assertArrayHasKey('data', $result);
  }

  /**
   * Test API, array of ID's, empty Cu.
   * @return void
   */
  public function test_has_results_with_array_of_trust_ids_and_empty_cu()
  {
    $post  = [
      'Cu' => '',
      'trustedids' => json_encode([
        'abeAI', 'ACCSOFT', 'ALLIEDPAY_SSO', 'MWI_LOANPAY', 'BDI', 'RDCBluepoint', 'RDCTranzCap', 'CERTEGY',
        'RDCCheckAlt', 'CHKFREE', 'CUDIRECT_SSO', 'DELUXE_OP', 'Bit', 'Digital', 'DMI', 'HcuDMI', 'MemberPay',
        'RDCENSENTA', 'ENSENTA_BRDC', 'FICS', 'HcuEZCARD', 'FIS_EZCARD', 'FISERV_CPS', 'RDCTest', 'FWDTranzCap',
        'MBLPAY_TEST', 'hcuLoanApp', 'HcuMIR', 'HOMECUSERVICE', 'HcuCheckImages', 'IDS_ES', 'IPAY', 'IPAYMBL',
        'IPAY_V3', 'IPAYBPS', 'IPAYAPP', 'IPAYTEST', 'LASERPRINT_ES', 'LASERTEC_ES', 'MDesk3', 'MDesk',
        'PAYVERIS', 'PAYZUR_SSO', 'PSCUPAY_SSO', 'PSCUPAY_API', 'PSCUINFO', 'PSCU_ACCPT', 'SavvyMo_SSO',
        'ThinkDigital', 'RDCDigiliti', 'GOTOMYCARD', 'RDCVsoft', 'VSOFT', 'WebShare', 'MeridianLink'
      ])
    ];

    // Use this to actually post.
    //$this->runAssertions($post);

    $result = $this->trustIdArrayNoCu();
    $this->assertArrayHasKey('status', $result);
    $this->assertArrayHasKey('data', $result);
  }

  /**
   * Test API, array of ID's, SCRUBCU.
   * @return void
   */
  public function test_test_has_results_with_single_trust_id_and_has_cu()
  {
    $post  = [
      'Cu' => 'SCRUBCU',
      'trustedids' => json_encode([
        'abeAI', 'ACCSOFT', 'ALLIEDPAY_SSO', 'MWI_LOANPAY', 'BDI', 'RDCBluepoint', 'RDCTranzCap', 'CERTEGY',
        'RDCCheckAlt', 'CHKFREE', 'CUDIRECT_SSO', 'DELUXE_OP', 'Bit', 'Digital', 'DMI', 'HcuDMI', 'MemberPay',
        'RDCENSENTA', 'ENSENTA_BRDC', 'FICS', 'HcuEZCARD', 'FIS_EZCARD', 'FISERV_CPS', 'RDCTest', 'FWDTranzCap',
        'MBLPAY_TEST', 'hcuLoanApp', 'HcuMIR', 'HOMECUSERVICE', 'HcuCheckImages', 'IDS_ES', 'IPAY', 'IPAYMBL',
        'IPAY_V3', 'IPAYBPS', 'IPAYAPP', 'IPAYTEST', 'LASERPRINT_ES', 'LASERTEC_ES', 'MDesk3', 'MDesk',
        'PAYVERIS', 'PAYZUR_SSO', 'PSCUPAY_SSO', 'PSCUPAY_API', 'PSCUINFO', 'PSCU_ACCPT', 'SavvyMo_SSO',
        'ThinkDigital', 'RDCDigiliti', 'GOTOMYCARD', 'RDCVsoft', 'VSOFT', 'WebShare', 'MeridianLink'
      ])
    ];

    // Use this to actually post.
    //$this->runAssertions($post);

    $result = $this->trustIdArrayNoCu();
    $this->assertArrayHasKey('status', $result);
    $this->assertArrayHasKey('data', $result);
  }

  /**
   * Common to all live tests, run assertions that check if we have an array with status and data members.
   * @param array $post
   * @return void
   */
  protected function runAssertions($post)
  {
    $result = $this->postToUrl($post);
    $this->assertArrayHasKey('status', $result);
    $this->assertArrayHasKey('data', $result);
  }

  /**
   * Mock the response received from a live curl call, single trust ID, no CU.
   * @return array
   */
  protected function singleTrustIdEmptyCuResult()
  {
    return [
      'status' => [
        'Response' => true,
        'Message' => 'OK',
        'Errors' => []
      ],
      'data' => [
        'SCRUBCU|IPAY_V3]' => [
          'cu' => 'SCRUBCU',
          'trustedid' => 'IPAY_V3',
          'fields' =>  []
        ],
        'CRUISECU|IPAY_V3]' => [
          'cu' => 'CRUISECU',
          'trustedid' => 'IPAY_V3',
          'fields' =>  []
        ]
      ]
    ];
  }

  /**
   * Mock the response received from a live curl call, single trust ID, SCRUBCU.
   * @return array
   */
  protected function singleTrustIdScrubCuResult()
  {
    return [
      'status' => [
        'Response' => true,
        'Message' => 'OK',
        'Errors' => []
      ],
      'data' => [
        'SCRUBCU|IPAY_V3]' => [
          'cu' => 'SCRUBCU',
          'trustedid' => 'IPAY_V3',
          'fields' =>  []
        ]
      ]
    ];
  }

  /**
   * Mock the response with array of trusted ID's and no CU specified.
   * This is a shortened version of the actual return array you'll get.
   * @return array
   */
  protected function trustIdArrayNoCu()
  {
    return [
      'status' => [
        'Response' => true,
        'Message' => 'OK',
        'Errors' => []
      ],
      'data' => [
        'SCRUBCU|ACCSOFT' => [
          'cu' => 'SCRUBCU',
          'trustedid' => 'CCSOFT',
          'fields' => [
            'privateKey' => '',
            'sharedKey' => '',
          ]
        ],
        'SCRUBCU|CERTEGY' => [
          'cu' => 'SCRUBCU',
          'trustedid' => 'CERTEGY',
          'fields' => [
            'FIID' => '0006',
            'ACCOUNT' => '',
            'pilotURL' => 'https://bp01.premierbillpay.com/servlet/tpservlet',
            'certegyKey' => '8Pqb@NZ&!JH%g89Fql0m12P$',
            'pilotKey' => 'pO_cI0m&asoagia4lec#uHI8',
            'certegyURL' => 'https://sso-redirector.ezbills.com/mvsso/servlet/tpservlet',
            'pilot' => 0,
            'hcuLogging' => 0
          ]
        ],
        'CRUISECU|IPAY_V3]' => [
          'cu' => 'CRUISECU',
          'trustedid' => 'IPAY_V3',
          'fields' =>  []
        ]
      ]
    ];
  }

  /**
   * Mock the response with an array of trusted ID's and SCRUBCU specified.
   * This is a shortened version of the actual return array you'll get.
   * @return array
   */
  protected function trustIdArrayScrubCu()
  {
    return [
      'status' => [
        'Response' => true,
        'Message' => 'OK',
        'Errors' => []
      ],
      'data' => [
        'SCRUBCU|ACCSOFT' => [
          'cu' => 'SCRUBCU',
          'trustedid' => 'CCSOFT',
          'fields' => [
            'privateKey' => '',
            'sharedKey' => '',
          ]
        ],
        'SCRUBCU|CERTEGY' => [
          'cu' => 'SCRUBCU',
          'trustedid' => 'CERTEGY',
          'fields' => [
            'FIID' => '0006',
            'ACCOUNT' => '',
            'pilotURL' => 'https://bp01.premierbillpay.com/servlet/tpservlet',
            'certegyKey' => '8Pqb@NZ&!JH%g89Fql0m12P$',
            'pilotKey' => 'pO_cI0m&asoagia4lec#uHI8',
            'certegyURL' => 'https://sso-redirector.ezbills.com/mvsso/servlet/tpservlet',
            'pilot' => 0,
            'hcuLogging' => 0
          ]
        ]
      ]
    ];
  }

  /**
   * Basic native curl call for tests. Use only yo test live, do not leave calls in unit test.
   * @param array [Cu => string optional, trustid => string optional, trustids => string (JSON encoded array), optional]
   * @return array
   */
  protected function postToUrl($post)
  {
    $params = http_build_query($post);

    $curlcookies = "HCUTicket={$this->your_cookie};";

    $ch = curl_init($this->url);
    curl_setopt($ch,CURLOPT_COOKIE, $curlcookies);
    curl_setopt($ch,CURLOPT_USERPWD,"nobody:no1home");
    curl_setopt($ch,CURLOPT_RETURNTRANSFER,1);
    curl_setopt($ch,CURLOPT_POST, true);
    curl_setopt($ch,CURLOPT_POSTFIELDS, $params);
    //curl_setopt($ch, CURLOPT_VERBOSE, true);

    $rawresp = curl_exec($ch);

    return json_decode($rawresp, true);
  }

}