lxbfYeaa/PayPal-PHP-SDK
Archived
Template
1
0
Fork 0
forked from LiveCarta/PayPal-PHP-SDK
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Configurable Headers for All Requests to PayPal

Browse Source 
- Allows adding additional headers to every call to PayPal APIs.
- Refactored OAuthTokenCredential to share code for making Rest Calls
- SDK Config to add headers with http.headers.* syntax
- Fixes #193
This commit is contained in:
japatel
2014-12-17 15:36:41 -06:00
parent 515b747223
commit 20038e7525
8 changed files with 170 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
lib/PayPal/Auth/OAuthTokenCredential.php
View File

@@ -3,16 +3,13 @@
namespace PayPal\Auth;
use PayPal\Cache\AuthorizationCache;
use PayPal\Common\PPModel;
use PayPal\Common\PPUserAgent;
use PayPal\Common\ResourceModel;
use PayPal\Core\PPConstants;
use PayPal\Core\PPHttpConfig;
use PayPal\Core\PPHttpConnection;
use PayPal\Core\PPLoggingManager;
use PayPal\Exception\PPConfigurationException;
use PayPal\Rest\RestHandler;
use PayPal\Validation\JsonValidator;
use PayPal\Handler\IPPHandler;
use PayPal\Rest\ApiContext;
/**
* Class OAuthTokenCredential
@@ -21,6 +18,12 @@ class OAuthTokenCredential extends ResourceModel
{
public static $CACHE_PATH = '/../../../var/auth.cache';
/**
* @var string Default Auth Handler
*/
public static $AUTH_HANDLER = 'PayPal\Rest\OauthHandler';
/**
* Private Variable
*
@@ -192,6 +195,8 @@ class OAuthTokenCredential extends ResourceModel
* Retrieves the token based on the input configuration
*
* @param array $config
* @param string $clientId
* @param string $clientSecret
* @param string $payload
* @return mixed
* @throws PPConfigurationException
@@ -199,17 +204,20 @@ class OAuthTokenCredential extends ResourceModel
*/
private function getToken($config, $clientId, $clientSecret, $payload)
{
$base64ClientID = base64_encode($clientId . ":" . $clientSecret);
$headers = array(
"User-Agent" => PPUserAgent::getValue(PPConstants::SDK_NAME, PPConstants::SDK_VERSION),
"Authorization" => "Basic " . $base64ClientID,
"Accept" => "*/*"
);
$httpConfig = new PPHttpConfig(null, 'POST');
$httpConfiguration = self::getOAuthHttpConfiguration($config);
$httpConfiguration->setHeaders($headers);
$handlers = array(self::$AUTH_HANDLER);
$connection = new PPHttpConnection($httpConfiguration, $config);
/** @var IPPHandler $handler */
foreach ($handlers as $handler) {
if (!is_object($handler)) {
$fullHandler = "\\" . (string)$handler;
$handler = new $fullHandler(new ApiContext($this));
}
$handler->handle($httpConfig, $payload, array('clientId' => $clientId, 'clientSecret' => $clientSecret));
}
$connection = new PPHttpConnection($httpConfig, $config);
$res = $connection->execute($payload);
$response = json_decode($res, true);
@@ -249,40 +257,4 @@ class OAuthTokenCredential extends ResourceModel
return $this->accessToken;
}
/**
* Get HttpConfiguration object for OAuth API
*
* @param array $config
*
* @return PPHttpConfig
* @throws \PayPal\Exception\PPConfigurationException
*/
private static function getOAuthHttpConfiguration($config)
{
if (isset($config['oauth.EndPoint'])) {
$baseEndpoint = $config['oauth.EndPoint'];
} else if (isset($config['service.EndPoint'])) {
$baseEndpoint = $config['service.EndPoint'];
} else if (isset($config['mode'])) {
switch (strtoupper($config['mode'])) {
case 'SANDBOX':
$baseEndpoint = PPConstants::REST_SANDBOX_ENDPOINT;
break;
case 'LIVE':
$baseEndpoint = PPConstants::REST_LIVE_ENDPOINT;
break;
default:
throw new PPConfigurationException('The mode config parameter must be set to either sandbox/live');
}
} else {
throw new PPConfigurationException(
'You must set one of service.endpoint or mode parameters in your configuration'
);
}
$baseEndpoint = rtrim(trim($baseEndpoint), '/');
return new PPHttpConfig($baseEndpoint . "/v1/oauth2/token", "POST");
}
}

2
lib/PayPal/Core/PPConstants.php
View File

