From 792da6f0c4642f8dbd10ed43a85e56ad3626d2e8 Mon Sep 17 00:00:00 2001
From: Alexander Rhodes <ironsizide@787980.no-reply.drupal.org>
Date: Wed, 8 Mar 2017 17:13:37 -0500
Subject: [PATCH] Fixes the RestClient constructors fixes
All references to salesforce_encrypt.client service removed
salesforce_encrypt.client service definition removed
Unused use statements removed from EncryptedRestClientInterface andRestCientInterface
Constructors removed from EncryptedRestClientInterface and RestClientInterface
Salesforce_encrypt\RestClient constructor cleaned up
Adds Json mock to salesforce_encrypt\RestClientTest
Fixes service name error in PullBase
Fixes property visibility settings in RestClient so child salesforce_encrypt\RestClient may
inherit them.
---
.../salesforce_encrypt.services.yml | 4 -
.../src/Form/SettingsForm.php | 2 +-
.../src/Rest/EncryptedRestClientInterface.php | 29 +-
.../src/Rest/RestClient.php | 27 +-
.../tests/src/Unit/RestClientTest.php | 15 +-
.../src/Plugin/QueueWorker/PullBase.php | 10 +-
src/Rest/RestClient.php | 87 +-
src/Rest/RestClientBase.php | 856 ------------------
src/Rest/RestClientBaseInterface.php | 408 ---------
src/Rest/RestClientInterface.php | 406 ++++++++-
10 files changed, 467 insertions(+), 1377 deletions(-)
delete mode 100644 modules/salesforce_encrypt/salesforce_encrypt.services.yml
delete mode 100644 src/Rest/RestClientBase.php
delete mode 100644 src/Rest/RestClientBaseInterface.php
diff --git a/modules/salesforce_encrypt/salesforce_encrypt.services.yml b/modules/salesforce_encrypt/salesforce_encrypt.services.yml
deleted file mode 100644
index 000e8bd3..00000000
--- a/modules/salesforce_encrypt/salesforce_encrypt.services.yml
+++ /dev/null
@@ -1,4 +0,0 @@
-services:
- salesforce_encrypt.client:
- class: Drupal\salesforce_encrypt\Rest\RestClient
- arguments: ['@http_client', '@config.factory', '@state', '@cache.default', '@encryption', '@encrypt.encryption_profile.manager', '@lock']
diff --git a/modules/salesforce_encrypt/src/Form/SettingsForm.php b/modules/salesforce_encrypt/src/Form/SettingsForm.php
index e9632d1b..a231acbf 100644
--- a/modules/salesforce_encrypt/src/Form/SettingsForm.php
+++ b/modules/salesforce_encrypt/src/Form/SettingsForm.php
@@ -37,7 +37,7 @@ class SettingsForm extends FormBase {
return new static(
$container->get('state'),
$container->get('encrypt.encryption_profile.manager'),
- $container->get('salesforce_encrypt.client')
+ $container->get('salesforce.client')
);
}
diff --git a/modules/salesforce_encrypt/src/Rest/EncryptedRestClientInterface.php b/modules/salesforce_encrypt/src/Rest/EncryptedRestClientInterface.php
index 931419cd..92acecd9 100644
--- a/modules/salesforce_encrypt/src/Rest/EncryptedRestClientInterface.php
+++ b/modules/salesforce_encrypt/src/Rest/EncryptedRestClientInterface.php
@@ -2,37 +2,14 @@
namespace Drupal\salesforce_encrypt\Rest;
-use Drupal\salesforce\Rest\RestClientBaseInterface;
-use Drupal\encrypt\Entity\EncryptionProfile;
-use Drupal\encrypt\EncryptServiceInterface;
-use Drupal\encrypt\EncryptionProfileManagerInterface;
use Drupal\encrypt\EncryptionProfileInterface;
-use Drupal\Core\Lock\LockBackendInterface;
-use Drupal\Core\Cache\CacheBackendInterface;
-use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\State\StateInterface;
-use GuzzleHttp\ClientInterface;
+use Drupal\salesforce\Rest\RestClientInterface;
+
/**
* Objects, properties, and methods to communicate with the Salesforce REST API.
*/
-interface EncryptedRestClientInterface extends RestClientBaseInterface {
-
- /**
- * Constructor which initializes the consumer.
- *
- * @param \GuzzleHttp\ClientInterface $http_client
- * The GuzzleHttp Client.
- * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
- * The config factory service.
- * @param \Drupal\Core\State\StateInterface $state
- * The state service.
- * @param \Drupal\Core\Cache\CacheBackendInterface $cache
- * The cache service.
- * @param \Drupal\Component\Serialization\Json $json
- * The JSON serializer service.
- */
- public function __construct(ClientInterface $http_client, ConfigFactoryInterface $config_factory, StateInterface $state, CacheBackendInterface $cache, EncryptServiceInterface $encryption, EncryptionProfileManagerInterface $encryptionProfileManager, LockBackendInterface $lock);
+interface EncryptedRestClientInterface extends RestClientInterface {
/**
* Encrypts all sensitive salesforce config values.
diff --git a/modules/salesforce_encrypt/src/Rest/RestClient.php b/modules/salesforce_encrypt/src/Rest/RestClient.php
index 399136d9..38dad6ec 100644
--- a/modules/salesforce_encrypt/src/Rest/RestClient.php
+++ b/modules/salesforce_encrypt/src/Rest/RestClient.php
@@ -2,6 +2,7 @@
namespace Drupal\salesforce_encrypt\Rest;
+use Drupal\Component\Serialization\Json;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
@@ -13,14 +14,13 @@ use Drupal\encrypt\EncryptServiceInterface;
use Drupal\encrypt\EncryptionProfileInterface;
use Drupal\encrypt\EncryptionProfileManagerInterface;
use Drupal\salesforce\EntityNotFoundException;
-use Drupal\salesforce\Rest\RestClientBase;
+use Drupal\salesforce\Rest\RestClient as SalesforceRestClient;
use GuzzleHttp\ClientInterface;
-use Drupal\salesforce_encrypt\Rest\EncryptedRestClientInterface;
/**
* Objects, properties, and methods to communicate with the Salesforce REST API.
*/
-class RestClient extends RestClientBase implements EncryptedRestClientInterface {
+class RestClient extends SalesforceRestClient implements EncryptedRestClientInterface {
use StringTranslationTrait;
@@ -32,17 +32,18 @@ class RestClient extends RestClientBase implements EncryptedRestClientInterface
* Constructor which initializes the consumer.
*
* @param \GuzzleHttp\ClientInterface $http_client
- * The config factory.
- * @param \Guzzle\Http\ClientInterface $http_client
- * The config factory.
+ * The GuzzleHttp Client.
+ * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+ * The config factory service.
+ * @param \Drupal\Core\State\StateInterface $state
+ * The state service.
+ * @param \Drupal\Core\Cache\CacheBackendInterface $cache
+ * The cache service.
+ * @param \Drupal\Component\Serialization\Json $json
+ * The JSON serializer service.
*/
- public function __construct(ClientInterface $http_client, ConfigFactoryInterface $config_factory, StateInterface $state, CacheBackendInterface $cache, EncryptServiceInterface $encryption, EncryptionProfileManagerInterface $encryptionProfileManager, LockBackendInterface $lock) {
- $this->configFactory = $config_factory;
- $this->httpClient = $http_client;
- $this->config = $this->configFactory->get('salesforce.settings');
- $this->configEditable = $this->configFactory->getEditable('salesforce.settings');
- $this->state = $state;
- $this->cache = $cache;
+ public function __construct(ClientInterface $http_client, ConfigFactoryInterface $config_factory, StateInterface $state, CacheBackendInterface $cache, Json $json, EncryptServiceInterface $encryption, EncryptionProfileManagerInterface $encryptionProfileManager, LockBackendInterface $lock) {
+ parent::__construct($http_client, $config_factory, $state, $cache, $json);
$this->encryption = $encryption;
$this->encryptionProfileId = $state->get('salesforce_encrypt.profile');
$this->encryptionProfileManager = $encryptionProfileManager;
diff --git a/modules/salesforce_encrypt/tests/src/Unit/RestClientTest.php b/modules/salesforce_encrypt/tests/src/Unit/RestClientTest.php
index 7919b8c7..5f280337 100644
--- a/modules/salesforce_encrypt/tests/src/Unit/RestClientTest.php
+++ b/modules/salesforce_encrypt/tests/src/Unit/RestClientTest.php
@@ -2,16 +2,16 @@
namespace Drupal\Tests\salesforce_encrypt\Unit;
-use Drupal\Tests\UnitTestCase;
-use Drupal\salesforce_encrypt\Rest\RestClient;
+use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Config\ConfigFactory;
-use GuzzleHttp\Client;
+use Drupal\Core\Lock\LockBackendInterface;
use Drupal\Core\State\State;
-use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Tests\UnitTestCase;
use Drupal\encrypt\EncryptServiceInterface;
-use Drupal\encrypt\EncryptionProfileManagerInterface;
-use Drupal\Core\Lock\LockBackendInterface;
use Drupal\encrypt\EncryptionProfileInterface;
+use Drupal\encrypt\EncryptionProfileManagerInterface;
+use Drupal\salesforce_encrypt\Rest\RestClient;
+use GuzzleHttp\Client;
/**
* @coversDefaultClass \Drupal\salesforce_encrypt\Rest\RestClient
@@ -37,12 +37,13 @@ class RestClientTest extends UnitTestCase {
->disableOriginalConstructor()
->getMock();
$this->cache = $this->getMock(CacheBackendInterface::CLASS);
+ $this->json = $this->getMock('Drupal\Component\Serialization\Json');
$this->encryption = $this->getMock(EncryptServiceInterface::CLASS);
$this->profileManager = $this->getMock(EncryptionProfileManagerInterface::CLASS);
$this->lock = $this->getMock(LockBackendInterface::CLASS);
$this->encryptionProfile = $this->getMock(EncryptionProfileInterface::CLASS);
- $this->client = $this->getMock(RestClient::CLASS, ['getEncryptionProfile'], [$this->httpClient, $this->configFactory, $this->state, $this->cache, $this->encryption, $this->profileManager, $this->lock]);
+ $this->client = $this->getMock(RestClient::CLASS, ['getEncryptionProfile'], [$this->httpClient, $this->configFactory, $this->state, $this->cache, $this->json, $this->encryption, $this->profileManager, $this->lock]);
}
/**
diff --git a/modules/salesforce_pull/src/Plugin/QueueWorker/PullBase.php b/modules/salesforce_pull/src/Plugin/QueueWorker/PullBase.php
index bc6394f2..06c65751 100644
--- a/modules/salesforce_pull/src/Plugin/QueueWorker/PullBase.php
+++ b/modules/salesforce_pull/src/Plugin/QueueWorker/PullBase.php
@@ -7,16 +7,16 @@ use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Queue\QueueWorkerBase;
use Drupal\Core\Utility\Error;
+use Drupal\salesforce\Rest\RestClient;
+use Drupal\salesforce\Rest\RestException;
+use Drupal\salesforce\SObject;
+use Drupal\salesforce\SalesforceEvents;
use Drupal\salesforce_mapping\Entity\MappedObjectInterface;
use Drupal\salesforce_mapping\Entity\SalesforceMappingInterface;
use Drupal\salesforce_mapping\MappingConstants;
use Drupal\salesforce_mapping\PushParams;
use Drupal\salesforce_mapping\SalesforcePullEvent;
use Drupal\salesforce_pull\PullException;
-use Drupal\salesforce\Rest\RestClient;
-use Drupal\salesforce\Rest\RestException;
-use Drupal\salesforce\SalesforceEvents;
-use Drupal\salesforce\SObject;
use Psr\Log\LogLevel;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
@@ -98,7 +98,7 @@ abstract class PullBase extends QueueWorkerBase implements ContainerFactoryPlugi
$container->get('entity_type.manager'),
$container->get('salesforce.client'),
$container->get('logger.factory'),
- $container->get('eventDispatcher')
+ $container->get('event_dispatcher')
);
}
diff --git a/src/Rest/RestClient.php b/src/Rest/RestClient.php
index a26e5353..41a3fe9d 100644
--- a/src/Rest/RestClient.php
+++ b/src/Rest/RestClient.php
@@ -21,7 +21,7 @@ use GuzzleHttp\Psr7\Response;
/**
* Objects, properties, and methods to communicate with the Salesforce REST API.
*/
-class RestClient extends RestClientBase implements RestClientInterface {
+class RestClient implements RestClientInterface {
/**
* Reponse object.
@@ -56,40 +56,51 @@ class RestClient extends RestClientBase implements RestClientInterface {
*
* @var \Drupal\Core\Config\ImmutableConfig
*/
- private $config;
+ protected $config;
/**
* Editable version of config entity.
*
* @var \Drupal\Core\Config\Config
*/
- private $configEditable;
+ protected$configEditable;
/**
* The state service.
*
- * @var \Drupal\Core\State\StateInterface $state
+ * @var \Drupal\Core\State\StateInterface
*/
- private $state;
+ protected $state;
/**
* The cache service.
*
- * @var Drupal\Core\Cache\CacheBackendInterface Scache
+ * @var Drupal\Core\Cache\CacheBackendInterface
*/
protected $cache;
/**
* The JSON serializer service.
*
- * @var \Drupal\Component\Serialization\Json $json
+ * @var \Drupal\Component\Serialization\Json
*/
protected $json;
const CACHE_LIFETIME = 300;
/**
- * {@inheritdoc}
+ * Constructor which initializes the consumer.
+ *
+ * @param \GuzzleHttp\ClientInterface $http_client
+ * The GuzzleHttp Client.
+ * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
+ * The config factory service.
+ * @param \Drupal\Core\State\StateInterface $state
+ * The state service.
+ * @param \Drupal\Core\Cache\CacheBackendInterface $cache
+ * The cache service.
+ * @param \Drupal\Component\Serialization\Json $json
+ * The JSON serializer service.
*/
public function __construct(ClientInterface $http_client, ConfigFactoryInterface $config_factory, StateInterface $state, CacheBackendInterface $cache, Json $json) {
$this->configFactory = $config_factory;
@@ -147,7 +158,7 @@ class RestClient extends RestClientBase implements RestClientInterface {
}
if (empty($this->response)
- || ((int)floor($this->response->getStatusCode() / 100)) != 2) {
+ || ((int) floor($this->response->getStatusCode() / 100)) != 2) {
throw new RestException($this->response, 'Unknown error occurred during API call');
}
@@ -170,6 +181,7 @@ class RestClient extends RestClientBase implements RestClientInterface {
* Method to initiate the call, such as GET or POST. Defaults to GET.
*
* @return GuzzleHttp\Psr7\Response
+ * Response object.
*/
protected function apiHttpRequest($path, array $params, $method) {
if (!$this->getAccessToken()) {
@@ -201,18 +213,22 @@ class RestClient extends RestClientBase implements RestClientInterface {
* Method to initiate the call, such as GET or POST. Defaults to GET.
*
* @throws RequestException
+ * Request exxception.
*
* @return GuzzleHttp\Psr7\Response
+ * Response object.
*/
- protected function httpRequest($url, $data = NULL, array $headers = [], $method = 'GET') {
+ protected function httpRequest($url, array $data = NULL, array $headers = [], $method = 'GET') {
// Build the request, including path and headers. Internal use.
return $this->httpClient->$method($url, ['headers' => $headers, 'body' => $data]);
}
/**
- * Extract normalized error information from a RequestException
+ * Extract normalized error information from a RequestException.
*
* @param RequestException $e
+ * Exception object.
+ *
* @return array
* Error array with keys:
* * message
@@ -229,7 +245,6 @@ class RestClient extends RestClientBase implements RestClientInterface {
return $data;
}
-
/**
* Get the API end point for a given type of the API.
*
@@ -536,6 +551,7 @@ class RestClient extends RestClientBase implements RestClientInterface {
* The constructed SOQL query.
*
* @return SelectQueryResult
+ * Query result object.
*
* @addtogroup salesforce_apicalls
*/
@@ -554,6 +570,7 @@ class RestClient extends RestClientBase implements RestClientInterface {
* Whether to reset the cache and retrieve a fresh version from Salesforce.
*
* @return RestResponse_Describe
+ * Salesforce object description object.
*
* @addtogroup salesforce_apicalls
*/
@@ -583,6 +600,7 @@ class RestClient extends RestClientBase implements RestClientInterface {
* Values of the fields to set for the object.
*
* @return Drupal\salesforce\SFID
+ * Salesforce ID object.
*
* @addtogroup salesforce_apicalls
*/
@@ -608,7 +626,8 @@ class RestClient extends RestClientBase implements RestClientInterface {
* @param array $params
* Values of the fields to set for the object.
*
- * @return Drupal\salesforce\SFID or NULL
+ * @return mixed
+ * Drupal\salesforce\SFID or NULL.
*
* @addtogroup salesforce_apicalls
*/
@@ -636,6 +655,8 @@ class RestClient extends RestClientBase implements RestClientInterface {
/**
* Update an existing object.
*
+ * Update() doesn't return any data. Examine HTTP response or Exception.
+ *
* @param string $name
* Object type name, E.g., Contact, Account.
* @param string $id
@@ -643,9 +664,6 @@ class RestClient extends RestClientBase implements RestClientInterface {
* @param array $params
* Values of the fields to set for the object.
*
- * @return null
- * Update() doesn't return any data. Examine HTTP response or Exception.
- *
* @addtogroup salesforce_apicalls
*/
public function objectUpdate($name, $id, array $params) {
@@ -689,21 +707,21 @@ class RestClient extends RestClientBase implements RestClientInterface {
}
/**
- * Delete a Salesforce object. Note: if Object with given $id doesn't exist,
+ * Delete a Salesforce object.
+ *
+ * Note: if Object with given $id doesn't exist,
* objectDelete() will assume success unless $throw_exception is given.
+ * Delete() doesn't return any data. Examine HTTP response or Exception.
*
* @param string $name
* Object type name, E.g., Contact, Account.
* @param string $id
* Salesforce id of the object.
- * @pararm bool $throw_exception
+ * @param bool $throw_exception
* (optional) If TRUE, 404 response code will cause RequestException to be
* thrown. Otherwise, hide those errors. Default is FALSE.
*
* @addtogroup salesforce_apicalls
- *
- * @return null
- * Delete() doesn't return any data. Examine HTTP response or Exception.
*/
public function objectDelete($name, $id, $throw_exception = FALSE) {
try {
@@ -749,14 +767,12 @@ class RestClient extends RestClientBase implements RestClientInterface {
*
* @param string $name
* Object type name, E.g., Contact, Account.
- *
* @param int $start
- * unix timestamp for older timeframe for updates.
+ * Unix timestamp for older timeframe for updates.
* Defaults to "-29 days" if empty.
- *
* @param int $end
- * unix timestamp for end of timeframe for updates.
- * Defaults to now if empty
+ * Unix timestamp for end of timeframe for updates.
+ * Defaults to now if empty.
*
* @return array
* return array has 2 indexes:
@@ -769,7 +785,7 @@ class RestClient extends RestClientBase implements RestClientInterface {
*
* @addtogroup salesforce_apicalls
*/
- public function getUpdated($name, $start = null, $end = null) {
+ public function getUpdated($name, $start = NULL, $end = NULL) {
if (empty($start)) {
$start = strtotime('-29 days');
}
@@ -828,10 +844,8 @@ class RestClient extends RestClientBase implements RestClientInterface {
*
* @param string $name
* Object type name, E.g., Contact, Account.
- *
* @param string $devname
* RecordType DeveloperName, e.g. Donation, Membership, etc.
- *
* @return SFID
* The Salesforce ID of the given Record Type, or null.
*
@@ -846,11 +860,16 @@ class RestClient extends RestClientBase implements RestClientInterface {
}
/**
- * Utility function to determine object type for given SFID
+ * Utility function to determine object type for given SFID.
*
* @param SFID $id
+ * Salesforce object ID.
+ *
* @return string
- * @throws Exception if SFID doesn't match any object type
+ * Object type's name.
+ *
+ * @throws Exception
+ * If SFID doesn't match any object type.
*/
public static function getObjectTypeName(SFID $id) {
$prefix = substr((string)$id, 0, 3);
@@ -863,6 +882,12 @@ class RestClient extends RestClientBase implements RestClientInterface {
throw new \Exception('No matching object type');
}
+ /**
+ * Returns REQUEST_TIME.
+ *
+ * @return string
+ * The REQUEST_TIME server variable.
+ */
protected function getRequestTime() {
return defined('REQUEST_TIME') ? REQUEST_TIME : (int) $_SERVER['REQUEST_TIME'];
}
diff --git a/src/Rest/RestClientBase.php b/src/Rest/RestClientBase.php
deleted file mode 100644
index d18f47b7..00000000
--- a/src/Rest/RestClientBase.php
+++ /dev/null
@@ -1,856 +0,0 @@
-<?php
-
-namespace Drupal\salesforce\Rest;
-
-use Drupal\Component\Serialization\Json;
-use Drupal\Component\Utility\Unicode;
-use Drupal\Component\Utility\UrlHelper;
-use Drupal\Core\Cache\CacheBackendInterface;
-use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\State\StateInterface;
-use Drupal\Core\Url;
-use Drupal\salesforce\Rest\RestException;
-use Drupal\salesforce\SelectQuery;
-use Drupal\salesforce\SelectQueryResult;
-use Drupal\salesforce\SFID;
-use Drupal\salesforce\SObject;
-use GuzzleHttp\ClientInterface;
-use GuzzleHttp\Exception\RequestException;
-use GuzzleHttp\Psr7\Response;
-
-/**
- * Objects, properties, and methods to communicate with the Salesforce REST API.
- */
-class RestClientBase implements RestClientBaseInterface {
-
- /**
- * Reponse object.
- *
- * @var \GuzzleHttp\Psr7\Response
- */
- public $response;
-
- /**
- * GuzzleHttp client.
- *
- * @var \GuzzleHttp\ClientInterface
- */
- protected $httpClient;
-
- /**
- * Config factory service.
- *
- * @var \Drupal\Core\Config\ConfigFactoryInterface
- */
- protected $configFactory;
-
- /**
- * Salesforce API URL.
- *
- * @var Drupal\Core\Url
- */
- protected $url;
-
- /**
- * Salesforce config entity.
- *
- * @var \Drupal\Core\Config\ImmutableConfig
- */
- private $config;
-
- /**
- * Editable version of config entity.
- *
- * @var \Drupal\Core\Config\Config
- */
- private $configEditable;
-
- /**
- * The state service.
- *
- * @var \Drupal\Core\State\StateInterface $state
- */
- private $state;
-
- /**
- * The cache service.
- *
- * @var Drupal\Core\Cache\CacheBackendInterface Scache
- */
- protected $cache;
-
- /**
- * The JSON serializer service.
- *
- * @var \Drupal\Component\Serialization\Json $json
- */
- protected $json;
-
- const CACHE_LIFETIME = 300;
-
- /**
- * Determine if this SF instance is fully configured.
- *
- * @TODO: Consider making a test API call.
- */
- public function isAuthorized() {
- return $this->getConsumerKey() && $this->getConsumerSecret() && $this->getRefreshToken();
- }
-
- /**
- * {@inheritdoc}
- */
- public function apiCall($path, array $params = [], $method = 'GET', $returnObject = FALSE) {
- if (!$this->getAccessToken()) {
- $this->refreshToken();
- }
-
- try {
- $this->response = new RestResponse($this->apiHttpRequest($path, $params, $method));
- }
- catch (RequestException $e) {
- // RequestException gets thrown for any response status but 2XX.
- $this->response = $e->getResponse();
-
- // Any exceptions besides 401 get bubbled up.
- if (!$this->response || $this->response->getStatusCode() != 401) {
- throw new RestException($this->response, $e->getMessage());
- }
- }
-
- if ($this->response->getStatusCode() == 401) {
- // The session ID or OAuth token used has expired or is invalid: refresh
- // token. If refreshToken() throws an exception, or if apiHttpRequest()
- // throws anything but a RequestException, let it bubble up.
- $this->refreshToken();
- try {
- $this->response = new RestResponse($this->apiHttpRequest($path, $params, $method));
- }
- catch (RequestException $e) {
- $this->response = $e->getResponse();
- throw new RestException($this->response, $e->getMessage());
- }
- }
-
- if (empty($this->response)
- || ((int)floor($this->response->getStatusCode() / 100)) != 2) {
- throw new RestException($this->response, 'Unknown error occurred during API call');
- }
-
- if ($returnObject) {
- return $this->response;
- }
- else {
- return $this->response->data;
- }
- }
-
- /**
- * Private helper to issue an SF API request.
- *
- * @param string $path
- * Path to resource.
- * @param array $params
- * Parameters to provide.
- * @param string $method
- * Method to initiate the call, such as GET or POST. Defaults to GET.
- *
- * @return GuzzleHttp\Psr7\Response
- */
- protected function apiHttpRequest($path, array $params, $method) {
- if (!$this->getAccessToken()) {
- throw new \Exception('Missing OAuth Token');
- }
- $url = $this->getApiEndPoint() . $path;
-
- $headers = [
- 'Authorization' => 'OAuth ' . $this->getAccessToken(),
- 'Content-type' => 'application/json',
- ];
- $data = NULL;
- if (!empty($params)) {
- $data = $this->json->encode($params);
- }
- return $this->httpRequest($url, $data, $headers, $method);
- }
-
- /**
- * Make the HTTP request. Wrapper around drupal_http_request().
- *
- * @param string $url
- * Path to make request from.
- * @param array $data
- * The request body.
- * @param array $headers
- * Request headers to send as name => value.
- * @param string $method
- * Method to initiate the call, such as GET or POST. Defaults to GET.
- *
- * @throws RequestException
- *
- * @return GuzzleHttp\Psr7\Response
- */
- protected function httpRequest($url, $data = NULL, array $headers = [], $method = 'GET') {
- // Build the request, including path and headers. Internal use.
- return $this->httpClient->$method($url, ['headers' => $headers, 'body' => $data]);
- }
-
- /**
- * Extract normalized error information from a RequestException
- *
- * @param RequestException $e
- * @return array
- * Error array with keys:
- * * message
- * * errorCode
- * * fields
- */
- protected function getErrorData(RequestException $e) {
- $response = $e->getResponse();
- $response_body = $response->getBody()->getContents();
- $data = $this->json->decode($response_body);
- if (!empty($data[0])) {
- $data = $data[0];
- }
- return $data;
- }
-
-
- /**
- * Get the API end point for a given type of the API.
- *
- * @param string $api_type
- * E.g., rest, partner, enterprise.
- *
- * @return string
- * Complete URL endpoint for API access.
- */
- public function getApiEndPoint($api_type = 'rest') {
- $url = &drupal_static(__FUNCTION__ . $api_type);
- if (!isset($url)) {
- $identity = $this->getIdentity();
- if (is_string($identity)) {
- $url = $identity;
- }
- elseif (isset($identity['urls'][$api_type])) {
- $url = $identity['urls'][$api_type];
- }
- $url = str_replace('{version}', $this->config->get('rest_api_version.version'), $url);
- }
- return $url;
- }
-
- /**
- *
- */
- public function getConsumerKey() {
- return $this->state->get('salesforce.consumer_key');
- }
-
- /**
- *
- */
- public function setConsumerKey($value) {
- return $this->state->set('salesforce.consumer_key', $value);
- }
-
- /**
- *
- */
- public function getConsumerSecret() {
- return $this->state->get('salesforce.consumer_secret');
- }
-
- /**
- *
- */
- public function setConsumerSecret($value) {
- return $this->state->set('salesforce.consumer_secret', $value);
- }
-
- /**
- *
- */
- public function getLoginUrl() {
- $login_url = $this->state->get('salesforce.login_url');
- return empty($login_url) ? 'https://login.salesforce.com' : $login_url;
- }
-
- /**
- *
- */
- public function setLoginUrl($value) {
- return $this->state->set('salesforce.login_url', $value);
- }
-
- /**
- * Get the SF instance URL. Useful for linking to objects.
- */
- public function getInstanceUrl() {
- return $this->state->get('salesforce.instance_url');
- }
-
- /**
- * Set the SF instance URL.
- *
- * @param string $url
- * URL to set.
- */
- protected function setInstanceUrl($url) {
- $this->state->set('salesforce.instance_url', $url);
- return $this;
- }
-
- /**
- * Get the access token.
- */
- public function getAccessToken() {
- $access_token = $this->state->get('salesforce.access_token');
- return isset($access_token) && Unicode::strlen($access_token) !== 0 ? $access_token : FALSE;
- }
-
- /**
- * Set the access token.
- *
- * @param string $token
- * Access token from Salesforce.
- */
- public function setAccessToken($token) {
- $this->state->set('salesforce.access_token', $token);
- return $this;
- }
-
- /**
- * Get refresh token.
- */
- protected function getRefreshToken() {
- return $this->state->get('salesforce.refresh_token');
- }
-
- /**
- * Set refresh token.
- *
- * @param string $token
- * Refresh token from Salesforce.
- */
- protected function setRefreshToken($token) {
- $this->state->set('salesforce.refresh_token', $token);
- return $this;
- }
-
- /**
- * Refresh access token based on the refresh token.
- *
- * @throws Exception
- */
- protected function refreshToken() {
- $refresh_token = $this->getRefreshToken();
- if (empty($refresh_token)) {
- throw new \Exception(t('There is no refresh token.'));
- }
-
- $data = UrlHelper::buildQuery([
- 'grant_type' => 'refresh_token',
- 'refresh_token' => urldecode($refresh_token),
- 'client_id' => $this->getConsumerKey(),
- 'client_secret' => $this->getConsumerSecret(),
- ]);
-
- $url = $this->getAuthTokenUrl();
- $headers = [
- // This is an undocumented requirement on Salesforce's end.
- 'Content-Type' => 'application/x-www-form-urlencoded',
- ];
- $response = $this->httpRequest($url, $data, $headers, 'POST');
-
- $this->handleAuthResponse($response);
- return $this;
- }
-
- /**
- * Helper callback for OAuth handshake, and refreshToken()
- *
- * @param GuzzleHttp\Psr7\Response $response
- * Response object from refreshToken or authToken endpoints.
- *
- * @see SalesforceController::oauthCallback()
- * @see self::refreshToken()
- */
- public function handleAuthResponse(Response $response) {
- if ($response->getStatusCode() != 200) {
- throw new \Exception($response->getReasonPhrase(), $response->getStatusCode());
- }
-
- $data = (new RestResponse($response))->data;
-
- $this
- ->setAccessToken($data['access_token'])
- ->initializeIdentity($data['id'])
- ->setInstanceUrl($data['instance_url']);
-
- // Do not overwrite an existing refresh token with an empty value.
- if (!empty($data['refresh_token'])) {
- $this->setRefreshToken($data['refresh_token']);
- }
- return $this;
- }
-
- /**
- * Retrieve and store the Salesforce identity given an ID url.
- *
- * @param string $id
- * Identity URL.
- *
- * @throws Exception
- */
- public function initializeIdentity($id) {
- $headers = [
- 'Authorization' => 'OAuth ' . $this->getAccessToken(),
- 'Content-type' => 'application/json',
- ];
- $response = $this->httpRequest($id, NULL, $headers);
-
- if ($response->getStatusCode() != 200) {
- throw new \Exception(t('Unable to access identity service.'), $response->getStatusCode());
- }
- $data = (new RestResponse($response))->data;
-
- $this->setIdentity($data);
- return $this;
- }
-
- /**
- *
- */
- protected function setIdentity($data) {
- $this->state->set('salesforce.identity', $data);
- return $this;
- }
-
- /**
- * Return the Salesforce identity, which is stored in a variable.
- *
- * @return array
- * Returns FALSE is no identity has been stored.
- */
- public function getIdentity() {
- return $this->state->get('salesforce.identity');
- }
-
- /**
- * Helper to build the redirect URL for OAUTH workflow.
- *
- * @return string
- * Redirect URL.
- *
- * @see Drupal\salesforce\Controller\SalesforceController
- */
- public function getAuthCallbackUrl() {
- return Url::fromRoute('salesforce.oauth_callback', [], [
- 'absolute' => TRUE,
- 'https' => TRUE,
- ])->toString();
- }
-
- /**
- * Get Salesforce oauth login endpoint. (OAuth step 1)
- *
- * @return string
- * REST OAuth Login URL.
- */
- public function getAuthEndpointUrl() {
- return $this->getLoginUrl() . '/services/oauth2/authorize';
- }
-
- /**
- * Get Salesforce oauth token endpoint. (OAuth step 2)
- *
- * @return string
- * REST OAuth Token URL.
- */
- public function getAuthTokenUrl() {
- return $this->getLoginUrl() . '/services/oauth2/token';
- }
-
- /**
- * @defgroup salesforce_apicalls Wrapper calls around core apiCall()
- */
-
- /**
- * Available objects and their metadata for your organization's data.
- *
- * @param array $conditions
- * Associative array of filters to apply to the returned objects. Filters
- * are applied after the list is returned from Salesforce.
- * @param bool $reset
- * Whether to reset the cache and retrieve a fresh version from Salesforce.
- *
- * @return array
- * Available objects and metadata.
- *
- * @addtogroup salesforce_apicalls
- */
- public function objects(array $conditions = ['updateable' => TRUE], $reset = FALSE) {
- $cache = $this->cache->get('salesforce:objects');
-
- // Force the recreation of the cache when it is older than 5 minutes.
- if ($cache && $this->getRequestTime() < ($cache->created + self::CACHE_LIFETIME) && !$reset) {
- $result = $cache->data;
- }
- else {
- $result = $this->apiCall('sobjects');
- $this->cache->set('salesforce:objects', $result, 0, ['salesforce']);
- }
-
- if (!empty($conditions)) {
- foreach ($result['sobjects'] as $key => $object) {
- foreach ($conditions as $condition => $value) {
- if (!$object[$condition] == $value) {
- unset($result['sobjects'][$key]);
- }
- }
- }
- }
-
- return $result['sobjects'];
- }
-
- /**
- * Use SOQL to get objects based on query string.
- *
- * @param SelectQuery $query
- * The constructed SOQL query.
- *
- * @return SelectQueryResult
- *
- * @addtogroup salesforce_apicalls
- */
- public function query(SelectQuery $query) {
- // $this->moduleHandler->alter('salesforce_query', $query);
- // Casting $query as a string calls SelectQuery::__toString().
- return new SelectQueryResult($this->apiCall('query?q=' . (string) $query));
- }
-
- /**
- * Retreieve all the metadata for an object.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account, etc.
- * @param bool $reset
- * Whether to reset the cache and retrieve a fresh version from Salesforce.
- *
- * @return RestResponse_Describe
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectDescribe($name, $reset = FALSE) {
- if (empty($name)) {
- throw new \Exception('No name provided to describe');
- }
-
- $cache = $this->cache->get('salesforce:object:' . $name);
- // Force the recreation of the cache when it is older than 5 minutes.
- if ($cache && $this->getRequestTime() < ($cache->created + self::CACHE_LIFETIME) && !$reset) {
- return $cache->data;
- }
- else {
- $response = new RestResponse_Describe($this->apiCall("sobjects/{$name}/describe", [], 'GET', TRUE));
- $this->cache->set('salesforce:object:' . $name, $response, 0, ['salesforce']);
- return $response;
- }
- }
-
- /**
- * Create a new object of the given type.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account, etc.
- * @param array $params
- * Values of the fields to set for the object.
- *
- * @return Drupal\salesforce\SFID
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectCreate($name, array $params) {
- $response = $this->apiCall("sobjects/{$name}", $params, 'POST', TRUE);
- $data = $response->data;
- return new SFID($data['id']);
- }
-
- /**
- * Create new records or update existing records.
- *
- * The new records or updated records are based on the value of the specified
- * field. If the value is not unique, REST API returns a 300 response with
- * the list of matching records and throws an Exception.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $key
- * The field to check if this record should be created or updated.
- * @param string $value
- * The value for this record of the field specified for $key.
- * @param array $params
- * Values of the fields to set for the object.
- *
- * @return Drupal\salesforce\SFID or NULL
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectUpsert($name, $key, $value, array $params) {
- // If key is set, remove from $params to avoid UPSERT errors.
- if (isset($params[$key])) {
- unset($params[$key]);
- }
-
- $response = $this->apiCall("sobjects/{$name}/{$key}/{$value}", $params, 'PATCH', TRUE);
-
- // On update, upsert method returns an empty body. Retreive object id, so that we can return a consistent response.
- if ($response->getStatusCode() == 204) {
- // We need a way to allow callers to distinguish updates and inserts. To
- // that end, cache the original response and reset it after fetching the
- // ID.
- $this->original_response = $response;
- $sf_object = $this->objectReadbyExternalId($name, $key, $value);
- return $sf_object->id();
- }
- $data = $response->data;
- return new SFID($data['id']);
- }
-
- /**
- * Update an existing object.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $id
- * Salesforce id of the object.
- * @param array $params
- * Values of the fields to set for the object.
- *
- * @return null
- * Update() doesn't return any data. Examine HTTP response or Exception.
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectUpdate($name, $id, array $params) {
- $this->apiCall("sobjects/{$name}/{$id}", $params, 'PATCH');
- }
-
- /**
- * Return a full loaded Salesforce object.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $id
- * Salesforce id of the object.
- *
- * @return SObject
- * Object of the requested Salesforce object.
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectRead($name, $id) {
- return new SObject($this->apiCall("sobjects/{$name}/{$id}"));
- }
-
- /**
- * Return a full loaded Salesforce object from External ID.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $field
- * Salesforce external id field name.
- * @param string $value
- * Value of external id.
- *
- * @return SObject
- * Object of the requested Salesforce object.
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectReadbyExternalId($name, $field, $value) {
- return new SObject($this->apiCall("sobjects/{$name}/{$field}/{$value}"));
- }
-
- /**
- * Delete a Salesforce object. Note: if Object with given $id doesn't exist,
- * objectDelete() will assume success unless $throw_exception is given.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $id
- * Salesforce id of the object.
- * @pararm bool $throw_exception
- * (optional) If TRUE, 404 response code will cause RequestException to be
- * thrown. Otherwise, hide those errors. Default is FALSE.
- *
- * @addtogroup salesforce_apicalls
- *
- * @return null
- * Delete() doesn't return any data. Examine HTTP response or Exception.
- */
- public function objectDelete($name, $id, $throw_exception = FALSE) {
- try {
- $this->apiCall("sobjects/{$name}/{$id}", [], 'DELETE');
- }
- catch (RequestException $e) {
- if ($throw_exception || $e->getResponse()->getStatusCode() != 404) {
- throw $e;
- }
- }
- }
-
- /**
- * Retrieves the list of individual objects that have been deleted within the
- * given timespan for a specified object type.
- *
- * @param string $type
- * Object type name, E.g., Contact, Account.
- * @param string $startDate
- * Start date to check for deleted objects (in ISO 8601 format).
- * @param string $endDate
- * End date to check for deleted objects (in ISO 8601 format).
- * @return GetDeletedResult
- */
- public function getDeleted($type, $startDate, $endDate) {
- return $this->apiCall("sobjects/{$type}/deleted/?start={$startDate}&end={$endDate}");
- }
-
- /**
- * Return a list of available resources for the configured API version.
- *
- * @return Drupal\salesforce\Rest\RestResponse_Resources
- *
- * @addtogroup salesforce_apicalls
- */
- public function listResources() {
- return new RestResponse_Resources($this->apiCall('', [], 'GET', TRUE));
- }
-
- /**
- * Return a list of SFIDs for the given object, which have been created or
- * updated in the given timeframe.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- *
- * @param int $start
- * unix timestamp for older timeframe for updates.
- * Defaults to "-29 days" if empty.
- *
- * @param int $end
- * unix timestamp for end of timeframe for updates.
- * Defaults to now if empty
- *
- * @return array
- * return array has 2 indexes:
- * "ids": a list of SFIDs of those records which have been created or
- * updated in the given timeframe.
- * "latestDateCovered": ISO 8601 format timestamp (UTC) of the last date
- * covered in the request.
- *
- * @see https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_getupdated.htm
- *
- * @addtogroup salesforce_apicalls
- */
- public function getUpdated($name, $start = null, $end = null) {
- if (empty($start)) {
- $start = strtotime('-29 days');
- }
- $start = urlencode(gmdate(DATE_ATOM, $start));
-
- if (empty($end)) {
- $end = time();
- }
- $end = urlencode(gmdate(DATE_ATOM, $end));
-
- return $this->apiCall("sobjects/{$name}/updated/?start=$start&end=$end");
- }
-
- /**
- * Retrieve all record types for this org. If $name is provided, retrieve
- * record types for the given object type only.
- *
- * @param string $name
- * Object type name, e.g. Contact, Account, etc.
- *
- * @return array
- * If $name is given, an array of record types indexed by developer name.
- * Otherwise, an array of record type arrays, indexed by object type name.
- */
- public function getRecordTypes($name = NULL, $reset = FALSE) {
- $cache = $this->cache->get('salesforce:record_types');
-
- // Force the recreation of the cache when it is older than CACHE_LIFETIME
- if ($cache && $this->getRequestTime() < ($cache->created + self::CACHE_LIFETIME) && !$reset) {
- $record_types = $cache->data;
- }
- else {
- $query = new SelectQuery('RecordType');
- $query->fields = array('Id', 'Name', 'DeveloperName', 'SobjectType');
- $result = $this->query($query);
- $record_types = array();
- foreach ($result->records() as $rt) {
- $record_types[$rt->field('SobjectType')][$rt->field('DeveloperName')] = $rt;
- }
- $this->cache->set('salesforce:record_types', $record_types, 0, ['salesforce']);
- }
-
- if ($name != NULL) {
- if (!isset($record_types[$name])) {
- throw new \Exception("No record types for $name");
- }
- return $record_types[$name];
- }
- return $record_types;
- }
-
- /**
- * Given a DeveloperName and SObject Name, return the SFID of the
- * corresponding RecordType. DeveloperName doesn't change between Salesforce
- * environments, so it's safer to rely on compared to SFID.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- *
- * @param string $devname
- * RecordType DeveloperName, e.g. Donation, Membership, etc.
- *
- * @return SFID
- * The Salesforce ID of the given Record Type, or null.
- *
- * @throws Exception if record type not found
- */
- public function getRecordTypeIdByDeveloperName($name, $devname, $reset = FALSE) {
- $record_types = $this->getRecordTypes();
- if (empty($record_types[$name][$devname])) {
- throw new \Exception("No record type $devname for $name");
- }
- return $record_types[$name][$devname]->id();
- }
-
- /**
- * Utility function to determine object type for given SFID
- *
- * @param SFID $id
- * @return string
- * @throws Exception if SFID doesn't match any object type
- */
- public static function getObjectTypeName(SFID $id) {
- $prefix = substr((string)$id, 0, 3);
- $describe = $this->objects();
- foreach ($describe as $object) {
- if ($prefix == $object['keyPrefix']) {
- return $object['name'];
- }
- }
- throw new \Exception('No matching object type');
- }
-
- protected function getRequestTime() {
- return defined('REQUEST_TIME') ? REQUEST_TIME : (int) $_SERVER['REQUEST_TIME'];
- }
-
-}
diff --git a/src/Rest/RestClientBaseInterface.php b/src/Rest/RestClientBaseInterface.php
deleted file mode 100644
index d2bfbe59..00000000
--- a/src/Rest/RestClientBaseInterface.php
+++ /dev/null
@@ -1,408 +0,0 @@
-<?php
-
-namespace Drupal\salesforce\Rest;
-
-use Drupal\Component\Serialization\Json;
-use Drupal\Component\Utility\Unicode;
-use Drupal\Component\Utility\UrlHelper;
-use Drupal\Core\Cache\CacheBackendInterface;
-use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\State\StateInterface;
-use Drupal\Core\Url;
-use Drupal\salesforce\SFID;
-use Drupal\salesforce\SObject;
-use Drupal\salesforce\SelectQuery;
-use Drupal\salesforce\SelectQueryResult;
-use GuzzleHttp\ClientInterface;
-use GuzzleHttp\Exception\RequestException;
-use GuzzleHttp\Psr7\Response;
-use Symfony\Component\DependencyInjection\ContainerInterface;
-
-/**
- * Objects, properties, and methods to communicate with the Salesforce REST API.
- */
-interface RestClientBaseInterface {
-
- /**
- * Determine if this SF instance is fully configured.
- *
- * @TODO: Consider making a test API call.
- */
- public function isAuthorized();
-
- /**
- * Make a call to the Salesforce REST API.
- *
- * @param string $path
- * Path to resource.
- * @param array $params
- * Parameters to provide.
- * @param string $method
- * Method to initiate the call, such as GET or POST. Defaults to GET.
- * @param bool $returnObject
- * If true, return a Drupal\salesforce\Rest\RestResponse;
- * Otherwise, return json-decoded response body only.
- * Defaults to FALSE for backwards compatibility.
- *
- * @return mixed
- *
- * @throws GuzzleHttp\Exception\RequestException
- */
- public function apiCall($path, array $params = [], $method = 'GET', $returnObject = FALSE);
-
- /**
- * Get the API end point for a given type of the API.
- *
- * @param string $api_type
- * E.g., rest, partner, enterprise.
- *
- * @return string
- * Complete URL endpoint for API access.
- */
- public function getApiEndPoint($api_type = 'rest');
-
- /**
- *
- */
- public function getConsumerKey();
-
- /**
- *
- */
- public function setConsumerKey($value);
-
- /**
- *
- */
- public function getConsumerSecret();
-
- /**
- *
- */
- public function setConsumerSecret($value);
-
- /**
- *
- */
- public function getLoginUrl();
-
- /**
- *
- */
- public function setLoginUrl($value);
-
- /**
- * Get the SF instance URL. Useful for linking to objects.
- */
- public function getInstanceUrl();
-
- /**
- * Get the access token.
- */
- public function getAccessToken();
-
- /**
- * Set the access token.
- *
- * @param string $token
- * Access token from Salesforce.
- */
- public function setAccessToken($token);
-
- /**
- * Helper callback for OAuth handshake, and refreshToken()
- *
- * @param GuzzleHttp\Psr7\Response $response
- * Response object from refreshToken or authToken endpoints.
- *
- * @see SalesforceController::oauthCallback()
- * @see self::refreshToken()
- */
- public function handleAuthResponse(Response $response);
-
- /**
- * Retrieve and store the Salesforce identity given an ID url.
- *
- * @param string $id
- * Identity URL.
- *
- * @throws Exception
- */
- public function initializeIdentity($id);
-
- /**
- * Return the Salesforce identity, which is stored in a variable.
- *
- * @return array
- * Returns FALSE is no identity has been stored.
- */
- public function getIdentity();
-
- /**
- * Helper to build the redirect URL for OAUTH workflow.
- *
- * @return string
- * Redirect URL.
- *
- * @see Drupal\salesforce\Controller\SalesforceController
- */
- public function getAuthCallbackUrl();
-
- /**
- * Get Salesforce oauth login endpoint. (OAuth step 1)
- *
- * @return string
- * REST OAuth Login URL.
- */
- public function getAuthEndpointUrl();
-
- /**
- * Get Salesforce oauth token endpoint. (OAuth step 2)
- *
- * @return string
- * REST OAuth Token URL.
- */
- public function getAuthTokenUrl();
-
- /**
- * @defgroup salesforce_apicalls Wrapper calls around core apiCall()
- */
-
- /**
- * Available objects and their metadata for your organization's data.
- *
- * @param array $conditions
- * Associative array of filters to apply to the returned objects. Filters
- * are applied after the list is returned from Salesforce.
- * @param bool $reset
- * Whether to reset the cache and retrieve a fresh version from Salesforce.
- *
- * @return array
- * Available objects and metadata.
- *
- * @addtogroup salesforce_apicalls
- */
- public function objects(array $conditions = ['updateable' => TRUE], $reset = FALSE);
-
- /**
- * Use SOQL to get objects based on query string.
- *
- * @param SelectQuery $query
- * The constructed SOQL query.
- *
- * @return SelectQueryResult
- *
- * @addtogroup salesforce_apicalls
- */
- public function query(SelectQuery $query);
-
- /**
- * Retreieve all the metadata for an object.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account, etc.
- * @param bool $reset
- * Whether to reset the cache and retrieve a fresh version from Salesforce.
- *
- * @return RestResponse_Describe
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectDescribe($name, $reset = FALSE);
-
- /**
- * Create a new object of the given type.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account, etc.
- * @param array $params
- * Values of the fields to set for the object.
- *
- * @return Drupal\salesforce\SFID
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectCreate($name, array $params);
-
- /**
- * Create new records or update existing records.
- *
- * The new records or updated records are based on the value of the specified
- * field. If the value is not unique, REST API returns a 300 response with
- * the list of matching records and throws an Exception.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $key
- * The field to check if this record should be created or updated.
- * @param string $value
- * The value for this record of the field specified for $key.
- * @param array $params
- * Values of the fields to set for the object.
- *
- * @return Drupal\salesforce\SFID or NULL
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectUpsert($name, $key, $value, array $params);
-
- /**
- * Update an existing object.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $id
- * Salesforce id of the object.
- * @param array $params
- * Values of the fields to set for the object.
- *
- * @return null
- * Update() doesn't return any data. Examine HTTP response or Exception.
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectUpdate($name, $id, array $params);
-
- /**
- * Return a full loaded Salesforce object.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $id
- * Salesforce id of the object.
- *
- * @return SObject
- * Object of the requested Salesforce object.
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectRead($name, $id);
-
- /**
- * Return a full loaded Salesforce object from External ID.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $field
- * Salesforce external id field name.
- * @param string $value
- * Value of external id.
- *
- * @return SObject
- * Object of the requested Salesforce object.
- *
- * @addtogroup salesforce_apicalls
- */
- public function objectReadbyExternalId($name, $field, $value);
-
- /**
- * Delete a Salesforce object. Note: if Object with given $id doesn't exist,
- * objectDelete() will assume success unless $throw_exception is given.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- * @param string $id
- * Salesforce id of the object.
- * @pararm bool $throw_exception
- * (optional) If TRUE, 404 response code will cause RequestException to be
- * thrown. Otherwise, hide those errors. Default is FALSE.
- *
- * @addtogroup salesforce_apicalls
- *
- * @return null
- * Delete() doesn't return any data. Examine HTTP response or Exception.
- */
- public function objectDelete($name, $id, $throw_exception = FALSE);
-
- /**
- * Retrieves the list of individual objects that have been deleted within the
- * given timespan for a specified object type.
- *
- * @param string $type
- * Object type name, E.g., Contact, Account.
- * @param string $startDate
- * Start date to check for deleted objects (in ISO 8601 format).
- * @param string $endDate
- * End date to check for deleted objects (in ISO 8601 format).
- * @return GetDeletedResult
- */
- public function getDeleted($type, $startDate, $endDate);
-
- /**
- * Return a list of available resources for the configured API version.
- *
- * @return Drupal\salesforce\Rest\RestResponse_Resources
- *
- * @addtogroup salesforce_apicalls
- */
- public function listResources();
-
- /**
- * Return a list of SFIDs for the given object, which have been created or
- * updated in the given timeframe.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- *
- * @param int $start
- * unix timestamp for older timeframe for updates.
- * Defaults to "-29 days" if empty.
- *
- * @param int $end
- * unix timestamp for end of timeframe for updates.
- * Defaults to now if empty
- *
- * @return array
- * return array has 2 indexes:
- * "ids": a list of SFIDs of those records which have been created or
- * updated in the given timeframe.
- * "latestDateCovered": ISO 8601 format timestamp (UTC) of the last date
- * covered in the request.
- *
- * @see https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_getupdated.htm
- *
- * @addtogroup salesforce_apicalls
- */
- public function getUpdated($name, $start = null, $end = null);
-
- /**
- * Retrieve all record types for this org. If $name is provided, retrieve
- * record types for the given object type only.
- *
- * @param string $name
- * Object type name, e.g. Contact, Account, etc.
- *
- * @return array
- * If $name is given, an array of record types indexed by developer name.
- * Otherwise, an array of record type arrays, indexed by object type name.
- */
- public function getRecordTypes($name = NULL);
-
- /**
- * Given a DeveloperName and SObject Name, return the SFID of the
- * corresponding RecordType. DeveloperName doesn't change between Salesforce
- * environments, so it's safer to rely on compared to SFID.
- *
- * @param string $name
- * Object type name, E.g., Contact, Account.
- *
- * @param string $devname
- * RecordType DeveloperName, e.g. Donation, Membership, etc.
- *
- * @return SFID
- * The Salesforce ID of the given Record Type, or null.
- *
- * @throws Exception if record type not found
- */
- public function getRecordTypeIdByDeveloperName($name, $devname, $reset = FALSE);
-
- /**
- * Utility function to determine object type for given SFID
- *
- * @param SFID $id
- * @return string
- * @throws Exception if SFID doesn't match any object type
- */
- public static function getObjectTypeName(SFID $id);
-
-}
diff --git a/src/Rest/RestClientInterface.php b/src/Rest/RestClientInterface.php
index 8f9181a3..b46ef3f4 100644
--- a/src/Rest/RestClientInterface.php
+++ b/src/Rest/RestClientInterface.php
@@ -2,42 +2,396 @@
namespace Drupal\salesforce\Rest;
-use Drupal\Component\Serialization\Json;
-use Drupal\Component\Utility\Unicode;
-use Drupal\Component\Utility\UrlHelper;
-use Drupal\Core\Cache\CacheBackendInterface;
-use Drupal\Core\Config\ConfigFactoryInterface;
-use Drupal\Core\State\StateInterface;
-use Drupal\Core\Url;
use Drupal\salesforce\SFID;
-use Drupal\salesforce\SObject;
use Drupal\salesforce\SelectQuery;
-use Drupal\salesforce\SelectQueryResult;
-use GuzzleHttp\ClientInterface;
-use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7\Response;
-use Symfony\Component\DependencyInjection\ContainerInterface;
-use Drupal\salesforce\Rest\RestClientBaseInterface;
/**
* Objects, properties, and methods to communicate with the Salesforce REST API.
*/
-interface RestClientInterface extends RestClientBaseInterface {
+interface RestClientInterface {
/**
- * Constructor which initializes the consumer.
+ * Determine if this SF instance is fully configured.
*
- * @param \GuzzleHttp\ClientInterface $http_client
- * The GuzzleHttp Client.
- * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
- * The config factory service.
- * @param \Drupal\Core\State\StateInterface $state
- * The state service.
- * @param \Drupal\Core\Cache\CacheBackendInterface $cache
- * The cache service.
- * @param \Drupal\Component\Serialization\Json $json
- * The JSON serializer service.
+ * @TODO: Consider making a test API call.
*/
- public function __construct(ClientInterface $http_client, ConfigFactoryInterface $config_factory, StateInterface $state, CacheBackendInterface $cache, Json $json);
+ public function isAuthorized();
+
+ /**
+ * Make a call to the Salesforce REST API.
+ *
+ * @param string $path
+ * Path to resource.
+ * @param array $params
+ * Parameters to provide.
+ * @param string $method
+ * Method to initiate the call, such as GET or POST. Defaults to GET.
+ * @param bool $returnObject
+ * If true, return a Drupal\salesforce\Rest\RestResponse;
+ * Otherwise, return json-decoded response body only.
+ * Defaults to FALSE for backwards compatibility.
+ *
+ * @return mixed
+ * Reponce object or response data.
+ *
+ * @throws GuzzleHttp\Exception\RequestException
+ */
+ public function apiCall($path, array $params = [], $method = 'GET', $returnObject = FALSE);
+
+ /**
+ * Get the API end point for a given type of the API.
+ *
+ * @param string $api_type
+ * E.g., rest, partner, enterprise.
+ *
+ * @return string
+ * Complete URL endpoint for API access.
+ */
+ public function getApiEndPoint($api_type = 'rest');
+
+ /**
+ *
+ */
+ public function getConsumerKey();
+
+ /**
+ *
+ */
+ public function setConsumerKey($value);
+
+ /**
+ *
+ */
+ public function getConsumerSecret();
+
+ /**
+ *
+ */
+ public function setConsumerSecret($value);
+
+ /**
+ *
+ */
+ public function getLoginUrl();
+
+ /**
+ *
+ */
+ public function setLoginUrl($value);
+
+ /**
+ * Get the SF instance URL. Useful for linking to objects.
+ */
+ public function getInstanceUrl();
+
+ /**
+ * Get the access token.
+ */
+ public function getAccessToken();
+
+ /**
+ * Set the access token.
+ *
+ * @param string $token
+ * Access token from Salesforce.
+ */
+ public function setAccessToken($token);
+
+ /**
+ * Helper callback for OAuth handshake, and refreshToken()
+ *
+ * @param GuzzleHttp\Psr7\Response $response
+ * Response object from refreshToken or authToken endpoints.
+ *
+ * @see SalesforceController::oauthCallback()
+ * @see self::refreshToken()
+ */
+ public function handleAuthResponse(Response $response);
+
+ /**
+ * Retrieve and store the Salesforce identity given an ID url.
+ *
+ * @param string $id
+ * Identity URL.
+ *
+ * @throws Exception
+ */
+ public function initializeIdentity($id);
+
+ /**
+ * Return the Salesforce identity, which is stored in a variable.
+ *
+ * @return array
+ * Returns FALSE is no identity has been stored.
+ */
+ public function getIdentity();
+
+ /**
+ * Helper to build the redirect URL for OAUTH workflow.
+ *
+ * @return string
+ * Redirect URL.
+ *
+ * @see Drupal\salesforce\Controller\SalesforceController
+ */
+ public function getAuthCallbackUrl();
+
+ /**
+ * Get Salesforce oauth login endpoint. (OAuth step 1)
+ *
+ * @return string
+ * REST OAuth Login URL.
+ */
+ public function getAuthEndpointUrl();
+
+ /**
+ * Get Salesforce oauth token endpoint. (OAuth step 2)
+ *
+ * @return string
+ * REST OAuth Token URL.
+ */
+ public function getAuthTokenUrl();
+
+ /**
+ * @defgroup salesforce_apicalls Wrapper calls around core apiCall()
+ */
+
+ /**
+ * Available objects and their metadata for your organization's data.
+ *
+ * @param array $conditions
+ * Associative array of filters to apply to the returned objects. Filters
+ * are applied after the list is returned from Salesforce.
+ * @param bool $reset
+ * Whether to reset the cache and retrieve a fresh version from Salesforce.
+ *
+ * @return array
+ * Available objects and metadata.
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function objects(array $conditions = ['updateable' => TRUE], $reset = FALSE);
+
+ /**
+ * Use SOQL to get objects based on query string.
+ *
+ * @param SelectQuery $query
+ * The constructed SOQL query.
+ *
+ * @return SelectQueryResult
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function query(SelectQuery $query);
+
+ /**
+ * Retreieve all the metadata for an object.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account, etc.
+ * @param bool $reset
+ * Whether to reset the cache and retrieve a fresh version from Salesforce.
+ *
+ * @return RestResponse_Describe
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function objectDescribe($name, $reset = FALSE);
+
+ /**
+ * Create a new object of the given type.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account, etc.
+ * @param array $params
+ * Values of the fields to set for the object.
+ *
+ * @return Drupal\salesforce\SFID
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function objectCreate($name, array $params);
+
+ /**
+ * Create new records or update existing records.
+ *
+ * The new records or updated records are based on the value of the specified
+ * field. If the value is not unique, REST API returns a 300 response with
+ * the list of matching records and throws an Exception.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account.
+ * @param string $key
+ * The field to check if this record should be created or updated.
+ * @param string $value
+ * The value for this record of the field specified for $key.
+ * @param array $params
+ * Values of the fields to set for the object.
+ *
+ * @return Drupal\salesforce\SFID or NULL
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function objectUpsert($name, $key, $value, array $params);
+
+ /**
+ * Update an existing object.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account.
+ * @param string $id
+ * Salesforce id of the object.
+ * @param array $params
+ * Values of the fields to set for the object.
+ *
+ * @return null
+ * Update() doesn't return any data. Examine HTTP response or Exception.
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function objectUpdate($name, $id, array $params);
+
+ /**
+ * Return a full loaded Salesforce object.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account.
+ * @param string $id
+ * Salesforce id of the object.
+ *
+ * @return SObject
+ * Object of the requested Salesforce object.
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function objectRead($name, $id);
+
+ /**
+ * Return a full loaded Salesforce object from External ID.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account.
+ * @param string $field
+ * Salesforce external id field name.
+ * @param string $value
+ * Value of external id.
+ *
+ * @return SObject
+ * Object of the requested Salesforce object.
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function objectReadbyExternalId($name, $field, $value);
+
+ /**
+ * Delete a Salesforce object. Note: if Object with given $id doesn't exist,
+ * objectDelete() will assume success unless $throw_exception is given.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account.
+ * @param string $id
+ * Salesforce id of the object.
+ * @pararm bool $throw_exception
+ * (optional) If TRUE, 404 response code will cause RequestException to be
+ * thrown. Otherwise, hide those errors. Default is FALSE.
+ *
+ * @addtogroup salesforce_apicalls
+ *
+ * @return null
+ * Delete() doesn't return any data. Examine HTTP response or Exception.
+ */
+ public function objectDelete($name, $id, $throw_exception = FALSE);
+
+ /**
+ * Retrieves the list of individual objects that have been deleted within the
+ * given timespan for a specified object type.
+ *
+ * @param string $type
+ * Object type name, E.g., Contact, Account.
+ * @param string $startDate
+ * Start date to check for deleted objects (in ISO 8601 format).
+ * @param string $endDate
+ * End date to check for deleted objects (in ISO 8601 format).
+ * @return GetDeletedResult
+ */
+ public function getDeleted($type, $startDate, $endDate);
+
+ /**
+ * Return a list of available resources for the configured API version.
+ *
+ * @return Drupal\salesforce\Rest\RestResponse_Resources
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function listResources();
+
+ /**
+ * Return a list of SFIDs for the given object, which have been created or
+ * updated in the given timeframe.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account.
+ *
+ * @param int $start
+ * Unix timestamp for older timeframe for updates.
+ * Defaults to "-29 days" if empty.
+ *
+ * @param int $end
+ * unix timestamp for end of timeframe for updates.
+ * Defaults to now if empty
+ *
+ * @return array
+ * return array has 2 indexes:
+ * "ids": a list of SFIDs of those records which have been created or
+ * updated in the given timeframe.
+ * "latestDateCovered": ISO 8601 format timestamp (UTC) of the last date
+ * covered in the request.
+ *
+ * @see https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_getupdated.htm
+ *
+ * @addtogroup salesforce_apicalls
+ */
+ public function getUpdated($name, $start = null, $end = null);
+
+ /**
+ * Retrieve all record types for this org. If $name is provided, retrieve
+ * record types for the given object type only.
+ *
+ * @param string $name
+ * Object type name, e.g. Contact, Account, etc.
+ *
+ * @return array
+ * If $name is given, an array of record types indexed by developer name.
+ * Otherwise, an array of record type arrays, indexed by object type name.
+ */
+ public function getRecordTypes($name = NULL);
+
+ /**
+ * Given a DeveloperName and SObject Name, return the SFID of the
+ * corresponding RecordType. DeveloperName doesn't change between Salesforce
+ * environments, so it's safer to rely on compared to SFID.
+ *
+ * @param string $name
+ * Object type name, E.g., Contact, Account.
+ *
+ * @param string $devname
+ * RecordType DeveloperName, e.g. Donation, Membership, etc.
+ *
+ * @return SFID
+ * The Salesforce ID of the given Record Type, or null.
+ *
+ * @throws Exception if record type not found
+ */
+ public function getRecordTypeIdByDeveloperName($name, $devname, $reset = FALSE);
+
+ /**
+ * Utility function to determine object type for given SFID
+ *
+ * @param SFID $id
+ * @return string
+ * @throws Exception if SFID doesn't match any object type
+ */
+ public static function getObjectTypeName(SFID $id);
}
--
GitLab