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

Merge pull request #28241 from woocommerce/fix/27566 

Add shipping, tax and fee lines to refund response for better information in refund REST API.
This commit is contained in:
Roy Ho 2020-11-11 08:11:56 -08:00 committed by GitHub
parent 04c9e2f12f 62ae94d93e
commit e0204e04e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 157 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
includes/rest-api/Controllers/Version2/class-wc-rest-order-refunds-v2-controller.php
View File

@ -58,7 +58,9 @@ class WC_REST_Order_Refunds_V2_Controller extends WC_REST_Orders_V2_Controller {
*/
public function register_routes() {
register_rest_route(
$this->namespace, '/' . $this->rest_base, array(
$this->namespace,
'/' . $this->rest_base,
array(
'args' => array(
'order_id' => array(
'description' => __( 'The order ID.', 'woocommerce' ),
@ -82,7 +84,9 @@ class WC_REST_Order_Refunds_V2_Controller extends WC_REST_Orders_V2_Controller {
);
register_rest_route(
$this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array(
$this->namespace,
'/' . $this->rest_base . '/(?P<id>[\d]+)',
array(
'args' => array(
'order_id' => array(
'description' => __( 'The order ID.', 'woocommerce' ),
@ -140,7 +144,7 @@ class WC_REST_Order_Refunds_V2_Controller extends WC_REST_Orders_V2_Controller {
$data = $object->get_data();
$format_decimal = array( 'amount' );
$format_date = array( 'date_created' );
$format_line_items = array( 'line_items' );
$format_line_items = array( 'line_items', 'shipping_lines', 'tax_lines', 'fee_lines' );
// Format decimal values.
foreach ( $format_decimal as $key ) {
@ -169,6 +173,9 @@ class WC_REST_Order_Refunds_V2_Controller extends WC_REST_Orders_V2_Controller {
'refunded_payment' => $data['refunded_payment'],
'meta_data' => $data['meta_data'],
'line_items' => $data['line_items'],
'shipping_lines' => $data['shipping_lines'],
'tax_lines' => $data['tax_lines'],
'fee_lines' => $data['fee_lines'],
);
}

29
tests/legacy/framework/helpers/class-wc-helper-order.php
View File

@ -119,4 +119,33 @@ class WC_Helper_Order {
return $order;
}
/**
* Helper function to create order with fees and shipping objects.
*
* @param int $customer_id The ID of the customer the order is for.
* @param WC_Product $product The product to add to the order.
*
* @return WC_Order
*/
public static function create_order_with_fees_and_shipping( $customer_id = 1, $product = null ) {
$order = self::create_order( $customer_id, $product );
$fee_item = new WC_Order_Item_Fee();
$fee_item->set_order_id( $order->get_id() );
$fee_item->set_name( 'Testing fees' );
$fee_item->set_total( 100 );
$shipping_item = new WC_Order_Item_Shipping();
$shipping_item->set_order_id( $order->get_id() );
$shipping_item->set_name( 'Flat shipping' );
$shipping_item->set_total( 25 );
$order->add_item( $fee_item );
$order->add_item( $shipping_item );
$order->save();
$order->calculate_totals( true );
return $order;
}
}

59
tests/php/includes/rest-api/Controllers/Version2/class-wc-rest-order-refunds-v2-controller-test.php Normal file
View File

@ -0,0 +1,59 @@
<?php
/**
* Class WC_REST_Order_Refunds_Controller_Test.
*/
class WC_REST_Order_Refunds_V2_Controller_Test extends WC_REST_Unit_Test_Case {
/**
* Test if line, fees and shipping items are all included in refund response.
*/
public function test_items_response_fields() {
wp_set_current_user( 1 );
$order = WC_Helper_Order::create_order_with_fees_and_shipping();
$product_item = current( $order->get_items( 'line_item' ) );
$fee_item = current( $order->get_items( 'fee' ) );
$shipping_item = current( $order->get_items( 'shipping' ) );
$refund = wc_create_refund(
array(
'order_id' => $order->get_id(),
'reason' => 'testing',
'line_items' => array(
$product_item->get_id() =>
array(
'qty' => 1,
'refund_total' => 1,
),
$fee_item->get_id() =>
array(
'refund_total' => 10,
),
$shipping_item->get_id() =>
array(
'refund_total' => 20,
),
),
)
);
$this->assertNotWPError( $refund );
$request = new WP_REST_Request( 'GET', '/wc/v2/orders/' . $order->get_id() . '/refunds/' . $refund->get_id() );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$this->assertEquals( 200, $response->get_status() );
$this->assertContains( 'line_items', array_keys( $data ) );
$this->assertEquals( -1, $data['line_items'][0]['total'] );
$this->assertContains( 'fee_lines', array_keys( $data ) );
$this->assertEquals( -10, $data['fee_lines'][0]['total'] );
$this->assertContains( 'shipping_lines', array_keys( $data ) );
$this->assertEquals( -20, $data['shipping_lines'][0]['total'] );
}
}

59
tests/php/includes/rest-api/Controllers/Version3/class-wc-rest-order-refunds-controller-test.php Normal file
View File

@ -0,0 +1,59 @@
<?php
/**
* Class WC_REST_Order_Refunds_Controller_Test.
*/
class WC_REST_Order_Refunds_Controller_Test extends WC_REST_Unit_Test_Case {
/**
* Test if line, fees and shipping items are all included in refund response.
*/
public function test_items_response_fields() {
wp_set_current_user( 1 );
$order = WC_Helper_Order::create_order_with_fees_and_shipping();
$product_item = current( $order->get_items( 'line_item' ) );
$fee_item = current( $order->get_items( 'fee' ) );
$shipping_item = current( $order->get_items( 'shipping' ) );
$refund = wc_create_refund(
array(
'order_id' => $order->get_id(),
'reason' => 'testing',
'line_items' => array(
$product_item->get_id() =>
array(
'qty' => 1,
'refund_total' => 1,
),
$fee_item->get_id() =>
array(
'refund_total' => 10,
),
$shipping_item->get_id() =>
array(
'refund_total' => 20,
),
),
)
);
$this->assertNotWPError( $refund );
$request = new WP_REST_Request( 'GET', '/wc/v3/orders/' . $order->get_id() . '/refunds/' . $refund->get_id() );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$this->assertEquals( 200, $response->get_status() );
$this->assertContains( 'line_items', array_keys( $data ) );
$this->assertEquals( -1, $data['line_items'][0]['total'] );
$this->assertContains( 'fee_lines', array_keys( $data ) );
$this->assertEquals( -10, $data['fee_lines'][0]['total'] );
$this->assertContains( 'shipping_lines', array_keys( $data ) );
$this->assertEquals( -20, $data['shipping_lines'][0]['total'] );
}
}