tests/phpunit/api/v3/ContributionSoftTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 APIv3 civicrm_contribute_* functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_ContributionSoft
  35  */
  36 class api_v3_ContributionSoftTest extends CiviUnitTestCase {
  37
  38   /**
  39    * Assume empty database with just civicrm_data
  40    */
  41   protected $_individualId; //the hard credit contact
  42   protected $_softIndividual1Id; //the first soft credit contact
  43   protected $_softIndividual2Id; //the second soft credit contact
  44   protected $_contributionId;
  45   protected $_financialTypeId = 1;
  46   protected $_apiversion = 3;
  47   protected $_entity = 'Contribution';
  48   public $debug = 0;
  49   protected $_params;
  50
  51
  52   public function setUp() {
  53     parent::setUp();
  54     $this->useTransaction(TRUE);
  55
  56     $this->_individualId = $this->individualCreate();
  57     $this->_softIndividual1Id = $this->individualCreate();
  58     $this->_softIndividual2Id = $this->individualCreate();
  59     $this->_contributionId = $this->contributionCreate($this->_individualId);
  60
  61     $paymentProcessor = $this->processorCreate();
  62     $this->_params = array(
  63       'contact_id' => $this->_individualId,
  64       'receive_date' => '20120511',
  65       'total_amount' => 100.00,
  66       'financial_type_id' => $this->_financialTypeId,
  67       'non_deductible_amount' => 10.00,
  68       'fee_amount' => 5.00,
  69       'net_amount' => 95.00,
  70       'source' => 'SSF',
  71       'contribution_status_id' => 1,
  72     );
  73     $this->_processorParams = array(
  74       'domain_id' => 1,
  75       'name' => 'Dummy',
  76       'payment_processor_type_id' => 10,
  77       'financial_account_id' => 12,
  78       'is_active' => 1,
  79       'user_name' => '',
  80       'url_site' => 'http://dummy.com',
  81       'url_recur' => 'http://dummy.com',
  82       'billing_mode' => 1,
  83     );
  84   }
  85
  86   /**
  87    * Test get methods
  88    * @todo - this might be better broken down into more smaller tests
  89    */
  90   public function testGetContributionSoft() {
  91     //We don't test for PCP fields because there's no PCP API, so we can't create campaigns.
  92     $p = array(
  93       'contribution_id' => $this->_contributionId,
  94       'contact_id' => $this->_softIndividual1Id,
  95       'amount' => 10.00,
  96       'currency' => 'USD',
  97       'soft_credit_type_id' => 4,
  98     );
  99
 100     $this->_softcontribution = $this->callAPISuccess('contribution_soft', 'create', $p);
 101     $params = array(
 102       'id' => $this->_softcontribution['id'],
 103     );
 104     $softcontribution = $this->callAPIAndDocument('contribution_soft', 'get', $params, __FUNCTION__, __FILE__);
 105     $this->assertEquals(1, $softcontribution['count']);
 106     $this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['contribution_id'], $this->_contributionId, 'In line ' . __LINE__);
 107     $this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['contact_id'], $this->_softIndividual1Id, 'In line ' . __LINE__);
 108     $this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['amount'], '10.00', 'In line ' . __LINE__);
 109     $this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['currency'], 'USD', 'In line ' . __LINE__);
 110     $this->assertEquals($softcontribution['values'][$this->_softcontribution['id']]['soft_credit_type_id'], 4, 'In line ' . __LINE__);
 111
 112     //create a second soft contribution on the same hard contribution - we are testing that 'id' gets the right soft contribution id (not the contribution id)
 113     $p['contact_id'] = $this->_softIndividual2Id;
 114     $this->_softcontribution2 = $this->callAPISuccess('contribution_soft', 'create', $p);
 115
 116     // now we have 2 - test getcount
 117     $softcontribution = $this->callAPISuccess('contribution_soft', 'getcount', array());
 118     $this->assertEquals(2, $softcontribution);
 119
 120     //check first contribution
 121     $result = $this->callAPISuccess('contribution_soft', 'get', array(
 122       'id' => $this->_softcontribution['id'],
 123     ));
 124     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
 125     $this->assertEquals($this->_softcontribution['id'], $result['id']);
 126     $this->assertEquals($this->_softcontribution['id'], $result['id'], print_r($softcontribution, TRUE));
 127
 128     //test id only format - second soft credit
 129     $resultID2 = $this->callAPISuccess('contribution_soft', 'get', array(
 130       'id' => $this->_softcontribution2['id'],
 131       'format.only_id' => 1,
 132     ));
 133     $this->assertEquals($this->_softcontribution2['id'], $resultID2);
 134
 135     //test get by contact id works
 136     $result = $this->callAPISuccess('contribution_soft', 'get', array(
 137         'contact_id' => $this->_softIndividual2Id
 138       )
 139     );
 140     $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
 141
 142     $this->callAPISuccess('contribution_soft', 'Delete', array(
 143       'id' => $this->_softcontribution['id'],
 144     ));
 145     // check one soft credit remains
 146     $expectedCount = 1;
 147     $this->callAPISuccess('contribution_soft', 'getcount', array(), $expectedCount);
 148
 149     //check id is same as 2
 150     $this->assertEquals($this->_softcontribution2['id'], $this->callAPISuccess('contribution_soft', 'getvalue', array('return' => 'id')));
 151
 152     $this->callAPISuccess('ContributionSoft', 'Delete', array(
 153       'id' => $this->_softcontribution2['id'],
 154     ));
 155   }
 156
 157
 158   ///////////////// civicrm_contribution_soft
 159   public function testCreateEmptyParamsContributionSoft() {
 160     $softcontribution = $this->callAPIFailure('contribution_soft', 'create', array(),
 161       'Mandatory key(s) missing from params array: contribution_id, amount, contact_id'
 162     );
 163   }
 164
 165   public function testCreateParamsWithoutRequiredKeysContributionSoft() {
 166     $softcontribution = $this->callAPIFailure('contribution_soft', 'create', array(),
 167       'Mandatory key(s) missing from params array: contribution_id, amount, contact_id'
 168     );
 169   }
 170
 171   public function testCreateContributionSoftInvalidContact() {
 172
 173     $params = array(
 174       'contact_id' => 999,
 175       'contribution_id' => $this->_contributionId,
 176       'amount' => 10.00,
 177       'currency' => 'USD',
 178     );
 179
 180     $softcontribution = $this->callAPIFailure('contribution_soft', 'create', $params,
 181       'contact_id is not valid : 999'
 182     );
 183   }
 184
 185   public function testCreateContributionSoftInvalidContributionId() {
 186
 187     $params = array(
 188       'contribution_id' => 999999,
 189       'contact_id' => $this->_softIndividual1Id,
 190       'amount' => 10.00,
 191       'currency' => 'USD',
 192     );
 193
 194     $softcontribution = $this->callAPIFailure('contribution_soft', 'create', $params,
 195       'contribution_id is not valid : 999999'
 196     );
 197   }
 198
 199   /**
 200    * Function tests that additional financial records are created when fee amount is recorded
 201    */
 202   public function testCreateContributionSoft() {
 203     $params = array(
 204       'contribution_id' => $this->_contributionId,
 205       'contact_id' => $this->_softIndividual1Id,
 206       'amount' => 10.00,
 207       'currency' => 'USD',
 208       'soft_credit_type_id' => 5,
 209     );
 210
 211     $softcontribution = $this->callAPIAndDocument('contribution_soft', 'create', $params, __FUNCTION__, __FILE__);
 212     $this->assertEquals($softcontribution['values'][$softcontribution['id']]['contribution_id'], $this->_contributionId, 'In line ' . __LINE__);
 213     $this->assertEquals($softcontribution['values'][$softcontribution['id']]['contact_id'], $this->_softIndividual1Id, 'In line ' . __LINE__);
 214     $this->assertEquals($softcontribution['values'][$softcontribution['id']]['amount'], '10.00', 'In line ' . __LINE__);
 215     $this->assertEquals($softcontribution['values'][$softcontribution['id']]['currency'], 'USD', 'In line ' . __LINE__);
 216     $this->assertEquals($softcontribution['values'][$softcontribution['id']]['soft_credit_type_id'], 5, 'In line ' . __LINE__);
 217   }
 218
 219   //To Update Soft Contribution
 220   public function testCreateUpdateContributionSoft() {
 221     //create a soft credit
 222     $params = array(
 223       'contribution_id' => $this->_contributionId,
 224       'contact_id' => $this->_softIndividual1Id,
 225       'amount' => 10.00,
 226       'currency' => 'USD',
 227       'soft_credit_type_id' => 6,
 228     );
 229
 230     $softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
 231     $softcontributionID = $softcontribution['id'];
 232
 233     $old_params = array(
 234       'contribution_soft_id' => $softcontributionID,
 235     );
 236     $original = $this->callAPISuccess('contribution_soft', 'get', $old_params);
 237     //Make sure it came back
 238     $this->assertEquals($original['id'], $softcontributionID, 'In line ' . __LINE__);
 239     //set up list of old params, verify
 240     $old_contribution_id = $original['values'][$softcontributionID]['contribution_id'];
 241     $old_contact_id = $original['values'][$softcontributionID]['contact_id'];
 242     $old_amount = $original['values'][$softcontributionID]['amount'];
 243     $old_currency = $original['values'][$softcontributionID]['currency'];
 244     $old_soft_credit_type_id = $original['values'][$softcontributionID]['soft_credit_type_id'];
 245
 246     //check against original values
 247     $this->assertEquals($old_contribution_id, $this->_contributionId, 'In line ' . __LINE__);
 248     $this->assertEquals($old_contact_id, $this->_softIndividual1Id, 'In line ' . __LINE__);
 249     $this->assertEquals($old_amount, 10.00, 'In line ' . __LINE__);
 250     $this->assertEquals($old_currency, 'USD', 'In line ' . __LINE__);
 251     $this->assertEquals($old_soft_credit_type_id, 6, 'In line ' . __LINE__);
 252     $params = array(
 253       'id' => $softcontributionID,
 254       'contribution_id' => $this->_contributionId,
 255       'contact_id' => $this->_softIndividual1Id,
 256       'amount' => 7.00,
 257       'currency' => 'CAD',
 258       'soft_credit_type_id' => 7,
 259     );
 260
 261     $softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
 262
 263     $new_params = array(
 264       'id' => $softcontribution['id'],
 265     );
 266     $softcontribution = $this->callAPISuccess('contribution_soft', 'get', $new_params);
 267     //check against original values
 268     $this->assertEquals($softcontribution['values'][$softcontributionID]['contribution_id'], $this->_contributionId, 'In line ' . __LINE__);
 269     $this->assertEquals($softcontribution['values'][$softcontributionID]['contact_id'], $this->_softIndividual1Id, 'In line ' . __LINE__);
 270     $this->assertEquals($softcontribution['values'][$softcontributionID]['amount'], 7.00, 'In line ' . __LINE__);
 271     $this->assertEquals($softcontribution['values'][$softcontributionID]['currency'], 'CAD', 'In line ' . __LINE__);
 272     $this->assertEquals($softcontribution['values'][$softcontributionID]['soft_credit_type_id'], 7, 'In line ' . __LINE__);
 273
 274     $params = array(
 275       'id' => $softcontributionID,
 276     );
 277     $result = $this->callAPISuccess('contribution_soft', 'delete', $params);
 278   }
 279
 280   ///////////////// civicrm_contribution_soft_delete methods
 281   public function testDeleteEmptyParamsContributionSoft() {
 282     $params = array();
 283     $softcontribution = $this->callAPIFailure('contribution_soft', 'delete', $params);
 284   }
 285
 286   public function testDeleteWrongParamContributionSoft() {
 287     $params = array(
 288       'contribution_source' => 'SSF',
 289     );
 290     $softcontribution = $this->callAPIFailure('contribution_soft', 'delete', $params);
 291   }
 292
 293   public function testDeleteContributionSoft() {
 294     //create a soft credit
 295     $params = array(
 296       'contribution_id' => $this->_contributionId,
 297       'contact_id' => $this->_softIndividual1Id,
 298       'amount' => 10.00,
 299       'currency' => 'USD',
 300     );
 301
 302     $softcontribution = $this->callAPISuccess('contribution_soft', 'create', $params);
 303     $softcontributionID = $softcontribution['id'];
 304     $params = array(
 305       'id' => $softcontributionID,
 306     );
 307     $result = $this->callAPIAndDocument('contribution_soft', 'delete', $params, __FUNCTION__, __FILE__);
 308   }
 309
 310   ///////////////// civicrm_contribution_search methods
 311
 312   /**
 313    *  Test civicrm_contribution_search with empty params.
 314    *  All available contributions expected.
 315    */
 316   public function testSearchEmptyParams() {
 317     $p = array(
 318       'contribution_id' => $this->_contributionId,
 319       'contact_id' => $this->_softIndividual1Id,
 320       'amount' => 10.00,
 321       'currency' => 'USD',
 322     );
 323     $softcontribution = $this->callAPISuccess('contribution_soft', 'create', $p);
 324
 325     $result = $this->callAPISuccess('contribution_soft', 'get', array());
 326     // We're taking the first element.
 327     $res = $result['values'][$softcontribution['id']];
 328
 329     $this->assertEquals($p['contribution_id'], $res['contribution_id'], 'In line ' . __LINE__);
 330     $this->assertEquals($p['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
 331     $this->assertEquals($p['amount'], $res['amount'], 'In line ' . __LINE__);
 332     $this->assertEquals($p['currency'], $res['currency'], 'In line ' . __LINE__);
 333   }
 334
 335   /**
 336    *  Test civicrm_contribution_soft_search. Success expected.
 337    */
 338   public function testSearch() {
 339     $p1 = array(
 340       'contribution_id' => $this->_contributionId,
 341       'contact_id' => $this->_softIndividual1Id,
 342       'amount' => 10.00,
 343       'currency' => 'USD',
 344     );
 345     $softcontribution1 = $this->callAPISuccess('contribution_soft', 'create', $p1);
 346
 347     $p2 = array(
 348       'contribution_id' => $this->_contributionId,
 349       'contact_id' => $this->_softIndividual2Id,
 350       'amount' => 25.00,
 351       'currency' => 'CAD',
 352     );
 353     $softcontribution2 = $this->callAPISuccess('contribution_soft', 'create', $p2);
 354
 355     $params = array(
 356       'id' => $softcontribution2['id'],
 357     );
 358     $result = $this->callAPISuccess('contribution_soft', 'get', $params);
 359     $res = $result['values'][$softcontribution2['id']];
 360
 361     $this->assertEquals($p2['contribution_id'], $res['contribution_id'], 'In line ' . __LINE__);
 362     $this->assertEquals($p2['contact_id'], $res['contact_id'], 'In line ' . __LINE__);
 363     $this->assertEquals($p2['amount'], $res['amount'], 'In line ' . __LINE__);
 364     $this->assertEquals($p2['currency'], $res['currency'], 'In line ' . __LINE__);
 365   }
 366 }