Feat/sync with square

.github/workflows/zip.yml

@@ -160,6 +160,21 @@ jobs:
         if: ${{ env.PRODUCTION_ZIP == 'true' }}
         run: composer -- pup i18n
 
+      # ------------------------------------------------------------------------------
+      # Check `@release-engineer` tasks
+      # ------------------------------------------------------------------------------
+      - name: Check `@release-engineer` tasks
+        if: ${{ env.PRODUCTION_ZIP == 'true' }}
+        run: |
+          OUTPUT=$(find ./src/ -type f -exec grep -l "@release-engineer" {} \;)
+          if [ -n "$OUTPUT" ]; then
+            echo "Found @release-engineer tasks:"
+            echo "$OUTPUT"
+            exit 1
+          else
+            echo "No @release-engineer tasks found."
+          fi
+
       # ------------------------------------------------------------------------------
       # Run Pup Package - creates the zip file for new OR production builds
       # ------------------------------------------------------------------------------

event-tickets.php

@@ -3,7 +3,7 @@
  * Plugin Name: Event Tickets
  * Plugin URI:  https://evnt.is/1acb
  * Description: Event Tickets allows you to sell basic tickets and collect RSVPs from any post, page, or event.
- * Version: 5.21.1
+ * Version: 5.24.0
  * Requires at least: 6.5
  * Requires PHP: 7.4
  * Author: The Events Calendar

package.json

