tests/phpunit/api/v3/ContributionRecurTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *  Test APIv3 civicrm_contribute_recur* functions
  14  *
  15  * @package CiviCRM_APIv3
  16  * @subpackage API_Contribution
  17  * @group headless
  18  */
  19 class api_v3_ContributionRecurTest extends CiviUnitTestCase {
  20   protected $_apiversion = 3;
  21   protected $params;
  22   protected $ids = [];
  23   protected $_entity = 'contribution_recur';
  24
  25   public $DBResetRequired = FALSE;
  26
  27   public function setUp() {
  28     parent::setUp();
  29     $this->useTransaction(TRUE);
  30     $this->ids['contact'][0] = $this->individualCreate();
  31     $this->params = [
  32       'contact_id' => $this->ids['contact'][0],
  33       'installments' => '12',
  34       'frequency_interval' => '1',
  35       'amount' => '500',
  36       'contribution_status_id' => 1,
  37       'start_date' => '2012-01-01 00:00:00',
  38       'currency' => 'USD',
  39       'frequency_unit' => 'day',
  40     ];
  41   }
  42
  43   public function testCreateContributionRecur() {
  44     $result = $this->callAPIAndDocument($this->_entity, 'create', $this->params, __FUNCTION__, __FILE__);
  45     $this->assertEquals(1, $result['count']);
  46     $this->assertNotNull($result['values'][$result['id']]['id']);
  47     $this->getAndCheck($this->params, $result['id'], $this->_entity);
  48   }
  49
  50   public function testGetContributionRecur() {
  51     $this->callAPISuccess($this->_entity, 'create', $this->params);
  52     $getParams = [
  53       'amount' => '500',
  54     ];
  55     $result = $this->callAPIAndDocument($this->_entity, 'get', $getParams, __FUNCTION__, __FILE__);
  56     $this->assertEquals(1, $result['count']);
  57   }
  58
  59   public function testCreateContributionRecurWithToken() {
  60     // create token
  61     $this->createLoggedInUser();
  62     $token = $this->callAPISuccess('PaymentToken', 'create', [
  63       'payment_processor_id' => $this->processorCreate(),
  64       'token' => 'hhh',
  65       'contact_id' => $this->individualCreate(),
  66     ]);
  67     $params['payment_token_id'] = $token['id'];
  68     $result = $this->callAPISuccess($this->_entity, 'create', $this->params);
  69     $this->assertEquals(1, $result['count']);
  70     $this->assertNotNull($result['values'][$result['id']]['id']);
  71     $this->getAndCheck($this->params, $result['id'], $this->_entity);
  72   }
  73
  74   public function testDeleteContributionRecur() {
  75     $result = $this->callAPISuccess($this->_entity, 'create', $this->params);
  76     $deleteParams = ['id' => $result['id']];
  77     $this->callAPIAndDocument($this->_entity, 'delete', $deleteParams, __FUNCTION__, __FILE__);
  78     $checkDeleted = $this->callAPISuccess($this->_entity, 'get', []);
  79     $this->assertEquals(0, $checkDeleted['count']);
  80   }
  81
  82   public function testGetFieldsContributionRecur() {
  83     $result = $this->callAPISuccess($this->_entity, 'getfields', ['action' => 'create']);
  84     $this->assertEquals(12, $result['values']['start_date']['type']);
  85   }
  86
  87   /**
  88    * Test that we can cancel a contribution and add a cancel_reason via the api.
  89    */
  90   public function testContributionRecurCancel() {
  91     $result = $this->callAPISuccess($this->_entity, 'create', $this->params);
  92     $this->callAPISuccess('ContributionRecur', 'cancel', ['id' => $result['id'], 'cancel_reason' => 'just cos', 'processor_message' => 'big fail']);
  93     $cancelled = $this->callAPISuccess('ContributionRecur', 'getsingle', ['id' => $result['id']]);
  94     $this->assertEquals('just cos', $cancelled['cancel_reason']);
  95     $this->assertEquals(CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_ContributionRecur', 'contribution_status_id', 'Cancelled'), $cancelled['contribution_status_id']);
  96     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($cancelled['cancel_date'])));
  97     $activity = $this->callAPISuccessGetSingle('Activity', ['activity_type_id' => 'Cancel Recurring Contribution', 'record_type_id' => $result['id']]);
  98     $this->assertEquals('Recurring contribution cancelled', $activity['subject']);
  99     $this->assertEquals('big fail<br/>The recurring contribution of 500.00, every 1 day has been cancelled.', $activity['details']);
 100     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($activity['activity_date_time'])));
 101     $this->assertEquals($this->params['contact_id'], $activity['source_contact_id']);
 102     $this->assertEquals(CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Completed'), $activity['status_id']);
 103   }
 104
 105 }