Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix missing leaderboard schema options (https://github.com/woocommerce/woocommerce-admin/pull/2059) 

* Add missing schema properties

* Add missing leaderboard schema tests
This commit is contained in:
Joshua T Flowers 2019-04-27 01:43:52 +08:00 committed by Timmy Crawford
parent c0171f952e
commit 53a4098de1
2 changed files with 52 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
plugins/woocommerce-admin/includes/api/class-wc-admin-rest-leaderboards-controller.php
View File

@ -477,7 +477,13 @@ class WC_Admin_REST_Leaderboards_Controller extends WC_REST_Data_Controller {
'properties' => array(
'id' => array(
'type' => 'string',
'description' => __( 'Leaderboard Name.', 'woocommerce-admin' ),
'description' => __( 'Leaderboard ID.', 'woocommerce-admin' ),
'context' => array( 'view' ),
'readonly' => true,
),
'label' => array(
'type' => 'string',
'description' => __( 'Displayed title for the leaderboard.', 'woocommerce-admin' ),
'context' => array( 'view' ),
'readonly' => true,
),
@ -526,4 +532,15 @@ class WC_Admin_REST_Leaderboards_Controller extends WC_REST_Data_Controller {
return $this->add_additional_fields_schema( $schema );
}
/**
* Get schema for the list of allowed leaderboards.
*
* @return array $schema
*/
public function get_public_allowed_item_schema() {
$schema = $this->get_public_item_schema();
unset( $schema['properties']['rows'] );
return $schema;
}
}

35
plugins/woocommerce-admin/tests/api/leaderboards.php
View File

@ -56,8 +56,16 @@ class WC_Tests_API_Leaderboards extends WC_REST_Unit_Test_Case {
$data = $response->get_data();
$properties = $data['schema']['properties'];
$this->assertCount( 3, $properties );
$this->assertCount( 4, $properties );
$this->assert_item_schema( $properties );
$request = new WP_REST_Request( 'OPTIONS', $this->endpoint . '/allowed' );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$properties = $data['schema']['properties'];
$this->assertCount( 3, $properties );
$this->assert_allowed_item_schema( $properties );
}
/**
@ -67,6 +75,7 @@ class WC_Tests_API_Leaderboards extends WC_REST_Unit_Test_Case {
*/
public function assert_item_schema( $schema ) {
$this->assertArrayHasKey( 'id', $schema );
$this->assertArrayHasKey( 'label', $schema );
$this->assertArrayHasKey( 'headers', $schema );
$this->assertArrayHasKey( 'rows', $schema );
@ -80,6 +89,21 @@ class WC_Tests_API_Leaderboards extends WC_REST_Unit_Test_Case {
$this->assertArrayHasKey( 'value', $row_properties );
}
/**
* Asserts the allowed item schema is correct.
*
* @param array $schema Item to check schema.
*/
public function assert_allowed_item_schema( $schema ) {
$this->assertArrayHasKey( 'id', $schema );
$this->assertArrayHasKey( 'label', $schema );
$this->assertArrayHasKey( 'headers', $schema );
$header_properties = $schema['headers']['items']['properties'];
$this->assertCount( 1, $header_properties );
$this->assertArrayHasKey( 'label', $header_properties );
}
/**
* Test that leaderboards response changes based on applied filters.
*/
@ -91,6 +115,7 @@ class WC_Tests_API_Leaderboards extends WC_REST_Unit_Test_Case {
function( $leaderboards, $per_page, $after, $before, $persisted_query ) {
$leaderboards[] = array(
'id' => 'top_widgets',
'label' => 'Top Widgets',
'headers' => array(
array(
'label' => 'Widget Link',
@ -117,5 +142,13 @@ class WC_Tests_API_Leaderboards extends WC_REST_Unit_Test_Case {
$this->assertEquals( 200, $response->get_status() );
$this->assertEquals( 'top_widgets', $widgets_leaderboard['id'] );
$this->assertEquals( admin_url( 'admin.php?page=wc-admin#test/path?persisted_param=1' ), $widgets_leaderboard['rows'][0]['display'] );
$request = new WP_REST_Request( 'GET', $this->endpoint . '/allowed' );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$widgets_leaderboard = end( $data );
$this->assertEquals( 200, $response->get_status() );
$this->assertEquals( 'top_widgets', $widgets_leaderboard['id'] );
}
}