@@ -1,6 +1,6 @@
 {
   "name": "event-tickets",
-  "version": "5.21.1",
+  "version": "5.24.0",
   "repository": "[email protected]:the-events-calendar/event-tickets.git",
   "_zipname": "event-tickets",
   "_zipfoldername": "event-tickets",

readme.txt

@@ -2,7 +2,7 @@
 
 Contributors: theeventscalendar, brianjessee, camwynsp, redscar, tribalmike, rafsuntaskin, aguseo, bordoni, borkweb, jentheo, leahkoerper, lucatume, neillmcshea, vicskf, zbtirrell
 Tags: tickets, event registration, RSVP, ticket sales, attendee management
-Stable tag: 5.21.1
+Stable tag: 5.24.0
 Requires at least: 6.5
 Tested up to: 6.7.2
 Requires PHP: 7.4

src/Tickets/Commerce/Gateways/Contracts/Abstract_Requests.php

@@ -13,6 +13,17 @@
  */
 abstract class Abstract_Requests implements Requests_Interface {
 
+	/**
+	 * Get the headers.
+	 *
+	 * @since TBD
+	 *
+	 * @return array The headers.
+	 */
+	public static function get_headers(): array {
+		return [];
+	}
+
 	/**
 	 * @inheritDoc
 	 */
@@ -53,9 +64,12 @@ public static function request( $method, $url, array $query_args = [], array $re
 			: add_query_arg( $query_args, $url );
 
 		$default_arguments = [
-			'headers' => [
-				'Authorization' => 'Bearer ' . tribe( static::$merchant )->get_client_secret(),
-			],
+			'headers' => array_merge(
+				[
+					'Authorization' => 'Bearer ' . tribe( static::$merchant )->get_client_secret(),
+				],
+				static::get_headers()
+			),
 		];
 
 		// By default, it's important that we have a body set for any method that is not the GET method.

src/Tickets/Commerce/Gateways/Square/Assets.php

@@ -221,7 +221,7 @@ public function unregister(): void {
 			'tec-tickets-commerce-gateway-square-checkout',
 			'tec-tickets-commerce-square-style',
 			'tec-tickets-commerce-gateway-square-admin-webhooks',
-			'tec-tickets-commerce-gateway-square-admin-webhooks-styles',
+			'tec-tickets-commerce-admin-styles',
 		] as $asset ) {
 			$stellar_assets->remove( $asset );
 		}

src/Tickets/Commerce/Gateways/Square/Controller.php

@@ -10,6 +10,7 @@
 use TEC\Common\Contracts\Provider\Controller as Controller_Contract;
 use TEC\Tickets\Commerce\Gateways\Square\REST\On_Boarding_Endpoint;
 use TEC\Tickets\Commerce\Gateways\Square\REST\Order_Endpoint;
+use TEC\Tickets\Commerce\Gateways\Square\Syncs\Controller as Syncs_Controller;
 use TEC\Tickets\Commerce\Gateways\Square\Webhooks;
 
 /**
@@ -43,6 +44,12 @@ public function do_register(): void {
 		$this->container->register( Hooks::class );
 		$this->container->register( Notices\Controller::class );
 		$this->container->register( Webhooks::class );
+
+		if ( ! $this->container->get( Gateway::class )->is_enabled() ) {
+			return;
+		}
+
+		$this->container->register( Syncs_Controller::class );
 	}
 
 	/**
@@ -57,7 +64,13 @@ public function unregister(): void {
 		$this->container->get( Assets::class )->unregister();
 		$this->container->get( Ajax::class )->unregister();
 		$this->container->get( Hooks::class )->unregister();
-		$this->container->get( Webhooks::class )->unregister();
 		$this->container->get( Notices\Controller::class )->unregister();
+		$this->container->get( Webhooks::class )->unregister();
+
+		if ( ! $this->container->get( Gateway::class )->is_enabled() ) {
+			return;
+		}
+
+		$this->container->get( Syncs_Controller::class )->unregister();
 	}
 }

src/Tickets/Commerce/Gateways/Square/Gateway.php

@@ -355,9 +355,9 @@ public static function is_test_mode(): bool {
 	 */
 	public function get_location_id(): string {
 		if ( static::is_test_mode() ) {
-			return (string) tribe_get_option( Settings::$option_sandbox_location_id, '' );
+			return (string) tribe_get_option( Settings::OPTION_SANDBOX_LOCATION_ID, '' );
 		}
 
-		return (string) tribe_get_option( Settings::$option_location_id, '' );
+		return (string) tribe_get_option( Settings::OPTION_LOCATION_ID, '' );
 	}
 }

src/Tickets/Commerce/Gateways/Square/Merchant.php

@@ -469,8 +469,7 @@ public function fetch_merchant_data( bool $force_refresh = false ): array {
 			return [];
 		}
 
-		// Make request using the Requests class.
-		$response = tribe( Requests::class )->get( "merchants/{$merchant_id}" );
+		$response = Requests::get_with_cache( "merchants/{$merchant_id}" );
 
 		// Handle error responses.
 		if ( is_wp_error( $response ) || isset( $response['errors'] ) ) {
@@ -623,10 +622,10 @@ public function get_client_secret(): string {
 	 * @return string
 	 */
 	public function get_client_id(): string {
-		$client_id = tribe_get_option( Settings::$option_client_id );
+		$client_id = tribe_get_option( Settings::OPTION_CLIENT_ID );
 
 		if ( empty( $client_id ) && tribe( Gateway::class )->is_test_mode() ) {
-			$client_id = tribe_get_option( Settings::$option_sandbox_client_id );
+			$client_id = tribe_get_option( Settings::OPTION_SANDBOX_CLIENT_ID );
 		}
 
 		return $client_id;
@@ -658,7 +657,7 @@ public function get_locations(): array {
 
 		$url      = 'locations';
 		$args     = [];
-		$response = tribe( Requests::class )->get( $url, [], $args );
+		$response = Requests::get_with_cache( $url, [], $args );
 
 		if ( empty( $response['locations'] ) || ! is_array( $response['locations'] ) ) {
 			return [];

src/Tickets/Commerce/Gateways/Square/Payment.php

@@ -69,14 +69,26 @@ public static function create( string $source_id, Value $value, ?WP_Post $order
 			$body['reference_id'] = $order->ID;
 		}
 
+		/**
+		 * Filters the payment body.
+		 *
+		 * @since TBD
+		 *
+		 * @param array    $body The payment body.
+		 * @param string   $source_id The source ID.
+		 * @param Value    $value The value object.
+		 * @param ?WP_Post $order The order post object.
+		 */
+		$body = apply_filters( 'tec_tickets_commerce_square_payment_body', $body, $source_id, $value, $order );
+
 		$args = [
 			'body'    => $body,
 			'headers' => [
 				'Content-Type' => 'application/json',
 			],
 		];
 
-		return tribe( Requests::class )->post( 'payments', $query_args, $args );
+		return Requests::post( 'payments', $query_args, $args );
 	}
 
 	/**
@@ -152,7 +164,7 @@ public static function get( string $payment_id ): ?array {
 			'body' => $body,
 		];
 
-		return tribe( Requests::class )->get( "payments/{$payment_id}", $query_args, $args );
+		return Requests::get_with_cache( "payments/{$payment_id}", $query_args, $args );
 	}
 
 	/**
@@ -178,7 +190,7 @@ public static function update( string $payment_id, array $data ): ?array {
 			'body' => $body,
 		];
 
-		return tribe( Requests::class )->put( "payments/{$payment_id}", $query_args, $args );
+		return Requests::put( "payments/{$payment_id}", $query_args, $args );
 	}
 
 	/**
@@ -205,7 +217,7 @@ public static function cancel( string $payment_id ): ?array {
 			'body' => $body,
 		];
 
-		return tribe( Requests::class )->post( "payments/{$payment_id}/cancel", $query_args, $args );
+		return Requests::post( "payments/{$payment_id}/cancel", $query_args, $args );
 	}
 
 	/**

src/Tickets/Commerce/Gateways/Square/Requests.php

@@ -50,6 +50,34 @@ class Requests extends Abstract_Requests {
 		'sandbox' => 'https://connect.squareupsandbox.com/v2',
 	];
 
+	/**
+	 * Get a response from the Square API with caching.
+	 *
+	 * @since TBD
+	 *
+	 * @param string $endpoint          The endpoint path.
+	 * @param array  $query_args        Query args appended to the URL.
+	 * @param array  $request_arguments Request arguments.
+	 * @param bool   $raw               Whether to return the raw response.
+	 *
+	 * @return array|null
+	 */
+	public static function get_with_cache( $endpoint, array $query_args = [], array $request_arguments = [], $raw = false ): ?array {
+		$cache_key = md5( wp_json_encode( [ $endpoint, $query_args, $request_arguments, $raw ] ) );
+		$cache     = tribe_cache();
+
+		$cached_response = $cache->get_transient( $cache_key );
+		if ( false !== $cached_response ) {
+			return $cached_response;
+		}
+
+		$response = self::get( $endpoint, $query_args, $request_arguments, $raw );
+
+		$cache->set_transient( $cache_key, $response, MINUTE_IN_SECONDS * 10 );
+
+		return $response;
+	}
+
 	/**
 	 * Get REST API endpoint URL for requests.
 	 *
@@ -80,4 +108,17 @@ public static function get_environment_url() {
 
 		return static::API_BASE_URLS[ $mode ] ?? static::API_BASE_URLS['sandbox'];
 	}
+
+	/**
+	 * Get the headers.
+	 *
+	 * @since TBD
+	 *
+	 * @return array The headers.
+	 */
+	public static function get_headers(): array {
+		return [
+			'Square-Version' => '2025-04-16',
+		];
+	}
 }

src/Tickets/Commerce/Gateways/Square/Settings.php

@@ -22,7 +22,7 @@ class Settings extends Abstract_Settings {
 	 *
 	 * @var string
 	 */
-	public static string $option_client_id = 'tickets-commerce-square-client-id';
+	const OPTION_CLIENT_ID = 'tickets-commerce-square-client-id';
 
 	/**
 	 * Sandbox Client ID option key.
@@ -31,7 +31,7 @@ class Settings extends Abstract_Settings {
 	 *
 	 * @var string
 	 */
-	public static string $option_sandbox_client_id = 'tickets-commerce-square-sandbox-client-id';
+	const OPTION_SANDBOX_CLIENT_ID = 'tickets-commerce-square-sandbox-client-id';
 
 	/**
 	 * Location ID option key.
@@ -40,7 +40,7 @@ class Settings extends Abstract_Settings {
 	 *
 	 * @var string
 	 */
-	public static string $option_location_id = 'tickets-commerce-square-location-id';
+	const OPTION_LOCATION_ID = 'tickets-commerce-square-location-id';
 
 	/**
 	 * Sandbox Location ID option key.
@@ -49,7 +49,16 @@ class Settings extends Abstract_Settings {
 	 *
 	 * @var string
 	 */
-	public static string $option_sandbox_location_id = 'tickets-commerce-square-sandbox-location-id';
+	const OPTION_SANDBOX_LOCATION_ID = 'tickets-commerce-square-sandbox-location-id';
+
+	/**
+	 * Inventory sync option key.
+	 *
+	 * @since TBD
+	 *
+	 * @var string
+	 */
+	const OPTION_INVENTORY_SYNC = 'tickets-commerce-square-inventory-sync';
 
 	/**
 	 * Get all the settings for the Square gateway.
@@ -95,24 +104,31 @@ public function get_settings(): array {
 				'type' => 'html',
 				'html' => '<h3>' . esc_html__( 'Square Settings', 'event-tickets' ) . '</h3>',
 			],
+			static::OPTION_INVENTORY_SYNC => [
+				'type'            => 'checkbox_bool',
+				'label'           => esc_html__( 'Enable Inventory Sync', 'event-tickets' ),
+				'tooltip'         => esc_html__( 'If this option is selected, your Posts with Tickets on sale will be kept in sync with your Square inventory.', 'event-tickets' ),
+				'default'         => false,
+				'validation_type' => 'boolean',
+			],
 		];
 
 		// If in sandbox mode, only show the sandbox location settings.
 		if ( $is_sandbox_mode ) {
-			$connected_settings[ static::$option_sandbox_location_id ] = [
+			$connected_settings[ static::OPTION_SANDBOX_LOCATION_ID ] = [
 				'type'            => 'dropdown',
-				'label'           => esc_html__( 'Square Test Location', 'event-tickets' ),
-				'tooltip'         => esc_html__( 'Select the Square test location to process test payments through.', 'event-tickets' ),
+				'label'           => esc_html__( 'Square Test Web Location', 'event-tickets' ),
+				'tooltip'         => esc_html__( 'Select the Square test location to process test payments.', 'event-tickets' ),
 				'validation_type' => 'options',
 				'options'         => $this->get_location_options( true ),
 				'can_be_empty'    => false,
 			];
 		} else {
 			// In live mode, only show the live location settings.
-			$connected_settings[ static::$option_location_id ] = [
+			$connected_settings[ static::OPTION_LOCATION_ID ] = [
 				'type'            => 'dropdown',
-				'label'           => esc_html__( 'Square Location', 'event-tickets' ),
-				'tooltip'         => esc_html__( 'Select the Square location to process payments through.', 'event-tickets' ),
+				'label'           => esc_html__( 'Square Web Location', 'event-tickets' ),
+				'tooltip'         => esc_html__( 'Select the Square location to process payments.', 'event-tickets' ),
 				'validation_type' => 'options',
 				'options'         => $this->get_location_options( false ),
 				'can_be_empty'    => false,
@@ -162,6 +178,17 @@ public function get_settings(): array {
 		return apply_filters( 'tec_tickets_commerce_square_settings', array_merge( $main_settings, $connected_settings ), $is_connected );
 	}
 
+	/**
+	 * Check if inventory sync is enabled.
+	 *
+	 * @since TBD
+	 *
+	 * @return bool Whether inventory sync is enabled.
+	 */
+	public function is_inventory_sync_enabled(): bool {
+		return tribe_is_truthy( tribe_get_option( static::OPTION_INVENTORY_SYNC ) );
+	}
+
 	/**
 	 * Get all available Square locations as an array of options for a dropdown field.
 	 *