@@ -12,7 +12,7 @@ class PPConstants
{
const SDK_NAME = 'PayPal-PHP-SDK';
const SDK_VERSION = '0.16.0';
const SDK_VERSION = '0.16.1';
const REST_SANDBOX_ENDPOINT = "https://api.sandbox.paypal.com/";
const OPENID_REDIRECT_SANDBOX_URL = "https://www.sandbox.paypal.com/webapps/auth/protocol/openidconnect";

20
lib/PayPal/Rest/ApiContext.php
View File

@@ -58,6 +58,26 @@ class ApiContext
return $this->credential;
}
public function getRequestHeaders()
{
$result = PPConfigManager::getInstance()->get('http.headers');
$headers = array();
foreach ($result as $header => $value) {
$headerName = ltrim($header, 'http.headers');
$headers[$headerName] = $value;
}
return $headers;
}
public function addRequestHeader($name, $value)
{
// Determine if the name already has a 'http.headers' prefix. If not, add one.
if (!(substr($name, 0, strlen('http.headers')) === 'http.headers')) {
$name = 'http.headers.' . $name;
}
PPConfigManager::getInstance()->addConfigs(array($name => $value));
}
/**
* Get Request ID
*

105
lib/PayPal/Rest/OauthHandler.php Normal file
View File

@@ -0,0 +1,105 @@
<?php
/**
* API handler for OAuth Token Request REST API calls
*/
namespace PayPal\Rest;
use PayPal\Common\PPUserAgent;
use PayPal\Core\PPConstants;
use PayPal\Core\PPHttpConfig;
use PayPal\Exception\PPConfigurationException;
use PayPal\Exception\PPInvalidCredentialException;
use PayPal\Exception\PPMissingCredentialException;
use PayPal\Handler\IPPHandler;
/**
* Class OauthHandler
*/
class OauthHandler implements IPPHandler
{
/**
* Private Variable
*
* @var \Paypal\Rest\ApiContext $apiContext
*/
private $apiContext;
/**
* Construct
*
* @param \Paypal\Rest\ApiContext $apiContext
*/
public function __construct($apiContext)
{
$this->apiContext = $apiContext;
}
/**
* @param PPHttpConfig $httpConfig
* @param string $request
* @param mixed $options
* @return mixed|void
* @throws PPConfigurationException
* @throws PPInvalidCredentialException
* @throws PPMissingCredentialException
*/
public function handle($httpConfig, $request, $options)
{
$config = $this->apiContext->getConfig();
$httpConfig->setUrl(
rtrim(trim($this->_getEndpoint($config)), '/') .
(isset($options['path']) ? $options['path'] : '')
);
$headers = array(
"User-Agent" => PPUserAgent::getValue(PPConstants::SDK_NAME, PPConstants::SDK_VERSION),
"Authorization" => "Basic " . base64_encode($options['clientId'] . ":" . $options['clientSecret']),
"Accept" => "*/*"
);
$httpConfig->setHeaders($headers);
// Add any additional Headers that they may have provided
$headers = $this->apiContext->getRequestHeaders();
foreach ($headers as $key => $value) {
$httpConfig->addHeader($key, $value);
}
}
/**
* Get HttpConfiguration object for OAuth API
*
* @param array $config
*
* @return PPHttpConfig
* @throws \PayPal\Exception\PPConfigurationException
*/
private static function _getEndpoint($config)
{
if (isset($config['oauth.EndPoint'])) {
$baseEndpoint = $config['oauth.EndPoint'];
} else if (isset($config['service.EndPoint'])) {
$baseEndpoint = $config['service.EndPoint'];
} else if (isset($config['mode'])) {
switch (strtoupper($config['mode'])) {
case 'SANDBOX':
$baseEndpoint = PPConstants::REST_SANDBOX_ENDPOINT;
break;
case 'LIVE':
$baseEndpoint = PPConstants::REST_LIVE_ENDPOINT;
break;
default:
throw new PPConfigurationException('The mode config parameter must be set to either sandbox/live');
}
} else {
throw new PPConfigurationException(
'You must set one of service.endpoint or mode parameters in your configuration'
);
}
$baseEndpoint = rtrim(trim($baseEndpoint), '/') . "/v1/oauth2/token";
return $baseEndpoint;
}
}

5
lib/PayPal/Rest/RestHandler.php
View File

@@ -84,6 +84,11 @@ class RestHandler implements IPPHandler
if ($httpConfig->getMethod() == 'POST' || $httpConfig->getMethod() == 'PUT') {
$httpConfig->addHeader('PayPal-Request-Id', $this->apiContext->getRequestId());
}
// Add any additional Headers that they may have provided
$headers = $this->apiContext->getRequestHeaders();
foreach ($headers as $key => $value) {
$httpConfig->addHeader($key, $value);
}
}
/**