🚿 allow custom scopes in examples

codemasher · codemasher · commit 062dd541fe47 · 2021-04-17T15:38:30.000+02:00
diff --git a/examples/get-token/Amazon.php b/examples/get-token/Amazon.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $amazon      = new Amazon($http, $storage, $options, $logger);
 $servicename = $amazon->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$amazon->getAuthURL());
+	header('Location: '.$amazon->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/BattleNet.php b/examples/get-token/BattleNet.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $battlenet   = new BattleNet($http, $storage, $options, $logger);
 $servicename = $battlenet->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$battlenet->getAuthURL());
+	header('Location: '.$battlenet->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Deezer.php b/examples/get-token/Deezer.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $deezer      = new Deezer($http, $storage, $options, $logger);
 $servicename = $deezer->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$deezer->getAuthURL());
+	header('Location: '.$deezer->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/DeviantArt.php b/examples/get-token/DeviantArt.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $deviantart  = new DeviantArt($http, $storage, $options, $logger);
 $servicename = $deviantart->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$deviantart->getAuthURL());
+	header('Location: '.$deviantart->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Discord.php b/examples/get-token/Discord.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $discord     = new Discord($http, $storage, $options, $logger);
 $servicename = $discord->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$discord->getAuthURL());
+	header('Location: '.$discord->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/GitHub.php b/examples/get-token/GitHub.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $github      = new GitHub($http, $storage, $options, $logger);
 $servicename = $github->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$github->getAuthURL());
+	header('Location: '.$github->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Gitter.php b/examples/get-token/Gitter.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $gitter      = new Gitter($http, $storage, $options, $logger);
 $servicename = $gitter->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$gitter->getAuthURL());
+	header('Location: '.$gitter->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Google.php b/examples/get-token/Google.php
@@ -20,6 +20,7 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $google      = new Google($http, $storage, $options, $logger);
@@ -29,7 +30,7 @@
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
 	$params = ['access_type' => 'online'];
 
-	header('Location: '.$google->getAuthURL($params));
+	header('Location: '.$google->getAuthURL($params, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Instagram.php b/examples/get-token/Instagram.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $instagram   = new Instagram($http, $storage, $options, $logger);
 $servicename = $instagram->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$instagram->getAuthURL());
+	header('Location: '.$instagram->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Mastodon.php b/examples/get-token/Mastodon.php
@@ -21,6 +21,7 @@
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
  * @var \chillerlan\DotEnv\DotEnv $env
+ * @var array $SCOPES
  */
 
 // set the mastodon instance we're about to request data from
@@ -29,7 +30,7 @@
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$mastodon->getAuthURL());
+	header('Location: '.$mastodon->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/MicrosoftGraph.php b/examples/get-token/MicrosoftGraph.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $msgraph     = new MicrosoftGraph($http, $storage, $options, $logger);
 $servicename = $msgraph->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$msgraph->getAuthURL());
+	header('Location: '.$msgraph->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/NPROne.php b/examples/get-token/NPROne.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $npr         = new NPROne($http, $storage, $options, $logger);
 $servicename = $npr->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$npr->getAuthURL());
+	header('Location: '.$npr->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Patreon1.php b/examples/get-token/Patreon1.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $patreon1    = new Patreon1($http, $storage, $options, $logger);
 $servicename = $patreon1->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$patreon1->getAuthURL());
+	header('Location: '.$patreon1->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Patreon2.php b/examples/get-token/Patreon2.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $patreon2    = new Patreon2($http, $storage, $options, $logger);
 $servicename = $patreon2->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$patreon2->getAuthURL());
+	header('Location: '.$patreon2->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/PayPal.php b/examples/get-token/PayPal.php
@@ -20,6 +20,7 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $paypal      = new PayPal($http, $storage, $options, $logger);
@@ -28,7 +29,7 @@
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$paypal->getAuthURL(['flowEntry' => 'static', 'fullPage' => 'true']));
+	header('Location: '.$paypal->getAuthURL(['flowEntry' => 'static', 'fullPage' => 'true'], $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Slack.php b/examples/get-token/Slack.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $slack       = new Slack($http, $storage, $options, $logger);
 $servicename = $slack->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$slack->getAuthURL());
+	header('Location: '.$slack->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/SoundCloud.php b/examples/get-token/SoundCloud.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $soundcloud  = new SoundCloud($http, $storage, $options, $logger);
 $servicename = $soundcloud->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$soundcloud->getAuthURL());
+	header('Location: '.$soundcloud->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code'])){ // soundcloud doesn't support <state>
diff --git a/examples/get-token/Spotify.php b/examples/get-token/Spotify.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $spotify     = new Spotify($http, $storage, $options, $logger);
 $servicename = $spotify->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$spotify->getAuthURL());
+	header('Location: '.$spotify->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Stripe.php b/examples/get-token/Stripe.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $stripe      = new Stripe($http, $storage, $options, $logger);
 $servicename = $stripe->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$stripe->getAuthURL());
+	header('Location: '.$stripe->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Twitch.php b/examples/get-token/Twitch.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $twitch      = new Twitch($http, $storage, $options, $logger);
 $servicename = $twitch->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$twitch->getAuthURL());
+	header('Location: '.$twitch->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Vimeo.php b/examples/get-token/Vimeo.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $vimeo       = new Vimeo($http, $storage, $options, $logger);
 $servicename = $vimeo->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$vimeo->getAuthURL());
+	header('Location: '.$vimeo->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/get-token/Wordpress.php b/examples/get-token/Wordpress.php
@@ -20,14 +20,15 @@
  * @var \chillerlan\OAuth\Storage\OAuthStorageInterface $storage
  * @var \chillerlan\Settings\SettingsContainerInterface $options
  * @var \Psr\Log\LoggerInterface $logger
+ * @var array $SCOPES
  */
 
 $wordpress   = new Wordpress($http, $storage, $options, $logger);
 $servicename = $wordpress->serviceName;
 
 // step 2: redirect to the provider's login screen
 if(isset($_GET['login']) && $_GET['login'] === $servicename){
-	header('Location: '.$wordpress->getAuthURL());
+	header('Location: '.$wordpress->getAuthURL(null, $SCOPES));
 }
 // step 3: receive the access token
 elseif(isset($_GET['code']) && isset($_GET['state'])){
diff --git a/examples/provider-example-common.php b/examples/provider-example-common.php
@@ -35,11 +35,13 @@
  * @var string $ENVVAR   - name prefix for the environment variable
  * @var string $CFGDIR   - the directory where configuration is stored (.env, cacert, tokens)
  * @var string $LOGLEVEL - log level for the test logger, use 'none' to suppress logging
+ * @var array  $SCOPES   - a set of scopes for the current provider (OAuth2 only)
  */
-$ENVFILE  = $ENVFILE ?? '.env';
-$ENVVAR   = $ENVVAR ?? '';
-$CFGDIR   = $CFGDIR ?? __DIR__.'/../config';
-$LOGLEVEL = $LOGLEVEL ?? 'info';
+$ENVFILE  ??= '.env';
+$ENVVAR   ??= '';
+$CFGDIR   ??= __DIR__.'/../config';
+$LOGLEVEL ??= 'info';
+$SCOPES   ??= null;
 
 $env = (new DotEnv($CFGDIR, $ENVFILE, false))->load();
 
