use a concrete identifier rather than random env variables

Author: codemasher

.config/.env_example

@@ -236,6 +236,12 @@ TUMBLR_SECRET=
 TUMBLR_CALLBACK_URL=
 #TUMBLR_TESTUSER=
 
+# this is a copy of the tumblr key for the OAuth2 client
+TUMBLR2_KEY=
+TUMBLR2_SECRET=
+TUMBLR2_CALLBACK_URL=
+#TUMBLR2_TESTUSER=
+
 # https://www.twitch.tv/kraken/oauth2/clients/new
 TWITCH_KEY=
 TWITCH_SECRET=
@@ -248,6 +254,12 @@ TWITTER_SECRET=
 TWITTER_CALLBACK_URL=
 #TWITTER_TESTUSER=
 
+# this is a copy of the twitter key for the OAuth2 client
+TWITTERCC_KEY=
+TWITTERCC_SECRET=
+TWITTERCC_CALLBACK_URL=
+#TWITTERCC_TESTUSER=
+
 # https://developer.vimeo.com/apps/
 VIMEO_KEY=
 VIMEO_SECRET=

examples/OAuthExampleProviderFactory.php

@@ -84,14 +84,13 @@ protected function initFileStorage():OAuthStorageInterface{
 
 	public function getProvider(
 		string $providerFQN,
-		string $envVar,
 		int    $storageType = self::STORAGE_SESSION,
 	):OAuthInterface|OAuth1Interface|OAuth2Interface{
 		$options = new OAuthOptions;
-
-		$options->key              = ($this->getEnvVar($envVar.'_KEY') ?? '');
-		$options->secret           = ($this->getEnvVar($envVar.'_SECRET') ?? '');
-		$options->callbackURL      = ($this->getEnvVar($envVar.'_CALLBACK_URL') ?? '');
+		/** @param \chillerlan\OAuth\Core\OAuthInterface $providerFQN */
+		$options->key              = ($this->getEnvVar($providerFQN::IIDENTIFIER.'_KEY') ?? '');
+		$options->secret           = ($this->getEnvVar($providerFQN::IDENTIFIER.'_SECRET') ?? '');
+		$options->callbackURL      = ($this->getEnvVar($providerFQN::IDENTIFIER.'_CALLBACK_URL') ?? '');
 		$options->tokenAutoRefresh = true;
 		$options->sessionStart     = true;
 

examples/Providers/GitHub/github-common.php

@@ -9,9 +9,7 @@
 
 use chillerlan\OAuth\Providers\GitHub;
 
-$ENVVAR = 'GITHUB';
-
 require_once __DIR__.'/../../provider-example-common.php';
 
 /** @var \OAuthExampleProviderFactory $factory */
-$github = $factory->getProvider(GitHub::class, $ENVVAR, OAuthExampleProviderFactory::STORAGE_FILE);
+$github = $factory->getProvider(GitHub::class, OAuthExampleProviderFactory::STORAGE_FILE);

examples/Providers/LastFM/lastfm-common.php

@@ -10,9 +10,7 @@
 
 use chillerlan\OAuth\Providers\LastFM;
 
-$ENVVAR = 'LASTFM';
-
 require_once __DIR__.'/../../provider-example-common.php';
 
 /** @var \OAuthExampleProviderFactory $factory */
-$lfm = $factory->getProvider(LastFM::class, $ENVVAR, OAuthExampleProviderFactory::STORAGE_FILE);
+$lfm = $factory->getProvider(LastFM::class, OAuthExampleProviderFactory::STORAGE_FILE);

examples/Providers/Spotify/mixesdb-track-search.php

@@ -15,7 +15,6 @@
 /**
  * @var \OAuthExampleProviderFactory        $factory
  * @var \chillerlan\OAuth\Providers\Spotify $spotify
- * @var string                              $ENVVAR
  */
 require_once __DIR__.'/spotify-common.php';
 require_once __DIR__.'/MixesDBTrackSearch.php';
@@ -31,7 +30,7 @@
 	include __DIR__.'/mixesdb-scrape.php';
 }
 
-$spotify = $factory->getProvider(MixesDBTrackSearch::class, $ENVVAR, OAuthExampleProviderFactory::STORAGE_FILE);
+$spotify = $factory->getProvider(MixesDBTrackSearch::class, OAuthExampleProviderFactory::STORAGE_FILE);
 $spotify->getTracks($file, $since, $until, $find, $limit, $playlistPerSet);
 
 exit;

examples/Providers/Spotify/new-releases.php

@@ -16,7 +16,6 @@
 /**
  * @var \OAuthExampleProviderFactory $factory
  * @var \SpotifyNewReleases          $spotify
- * @var string                       $ENVVAR
  */
 
 require_once __DIR__.'/spotify-common.php';
@@ -30,7 +29,7 @@
 $fromCache         = false;
 $cacheDir          =  __DIR__.'/cache';
 
-$spotify = $factory->getProvider(SpotifyNewReleases::class, $ENVVAR, OAuthExampleProviderFactory::STORAGE_FILE);
+$spotify = $factory->getProvider(SpotifyNewReleases::class, OAuthExampleProviderFactory::STORAGE_FILE);
 $spotify->getNewReleases($since, $until, $minTracks, $skipVariousArtist, $skipAppearsOn, $fromCache, $cacheDir);
 
 /*

examples/Providers/Spotify/playlist-diff.php

@@ -34,8 +34,7 @@ public function diff(string $playlistID1, string $playlistID2, bool $createAsPla
 /**
  * @var \OAuthExampleProviderFactory $factory
  * @var \PlaylistDiff                $spotify
- * @var string                       $ENVVAR
  */
 
-$spotify = $factory->getProvider(PlaylistDiff::class, $ENVVAR, OAuthExampleProviderFactory::STORAGE_FILE);
+$spotify = $factory->getProvider(PlaylistDiff::class, OAuthExampleProviderFactory::STORAGE_FILE);
 $spotify->diff('37i9dQZF1DX4UtSsGT1Sbe', '37i9dQZF1DXb57FjYWz00c', true);

examples/Providers/Spotify/spotify-common.php

@@ -13,10 +13,8 @@
 
 use chillerlan\OAuth\Providers\Spotify;
 
-$ENVVAR = 'SPOTIFY';
-
 require_once __DIR__.'/../../provider-example-common.php';
 require_once __DIR__.'/SpotifyClient.php';
 
 /** @var \OAuthExampleProviderFactory $factory */
-$spotify = $factory->getProvider(Spotify::class, $ENVVAR, \OAuthExampleProviderFactory::STORAGE_FILE);
+$spotify = $factory->getProvider(Spotify::class, \OAuthExampleProviderFactory::STORAGE_FILE);

examples/get-token/Amazon.php

@@ -11,12 +11,10 @@
 
 use chillerlan\OAuth\Providers\Amazon;
 
-$ENVVAR ??= 'AMAZON';
-
 require_once __DIR__.'/../provider-example-common.php';
 
 /** @var \OAuthExampleProviderFactory $factory */
-$provider = $factory->getProvider(Amazon::class, $ENVVAR);
+$provider = $factory->getProvider(Amazon::class);
 
 require_once __DIR__.'/_flow-oauth2.php';
 

examples/get-token/BattleNet.php

@@ -11,12 +11,10 @@
 
 use chillerlan\OAuth\Providers\BattleNet;
 
-$ENVVAR ??= 'BATTLENET';
-
 require_once __DIR__.'/../provider-example-common.php';
 
 /** @var \OAuthExampleProviderFactory $factory */
-$provider = $factory->getProvider(BattleNet::class, $ENVVAR);
+$provider = $factory->getProvider(BattleNet::class);
 
 require_once __DIR__.'/_flow-oauth2.php';