tests/phpunit/api/v3/PledgePaymentTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 require_once 'CiviTest/CiviUnitTestCase.php';
  29
  30 /**
  31  * Test class for Pledge API - civicrm_pledge_*
  32  *
  33  * @package CiviCRM_APIv3
  34  */
  35 class api_v3_PledgePaymentTest extends CiviUnitTestCase {
  36
  37   /**
  38    * Assume empty database with just civicrm_data.
  39    */
  40   protected $_individualId;
  41   protected $_pledgeID;
  42   protected $_apiversion = 3;
  43   protected $_contributionID;
  44   protected $_financialTypeId = 1;
  45   protected $_entity = 'PledgePayment';
  46   public $DBResetRequired = TRUE;
  47
  48   public function setUp() {
  49     parent::setUp();
  50     $this->_individualId = $this->individualCreate();
  51     $this->_pledgeID = $this->pledgeCreate($this->_individualId);
  52     $this->_contributionID = $this->contributionCreate(array('contact_id' => $this->_individualId));
  53   }
  54
  55   public function tearDown() {
  56     $tablesToTruncate = array(
  57       'civicrm_contribution',
  58       'civicrm_contact',
  59       'civicrm_pledge',
  60       'civicrm_pledge_payment',
  61       'civicrm_line_item',
  62     );
  63
  64     $this->quickCleanup($tablesToTruncate);
  65   }
  66
  67   public function testGetPledgePayment() {
  68     $params = array();
  69     $result = $this->callAPIAndDocument('pledge_payment', 'get', $params, __FUNCTION__, __FILE__);
  70     $this->assertEquals(5, $result['count'], " in line " . __LINE__);
  71   }
  72
  73   /**
  74    * Test that passing in a single variable works.
  75    */
  76   public function testGetSinglePledgePayment() {
  77     $createparams = array(
  78       'contact_id' => $this->_individualId,
  79       'pledge_id' => $this->_pledgeID,
  80       'contribution_id' => $this->_contributionID,
  81       'status_id' => 1,
  82     );
  83     $createResult = $this->callAPISuccess('pledge_payment', 'create', $createparams);
  84     $params = array(
  85       'contribution_id' => $this->_contributionID,
  86     );
  87     $result = $this->callAPISuccess('pledge_payment', 'get', $params);
  88     $this->assertEquals(1, $result['count'], " in line " . __LINE__);
  89   }
  90
  91   /**
  92    * Test that passing in a single variable works:: status_id
  93    */
  94   public function testGetSinglePledgePaymentByStatusID() {
  95     $createparams = array(
  96       'contact_id' => $this->_individualId,
  97       'pledge_id' => $this->_pledgeID,
  98       'contribution_id' => $this->_contributionID,
  99       'status_id' => 1,
 100     );
 101     $createResult = $this->callAPISuccess('pledge_payment', 'create', $createparams);
 102     $params = array(
 103       'status_id' => 1,
 104     );
 105
 106     $result = $this->callAPISuccess('pledge_payment', 'get', $params);
 107     $this->assertEquals(1, $result['count'], " in line " . __LINE__);
 108   }
 109
 110   /**
 111    * Test that creating a payment will add the contribution ID.
 112    */
 113   public function testCreatePledgePayment() {
 114     //check that 5 pledge payments exist at the start
 115     $beforeAdd = $this->callAPISuccess('pledge_payment', 'get', array());
 116     $this->assertEquals(5, $beforeAdd['count'], " in line " . __LINE__);
 117
 118     //test the pledge_payment_create function
 119     $params = array(
 120       'contact_id' => $this->_individualId,
 121       'pledge_id' => $this->_pledgeID,
 122       'contribution_id' => $this->_contributionID,
 123       'status_id' => 1,
 124       'actual_amount' => 20,
 125     );
 126     $result = $this->callAPIAndDocument('pledge_payment', 'create', $params, __FUNCTION__, __FILE__);
 127
 128     //check existing updated not new one created - 'create' means add contribution_id in this context
 129     $afterAdd = $this->callAPISuccess('pledge_payment', 'get', array());
 130     $this->assertEquals(5, $afterAdd['count'], " in line " . __LINE__);
 131
 132     //get the created payment & check it out
 133     $getParams['id'] = $result['id'];
 134     $getIndPayment = $this->callAPISuccess('pledge_payment', 'get', $getParams);
 135     $this->assertEquals(1, $getIndPayment['count'], " in line " . __LINE__);
 136     $this->assertEquals(20, $getIndPayment['values'][$result['id']]['actual_amount'], " in line " . __LINE__);
 137
 138     //create a second pledge payment - need a contribution first &can't use the CiviUnitTest case function as invoice is hard-coded
 139     $contributionParams = array(
 140       'total_amount' => 20,
 141       'contact_id' => $this->_individualId,
 142       'financial_type_id' => $this->_financialTypeId,
 143     );
 144     $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
 145     $params['contribution_id'] = $contribution['id'];
 146
 147     $resultCont2 = $this->callAPISuccess('pledge_payment', 'create', $params);
 148     //make sure original is untouched & has not been updated
 149     $this->assertGreaterThan($result['id'], $resultCont2['id'], " in line " . __LINE__);
 150     $getIndPaymentAgain = $this->callAPISuccess('pledge_payment', 'get', $getParams);
 151     $this->assertEquals(1, $getIndPaymentAgain['count'], " in line " . __LINE__);
 152     $this->assertEquals($this->_contributionID, $getIndPaymentAgain['values'][$result['id']]['contribution_id'], " in line " . __LINE__);
 153   }
 154
 155   /**
 156    * Test checks behaviour when more payments are created than should be possible.
 157    */
 158   public function testCreatePledgePaymentAllCreated() {
 159     $params = array(
 160       'pledge_id' => $this->_pledgeID,
 161       'status_id' => 1,
 162     );
 163     // create one more pledge than there are spaces for
 164     $i = 0;
 165     while ($i <= 5) {
 166       $contributionParams = array(
 167         'total_amount' => 20,
 168         'contact_id' => $this->_individualId,
 169         'financial_type_id' => $this->_financialTypeId,
 170       );
 171       $contribution = $this->callAPISuccess('contribution', 'create', $contributionParams);
 172
 173       $params['contribution_id'] = $contribution['id'];
 174
 175       $resultCont2 = civicrm_api('pledge_payment', 'create', $params + array('version' => $this->_apiversion));
 176       $i++;
 177     }
 178     // check that only 5 exist & we got an error setting the 6th
 179     $result = $this->callAPISuccess('PledgePayment', 'Get', array(
 180       'pledge_id' => $this->_pledgeID,
 181     ));
 182     // the last one above should result in an error
 183     $this->assertEquals("There are no unmatched payment on this pledge. Pass in the pledge_payment id to specify one or 'option.create_new' to create one", $resultCont2['error_message']);
 184     $this->assertEquals(5, $result['count']);
 185
 186     $params['option.create_new'] = 1;
 187     $params['scheduled_amount'] = 20;
 188     $params['scheduled_date'] = '20131212';
 189     $resultcreatenew = $this->callAPISuccess('pledge_payment', 'create', $params);
 190     $result = $this->callAPISuccess('PledgePayment', 'Get', array(
 191       'pledge_id' => $this->_pledgeID,
 192     ));
 193
 194     $this->assertEquals(6, $result['count']);
 195   }
 196
 197   /**
 198    * Test that creating a payment adds the contribution ID where only one pledge payment is in schedule.
 199    */
 200   public function testCreatePledgePaymentWhereOnlyOnePayment() {
 201     $pledgeParams = array(
 202       'contact_id' => $this->_individualId,
 203       'pledge_create_date' => date('Ymd'),
 204       'start_date' => date('Ymd'),
 205       'scheduled_date' => 'first day 2015',
 206       'pledge_amount' => 100.00,
 207       'pledge_status_id' => '2',
 208       'pledge_financial_type_id' => '1',
 209       'pledge_original_installment_amount' => 20,
 210       'frequency_interval' => 5,
 211       'frequency_unit' => 'year',
 212       'frequency_day' => 15,
 213       'installments' => 1,
 214       'sequential' => 1,
 215     );
 216
 217     $contributionID = $this->contributionCreate(array(
 218       'contact_id' => $this->_individualId,
 219       'financial_type_id' => $this->_financialTypeId,
 220       'invoice_id' => 45,
 221       'trxn_id' => 45,
 222     ));
 223     $pledge = $this->callAPISuccess('Pledge', 'Create', $pledgeParams);
 224
 225     //test the pledge_payment_create function
 226     $params = array(
 227       'contact_id' => $this->_individualId,
 228       'pledge_id' => $pledge['id'],
 229       'contribution_id' => $contributionID,
 230       'status_id' => 1,
 231       'actual_amount' => 20,
 232     );
 233     $result = $this->callAPISuccess('pledge_payment', 'create', $params);
 234
 235     //check existing updated not new one created - 'create' means add contribution_id in this context
 236     $afterAdd = $this->callAPISuccess('pledge_payment', 'get', array(
 237       'contribution_id' => $contributionID,
 238     ));
 239     $this->assertEquals(1, $afterAdd['count'], " in line " . __LINE__);
 240   }
 241
 242   public function testUpdatePledgePayment() {
 243     $params = array(
 244       'pledge_id' => $this->_pledgeID,
 245       'contribution_id' => $this->_contributionID,
 246       'status_id' => 2,
 247       'actual_amount' => 20,
 248     );
 249     $result = $this->callAPISuccess('pledge_payment', 'create', $params);
 250     $updateparams = array(
 251       'id' => $result['id'],
 252       'status_id' => 1,
 253     );
 254
 255     $result = $this->callAPIAndDocument('pledge_payment', 'update', $updateparams, __FUNCTION__, __FILE__);
 256     $this->getAndCheck(array_merge($params, $updateparams), $result['id'], $this->_entity);
 257   }
 258
 259   public function testDeletePledgePayment() {
 260     $params = array(
 261       'contact_id' => $this->_individualId,
 262       'pledge_id' => $this->_pledgeID,
 263       'contribution_id' => $this->_contributionID,
 264       'status_id' => 1,
 265       'sequential' => 1,
 266       'actual_amount' => 20,
 267     );
 268     $pledgePayment = $this->callAPISuccess('pledge_payment', 'create', $params);
 269
 270     $deleteParams = array(
 271       'id' => $pledgePayment['id'],
 272     );
 273     $result = $this->callAPIAndDocument('pledge_payment', 'delete', $deleteParams, __FUNCTION__, __FILE__);
 274   }
 275
 276   public function testGetFields() {
 277     $result = $this->callAPISuccess('PledgePayment', 'GetFields', array());
 278     $this->assertType('array', $result);
 279   }
 280
 281 }