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