Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pinterest v5 store refresh times. #850

Merged
merged 7 commits into from
Jan 17, 2024
Merged

Pinterest v5 store refresh times. #850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0fc436b
Store refresh times.
budzanowski Nov 8, 2023
f09ed29
Refactor RefreshToken
budzanowski Nov 10, 2023
669092a
Fix PHPCS findings.
budzanowski Nov 13, 2023
edeff9a
remove wrong line
budzanowski Dec 29, 2023
168c3dd
Fix indentation
budzanowski Dec 29, 2023
52e8f7c
Ignore false positive
budzanowski Dec 29, 2023
7c5a9b4
Update unit tests.
budzanowski Dec 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions class-pinterest-for-woocommerce.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -717,17 +717,20 @@ public static function get_access_token() {
* Save encrypted token data. See the documentation of the get_token() method for the expected format of the related data variables.
*
* @since 1.0.0
* @since x.x.x Added refresh token and tokens expiration.
*
* @param array $token The array containing the token values to save.
*
* @return boolean
*/
public static function save_token_data( $token ) {
$token['access_token'] = empty( $token['access_token'] ) ? '' : Pinterest\Crypto::encrypt( $token['access_token'] );
$token['expires_in'] = $token['expires_in'] ?? '';
$token['refresh_token'] = empty( $token['refresh_token'] ) ? '' : Pinterest\Crypto::encrypt( $token['refresh_token'] );
$token['refresh_token_expires_in'] = $token['refresh_token_expires_in'] ?? '';
$token['scopes'] = empty( $token['scopes'] ) ? '' : $token['scopes'];
$token['refresh_time'] = time();

$token['access_token'] = empty( $token['access_token'] ) ? '' : Pinterest\Crypto::encrypt( $token['access_token'] );
$token['refresh_token'] = empty( $token['refresh_token'] ) ? '' : Pinterest\Crypto::encrypt( $token['refresh_token'] );
$token['scopes'] = empty( $token['scopes'] ) ? '' : $token['scopes'];
$token['refresh_date'] = time();
return self::save_data( 'token_data', $token );
}

Expand Down
96 changes: 66 additions & 30 deletions src/RefreshToken.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public static function schedule_event() {
public static function handle_refresh(): bool {
$token_data = Pinterest_For_Woocommerce::get_data( 'token_data', true );
$expires_in = intval( $token_data['expires_in'] );
$refresh_date = intval( $token_data['refresh_date'] );
$refresh_time = intval( $token_data['refresh_time'] );

/**
* Filters to determine if it is time to start refreshing the token.
Expand All @@ -53,43 +53,79 @@ public static function handle_refresh(): bool {
*/
$maybe_refresh = apply_filters(
PINTEREST_FOR_WOOCOMMERCE_OPTION_NAME . '_maybe_refresh_token',
$refresh_date + $expires_in - 2 * DAY_IN_SECONDS <= time()
( $refresh_time + $expires_in - 2 * DAY_IN_SECONDS ) <= time()
);

// Translators: %s is the value of $maybe_refresh.
$refresh_log = sprintf( 'Should refresh pinterest access token: %s', wc_bool_to_string( $maybe_refresh ) );
Logger::log( $refresh_log, WC_Log_Levels::DEBUG, 'pinterest-for-woocommerce' );

if ( $maybe_refresh ) {
try {
$endpoint = Pinterest_For_Woocommerce::get_connection_proxy_url() . 'renew/' . PINTEREST_FOR_WOOCOMMERCE_WOO_CONNECT_SERVICE;
$options = array(
'headers' => array(
'Content-Type' => 'application/x-www-form-urlencoded',
),
'body' => array(
'refresh_token' => Crypto::decrypt( $token_data['refresh_token'] ),
'url' => get_site_url(),
),
'sslverify' => false,
);

// Translators: %1$s is the endpoint, %2$s is the options.
$request_log = sprintf( 'Refresh token request to %1$s with %2$s', $endpoint, json_encode( $options ) );
Logger::log( $request_log, WC_Log_Levels::DEBUG, 'pinterest-for-woocommerce' );

$response = wp_safe_remote_post( $endpoint, $options );
$body = trim( wp_remote_retrieve_body( $response ) );

Logger::log( $body, WC_Log_Levels::DEBUG, 'pinterest-for-woocommerce' );

$body = json_decode( $body, true );
Pinterest_For_Woocommerce::save_token_data( $body );
$refreshed_token_data = self::refresh_token( $token_data );
Pinterest_For_Woocommerce::save_token_data( $refreshed_token_data );
} catch ( Exception $e ) {
Logger::log( $e->getMessage(), WC_Log_Levels::ERROR, 'pinterest-for-woocommerce' );
self::log( $e->getMessage(), WC_Log_Levels::ERROR );
return false;
}
}
return true;
}

/**
* Refreshes the token by sending a request to the Pinterest API.
*
* @param array $token_data The token data to be refreshed.
*
* @since x.x.x
*
* @throws Exception If the request fails.
*
* @return array|false The refreshed token data or false if the request failed.
*/
private static function refresh_token( $token_data ) {
$endpoint = Pinterest_For_Woocommerce::get_connection_proxy_url() . 'renew/' . PINTEREST_FOR_WOOCOMMERCE_WOO_CONNECT_SERVICE;
$options = array(
'headers' => array(
'Content-Type' => 'application/x-www-form-urlencoded',
),
'body' => array(
'refresh_token' => Crypto::decrypt( $token_data['refresh_token'] ),
'url' => get_site_url(),
),
'sslverify' => false,
);

// Translators: %s is the endpoint.
$request_log = sprintf( __( 'Refresh token request to %s.', 'pinterest-for-woocommerce' ), $endpoint );
self::log( $request_log );

$response = wp_safe_remote_post( $endpoint, $options );

if ( is_wp_error( $response ) ) {
throw new Exception( $response->get_error_message() ); // phpcs:ignore WordPress.Security.EscapeOutput.ExceptionNotEscaped
}

$body = trim( wp_remote_retrieve_body( $response ) );
$body = json_decode( $body, true );

$response['body'] = '**************';
self::log( $response );

if ( ! is_array( $body ) || ! isset( $body['access_token'], $body['expires_in'] ) ) {
return false;
}

return $body;
}

/**
* Logs a message to the log file.
*
* @since x.x.x
*
* @param string $message The message to be logged.
* @param string $level The level of the message.
*
* @return void
*/
public static function log( $message, $level = WC_Log_Levels::DEBUG ) {
Logger::log( $message, $level, 'pinterest-for-woocommerce-oauth-refresh' );
}
}
13 changes: 12 additions & 1 deletion tests/Unit/RefreshTokenTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,18 @@ function ( $response, $parsed_args, $url ) {
$url
);
$this->assertEquals( 'pinr.refresh_token', $parsed_args['body']['refresh_token'] ?? '' );
return true;
return array(
'body' =>
json_encode(
array(
'token_type' => 'bearer',
'access_token' => 'pina.access_token',
'expires_in' => 30 * DAY_IN_SECONDS,
'refresh_token' => 'pinr.new_refresh_token',
'scope' => 'ads:read ads:write catalogs:read catalogs:write pins:read pins:write user_accounts:read user_accounts:write',
),
),
);
},
10,
3
Expand Down