Implement PaymentProcessor and PaymentProcessorType APIv4 Entities

Move default values to spec as per Coleman Fix class name in tests and fix default values on tables Mock financial_account_id field Fix headers and remove some unnessary code Update api v4 code following move of the handling to the BAO and update tests as per Coleman
civicrm · Jan 11, 2020 · 8617314 · 8617314
1 parent 0a5024a
commit 8617314
Show file tree

Hide file tree

Showing 7 changed files with 240 additions and 22 deletions.
diff --git a/CRM/Upgrade/Incremental/sql/5.23.alpha1.mysql.tpl b/CRM/Upgrade/Incremental/sql/5.23.alpha1.mysql.tpl
@@ -1 +1,11 @@
 {* file to handle db changes in 5.23.alpha1 during upgrade *}
+UPDATE civicrm_payment_processor SET is_default = 0 WHERE is_default IS NULL;
+UPDATE civicrm_payment_processor SET is_active = 1 WHERE is_active IS NULL;
+UPDATE civicrm_payment_processor SET is_test = 0 WHERE is_test IS NULL;
+UPDATE civicrm_payment_processor_type SET is_active = 1 WHERE is_active IS NULL;
+UPDATE civicrm_payment_processor_type SET is_default = 0 WHERE is_default IS NULL;
+ALTER TABLE civicrm_payment_processor ALTER COLUMN is_default SET DEFAULT 0;
+ALTER TABLE civicrm_payment_processor ALTER COLUMN is_active SET DEFAULT 1;
+ALTER TABLE civicrm_payment_processor ALTER COLUMN is_test SET DEFAULT 0;
+ALTER TABLE civicrm_payment_processor_type ALTER COLUMN is_active SET DEFAULT 1;
+ALTER TABLE civicrm_payment_processor_type ALTER COLUMN is_default SET DEFAULT 0;
diff --git a/Civi/Api4/PaymentProcessor.php b/Civi/Api4/PaymentProcessor.php
@@ -0,0 +1,27 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+namespace Civi\Api4;
+
+/**
+ * Payment Processor entity.
+ *
+ * @package Civi\Api4
+ */
+class PaymentProcessor extends Generic\DAOEntity {
+
+}
diff --git a/Civi/Api4/PaymentProcessorType.php b/Civi/Api4/PaymentProcessorType.php
@@ -0,0 +1,27 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+namespace Civi\Api4;
+
+/**
+ * Payment Processor Type entity.
+ *
+ * @package Civi\Api4
+ */
+class PaymentProcessorType extends Generic\DAOEntity {
+
+}
diff --git a/Civi/Api4/Service/Spec/Provider/PaymentProcessorCreationSpecProvider.php b/Civi/Api4/Service/Spec/Provider/PaymentProcessorCreationSpecProvider.php
@@ -0,0 +1,52 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+
+namespace Civi\Api4\Service\Spec\Provider;
+
+use Civi\Api4\Service\Spec\FieldSpec;
+use Civi\Api4\Service\Spec\RequestSpec;
+
+class PaymentProcessorCreationSpecProvider implements Generic\SpecProviderInterface {
+
+  /**
+   * This runs for both create and get actions
+   *
+   * @inheritDoc
+   */
+  public function modifySpec(RequestSpec $spec) {
+    $spec->getFieldByName('domain_id')->setRequired(FALSE)->setDefaultValue('current_domain');
+    // Billing mode is copied across from the payment processor type field in the BAO::create function.
+    $spec->getFieldByName('billing_mode')->setRequired(FALSE);
+
+    $financial_account_id = new FieldSpec('financial_account_id', 'PaymentProcessor', 'Integer');
+    $financial_account_id
+      ->setTitle('Financial Account ID')
+      ->setDescription('The financial account that this payment processor is linked to')
+      ->setRequired(FALSE)
+      ->setDefaultValue(\CRM_Financial_BAO_PaymentProcessor::getDefaultFinancialAccountID())
+      ->setFkEntity('FinancialAccount');
+    $spec->addFieldSpec($financial_account_id);
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public function applies($entity, $action) {
+    return $entity === 'PaymentProcessor' && in_array($action, ['create']);
+  }
+
+}
diff --git a/Civi/Api4/Service/Spec/Provider/PaymentProcessorTypeCreationSpecProvider.php b/Civi/Api4/Service/Spec/Provider/PaymentProcessorTypeCreationSpecProvider.php
@@ -0,0 +1,56 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 5                                                  |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2019                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC (c) 2004-2019
+ * $Id$
+ *
+ */
+namespace Civi\Api4\Service\Spec\Provider;
+
+use Civi\Api4\Service\Spec\RequestSpec;
+
+class PaymentProcessorTypeCreationSpecProvider implements Generic\SpecProviderInterface {
+
+  /**
+   * This runs for both create and get actions
+   *
+   * @inheritDoc
+   */
+  public function modifySpec(RequestSpec $spec) {
+    $spec->getFieldByName('payment_instrument_id')->setRequired(FALSE)->setDefaultValue(1);
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public function applies($entity, $action) {
+    return $entity === 'PaymentProcessorType' && in_array($action, ['create']);
+  }
+
+}
diff --git a/tests/phpunit/api/v3/PaymentProcessorTest.php b/tests/phpunit/api/v3/PaymentProcessorTest.php
@@ -48,17 +48,21 @@ public function setUp() {
 
   /**
    * Check create with no name specified.
+   * @dataProvider versionThreeAndFour
    */
-  public function testPaymentProcessorCreateWithoutName() {
+  public function testPaymentProcessorCreateWithoutName($version) {
+    $this->_apiversion = $version;
     $this->callAPIFailure('payment_processor', 'create', ['is_active' => 1]);
   }
 
   /**
    * Create payment processor.
+   * @dataProvider versionThreeAndFour
    *
    * @throws \CRM_Core_Exception
    */
-  public function testPaymentProcessorCreate() {
+  public function testPaymentProcessorCreate($version) {
+    $this->_apiversion = $version;
     $params = $this->_params;
     $result = $this->callAPIAndDocument('payment_processor', 'create', $params, __FUNCTION__, __FILE__);
     $this->callAPISuccessGetSingle('EntityFinancialAccount', ['entity_table' => 'civicrm_payment_processor', 'entity_id' => $result['id']]);
@@ -77,10 +81,12 @@ public function testPaymentProcessorCreate() {
 
   /**
    * Update payment processor.
+   * @dataProvider versionThreeAndFour
    *
    * @throws \CRM_Core_Exception
    */
-  public function testPaymentProcessorUpdate() {
+  public function testPaymentProcessorUpdate($version) {
+    $this->_apiversion = $version;
     $params = $this->_params;
     $params['payment_instrument_id'] = 1;
     $result = $this->callAPISuccess('payment_processor', 'create', $params);
@@ -108,6 +114,14 @@ public function testPaymentProcessorUpdate() {
       'payment_instrument_id' => 1,
       'is_active' => 1,
     ];
+    if ($version === 4) {
+      // In APIv3 If a field is default NULL it is not returned.
+      foreach ($result['values'][$result['id']] as $field => $value) {
+        if (is_null($value)) {
+          unset($result['values'][$result['id']][$field]);
+        }
+      }
+    }
     $this->checkArrayEquals($expectedResult, $result['values'][$result['id']]);
   }
 
@@ -123,10 +137,12 @@ public function testPaymentProcessorCreateExample() {
 
   /**
    * Check payment processor delete.
+   * @dataProvider versionThreeAndFour
    *
    * @throws \CRM_Core_Exception
    */
-  public function testPaymentProcessorDelete() {
+  public function testPaymentProcessorDelete($version) {
+    $this->_apiversion = $version;
     $result = $this->callAPISuccess('payment_processor', 'create', $this->_params);
     $params = [
       'id' => $result['id'],
@@ -137,10 +153,12 @@ public function testPaymentProcessorDelete() {
 
   /**
    * Check with valid params array.
+   * @dataProvider versionThreeAndFour
    *
    * @throws \CRM_Core_Exception
    */
-  public function testPaymentProcessorsGet() {
+  public function testPaymentProcessorsGet($version) {
+    $this->_apiversion = $version;
     $params = $this->_params;
     $params['user_name'] = 'test@test.com';
     $this->callAPISuccess('payment_processor', 'create', $params);