From 4d4819b04f417a63bba415930bb3b74f55d9a68b Mon Sep 17 00:00:00 2001
From: JKingsnorth <john@johnkingsnorth.co.uk>
Date: Mon, 28 Nov 2016 11:04:07 +0000
Subject: [PATCH] CRM-19688 Create StateProvince API

---
 api/v3/StateProvince.php                   |  84 ++++++++++++++++
 tests/phpunit/api/v3/StateProvinceTest.php | 111 +++++++++++++++++++++
 2 files changed, 195 insertions(+)
 create mode 100644 api/v3/StateProvince.php
 create mode 100644 tests/phpunit/api/v3/StateProvinceTest.php

diff --git a/api/v3/StateProvince.php b/api/v3/StateProvince.php
new file mode 100644
index 0000000000..d363f27ea3
--- /dev/null
+++ b/api/v3/StateProvince.php
@@ -0,0 +1,84 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2016                                |
+ +--------------------------------------------------------------------+
+ | 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        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * This api exposes CiviCRM states/provinces
+ *
+ * @package CiviCRM_APIv3
+ */
+
+/**
+ * Add a state/province.
+ *
+ * @param array $params
+ *   Array per getfields metadata.
+ *
+ * @return array
+ *   API result array
+ * @throws \API_Exception
+ */
+function civicrm_api3_state_province_create($params) {
+  return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params);
+}
+
+/**
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ *   Array of parameters determined by getfields.
+ */
+function _civicrm_api3_state_province_create_spec(&$params) {
+  $params['name']['api.required'] = 1;
+  $params['country_id']['api.required'] = 1;
+  $params['abbreviation']['api.required'] = 1;
+}
+
+/**
+ * Deletes an existing state/province.
+ *
+ * @param array $params
+ *
+ * @return array
+ */
+function civicrm_api3_state_province_delete($params) {
+  return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params);
+}
+
+/**
+ * Retrieve one or more states/provinces.
+ *
+ * @param array $params
+ *   Array per getfields metadata.
+ *
+ * @return array
+ *   api result array
+ */
+function civicrm_api3_state_province_get($params) {
+  return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params);
+}
diff --git a/tests/phpunit/api/v3/StateProvinceTest.php b/tests/phpunit/api/v3/StateProvinceTest.php
new file mode 100644
index 0000000000..2e27ce8c21
--- /dev/null
+++ b/tests/phpunit/api/v3/StateProvinceTest.php
@@ -0,0 +1,111 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2016                                |
+ +--------------------------------------------------------------------+
+ | 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        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *  Test APIv3 civicrm_state_province* functions
+ *
+ * @package CiviCRM_APIv3
+ * @subpackage API_Contact
+ * @group headless
+ */
+class api_v3_StateProvinceTest extends CiviUnitTestCase {
+  protected $_apiversion;
+  protected $_params;
+
+  public function setUp() {
+    $this->_apiversion = 3;
+    parent::setUp();
+    $this->useTransaction(TRUE);
+    $this->_params = array(
+      'name' => 'Wessex',
+      'abbreviation' => 'WEX',
+      'country_id' => 1226,
+    );
+  }
+
+  public function testCreateStateProvince() {
+    $result = $this->callAPIAndDocument('StateProvince', 'create', $this->_params, __FUNCTION__, __FILE__);
+    $this->assertEquals(1, $result['count']);
+    $this->assertNotNull($result['values'][$result['id']]['id']);
+    $this->callAPISuccess('StateProvince', 'delete', array('id' => $result['id']));
+  }
+
+  public function testDeleteStateProvince() {
+    // Create
+    $create = $this->callAPISuccess('StateProvince', 'create', $this->_params);
+
+    // Delete
+    $result = $this->callAPIAndDocument('StateProvince', 'delete', array('id' => $create['id']), __FUNCTION__, __FILE__);
+    $this->assertEquals(1, $result['count']);
+    $get = $this->callAPISuccess('StateProvince', 'get', array(
+      'id' => $create['id'],
+    ));
+    $this->assertEquals(0, $get['count'], 'State/province not successfully deleted');
+  }
+
+  /**
+   * Test with empty params
+   */
+  public function testGetEmptyParams() {
+    $result = $this->callAPISuccess('StateProvince', 'Get', array());
+  }
+
+  /**
+   * Test with wrong params
+   */
+  public function testGetWrongParams() {
+    $this->callAPIFailure('StateProvince', 'Get', array('id' => 'abc'));
+  }
+
+  /**
+   * Test get
+   */
+  public function testGet() {
+    $province = $this->callAPISuccess('StateProvince', 'create', $this->_params);
+    $params = array(
+      'name' => $this->_params['name'],
+    );
+    $result = $this->callAPIAndDocument('StateProvince', 'Get', $params, __FUNCTION__, __FILE__);
+    $this->assertEquals($province['values'][$province['id']]['name'], $result['values'][$province['id']]['name']);
+    $this->assertEquals($province['values'][$province['id']]['abbreviation'], $result['values'][$province['id']]['abbreviation']);
+  }
+
+  /**
+   * There cannot be two state/provinces with the same name in the same country.
+   */
+  public function testCreateDuplicateFail() {
+    $params = $this->_params;
+    unset($params['id']);
+    $this->callAPISuccess('StateProvince', 'create', $params);
+    $this->callAPIFailure('StateProvince', 'create', $params);
+    $check = $this->callAPISuccess('StateProvince', 'getcount', array(
+      'name' => $params['name'],
+    ));
+    $this->assertEquals(1, $check);
+  }
+
+}
-- 
2.25.1