Add 'revoke auth' form, fix up some doc blocks

modules/salesforce_mapping/salesforce_mapping.info.yml

@@ -6,4 +6,4 @@ core: 8.x
 configure: entity.salesforce_mapping.list
 dependencies:
   - salesforce
-  - dynamic_entity_reference
+  - dynamic_entity_reference (2.x)

salesforce.links.menu.yml

@@ -15,9 +15,18 @@ salesforce.global_settings:
   parent: salesforce.admin_config_salesforce
   title: Salesforce Settings
   description: 'Manage global settings for Salesforce Suite.'
+  weight: -100
 
 salesforce.authorize:
   route_name: salesforce.authorize
   parent: salesforce.admin_config_salesforce
   title: Salesforce Authorization
   description: 'Manage OAuth consumer key and secret and authorize. View existing authorization details.'
+  weight: 99
+
+salesforce.revoke:
+  route_name: salesforce.revoke
+  parent: salesforce.admin_config_salesforce
+  title: Revoke Salesforce Authorization
+  description: 'Revoke OAuth tokens.'
+  weight: 100

salesforce.routing.yml

@@ -14,6 +14,15 @@ salesforce.authorize:
   requirements:
     _permission: 'authorize salesforce'
 
+salesforce.revoke:
+  path: '/admin/config/salesforce/revoke'
+  defaults:
+    _form: '\Drupal\salesforce\Form\RevokeAuthorizationForm'
+    _title: 'Revoke Salesforce Authorization'
+    _description: 'Revoke OAuth tokens.'
+  requirements:
+    _permission: 'authorize salesforce'
+
 salesforce.global_settings:
   path: '/admin/config/salesforce/settings'
   defaults:

src/Form/AuthorizeForm.php

@@ -47,7 +47,7 @@ class AuthorizeForm extends ConfigFormBase {
    *
    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
    *   The factory for configuration objects.
-   * @param \Drupal\salesforce\RestClient $salesforce_client
+   * @param \Drupal\salesforce\Rest\RestClientInterface $salesforce_client
    *   The factory for configuration objects.
    * @param \Drupal\Core\State\StateInterface $state
    *   The state keyvalue collection to use.
@@ -144,7 +144,8 @@ class AuthorizeForm extends ConfigFormBase {
           ];
         }
       }
