Merge pull request #184 from moderntribe/release/3.7.0

Package version 3.7.0

Author: becomevocal

CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [3.7.0]
+
+### Added
+
+- When using the WordPress password reset form or updated a user's password from the
+  WordPress admin, the new password will be synchronized with the BigCommerce customer
+  account for users who's accounts are configured to sync with BigCommerce.
+- Added an endpoint to handle abandoned cart recovery. Visitors who abandon their
+  carts will receive an email with a link that includes a token to recover the cart.
+  On clicking the link, the cart will be restored in the user's new browser session.
+- Added new route configurations to point BigCommerce-generated links to pages on the
+  WordPress site:
+  - `create_account` points to the user registration page
+  - `forgot_password` points to the lost password page
+  - `account_order_status` points to the order history page
+  - `account_new_return` points to the shipping & returns page
+  - `recover_abandoned_cart` points to the cart recovery endpoint
+
+### Changed
+
+- If a user account is configured to sync with BigCommerce but the customer ID user
+  meta is missing (as may happen if the BigCommerce plugin has been uninstalled and
+  reinstalled), a matching customer account may be found by email and used for
+  password validation.
+
 ## [3.6.0]
 
 ### Added
@@ -891,6 +916,7 @@
 
 
 [Unreleased]: https://github.com/moderntribe/bigcommerce/compare/master...develop
+[3.7.0]: https://github.com/bigcommerce/bigcommerce-for-wordpress/compare/3.6.0...3.7.0
 [3.6.0]: https://github.com/bigcommerce/bigcommerce-for-wordpress/compare/3.5.0...3.6.0
 [3.5.0]: https://github.com/bigcommerce/bigcommerce-for-wordpress/compare/3.4.1...3.5.0
 [3.4.1]: https://github.com/bigcommerce/bigcommerce-for-wordpress/compare/3.4.0...3.4.1

bigcommerce.php

@@ -3,7 +3,7 @@
 Plugin Name:  BigCommerce for WordPress
 Description:  Scale your ecommerce business with WordPress on the front-end and BigCommerce on the back end. Free up server resources from things like catalog management, processing payments, and managing fulfillment logistics.
 Author:       BigCommerce
-Version:      3.6.0
+Version:      3.7.0
 Author URI:   https://www.bigcommerce.com/wordpress
 Requires PHP: 5.6.24
 Text Domain:  bigcommerce

build-timestamp.php

@@ -1,2 +1,2 @@
 <?php
-define('BIGCOMMERCE_ASSETS_BUILD_TIMESTAMP', '5.51.09.06.2019');
+define('BIGCOMMERCE_ASSETS_BUILD_TIMESTAMP', '3.24.09.24.2019');

readme.txt

@@ -3,7 +3,7 @@ Contributors: bigcommerce, moderntribe, jbrinley, becomevocal, vincentlistrani,
 Tags: ecommerce, online store, sell online, storefront, retail, online shop, bigcommerce, big commerce, e-commerce, physical products, buy buttons, commerce, shopping cart, checkout, cart, shop, headless commerce, shipping, payments, fulfillment
 Requires at least: 4.6
 Tested up to: 5.2.2
-Stable tag: 3.6.0
+Stable tag: 3.7.0
 Requires PHP: 5.6.24
 License: GPLv2 or later
 License URI: https://www.gnu.org/licenses/gpl-2.0.html

src/BigCommerce/Accounts/Login.php

@@ -45,21 +45,35 @@ public function connect_customer_id( $username, $user ) {
 			return; // already connected
 		}
 
-		$api = $this->api_factory->customer();
+		$customer_id = $this->find_customer_id_by_email( $user->user_email );
+		if ( $customer_id ) {
+			$customer->set_customer_id( $customer_id );
 
-		try {
-			$matches = $api->getCustomers( [
-				'email' => $user->user_email,
-			] );
+			return;
+		}
 
-			if ( ! empty( $matches ) ) {
-				/** @var Api\Resources\Customer $customer */
-				$found_customer = reset( $matches );
-				$customer->set_customer_id( $found_customer->id );
+		$this->create_customer_from_user( $user );
+	}
 
-				return;
-			}
+	/**
+	 * Find the customer ID associated with the given email address
+	 *
+	 * @param string $email
+	 *
+	 * @return int The customer ID, 0 if not found
+	 */
+	private function find_customer_id_by_email( $email ) {
+		return $this->api_factory->customer()->find_customer_id_by_email( $email );
+	}
 
