Add support for automatic renewals with Subscriptions

Author: bekarice

README.md

@@ -22,7 +22,7 @@ Allows for minutes and hours-long Membership lengths for quicker testing.
 
 ### Bogus Gateway
 
-Adds a testing payment gateway that will call the `$order->payment_complete()` method to simulate a credit card payment.
+Adds a testing payment gateway that will call the `$order->payment_complete()` method to simulate a credit card payment. Can also be used for Subscriptions automatic renewals.
 
 ### Global Functions
 
@@ -45,6 +45,7 @@ Download and install just like any other WordPress plugin. If you want to be rea
 ## Changelog
 
 ### 0.7.0 - 2017.04.12
+ * Feature - Use the Bogus gateway for Subscriptions automatic renewals
  * Fix - Subscriptions integration throwing a warning in WooCommerce 3.0+
 
 ### 0.6.0 - 2017.02.18

includes/class-wc-dev-helper-bogus-gateway.php

@@ -23,7 +23,6 @@
  *
  * @since 0.6.0
  */
-
 class WC_Bogus_Gateway extends WC_Payment_Gateway {
 
 	/**
@@ -39,16 +38,40 @@ public function __construct() {
 		$this->method_title       = __( 'Bogus', 'woocommerce-dev-helper' );
 		$this->method_description = __( 'A testing gateway that calls "payment complete" to simulate credit card transactions.', 'woocommerce-dev-helper' );
 
-		// Load the settings.
+		// load the settings
 		$this->init_form_fields();
 		$this->init_settings();
 
-		// Define user set variables
-		$this->title        = $this->get_option( 'title' );
-		$this->description  = $this->get_option( 'description' );
-
-		// Actions
+		// define user set variables
+		$this->title         = $this->get_option( 'title' );
+		$this->description   = $this->get_option( 'description' );
+		$this->subscriptions = $this->get_option( 'subscriptions' );
+
+		if ( $this->subscriptions_available() ) {
+
+			// Subscriptions support
+			$this->supports = array_merge( $this->supports,
+				array(
+					'subscriptions',
+					'subscription_suspension',
+					'subscription_cancellation',
+					'subscription_reactivation',
+					'subscription_amount_changes',
+					'subscription_date_changes',
+					'subscription_payment_method_change_customer',
+					'subscription_payment_method_change_admin',
+					'multiple_subscriptions',
+				)
+			);
+		}
+
+		// Save settings
 		add_action( 'woocommerce_update_options_payment_gateways_' . $this->id, array( $this, 'process_admin_options' ) );
+
+		// Process renewal orders
+		if ( ! has_action( 'woocommerce_scheduled_subscription_payment_' . $this->id, array( $this, 'process_renewal_payment' ) ) ) {
+			add_action( 'woocommerce_scheduled_subscription_payment_' . $this->id, array( $this, 'process_renewal_payment' ), 10, 2 );
+		}
 	}
 
 
@@ -61,33 +84,52 @@ public function init_form_fields() {
 
 		$this->form_fields = apply_filters( 'wc_offline_form_fields', array(
 
-			'enabled' => array(
+			'enabled'       => array(
 				'title'   => __( 'Enable/Disable', 'woocommerce-dev-helper' ),
 				'type'    => 'checkbox',
 				'label'   => __( 'Enable Bogus Gateway', 'woocommerce-dev-helper' ),
 				'default' => 'yes'
 			),
 
-			'title' => array(
+			'title'         => array(
 				'title'       => __( 'Title', 'woocommerce-dev-helper' ),
 				'type'        => 'text',
 				'description' => __( 'This controls the title for the payment method the customer sees during checkout.', 'woocommerce-dev-helper' ),
 				'default'     => __( 'Bogus (Test)', 'woocommerce-dev-helper' ),
 				'desc_tip'    => true,
 			),
 
-			'description' => array(
+			'description'   => array(
 				'title'       => __( 'Description', 'woocommerce-dev-helper' ),
 				'type'        => 'textarea',
 				'description' => __( 'Payment method description that the customer will see on your checkout.', 'woocommerce-dev-helper' ),
 				'default'     => __( 'Nothingtodohere 🚀', 'woocommerce-dev-helper' ),
 				'desc_tip'    => true,
 			),
 
+			'subscriptions' => array(
+				'title'       => __( 'Enable Subscriptions support?', 'woocommerce-dev-helper' ),
+				'type'        => 'checkbox',
+				'description' => __( 'Makes the gateway available for subscriptions purchases', 'woocommerce-dev-helper' ),
+				'default'     => 'yes',
+				'desc_tip'    => true,
+			),
+
 		) );
 	}
 
 
+	/**
+	 * Returns true if Subscriptions support is enabled.
+	 *
+	 * @since 0.7.0
+	 * @return bool
+	 */
+	public function subscriptions_available() {
+		return 'yes' === $this->subscriptions;
+	}
+
+
 	/**
 	 * Process the payment and return the result.
 	 *
@@ -114,4 +156,20 @@ public function process_payment( $order_id ) {
 	}
 
 
+	/**
+	 * Processes a renewal payment automatically.
+	 *
+	 * @since 0.7.0
+	 * @param float $amount_to_charge subscription amount to charge, could include
+	 *              multiple renewals if they've previously failed and the admin
+	 *              has enabled it
+	 * @param WC_Order $order original order containing the subscription
+	 */
+	public function process_renewal_payment( $amount_to_charge, $order ) {
+
+		$order->payment_complete();
+		$order->add_order_note( __( 'Renewal order processed. Bogus is always approved 😎', 'woocommerce-dev-helper' ) );
+	}
+
+
 }