Version 2.0.0

.distignore

@@ -6,6 +6,10 @@
 .gitignore
 composer.json
 composer.lock
+composer-deps.json
+composer-deps.lock
+/tmp*
+scoper.custom.php
 docker-compose.phpunit.yml
 docker-compose.yml
 Dockerfile
@@ -28,3 +32,6 @@ yarn.lock
 /tests
 phpunit.xml.dist
 .phpunit.result.cache
+vendor/**/*
+vendor/*
+vendor

.github/workflows/create-dev-zip.yml

@@ -0,0 +1,74 @@
+name: Create Dev Zip
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    env:
+      PLUGIN_SLUG: truelayer-for-woocommerce
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 1
+
+    - name: Create composer cache directory
+      run: mkdir -p ~/.composer/cache
+
+    - name: Cache Composer dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.composer/cache
+        key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-composer-
+
+    - name: Cache npm dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-npm-
+
+    - name: Install dependencies and build project
+      run: |
+        mkdir -p ~/.composer/cache
+        composer install --prefer-dist --no-progress
+        npm ci && npm run build
+
+    - name: Get branch name and commit hash
+      id: vars
+      run: |
+        BRANCH_NAME=$(echo ${GITHUB_REF#refs/heads/})
+        COMMIT_HASH=$(git rev-parse --short HEAD)
+        ZIP_FILE_NAME="${{ env.PLUGIN_SLUG }}-dev-${BRANCH_NAME}-${COMMIT_HASH}.zip"
+        echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV
+        echo "COMMIT_HASH=${COMMIT_HASH}" >> $GITHUB_ENV
+        echo "ZIP_FILE_NAME=${ZIP_FILE_NAME}" >> $GITHUB_ENV
+
+    - name: Modify version, prepare zip directory, and create zip file
+      run: |
+        sed -i "s/^ \* Version: \(.*\)/ \* Version: \1-dev.${BRANCH_NAME}.${COMMIT_HASH}/" ${{ env.PLUGIN_SLUG }}.php
+        mkdir -p dev-zip-temp/${{ env.PLUGIN_SLUG }}
+        rsync -av --exclude-from='.distignore' --exclude='dev-zip-temp' . dev-zip-temp/${{ env.PLUGIN_SLUG }}
+        cd dev-zip-temp
+        zip -r ../${{ env.ZIP_FILE_NAME }} ${{ env.PLUGIN_SLUG }}
+
+    - name: Configure AWS credentials
+      uses: aws-actions/configure-aws-credentials@v4
+      with:
+        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_KROKEDIL_PLUGIN_DEV_ZIP }}
+        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_KROKEDIL_PLUGIN_DEV_ZIP }}
+        aws-region: eu-north-1
+
+    - name: Upload to S3
+      run: |
+        aws s3 cp ${{ env.ZIP_FILE_NAME }} s3://krokedil-plugin-dev-zip/${{ env.ZIP_FILE_NAME }}
+
+    - name: Add annotation to workflow run with dev zip url
+      run: echo "::notice::Dev Zip Url available for 30 days, https://krokedil-plugin-dev-zip.s3.eu-north-1.amazonaws.com/${{ env.ZIP_FILE_NAME }}"

.github/workflows/deploy.yml

@@ -10,15 +10,16 @@ jobs:
     steps:
     - name: Checkout code
       uses: actions/checkout@master
-    - name: Install Composer dependencies
-      uses: php-actions/composer@v6
-      with:
-        dev: no
-        php_version: 7.4
+
+      # Install all composer packages and build dependencies folder with wpify/scoper.
+    - name: Composer Install
+      run: composer install
+
     - name: Build assets and translation files
       run: |
         npm ci
         npm run build
+
     - name: WordPress Plugin Deploy
       uses: 10up/action-wordpress-plugin-deploy@master
       env:

.github/workflows/pr-phpunit.yml

@@ -15,7 +15,7 @@ jobs:
       uses: php-actions/composer@v6
       with:
         dev: yes
-        php_version: 7.4
+        php_version: 8.1
 
     - name: Build assets and translation files
       run: |

.gitignore

@@ -14,9 +14,12 @@ project.properties
 
 node_modules/
 vendor
-
+/vendor-bin/**/vendor/
 .phpunit.result.cache
 