+	/**
+	 * @param \WP_User $user
+	 *
+	 * @return int The new customer's ID, 0 on failure
+	 */
+	private function create_customer_from_user( $user ) {
+		try {
+			$api               = $this->api_factory->customer();
 			$new_customer_data = [
 				'first_name' => $user->first_name ?: $user->user_login,
 				'last_name'  => $user->last_name ?: __( 'User', 'bigcommerce' ),
@@ -70,14 +84,16 @@ public function connect_customer_id( $username, $user ) {
 			$response = $api->createCustomer( $new_customer_data );
 
 			if ( $response && ! empty( $response->id ) ) {
+				$customer = new Customer( $user->ID );
 				$customer->set_customer_id( $response->id );
 
-				return;
+				return $response->id;
 			}
-
 		} catch ( \Exception $e ) {
-			return;
+			return 0;
 		}
+
+		return 0;
 	}
 
 	/**
@@ -277,6 +293,11 @@ public function authenticate_new_user( $user, $username, $password ) {
 			return $user;
 		}
 
+		$matching_user = get_user_by( 'email', $username );
+		if ( $matching_user ) {
+			return $user; // don't try to create a new user if we already have one with that email
+		}
+
 		$api = $this->api_factory->customer();
 
 		try {
@@ -340,16 +361,29 @@ public function authenticate_new_user( $user, $username, $password ) {
 	 * @filter check_password
 	 */
 	public function check_password_for_linked_accounts( $match, $password, $hash, $user_id ) {
-		$customer    = new Customer( $user_id );
-		$customer_id = $customer->get_customer_id();
-		if ( ! $customer_id ) {
-			return $match;
-		}
 		$sync = get_user_meta( $user_id, User_Profile_Settings::SYNC_PASSWORD, true );
 		if ( ! $sync ) {
 			return $match;
 		}
 
+		$customer    = new Customer( $user_id );
+		$customer_id = $customer->get_customer_id();
+		if ( ! $customer_id ) {
+			/*
+			 * If an account is set to sync with BigCommerce, but we don't know
+			 * the customer ID, we'll look it up here. Presuming we find it,
+			 * we can validate the password against that ID.
+			 *
+			 * After a successful login, the customer ID will be set in
+			 * self::connect_customer_id() on the wp_login action.
+			 */
+			$user        = new \WP_User( $user_id );
+			$customer_id = $this->find_customer_id_by_email( $user->user_email );
+			if ( ! $customer_id ) {
+				return $match;
+			}
+		}
+
 		$api = $this->api_factory->customer();
 		try {
 			return $api->validatePassword( $customer_id, $password );
@@ -379,4 +413,4 @@ private function delete_user( $user_id, $customer_id ) {
 		wp_delete_user( $user_id );
 	}
 
-}
+}

src/BigCommerce/Accounts/Password_Reset.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace BigCommerce\Accounts;
+
+use BigCommerce\Api\Customer_Api;
+
+class Password_Reset {
+
+	/** @var Customer_Api */
+	private $customer_api;
+
+	public function __construct( Customer_Api $customer_api ) {
+		$this->customer_api = $customer_api;
+	}
+
+	/**
+	 * When a user submits the reset password form on the front end,
+	 * sync with BigCommerce.
+	 *
+	 * @param \WP_User $user     The user.
+	 * @param string   $new_pass New user password.
+	 *
+	 * @return void
+	 * @action after_password_reset
+	 */
+	public function sync_reset_password_with_bigcommerce( $user, $new_pass ) {
+		$sync = get_user_meta( $user->ID, User_Profile_Settings::SYNC_PASSWORD, true );
+		if ( ! $sync ) {
+			return;
+		}
+
+		$this->set_password( $user, $new_pass );
+	}
+
+	/**
+	 * When a user's password is updated from the admin, sync with BigCommerce.
+	 *
+	 * @param int      $user_id       User ID.
+	 * @param \WP_User $old_user_data Object containing user's data prior to update.
+	 *
+	 * @return void
+	 * @action profile_update
+	 */
+	public function sync_password_change_with_bigcommerce( $user_id, $old_user_data ) {
+		if ( empty( $_POST['pass1'] ) ) { // $_POST is the only place we can find the plain text password
+			return; // not a request to update a user's password
+		}
+		$sync = get_user_meta( $user_id, User_Profile_Settings::SYNC_PASSWORD, true );
+		if ( ! $sync ) {
+			return;
+		}
+		$current_user = new \WP_User( $user_id );
+
+		if ( $current_user->user_pass === $old_user_data->user_pass ) {
+			return; // nothing changes
+		}
+
+		$this->set_password( $current_user, $_POST['pass1'] );
+	}
+
+	/**
+	 * @param \WP_User $user
+	 * @param string   $password
+	 *
+	 * @return bool Whether the password was updated
+	 */
+	private function set_password( $user, $password ) {
+		$customer    = new Customer( $user->ID );
+		$customer_id = $customer->get_customer_id();
+		if ( ! $customer_id ) {
+			/*
+			 * If an account is set to sync with BigCommerce, but we don't know
+			 * the customer ID, we'll look it up here.
+			 */
+			$customer_id = $this->customer_api->find_customer_id_by_email( $user->user_email );
+		}
+		if ( ! $customer_id ) {
+			return false;
+		}
+
+		$profile = [
+			'_authentication' => [
+				'password' => $password,
+			],
+		];
+
+		try {
+			$this->customer_api->updateCustomer( $customer_id, $profile );
+
+			return true;
+		} catch ( \Exception $e ) {
+			return false;
+		}
+	}
+}

src/BigCommerce/Api/Customer_Api.php

@@ -3,7 +3,11 @@
 
 namespace BigCommerce\Api;
 
-
+/**
+ * Class Customer_Api
+ *
+ * @method mixed updateCustomer( $customer_id, $profile )
+ */
 class Customer_Api extends v2ApiAdapter {
 	/**
 	 * @param int    $customer_id
@@ -29,4 +33,27 @@ public function validatePassword( $customer_id, $password ) {
 
 		return ! empty( $response->success );
 	}
-}
+
+	/**
+	 * Find the customer ID associated with the given email address
+	 *
+	 * @param string $email
+	 *
+	 * @return int The customer ID, 0 if not found
+	 */
+	public function find_customer_id_by_email( $email ) {
+		try {
+			$matches = $this->getCustomers( [
+				'email' => $email,
+			] );
+
+			if ( empty( $matches ) ) {
+				return 0;
+			}
+
+			return reset( $matches )->id;
+		} catch ( \Exception $e ) {
+			return 0;
+		}
+	}
+}

src/BigCommerce/Api_Factory.php

@@ -16,6 +16,7 @@
 use BigCommerce\Api\v3\Api\WishlistsApi;
 use BigCommerce\Api\Webhooks_Api;
 use BigCommerce\Api\v3\Api\CartApi;
+use BigCommerce\Api\v3\Api\AbandonedCartApi;
 use BigCommerce\Api\v3\Api\CatalogApi;
 use BigCommerce\Api\v3\Api\ChannelsApi;
 use BigCommerce\Api\v3\Api\CustomersApi;
@@ -47,6 +48,13 @@ public function cart() {
 		return new CartApi( $this->api_client );
 	}
 
+	/**
+	 * @return AbandonedCartApi
+	 */
+	public function abandonedCart() {
+		return new AbandonedCartApi( $this->api_client );
+	}
+
 	/**
 	 * @return CatalogApi
 	 */

src/BigCommerce/Cart/Cart.php

@@ -56,7 +56,7 @@ public function get_cart_id() {
 	 *
 	 * @return void
 	 */
-	private function set_cart_id( $cart_id ) {
+	public function set_cart_id( $cart_id ) {
 		/**
 		 * Filter how long the cart cookie should persist
 		 *