Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Commit

Permalink
Update shipping/cart endpoints (#1833)
Browse files Browse the repository at this point in the history 
* Items should not have keys in API response

* Include package ID in response (this is just a basic index)

* /cart/select-shipping-rate/package_id

* Add package_id to package array

* Update responses and add shipping-rates to main cart endpoint

* update-shipping endpoint
  • Loading branch information
@mikejolley @senadir
mikejolley authored and senadir committed Mar 5, 2020
1 parent 913bb14 commit 8a6e87a
Show file tree
Hide file tree
Showing 6 changed files with 311 additions and 232 deletions.
2 changes: 1 addition & 1 deletion assets/js/base/components/shipping-rates-control/packages.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const Packages = ( {
} ) => {
return shippingRates.map( ( shippingRate, i ) => (
<Package
key={ Object.keys( shippingRate.items ).join() }
key={ shippingRate.package_id }
className={ className }
noResultsMessage={ noResultsMessage }
onChange={ ( newShippingRate ) => {
Expand Down
204 changes: 193 additions & 11 deletions src/RestApi/StoreApi/Controllers/Cart.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,17 +105,78 @@ public function register_routes() {
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/select-shipping',
'/' . $this->rest_base . '/update-shipping',
[
[
'methods' => 'POST',
'callback' => [ $this, 'update_shipping' ],
'args' => [
'address_1' => array(
'description' => __( 'First line of the address being shipped to.', 'woo-gutenberg-products-block' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'wc_clean',
'validate_callback' => 'rest_validate_request_arg',
),
'address_2' => [
'description' => __( 'Second line of the address being shipped to.', 'woo-gutenberg-products-block' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'wc_clean',
'validate_callback' => 'rest_validate_request_arg',
],
'city' => [
'description' => __( 'City of the address being shipped to.', 'woo-gutenberg-products-block' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'wc_clean',
'validate_callback' => 'rest_validate_request_arg',
],
'state' => [
'description' => __( 'ISO code, or name, for the state, province, or district of the address being shipped to.', 'woo-gutenberg-products-block' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'wc_clean',
'validate_callback' => 'rest_validate_request_arg',
],
'postcode' => [
'description' => __( 'Zip or Postcode of the address being shipped to.', 'woo-gutenberg-products-block' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'wc_clean',
'validate_callback' => 'rest_validate_request_arg',
],
'country' => [
'description' => __( 'ISO code for the country of the address being shipped to.', 'woo-gutenberg-products-block' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'wc_clean',
'validate_callback' => 'rest_validate_request_arg',
],
],
],
'schema' => [ $this, 'get_public_item_schema' ],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/select-shipping-rate/(?P<package_id>[\d]+)',
[
'args' => [
'shipping_rates' => [
'description' => __( 'Array of selected shipping rates ids.', 'woo-gutenberg-products-block' ),
'type' => 'array',
'package_id' => array(
'description' => __( 'The ID of the package being shipped.', 'woo-gutenberg-products-block' ),
'type' => 'integer',
'required' => true,
),
'rate_id' => [
'description' => __( 'The chosen rate ID for the package.', 'woo-gutenberg-products-block' ),
'type' => 'string',
'required' => true,
],
],
[
'methods' => 'POST',
'callback' => [ $this, 'select_shipping' ],
'callback' => [ $this, 'select_shipping_rate_for_package' ],
],
'schema' => [ $this, 'get_public_item_schema' ],
]
Expand All @@ -125,26 +186,32 @@ public function register_routes() {
/**
* Select a shipping rate for the cart.
*
* This selects a shipping rate and adds it to an array of selected shipping rates, passing one or multiple items will add them to the selected shipping rates, passing an empty array will unset everything.
* This selects a shipping rate for a package and adds it to an array of selected shipping rates.
*
* @param \WP_REST_Request $request Full details about the request.
* @return \WP_Error|\WP_REST_Response
*/
public function select_shipping( $request ) {
public function select_shipping_rate_for_package( $request ) {
if ( ! wc_shipping_enabled() ) {
return new RestError( 'woocommerce_rest_shipping_disabled', __( 'Shipping is disabled.', 'woo-gutenberg-products-block' ), array( 'status' => 404 ) );
}

if ( ! isset( $request['package_id'] ) || ! is_numeric( $request['package_id'] ) ) {
return new RestError( 'woocommerce_rest_cart_missing_package_id', __( 'Invalid Package ID.', 'woo-gutenberg-products-block' ), array( 'status' => 403 ) );
}

$controller = new CartController();
$cart = $controller->get_cart_instance();

if ( ! $cart || ! $cart instanceof \WC_Cart ) {
return new RestError( 'woocommerce_rest_cart_error', __( 'Unable to retrieve cart.', 'woo-gutenberg-products-block' ), array( 'status' => 500 ) );
}

$rates_ids = wc_clean( wp_unslash( $request['shipping_rates'] ) );
$package_id = absint( $request['package_id'] );
$rate_id = wc_clean( wp_unslash( $request['rate_id'] ) );

try {
$controller->select_shipping_rate( $rates_ids );
$controller->select_shipping_rate( $package_id, $rate_id );
} catch ( RestException $e ) {
return new RestError( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
Expand Down Expand Up @@ -222,6 +289,52 @@ public function remove_coupon( $request ) {
return $response;
}

/**
* Given an address, gets updated shipping rates for the cart.
*
* @param \WP_REST_Request $request Full details about the request.
* @return \WP_Error|\WP_REST_Response
*/
public function update_shipping( $request ) {
if ( ! wc_shipping_enabled() ) {
return new RestError( 'woocommerce_rest_shipping_disabled', __( 'Shipping is disabled.', 'woo-gutenberg-products-block' ), array( 'status' => 404 ) );
}

$controller = new CartController();
$cart = $controller->get_cart_instance();

if ( ! $cart || ! $cart instanceof \WC_Cart ) {
return new RestError( 'woocommerce_rest_cart_error', __( 'Unable to retrieve cart.', 'woo-gutenberg-products-block' ), array( 'status' => 500 ) );
}

$request = $this->validate_shipping_address( $request );

if ( is_wp_error( $request ) ) {
return $request;
}

// Update customer session.
WC()->customer->set_props(
array(
'shipping_country' => isset( $request['country'] ) ? $request['country'] : null,
'shipping_state' => isset( $request['state'] ) ? $request['state'] : null,
'shipping_postcode' => isset( $request['postcode'] ) ? $request['postcode'] : null,
'shipping_city' => isset( $request['city'] ) ? $request['city'] : null,
'shipping_address_1' => isset( $request['address_1'] ) ? $request['address_1'] : null,
'shipping_address_2' => isset( $request['address_2'] ) ? $request['address_2'] : null,
)
);
WC()->customer->save();

$cart->calculate_shipping();
$cart->calculate_totals();

$data = $this->prepare_item_for_response( $cart, $request );
$response = rest_ensure_response( $data );

return $response;
}

/**
* Get the cart.
*
Expand Down Expand Up @@ -259,8 +372,77 @@ public function get_item_schema() {
* @return \WP_REST_Response Response object.
*/
public function prepare_item_for_response( $cart, $request ) {
$data = $this->schema->get_item_response( $cart );
return rest_ensure_response( $this->schema->get_item_response( $cart ) );
}

/**
* Format the request address.
*
* @param \WP_REST_Request $request Full details about the request.
* @return \WP_Error|\WP_REST_Response
*/
protected function validate_shipping_address( $request ) {
$valid_countries = WC()->countries->get_shipping_countries();

if ( empty( $request['country'] ) ) {
return new RestError(
'woocommerce_rest_cart_shipping_rates_missing_country',
sprintf(
/* translators: 1: valid country codes */
__( 'No destination country code was given. Please provide one of the following: %s', 'woo-gutenberg-products-block' ),
implode( ', ', array_keys( $valid_countries ) )
),
[ 'status' => 400 ]
);
}

$request['country'] = wc_strtoupper( $request['country'] );

if (
is_array( $valid_countries ) &&
count( $valid_countries ) > 0 &&
! array_key_exists( $request['country'], $valid_countries )
) {
return new RestError(
'woocommerce_rest_cart_shipping_rates_invalid_country',
sprintf(
/* translators: 1: valid country codes */
__( 'Destination country code is not valid. Please enter one of the following: %s', 'woo-gutenberg-products-block' ),
implode( ', ', array_keys( $valid_countries ) )
),
[ 'status' => 400 ]
);
}

$request['postcode'] = $request['postcode'] ? wc_format_postcode( $request['postcode'], $request['country'] ) : null;

if ( ! empty( $request['state'] ) ) {
$valid_states = WC()->countries->get_states( $request['country'] );

if ( is_array( $valid_states ) && count( $valid_states ) > 0 ) {
$valid_state_values = array_map( 'wc_strtoupper', array_flip( array_map( 'wc_strtoupper', $valid_states ) ) );
$request['state'] = wc_strtoupper( $request['state'] );

if ( isset( $valid_state_values[ $request['state'] ] ) ) {
// With this part we consider state value to be valid as well,
// convert it to the state key for the valid_states check below.
$request['state'] = $valid_state_values[ $request['state'] ];
}

if ( ! in_array( $request['state'], $valid_state_values, true ) ) {
return new RestError(
'woocommerce_rest_cart_shipping_rates_invalid_state',
sprintf(
/* translators: 1: valid states */
__( 'Destination state is not valid. Please enter one of the following: %s', 'woo-gutenberg-products-block' ),
implode( ', ', $valid_states )
),
[ 'status' => 400 ]
);
}
}
}

return rest_ensure_response( $data );
return $request;
}
}
Loading

0 comments on commit 8a6e87a

Please sign in to comment.