Payment Gateway Framework Fixes, Refactors, Tweaks

Couple of small fixes, tweaks, refactors, and documentation updates for
the payment gateway framework

Author: justinstern

woocommerce/class-sv-wc-plugin.php

@@ -452,11 +452,10 @@ public function get_api_log_message( $data ) {
 
 		$messages = array();
 
-		$messages[] = isset( $data['uri'] ) ? 'Request' : 'Response';
+		$messages[] = isset( $data['uri'] ) && $data['uri'] ? 'Request' : 'Response';
 
 		foreach ( (array) $data as $key => $value ) {
-
-			$messages[] = sprintf( '%s: %s', $key, is_array( $value ) ? print_r( $value, true ) : $value );
+			$messages[] = sprintf( '%s: %s', $key, is_array( $value ) || ( is_object( $value ) && 'stdClass' == get_class( $value ) ) ? print_r( (array) $value, true ) : $value );
 		}
 
 		return implode( "\n", $messages );

woocommerce/payment-gateway/class-sv-wc-payment-gateway-direct.php

@@ -1191,15 +1191,19 @@ public function remove_subscription_renewal_order_meta( $order_meta_query, $orig
 			$order_meta_query .= $this->get_remove_subscription_renewal_order_meta(
 				array(
 					'_wc_' . $this->get_id() . '_trans_id',
+					'_wc_' . $this->get_id() . '_trans_date',
 					'_wc_' . $this->get_id() . '_payment_token',
 					'_wc_' . $this->get_id() . '_account_four',
 					'_wc_' . $this->get_id() . '_card_expiry_date',
 					'_wc_' . $this->get_id() . '_card_type',
 					'_wc_' . $this->get_id() . '_authorization_code',
+					'_wc_' . $this->get_id() . '_auth_can_be_captured',
+					'_wc_' . $this->get_id() . '_charge_captured',
 					'_wc_' . $this->get_id() . '_account_type',
 					'_wc_' . $this->get_id() . '_check_number',
 					'_wc_' . $this->get_id() . '_environment',
 					'_wc_' . $this->get_id() . '_customer_id',
+					'_wc_' . $this->get_id() . '_retry_count',
 				)
 			);
 		}

woocommerce/payment-gateway/class-sv-wc-payment-gateway-hosted.php

@@ -420,15 +420,15 @@ public function process_redirect_back() {
 				return wp_redirect( $this->get_return_url( $order ) );
 			} else {
 				// failed response, redirect back to pay page
-				return wp_redirect( $order->get_checkout_payment_url( $this->use_form_post() ) );
+				return wp_redirect( $order->get_checkout_payment_url( $this->use_form_post() && ! $this->use_auto_form_post() ) );
 			}
 
 		} catch( Exception $e ) {
 			// failure
 
 			if ( isset( $order ) && $order ) {
 				$this->mark_order_as_failed( $order, $e->getMessage(), $response );
-				return wp_redirect( $order->get_checkout_payment_url( $this->use_form_post() ) );
+				return wp_redirect( $order->get_checkout_payment_url( $this->use_form_post() && ! $this->use_auto_form_post() ) );
 			}
 
 			// otherwise, if no order is available, log the issue and redirect to home
@@ -550,7 +550,7 @@ protected function add_transaction_data( $order, $response = null ) {
 	 *
 	 * @since 2.1-1
 	 * @param WC_Order $order the order
-	 * @param SV_WC_Payment_Gateway_API_Payment_Notification_Response transaction response
+	 * @param SV_WC_Payment_Gateway_API_Payment_Notification_Credit_Card_Response transaction response
 	 */
 	protected function do_credit_card_transaction_approved( $order, $response ) {
 

woocommerce/payment-gateway/class-sv-wc-payment-gateway.php

@@ -113,23 +113,16 @@
  *
  * ### Logging
  *
- * You are responsible for handling your own logging, though some helper
- * methods and best practices are defined.
+ * You are responsible for firing an action from your API/response class to provide
+ * logging of the request/response.
  *
- * A recommended implementation strategy for direct payment gateways is to
- * do an action from within the API class, immediately after the remote request,
- * for instance like:
+ * From within the API class, immediately after the remote request, for instance like:
  *
  * do_action( 'wc_intuit_qbms_api_request_performed', $request_data, $response_data );
  *
- * Hook into this action from your child class constructor, ie:
- *
- * add_action( 'wc_intuit_qbms_api_request_performed', array( $this, 'log_api_communication' ), 10, 2 );
- *
- * Then define your own log_api_communication method, making use of
- * add_debug_message() method if so desired, ie:
- *
- * $this->add_debug_message( sprintf( __( "Request Method: %s\nRequest URI: %s\nRequest Body: %s", My_Gateway::TEXT_DOMAIN ), $request['method'], $request['uri'], $request['body'] ), 'message', true );
+ * Where $request_data and $response_data are associative arrays.  Don't
+ * forget to fire the action even when errors occur and when handling exceptions
+ * even if there isn't any response data to pass (that parameter is optional)
  *
  * This will have the effect of logging every communication request with the
  * remote endpoint, without you having to litter your code with logging calls,
@@ -1029,6 +1022,21 @@ protected function get_order( $order ) {
 
 		$order->description = sprintf( _x( '%s - Order %s', 'Order description', $this->text_domain ), esc_html( get_bloginfo( 'name' ) ), $order->get_order_number() );
 
+		$order = $this->get_order_with_unique_transaction_ref( $order );
+
+		return $order;
+	}
+
+
+	/**
+	 * Returns the $order object with a unique transaction ref member added
+	 *
+	 * @since 2.1-1
+	 * @param WC_Order $order the order object
+	 * @return WC_Order order object with member named unique_transaction_ref
+	 */
+	protected function get_order_with_unique_transaction_ref( $order ) {
+
 		// generate a unique retry count
 		if ( is_numeric( SV_WC_Plugin_Compatibility::get_order_custom_field( $order, 'wc_' . $this->get_id() . '_retry_count' ) ) ) {
 			$retry_count = SV_WC_Plugin_Compatibility::get_order_custom_field( $order, 'wc_' . $this->get_id() . '_retry_count' );
@@ -1712,7 +1720,7 @@ protected function add_debug_message( $message, $type = 'message', $set_message
 		}
 
 		// add debug message to woocommerce->errors/messages if checkout or both is enabled
-		if ( ( $this->debug_checkout() || $this->is_test_environment() ) && ! is_admin() ) {
+		if ( ( $this->debug_checkout() || ( 'error' === $type && $this->is_test_environment() ) ) && ( ! is_admin() || defined( 'DOING_AJAX' ) ) ) {
 
 			if ( 'message' === $type ) {