Added refresh cron and refresh method

This commit is contained in:
Justin Foell
2019-06-03 14:27:14 -05:00
parent 15de60d764
commit cfdf3aae9e
5 changed files with 128 additions and 15 deletions
+3 -2
View File
@@ -46,11 +46,12 @@ class WPStrava {
*/ */
private function __construct() { private function __construct() {
$this->settings = new WPStrava_Settings(); $this->settings = new WPStrava_Settings();
$this->auth = WPStrava_Auth::get_auth( 'forever' ); $this->auth = WPStrava_Auth::get_auth( 'refresh' );
$this->auth->hook();
if ( is_admin() ) { if ( is_admin() ) {
$this->settings->hook(); $this->settings->hook();
$this->auth->hook();
} else { } else {
add_action( 'init', array( $this, 'register_shortcodes' ) ); add_action( 'init', array( $this, 'register_shortcodes' ) );
add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts' ) ); add_action( 'wp_enqueue_scripts', array( $this, 'register_scripts' ) );
+11 -3
View File
@@ -24,8 +24,10 @@ abstract class WPStrava_Auth {
abstract protected function get_authorize_url( $client_id ); abstract protected function get_authorize_url( $client_id );
public function hook() { public function hook() {
add_filter( 'pre_set_transient_settings_errors', array( $this, 'maybe_oauth' ) ); if ( is_admin() ) {
add_action( 'admin_init', array( $this, 'init' ) ); add_filter( 'pre_set_transient_settings_errors', array( $this, 'maybe_oauth' ) );
add_action( 'admin_init', array( $this, 'init' ) );
}
} }
/** /**
@@ -92,11 +94,13 @@ abstract class WPStrava_Auth {
'code' => $code, 'code' => $code,
); );
$data = $this->add_initial_params( $data );
$strava_info = $this->token_request( $data ); $strava_info = $this->token_request( $data );
if ( isset( $strava_info->access_token ) ) { if ( isset( $strava_info->access_token ) ) {
$settings->add_id( $client_id ); $settings->add_id( $client_id );
$settings->save_info( $client_id, $strava_info ); $settings->save_info( $client_id, $client_secret, $strava_info );
$this->feedback .= __( 'Successfully authenticated.', 'wp-strava' ); $this->feedback .= __( 'Successfully authenticated.', 'wp-strava' );
return $strava_info; return $strava_info;
@@ -117,4 +121,8 @@ abstract class WPStrava_Auth {
return $api->post( 'oauth/token', $data ); return $api->post( 'oauth/token', $data );
} }
protected function add_initial_params( $data ) {
return $data;
}
} }
+9
View File
@@ -9,9 +9,18 @@
* AuthForever Class * AuthForever Class
* *
* @since 2.0.0 * @since 2.0.0
* @see http://developers.strava.com/docs/authentication/
*/ */
class WPStrava_AuthForever extends WPStrava_Auth { class WPStrava_AuthForever extends WPStrava_Auth {
/**
* Authorize URL for old style forever tokens.
*
* @param int $client_id Strava API Client ID.
* @return string URL to authorize against.
* @author Justin Foell <justin@foell.org>
* @since 2.0.0
*/
protected function get_authorize_url( $client_id ) { protected function get_authorize_url( $client_id ) {
return add_query_arg( return add_query_arg(
array( array(
+84 -6
View File
@@ -4,14 +4,61 @@
* AuthRefresh class * AuthRefresh class
* *
* @since 2.0.0 * @since 2.0.0
* @see http://developers.strava.com/docs/authentication/
*/ */
class WPStrava_AuthRefresh extends WPStrava_Auth { class WPStrava_AuthRefresh extends WPStrava_Auth {
/**
* Hooks.
*
* @author Justin Foell <justin@foell.org>
* @since 2.0.0
*/
public function hook() { public function hook() {
parent::hook(); parent::hook();
// @TODO Need cronjob.
// Refresh tokens via cronjob.
add_action( 'init', array( $this, 'setup_auth_refresh_cron' ) );
add_action( 'wp_strava_auth_refresh_cron', array( $this, 'auth_refresh' ) );
} }
/**
* Set up cron to refresh the auth token hourly (expires after 6-hours).
*
* @author Justin Foell <justin@foell.org>
* @since 2.0.0
*/
public function setup_auth_refresh_cron() {
// Schedule the cron job to purge all expired transients.
if ( ! wp_next_scheduled( 'wp_strava_auth_refresh_cron' ) ) {
wp_schedule_event( time(), 'hourly', 'wp_strava_auth_refresh_cron' );
}
}
/**
* Cron method to refresh auth tokens from Strava.
*
* @author Justin Foell
* @since 2.0.0
*/
public function auth_refresh() {
$settings = WPStrava::get_instance()->settings;
foreach ( $settings->info as $client_id => $info ) {
if ( ! empty( $info->refresh_token ) ) {
$this->token_exchange_refresh( $client_id, $info );
}
}
}
/**
* Authorize URL for new style refresh token auth.
*
* @param int $client_id Strava API Client ID.
* @return string URL to authorize against.
* @author Justin Foell <justin@foell.org>
* @since 2.0.0
*/
protected function get_authorize_url( $client_id ) { protected function get_authorize_url( $client_id ) {
return add_query_arg( return add_query_arg(
array( array(
@@ -24,21 +71,52 @@ class WPStrava_AuthRefresh extends WPStrava_Auth {
); );
} }
protected function token_exchange_refresh() { /**
* Add 'authorization_code' grand type to first API request (when authenticating a new user).
*
* @param array $data Request array for the Strava API.
* @return array Data array with 'grant_type' => 'authorization_code' added.
* @author Justin Foell <justin@foell.org>
* @since 2.0.0
*/
protected function add_initial_params( $data ) {
$data['grant_type'] = 'authorization_code';
return $data;
}
/**
* Extend access by contacting strava with a refresh token.
*
* @param int $client_id
* @param stdClass $info
* @return boolean True if refreshed successfully, false otherwise.
* @author Justin Foell <justin@foell.org>
* @since 2.0.0
*/
protected function token_exchange_refresh( $client_id, $info ) {
$data = array( $data = array(
'client_id' => $client_id, 'client_id' => $client_id,
'client_secret' => $client_secret, 'client_secret' => $info->client_secret,
'refresh_token' => $refresh_token, 'refresh_token' => $info->refresh_token,
'grant_type' => 'refresh_token', 'grant_type' => 'refresh_token',
); );
$strava_info = $this->token_request( $data ); $strava_info = $this->token_request( $data );
if ( isset( $strava_info->access_token ) ) { if ( isset( $strava_info->access_token ) ) {
$this->feedback .= __( 'Successfully re-authenticated.', 'wp-strava' ); $this->feedback .= __( 'ID %s successfully re-authenticated.', 'wp-strava' );
return $strava_info;
if ( $strava_info->access_token != $info->access_token ) {
$this->feedback .= __( 'ID %s access extended.', 'wp-strava' );
$settings = WPStrava::get_instance()->settings;
$settings->save_info( $client_id, $info->client_secret, $strava_info );
}
return true;
} }
// @TODO how to determine if refresh wasn't successful?
$this->feedback .= sprintf( __( 'There was an error receiving data from Strava: <pre>%s</pre>', 'wp-strava' ), print_r( $strava_info, true ) ); // phpcs:ignore -- Debug output. $this->feedback .= sprintf( __( 'There was an error receiving data from Strava: <pre>%s</pre>', 'wp-strava' ), print_r( $strava_info, true ) ); // phpcs:ignore -- Debug output.
return false; return false;
} }
+21 -4
View File
@@ -398,18 +398,35 @@ class WPStrava_Settings {
/** /**
* Undocumented function * Undocumented function
* *
* @param [type] $id * @param int $id Strava API Client ID
* @param [type] $info * @param string $secret Strava API Client Secret
* @return void * @param stdClass $info
* @author Justin Foell <justin.foell@webdevstudios.com> * @author Justin Foell <justin.foell@webdevstudios.com>
* @since 2.0.0 * @since 2.0.0
*/ */
public function save_info( $id, $info ) { public function save_info( $id, $secret, $info ) {
$infos = get_option( 'strava_info', array() ); $infos = get_option( 'strava_info', array() );
$infos = array_filter( $infos, array( $this, 'filter_by_id' ), ARRAY_FILTER_USE_KEY ); // Remove old IDs.
$info->client_secret = $secret;
$infos[ $id ] = $info; $infos[ $id ] = $info;
update_option( 'strava_info', $infos ); update_option( 'strava_info', $infos );
} }
/**
* array_filter() callback to remove info for IDs we no longer have.
*
* @param int $key Strava Client ID
* @return boolean True if Client ID is in $this->ids, false otherwise.
* @author Justin Foell <justin.foell@webdevstudios.com>
* @since 2.0.0
*/
public function filter_by_id( $key ) {
if ( in_array( $key, $this->ids ) ) {
return true;
}
return false;
}
/** /**
* Undocumented function * Undocumented function
* *