+dependencies/*
+!dependencies/.gitkeep
+
 # OS X metadata
 .DS_Store
 
@@ -30,3 +33,6 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# tmp folders from scoping.
+tmp*

assets/css/truelayer-for-woocommerce-admin.css

@@ -13,19 +13,19 @@
 }
 
 #krokdocs-text-container{
-    padding: 1em;
+    padding: 2em;
     border: 1px solid #ccc;
     width:  350px;
     background-color: #f5f5f5;
 }
 
 .krokdocs-sidebar-title {
     font-size:1.3em;
-    margin-bottom: 0.5em;
+    margin: 0 0 0.5em 0;
 }
 
 #krokdocs-sidebar-bottom-holder {
-    padding: 5px 10px 10px 10px;
+    padding: 5px 0 0 0;
     margin-top: 10px;
     align-self: flex-end;
     flex-direction: column;

classes/admin/class-wc-truelayer-banners.php

@@ -49,6 +49,10 @@ public static function settings_sidebar() {
 					<span class="small-title">Webhook URI:</span><br>
 					<code><?php echo esc_url( $callback_uri ); ?></code>
 				</p>
+				<p class="krokdocs-sidebar-main-text">
+					<strong>Please make sure that you have enabled pretty permalinks in your WordPress installation.</strong> Otherwise callbacks from TrueLayer back to your store won’t work and orders will not be updated with the correct order status/information.<br>
+					<a href="https://wordpress.org/documentation/article/customize-permalinks/#pretty-permalinks" target="_blank">What is pretty permalinks?</a>
+				</p>
 				<h3 class="krokdocs-sidebar-title">Support</h3>
 				<p class="krokdocs-sidebar-main-text">
 					If you have questions regarding a certain purchase you are welcome to contact <a href="https://www.truelayer.com/" target="_blank">TrueLayer</a>.

classes/class-truelayer-api.php

@@ -9,55 +9,38 @@
 	exit;
 }
 
+use KrokedilTrueLayerDeps\TrueLayer\Interfaces\MerchantAccount\MerchantAccountInterface;
+use KrokedilTrueLayerDeps\TrueLayer\Interfaces\Payment\PaymentCreatedInterface;
+use KrokedilTrueLayerDeps\TrueLayer\Interfaces\Payment\PaymentRetrievedInterface;
+use KrokedilTrueLayerDeps\TrueLayer\Interfaces\Payment\RefundCreatedInterface;
+
 /**
  * The TrueLayer API class.
  */
 class TrueLayer_API {
 
-
 	/**
-	 * Get a JWT auth token.
+	 * The settings.
 	 *
-	 * @return string
+	 * @var array
 	 */
-	public function get_token() {
-		$token = false === get_transient( 'truelayer_bearer_token' ) ? '' : get_transient( 'truelayer_bearer_token' );
-
-		// Decrypt token.
-		try {
-			$token = TruelayerEncryption()->decrypt( $token );
-		} catch ( Exception $e ) {
-			TrueLayer_Logger::log( sprintf( 'TrueLayer bearer token not encrypted when fetched from transient. Error message: %s', $e->getMessage() ) );
-		}
-
-		if ( empty( $token ) ) {
-
-			// Fetch a new token from TrueLayer.
-			$request  = new TrueLayer_Request_Get_Token();
-			$response = $request->request();
+	protected $settings;
 
-			if ( ! is_wp_error( $response ) && isset( $response['access_token'] ) ) {
-				$token = $response['access_token'];
-				// Encrypt token before saving it to db.
-				try {
-					$encrypted_token = TruelayerEncryption()->encrypt( $token );
-					set_transient( 'truelayer_bearer_token', $encrypted_token, $response['expires_in'] );
-				} catch ( Exception $e ) {
-					TrueLayer_Logger::log( sprintf( 'TrueLayer bearer token could not be encrypted when saved to db. Error message: %s', $e->getMessage() ) );
-				}
-			}
-		}
-		return $token;
+	/**
+	 * TrueLayer_API constructor.
+	 */
+	public function __construct() {
+		$this->settings = get_option( 'woocommerce_truelayer_settings', array() );
 	}
 
 	/**
 	 * Create a TrueLayer payment.
 	 *
-	 * @param int $order_id The WooCommerce Order ID.
-	 * @return mixed
+	 * @param WC_Order|int|WP_Post $order The WooCommerce order, order ID or WP_Post object.
+	 * @return PaymentCreatedInterface|WP_Error
 	 */
-	public function create_payment( $order_id ) {
-		$request  = new TrueLayer_Request_Create_Payment( array( 'order_id' => $order_id ) );
+	public function create_payment( $order ) {
+		$request  = new TrueLayer_Request_Create_Payment( array( 'order' => $order ) );
 		$response = $request->request();
 
 		return $this->check_for_api_error( $response );
@@ -66,17 +49,17 @@ public function create_payment( $order_id ) {
 	/**
 	 * Refund Payment via TrueLayer.
 	 *
-	 * @param int    $order_id the WooCOmmerce Order ID.
-	 * @param int    $amount The amount to be refunded.
-	 * @param string $reason the refund reason.
-	 * @return mixed
+	 * @param WC_Order|int|WP_Post $order The WooCommerce order, order ID or WP_Post object.
+	 * @param int                  $amount The amount to be refunded.
+	 * @param string               $reason the refund reason.
+	 * @return RefundCreatedInterface|WP_Error
 	 */
-	public function refund_payment( $order_id, $amount, $reason ) {
+	public function refund_payment( $order, $amount, $reason ) {
 		$request  = new TrueLayer_Request_Refunds(
 			array(
-				'order_id' => $order_id,
-				'amount'   => $amount,
-				'reason'   => $reason,
+				'order'  => $order,
+				'amount' => $amount,
+				'reason' => $reason,
 			)
 		);
 		$response = $request->request();
@@ -88,7 +71,7 @@ public function refund_payment( $order_id, $amount, $reason ) {
 	 * Get the TrueLayer payment status.
 	 *
 	 * @param string $transaction_id The TrueLayer payment ID.
-	 * @return mixed
+	 * @return PaymentRetrievedInterface|WP_Error
 	 */
 	public function get_payment_status( $transaction_id ) {
 		$request  = new TrueLayer_Request_Get_Payment_Status( array( 'transaction_id' => $transaction_id ) );
@@ -98,29 +81,21 @@ public function get_payment_status( $transaction_id ) {
 	}
 
 	/**
-	 * Get the TrueLayer payment status.
+	 * Get the TrueLayer merchant accounts.
 	 *
-	 * @param string $transaction_id The TrueLayer payment ID.
-	 * @return mixed
+	 * @return MerchantAccountInterface[]|WP_Error
 	 */
-	public function get_merchant_accounts( $transaction_id ) {
-		$request  = new TrueLayer_Get_Merchant_Account( array( 'transaction_id' => $transaction_id ) );
+	public function get_merchant_accounts() {
+		$request  = new TrueLayer_Get_Merchant_Accounts( array() );
 		$response = $request->request();
 
-		foreach ( $response['items'] as $truelayer_item ) {
-
-			if ( 'GBP' === $truelayer_item['currency'] ) {
-				update_post_meta( $transaction_id, '_truelayer_merchant_account_id', $truelayer_item['id'] );
-			}
-		}
-
 		return $this->check_for_api_error( $response );
 	}
 
 	/**
 	 * Checks for WP Errors and returns either the response as array or a false.
 	 *
-	 * @param array $response The response from the request.
+	 * @param object|WP_Error $response The response from the request.
 	 * @return mixed
 	 */
 	private function check_for_api_error( $response ) {
@@ -131,5 +106,4 @@ private function check_for_api_error( $response ) {
 		}
 		return $response;
 	}
-
 }

classes/class-truelayer-encryption.php

@@ -5,11 +5,11 @@
  * @package TrueLayer/Classes/
  */
 
-use Defuse\Crypto\Crypto;
-use Defuse\Crypto\Exception\BadFormatException;
-use Defuse\Crypto\Exception\EnvironmentIsBrokenException;
-use Defuse\Crypto\Exception\WrongKeyOrModifiedCiphertextException;
-use Defuse\Crypto\Key;
+use KrokedilTrueLayerDeps\Defuse\Crypto\Crypto;
+use KrokedilTrueLayerDeps\Defuse\Crypto\Exception\BadFormatException;
+use KrokedilTrueLayerDeps\Defuse\Crypto\Exception\EnvironmentIsBrokenException;
+use KrokedilTrueLayerDeps\Defuse\Crypto\Exception\WrongKeyOrModifiedCiphertextException;
+use KrokedilTrueLayerDeps\Defuse\Crypto\Key;
 
 /**
  * Class Truelayer_Encryption
@@ -157,7 +157,7 @@ public function decrypt_values( $settings ) {
 		delete_option( 'truelayer_encryption_error' );
 
 		foreach ( $this->encrypted_keys as $encrypted_key ) {
-			$decrypted_value            = $this->decrypt_value( $encrypted_key );
+			$decrypted_value = $this->decrypt_value( $encrypted_key );
 
 			$settings[ $encrypted_key ] = $decrypted_value ? $decrypted_value : '';
 		}
@@ -168,7 +168,7 @@ public function decrypt_values( $settings ) {
 	/**
 	 * Returns the setting with the encrypted values decrypted.
 	 *
-	 * @param string $key The key to decrypt.
+	 * @param string      $key The key to decrypt.
 	 * @param string|bool $value The value to decrypt. Pass null to use the value from the settings array.
 	 *
 	 * @return string
@@ -200,8 +200,7 @@ public function encrypt( $value ) {
 		if ( defined( 'TRUELAYER_KEY' ) ) {
 			try {
 				return Crypto::encrypt( $value, $this->key );
-			}
-			catch (EnvironmentIsBrokenException | WrongKeyOrModifiedCiphertextException | BadFormatException $e) {
+			} catch ( EnvironmentIsBrokenException | WrongKeyOrModifiedCiphertextException | BadFormatException $e ) {
 				// If the value could not be encrypted, then we should add a error notice to the admin.
 				$message = __( 'There was an error when encrypting the settings for TrueLayer, please reconfigure the plugin and ensure the settings are saved properly.', 'truelayer-for-woocommerce' );
 				update_option( 'truelayer_encryption_error', $message, 'no' );
@@ -229,8 +228,7 @@ public function decrypt( $raw_value ) {
 		if ( defined( 'TRUELAYER_KEY' ) ) {
 			try {
 				return Crypto::decrypt( $raw_value, $this->key );
-			}
-			catch (EnvironmentIsBrokenException | WrongKeyOrModifiedCiphertextException | BadFormatException $e) {
+			} catch ( EnvironmentIsBrokenException | WrongKeyOrModifiedCiphertextException | BadFormatException $e ) {
 				// If the value could not be decrypted, then we should add a error notice to the admin.
 				$message = __( 'There was an error when decrypting the settings for TrueLayer, please reconfigure the plugin and ensure the settings are saved properly.', 'truelayer-for-woocommerce' );
 				update_option( 'truelayer_encryption_error', $message, 'no' );
@@ -266,8 +264,7 @@ private function get_default_key() {
 			delete_option( 'truelayer_encryption_key_error' );
 			try {
 				return Key::loadFromAsciiSafeString( TRUELAYER_KEY );
-			}
-			catch (BadFormatException | EnvironmentIsBrokenException $e) {
+			} catch ( BadFormatException | EnvironmentIsBrokenException $e ) {
 				$message = __( 'There was an error when loading the encryption key for TrueLayer, please ensure the encryption key saved in the <code>wp-config.php</code> file as <code>TRUELAYER_KEY</code> has not been modified. To reset delete the definition and add a new key.', 'truelayer-for-woocommerce' );
 				update_option( 'truelayer_encryption_key_error', $message, 'no' );
 				return null;