<?php
namespace Stripe\StripeTaxForWooCommerce\SDK\lib;
class BaseStripeClient implements StripeClientInterface, StripeStreamingClientInterface {
/** @var string default base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's API */
const DEFAULT_API_BASE = 'https://api.stripe.com';
/** @var string default base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's OAuth API */
const DEFAULT_CONNECT_BASE = 'https://connect.stripe.com';
/** @var string default base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's Files API */
const DEFAULT_FILES_BASE = 'https://files.stripe.com';
/** @var array<string, null|string> */
const DEFAULT_CONFIG = array(
'api_key' => null,
'client_id' => null,
'stripe_account' => null,
'stripe_version' => \Stripe\StripeTaxForWooCommerce\SDK\lib\Util\ApiVersion::CURRENT,
'api_base' => self::DEFAULT_API_BASE,
'connect_base' => self::DEFAULT_CONNECT_BASE,
'files_base' => self::DEFAULT_FILES_BASE,
);
/** @var array<string, mixed> */
private $config;
/** @var \Stripe\StripeTaxForWooCommerce\SDK\lib\Util\RequestOptions */
private $defaultOpts;
/**
* Initializes a new instance of the {@link BaseStripeClient} class.
*
* The constructor takes a single argument. The argument can be a string, in which case it
* should be the API key. It can also be an array with various configuration settings.
*
* Configuration settings include the following options:
*
* - api_key (null|string): the Stripe\StripeTaxForWooCommerce\SDK\lib API key, to be used in regular API requests.
* - client_id (null|string): the Stripe\StripeTaxForWooCommerce\SDK\lib client ID, to be used in OAuth requests.
* - stripe_account (null|string): a Stripe\StripeTaxForWooCommerce\SDK\lib account ID. If set, all requests sent by the client
* will automatically use the {@code Stripe\StripeTaxForWooCommerce\SDK\lib-Account} header with that account ID.
* - stripe_version (null|string): a Stripe\StripeTaxForWooCommerce\SDK\lib API verion. If set, all requests sent by the client
* will include the {@code Stripe\StripeTaxForWooCommerce\SDK\lib-Version} header with that API version.
*
* The following configuration settings are also available, though setting these should rarely be necessary
* (only useful if you want to send requests to a mock server like stripe-mock):
*
* - api_base (string): the base URL for regular API requests. Defaults to
* {@link DEFAULT_API_BASE}.
* - connect_base (string): the base URL for OAuth requests. Defaults to
* {@link DEFAULT_CONNECT_BASE}.
* - files_base (string): the base URL for file creation requests. Defaults to
* {@link DEFAULT_FILES_BASE}.
*
* @param array<string, mixed>|string $config the API key as a string, or an array containing
* the client configuration settings
*/
public function __construct( $config = array() ) {
if ( \is_string( $config ) ) {
$config = array( 'api_key' => $config );
} elseif ( ! \is_array( $config ) ) {
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( '$config must be a string or an array' );
}
$config = \array_merge( self::DEFAULT_CONFIG, $config );
$this->validateConfig( $config );
$this->config = $config;
$this->defaultOpts = \Stripe\StripeTaxForWooCommerce\SDK\lib\Util\RequestOptions::parse(
array(
'stripe_account' => $config['stripe_account'],
'stripe_version' => $config['stripe_version'],
)
);
}
/**
* Gets the API key used by the client to send requests.
*
* @return null|string the API key used by the client to send requests
*/
public function getApiKey() {
return $this->config['api_key'];
}
/**
* Gets the client ID used by the client in OAuth requests.
*
* @return null|string the client ID used by the client in OAuth requests
*/
public function getClientId() {
return $this->config['client_id'];
}
/**
* Gets the base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's API.
*
* @return string the base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's API
*/
public function getApiBase() {
return $this->config['api_base'];
}
/**
* Gets the base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's OAuth API.
*
* @return string the base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's OAuth API
*/
public function getConnectBase() {
return $this->config['connect_base'];
}
/**
* Gets the base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's Files API.
*
* @return string the base URL for Stripe\StripeTaxForWooCommerce\SDK\lib's Files API
*/
public function getFilesBase() {
return $this->config['files_base'];
}
/**
* Sends a request to Stripe\StripeTaxForWooCommerce\SDK\lib's API.
*
* @param 'delete'|'get'|'post' $method the HTTP method
* @param string $path the path of the request
* @param array $params the parameters of the request
* @param array|\Stripe\StripeTaxForWooCommerce\SDK\lib\Util\RequestOptions $opts the special modifiers of the request
*
* @return \Stripe\StripeTaxForWooCommerce\SDK\lib\StripeObject the object returned by Stripe\StripeTaxForWooCommerce\SDK\lib's API
*/
public function request( $method, $path, $params, $opts ) {
$opts = $this->defaultOpts->merge( $opts, true );
$baseUrl = $opts->apiBase ?: $this->getApiBase();
$requestor = new \Stripe\StripeTaxForWooCommerce\SDK\lib\ApiRequestor( $this->apiKeyForRequest( $opts ), $baseUrl );
list($response, $opts->apiKey) = $requestor->request( $method, $path, $params, $opts->headers, array( 'stripe_client' ) );
$opts->discardNonPersistentHeaders();
$obj = \Stripe\StripeTaxForWooCommerce\SDK\lib\Util\Util::convertToStripeObject( $response->json, $opts );
$obj->setLastResponse( $response );
return $obj;
}
/**
* Sends a request to Stripe\StripeTaxForWooCommerce\SDK\lib's API, passing chunks of the streamed response
* into a user-provided $readBodyChunkCallable callback.
*
* @param 'delete'|'get'|'post' $method the HTTP method
* @param string $path the path of the request
* @param callable $readBodyChunkCallable a function that will be called
* @param array $params the parameters of the request
* @param array|\Stripe\StripeTaxForWooCommerce\SDK\lib\Util\RequestOptions $opts the special modifiers of the request
* with chunks of bytes from the body if the request is successful
*/
public function requestStream( $method, $path, $readBodyChunkCallable, $params, $opts ) {
$opts = $this->defaultOpts->merge( $opts, true );
$baseUrl = $opts->apiBase ?: $this->getApiBase();
$requestor = new \Stripe\StripeTaxForWooCommerce\SDK\lib\ApiRequestor( $this->apiKeyForRequest( $opts ), $baseUrl );
list($response, $opts->apiKey) = $requestor->requestStream( $method, $path, $readBodyChunkCallable, $params, $opts->headers, array( 'stripe_client' ) );
}
/**
* Sends a request to Stripe\StripeTaxForWooCommerce\SDK\lib's API.
*
* @param 'delete'|'get'|'post' $method the HTTP method
* @param string $path the path of the request
* @param array $params the parameters of the request
* @param array|\Stripe\StripeTaxForWooCommerce\SDK\lib\Util\RequestOptions $opts the special modifiers of the request
*
* @return \Stripe\StripeTaxForWooCommerce\SDK\lib\Collection of ApiResources
*/
public function requestCollection( $method, $path, $params, $opts ) {
$obj = $this->request( $method, $path, $params, $opts );
if ( ! ( $obj instanceof \Stripe\StripeTaxForWooCommerce\SDK\lib\Collection ) ) {
$received_class = \get_class( $obj );
$msg = "Expected to receive `Stripe\StripeTaxForWooCommerce\SDK\lib\\Collection` object from Stripe\StripeTaxForWooCommerce\SDK\lib API. Instead received `{$received_class}`.";
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\UnexpectedValueException( $msg );
}
$obj->setFilters( $params );
return $obj;
}
/**
* Sends a request to Stripe\StripeTaxForWooCommerce\SDK\lib's API.
*
* @param 'delete'|'get'|'post' $method the HTTP method
* @param string $path the path of the request
* @param array $params the parameters of the request
* @param array|\Stripe\StripeTaxForWooCommerce\SDK\lib\Util\RequestOptions $opts the special modifiers of the request
*
* @return \Stripe\StripeTaxForWooCommerce\SDK\lib\SearchResult of ApiResources
*/
public function requestSearchResult( $method, $path, $params, $opts ) {
$obj = $this->request( $method, $path, $params, $opts );
if ( ! ( $obj instanceof \Stripe\StripeTaxForWooCommerce\SDK\lib\SearchResult ) ) {
$received_class = \get_class( $obj );
$msg = "Expected to receive `Stripe\StripeTaxForWooCommerce\SDK\lib\\SearchResult` object from Stripe\StripeTaxForWooCommerce\SDK\lib API. Instead received `{$received_class}`.";
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\UnexpectedValueException( $msg );
}
$obj->setFilters( $params );
return $obj;
}
/**
* @param \Stripe\StripeTaxForWooCommerce\SDK\lib\Util\RequestOptions $opts
*
* @return string
* @throws \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\AuthenticationException
*/
private function apiKeyForRequest( $opts ) {
$apiKey = $opts->apiKey ?: $this->getApiKey();
if ( null === $apiKey ) {
$msg = 'No API key provided. Set your API key when constructing the '
. 'StripeClient instance, or provide it on a per-request basis '
. 'using the `api_key` key in the $opts argument.';
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\AuthenticationException( $msg );
}
return $apiKey;
}
/**
* @param array<string, mixed> $config
*
* @throws \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException
*/
private function validateConfig( $config ) {
// api_key
if ( null !== $config['api_key'] && ! \is_string( $config['api_key'] ) ) {
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( 'api_key must be null or a string' );
}
if ( null !== $config['api_key'] && ( '' === $config['api_key'] ) ) {
$msg = 'api_key cannot be the empty string';
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( $msg );
}
if ( null !== $config['api_key'] && ( \preg_match( '/\s/', $config['api_key'] ) ) ) {
$msg = 'api_key cannot contain whitespace';
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( $msg );
}
// client_id
if ( null !== $config['client_id'] && ! \is_string( $config['client_id'] ) ) {
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( 'client_id must be null or a string' );
}
// stripe_account
if ( null !== $config['stripe_account'] && ! \is_string( $config['stripe_account'] ) ) {
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( 'stripe_account must be null or a string' );
}
// stripe_version
if ( null !== $config['stripe_version'] && ! \is_string( $config['stripe_version'] ) ) {
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( 'stripe_version must be null or a string' );
}
// api_base
if ( ! \is_string( $config['api_base'] ) ) {
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( 'api_base must be a string' );
}
// connect_base
if ( ! \is_string( $config['connect_base'] ) ) {
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( 'connect_base must be a string' );
}
// files_base
if ( ! \is_string( $config['files_base'] ) ) {
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( 'files_base must be a string' );
}
// check absence of extra keys
$extraConfigKeys = \array_diff( \array_keys( $config ), \array_keys( self::DEFAULT_CONFIG ) );
if ( ! empty( $extraConfigKeys ) ) {
// Wrap in single quote to more easily catch trailing spaces errors
$invalidKeys = "'" . \implode( "', '", $extraConfigKeys ) . "'";
throw new \Stripe\StripeTaxForWooCommerce\SDK\lib\Exception\InvalidArgumentException( 'Found unknown key(s) in configuration array: ' . $invalidKeys );
}
}
}