-      catch (RequestException $e) {
+      catch (\Exception $e) {
+        // Do not allow any exceptions to interfere with displaying this page.
         drupal_set_message($e->getMessage(), 'warning');
         $this->eventDispatcher->dispatch(SalesforceEvents::ERROR, new SalesforceErrorEvent($e));
       }

src/Form/RevokeAuthorizationForm.php

+<?php
+
+namespace Drupal\salesforce\Form;
+
+use Drupal\Core\Config\ConfigFactoryInterface;
+use Drupal\Core\Form\ConfigFormBase;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\salesforce\Event\SalesforceEvents;
+use Drupal\salesforce\Event\SalesforceNoticeEvent;
+use Drupal\salesforce\Rest\RestClientInterface;
+use Drupal\Core\State\StateInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+
+class RevokeAuthorizationForm extends ConfigFormBase {
+
+  /**
+   * The Salesforce REST client.
+   *
+   * @var \Drupal\salesforce\Rest\RestClientInterface
+   */
+  protected $sf_client;
+
+  /**
+   * The sevent dispatcher service..
+   *
+   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
+   */
+  protected $eventDispatcher;
+
+  /**
+   * The state keyvalue collection.
+   *
+   * @var \Drupal\Core\State\StateInterface
+   */
+  protected $state;
+
+  /**
+   * Constructs a \Drupal\system\ConfigFormBase object.
+   *
+   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+   *   The factory for configuration objects.
+   * @param \Drupal\salesforce\Rest\RestClientInterface $salesforce_client
+   *   The factory for configuration objects.
+   * @param \Drupal\Core\State\StateInterface $state
+   *   The state keyvalue collection to use.
+   */
+  public function __construct(ConfigFactoryInterface $config_factory, RestClientInterface $salesforce_client, EventDispatcherInterface $event_dispatcher) {
+    parent::__construct($config_factory);
+    $this->sf_client = $salesforce_client;
+    $this->eventDispatcher = $event_dispatcher;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('config.factory'),
+      $container->get('salesforce.client'),
+      $container->get('event_dispatcher')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId() {
+    return 'salesforce_oauth';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getEditableConfigNames() {
+    return [
+      'salesforce.settings',
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    $form = parent::buildForm($form, $form_state);
+    $form['actions']['#title'] = 'Are you sure you want to revoke authorization?';
+    $form['actions']['#type'] = 'details';
+    $form['actions']['#open'] = TRUE;
+    $form['actions']['#description'] = t('Revoking authorization will destroy Salesforce OAuth and refresh tokens. Drupal will no longer be authorized to communicate with Salesforce.');
+    $form['actions']['submit']['#value'] = t('Revoke authorization');
+
+    // By default, render the form using system-config-form.html.twig.
+    $form['#theme'] = 'system_config_form';
+
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    $this->sf_client->setAccessToken('');
+    $this->sf_client->setRefreshToken('');
+    $this->sf_client->setInstanceUrl('');
+    $this->sf_client->setIdentity(FALSE);
+    drupal_set_message($this->t('Salesforce OAuth tokens have been revoked.'));
+    $this->eventDispatcher->dispatch(SalesforceEvents::NOTICE, new SalesforceNoticeEvent(NULL, "Salesforce OAuth tokens revoked."));
+  }
+
+}
\ No newline at end of file

src/Rest/RestClient.php

@@ -307,12 +307,15 @@ class RestClient implements RestClientInterface {
    *   E.g., rest, partner, enterprise.
    *
    * @return string
-   *   Complete URL endpoint for API access.
+   *   Complete URL endpoint for API access, or FALSE if no identity is set.
    */
   public function getApiEndPoint($api_type = 'rest') {
     $url = &drupal_static(__FUNCTION__ . $api_type);
     if (!isset($url)) {
       $identity = $this->getIdentity();
+      if (empty($identity)) {
+        return FALSE;
+      }
       if (is_string($identity)) {
         $url = $identity;
       }
@@ -413,7 +416,7 @@ class RestClient implements RestClientInterface {
    * @param string $url
    *   URL to set.
    */
-  protected function setInstanceUrl($url) {
+  public function setInstanceUrl($url) {
     $this->state->set('salesforce.instance_url', $url);
     return $this;
   }
@@ -450,7 +453,7 @@ class RestClient implements RestClientInterface {
    * @param string $token
    *   Refresh token from Salesforce.
    */
-  protected function setRefreshToken($token) {
+  public function setRefreshToken($token) {
     $this->state->set('salesforce.refresh_token', $token);
     return $this;
   }
@@ -539,7 +542,7 @@ class RestClient implements RestClientInterface {
    *
    * @return $this
    */
-  protected function setIdentity($data) {
+  public function setIdentity($data) {
     $this->state->set('salesforce.identity', $data);
     return $this;
   }
@@ -596,7 +599,8 @@ class RestClient implements RestClientInterface {
    *   Whether to reset cache.
    *
    * @return array
-   *   Array of all available Salesforce versions.
+   *   Array of all available Salesforce versions, or empty array if version
+   *   info is not available.
    */
   public function getVersions($reset = FALSE) {
     if (!$reset && ($cache = $this->cache->get('salesforce:versions'))) {
@@ -605,13 +609,18 @@ class RestClient implements RestClientInterface {
 
     $versions = [];
     $id = $this->getIdentity();
-    $url = str_replace('v{version}/', '', $id['urls']['rest']);
-    $response = new RestResponse($this->httpRequest($url));
-    foreach ($response->data as $version) {
-      $versions[$version['version']] = $version;
+    if (!empty($identity)) {
+      $url = str_replace('v{version}/', '', $id['urls']['rest']);
+      $response = new RestResponse($this->httpRequest($url));
+      foreach ($response->data as $version) {
+        $versions[$version['version']] = $version;
+      }
+      $this->cache->set('salesforce:versions', $versions, $this->getRequestTime() + self::LONGTERM_CACHE_LIFETIME, ['salesforce']);
+      return $versions;
+    }
+    else {
+      return [];
     }
-    $this->cache->set('salesforce:versions', $versions, $this->getRequestTime() + self::LONGTERM_CACHE_LIFETIME, ['salesforce']);
-    return $versions;
   }
 
   /**

src/Rest/RestClientInterface.php

@@ -143,6 +143,11 @@ interface RestClientInterface {
   public function getInstanceUrl();
 
   /**
+   * Set the SF instance URL.
+   */
+  public function setInstanceUrl($url);
+
+    /**
    * Get the access token.
    */
   public function getAccessToken();
@@ -155,6 +160,14 @@ interface RestClientInterface {
    */
   public function setAccessToken($token);
 
+  /**
+   * Set the refresh token.
+   *
+   * @param string $token
+   *   Refresh token from Salesforce.
+   */
+  public function setRefreshToken($token);
+
   /**
    * Refresh access token based on the refresh token.
    *
@@ -191,6 +204,11 @@ interface RestClientInterface {
    */
   public function getIdentity();
 
+  /**
+   * Set the Salesforce identity, which is stored in a variable.
+   */
+  public function setIdentity($data);
+
   /**
    * Helper to build the redirect URL for OAUTH workflow.
    *