Change StripeClient initialization

stripe · Mar 25, 2020 · 9f5a679 · 9f5a679
1 parent 66b0dcd
commit 9f5a679
Show file tree

Hide file tree

Showing 59 changed files with 104 additions and 85 deletions.
diff --git a/lib/BaseStripeClient.php b/lib/BaseStripeClient.php
@@ -29,21 +29,42 @@ class BaseStripeClient implements StripeClientInterface
     private $filesBase;
 
     /**
-     * Initializes a new instance of the {@link StripeClient} class.
+     * Initializes a new instance of the {@link BaseStripeClient} class.
      *
-     * @param null|string $apiKey the API key used by the client to make requests
-     * @param null|string $clientId the client ID used by the client in OAuth requests
-     * @param null|string $apiBase The base URL for Stripe's API. Defaults to {@link DEFAULT_API_BASE}.
-     * @param null|string $connectBase The base URL for Stripe's OAuth API. Defaults to {@link DEFAULT_CONNECT_BASE}.
-     * @param null|string $filesBase The base URL for Stripe's Files API. Defaults to {@link DEFAULT_FILES_BASE}.
+     * 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 (string): the Stripe API key, to be used in regular API requests.
+     * - client_id (string): the Stripe client ID, to be used in OAuth requests.
+     * - api_base (string): the base URL for regular API requests. Defaults to
+     *   {@link DEFAULT_API_BASE}. Changing this should rarely be necessary.
+     * - connect_base (string): the base URL for OAuth requests. Defaults to
+     *   {@link DEFAULT_CONNECT_BASE}. Changing this should rarely be necessary.
+     * - files_base (string): the base URL for file creation requests. Defaults to
+     *   {@link DEFAULT_FILES_BASE}. Changing this should rarely be necessary.
+     *
+     * @param array<string, mixed>|string $config the API key as a string, or an array containing
+     *   the client configuration settings
      */
-    public function __construct(
-        $apiKey,
-        $clientId = null,
-        $apiBase = null,
-        $connectBase = null,
-        $filesBase = null
-    ) {
+    public function __construct($config = [])
+    {
+        if (\is_string($config)) {
+            $config = ['api_key' => $config];
+        }
+
+        $defaults = [
+            'api_key' => null,
+            'client_id' => null,
+            'api_base' => self::DEFAULT_API_BASE,
+            'connect_base' => self::DEFAULT_CONNECT_BASE,
+            'files_base' => self::DEFAULT_FILES_BASE,
+        ];
+        $config = \array_merge($defaults, $config);
+
+        $apiKey = $config['api_key'];
+
         if (null !== $apiKey && ('' === $apiKey)) {
             $msg = 'API key cannot be the empty string.';
 
@@ -57,11 +78,10 @@ public function __construct(
         }
 
         $this->apiKey = $apiKey;
-        $this->clientId = $clientId;
-
-        $this->apiBase = $apiBase ?: self::DEFAULT_API_BASE;
-        $this->connectBase = $connectBase ?: self::DEFAULT_CONNECT_BASE;
-        $this->filesBase = $filesBase ?: self::DEFAULT_FILES_BASE;
+        $this->clientId = $config['client_id'];
+        $this->apiBase = $config['api_base'];
+        $this->connectBase = $config['connect_base'];
+        $this->filesBase = $config['files_base'];
     }
 
     /**

diff --git a/tests/Stripe/BaseStripeClientTest.php b/tests/Stripe/BaseStripeClientTest.php
@@ -8,9 +8,9 @@
  */
 final class BaseStripeClientTest extends \PHPUnit\Framework\TestCase
 {
-    public function testCtorDoesNotThrowIfApiKeyIsNull()
+    public function testCtorDoesNotThrowWhenNoParams()
     {
-        $client = new BaseStripeClient(null);
+        $client = new BaseStripeClient();
         static::assertNotNull($client);
         static::assertNull($client->getApiKey());
     }
@@ -33,7 +33,7 @@ public function testCtorThrowsIfApiKeyContainsWhitespace()
 
     public function testRequestWithClientApiKey()
     {
-        $client = new BaseStripeClient('sk_test_client', null, MOCK_URL);
+        $client = new BaseStripeClient(['api_key' => 'sk_test_client', 'api_base' => MOCK_URL]);
         $charge = $client->request('get', '/v1/charges/ch_123', [], []);
         static::assertNotNull($charge);
         $optsReflector = new \ReflectionProperty(\Stripe\StripeObject::class, '_opts');
@@ -43,10 +43,9 @@ public function testRequestWithClientApiKey()
 
     public function testRequestWithOptsApiKey()
     {
-        $client = new BaseStripeClient(null, null, MOCK_URL);
+        $client = new BaseStripeClient(['api_base' => MOCK_URL]);
         $charge = $client->request('get', '/v1/charges/ch_123', [], ['api_key' => 'sk_test_opts']);
         static::assertNotNull($charge);
-        static::assertNotNull($charge);
         $optsReflector = new \ReflectionProperty(\Stripe\StripeObject::class, '_opts');
         $optsReflector->setAccessible(true);
         static::assertSame('sk_test_opts', $optsReflector->getValue($charge)->apiKey);
@@ -57,7 +56,7 @@ public function testRequestThrowsIfNoApiKeyInClientAndOpts()
         $this->expectException(\Stripe\Exception\AuthenticationException::class);
         $this->expectExceptionMessage('No API key provided.');
 
-        $client = new BaseStripeClient(null, null, MOCK_URL);
+        $client = new BaseStripeClient(['api_base' => MOCK_URL]);
         $charge = $client->request('get', '/v1/charges/ch_123', [], []);
         static::assertNotNull($charge);
         static::assertSame('ch_123', $charge->id);
@@ -68,7 +67,7 @@ public function testRequestThrowsIfOptsIsString()
         $this->expectException(\Stripe\Exception\InvalidArgumentException::class);
         $this->expectExceptionMessageRegExp('#Do not pass a string for request options.#');
 
-        $client = new BaseStripeClient(null, null, MOCK_URL);
+        $client = new BaseStripeClient(['api_base' => MOCK_URL]);
         $charge = $client->request('get', '/v1/charges/ch_123', [], 'foo');
         static::assertNotNull($charge);
         static::assertSame('ch_123', $charge->id);
@@ -79,7 +78,7 @@ public function testRequestThrowsIfOptsIsArrayWithUnexpectedKeys()
         $this->expectException(\Stripe\Exception\InvalidArgumentException::class);
         $this->expectExceptionMessage('Got unexpected keys in options array: foo');
 
-        $client = new BaseStripeClient(null, null, MOCK_URL);
+        $client = new BaseStripeClient(['api_base' => MOCK_URL]);
         $charge = $client->request('get', '/v1/charges/ch_123', [], ['foo' => 'bar']);
         static::assertNotNull($charge);
         static::assertSame('ch_123', $charge->id);

diff --git a/tests/Stripe/Service/AbstractServiceTest.php b/tests/Stripe/Service/AbstractServiceTest.php
@@ -21,7 +21,7 @@ final class AbstractServiceTest extends \PHPUnit\Framework\TestCase
      */
     public function setUpMockService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         // Testing with CouponService, because testing abstract classes is hard in PHP :/
         $this->service = new \Stripe\Service\CouponService($this->client);
     }

diff --git a/tests/Stripe/Service/AccountLinkServiceTest.php b/tests/Stripe/Service/AccountLinkServiceTest.php
@@ -21,7 +21,7 @@ final class AccountLinkServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new AccountLinkService($this->client);
     }
 

diff --git a/tests/Stripe/Service/AccountServiceTest.php b/tests/Stripe/Service/AccountServiceTest.php
@@ -26,7 +26,7 @@ final class AccountServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new AccountService($this->client);
     }
 

diff --git a/tests/Stripe/Service/ApplePayDomainServiceTest.php b/tests/Stripe/Service/ApplePayDomainServiceTest.php
@@ -23,7 +23,7 @@ final class ApplePayDomainServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new ApplePayDomainService($this->client);
     }
 

diff --git a/tests/Stripe/Service/ApplicationFeeServiceTest.php b/tests/Stripe/Service/ApplicationFeeServiceTest.php
@@ -24,7 +24,7 @@ final class ApplicationFeeServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new ApplicationFeeService($this->client);
     }
 

diff --git a/tests/Stripe/Service/BalanceServiceTest.php b/tests/Stripe/Service/BalanceServiceTest.php
@@ -21,7 +21,7 @@ final class BalanceServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new BalanceService($this->client);
     }
 

diff --git a/tests/Stripe/Service/BalanceTransactionServiceTest.php b/tests/Stripe/Service/BalanceTransactionServiceTest.php
@@ -23,7 +23,7 @@ final class BalanceTransactionServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new BalanceTransactionService($this->client);
     }
 

diff --git a/tests/Stripe/Service/ChargeServiceTest.php b/tests/Stripe/Service/ChargeServiceTest.php
@@ -23,7 +23,7 @@ final class ChargeServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new ChargeService($this->client);
     }
 

diff --git a/tests/Stripe/Service/Checkout/SessionServiceTest.php b/tests/Stripe/Service/Checkout/SessionServiceTest.php
@@ -23,7 +23,7 @@ final class SessionServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new SessionService($this->client);
     }
 

diff --git a/tests/Stripe/Service/CoreServiceFactoryTest.php b/tests/Stripe/Service/CoreServiceFactoryTest.php
@@ -19,7 +19,7 @@ final class CoreServiceFactoryTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->serviceFactory = new CoreServiceFactory($this->client);
     }
 

diff --git a/tests/Stripe/Service/CountrySpecServiceTest.php b/tests/Stripe/Service/CountrySpecServiceTest.php
@@ -23,7 +23,7 @@ final class CountrySpecServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new CountrySpecService($this->client);
     }
 

diff --git a/tests/Stripe/Service/CouponServiceTest.php b/tests/Stripe/Service/CouponServiceTest.php
@@ -23,7 +23,7 @@ final class CouponServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new CouponService($this->client);
     }
 

diff --git a/tests/Stripe/Service/CreditNoteServiceTest.php b/tests/Stripe/Service/CreditNoteServiceTest.php
@@ -23,7 +23,7 @@ final class CreditNoteServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new CreditNoteService($this->client);
     }
 

diff --git a/tests/Stripe/Service/CustomerServiceTest.php b/tests/Stripe/Service/CustomerServiceTest.php
@@ -26,7 +26,7 @@ final class CustomerServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new CustomerService($this->client);
     }
 

diff --git a/tests/Stripe/Service/DisputeServiceTest.php b/tests/Stripe/Service/DisputeServiceTest.php
@@ -23,7 +23,7 @@ final class DisputeServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new DisputeService($this->client);
     }
 

diff --git a/tests/Stripe/Service/EphemeralKeyServiceTest.php b/tests/Stripe/Service/EphemeralKeyServiceTest.php
@@ -23,7 +23,7 @@ final class EphemeralKeyServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new EphemeralKeyService($this->client);
     }
 

diff --git a/tests/Stripe/Service/EventServiceTest.php b/tests/Stripe/Service/EventServiceTest.php
@@ -23,7 +23,7 @@ final class EventServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new EventService($this->client);
     }
 

diff --git a/tests/Stripe/Service/ExchangeRateServiceTest.php b/tests/Stripe/Service/ExchangeRateServiceTest.php
@@ -21,7 +21,7 @@ final class ExchangeRateServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new ExchangeRateService($this->client);
     }
 

diff --git a/tests/Stripe/Service/FileLinkServiceTest.php b/tests/Stripe/Service/FileLinkServiceTest.php
@@ -23,7 +23,7 @@ final class FileLinkServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new FileLinkService($this->client);
     }
 

diff --git a/tests/Stripe/Service/FileServiceTest.php b/tests/Stripe/Service/FileServiceTest.php
@@ -23,7 +23,7 @@ final class FileServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new FileService($this->client);
     }
 
@@ -40,7 +40,7 @@ public function testAll()
 
     public function testCreateWithCURLFile()
     {
-        $client = new \Stripe\StripeClient('sk_test_123', null, null, null, MOCK_URL);
+        $client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'files_base' => MOCK_URL]);
         $service = new FileService($client);
 
         $this->expectsRequest(
@@ -62,7 +62,7 @@ public function testCreateWithCURLFile()
 
     public function testCreateWithFileHandle()
     {
-        $client = new \Stripe\StripeClient('sk_test_123', null, null, null, MOCK_URL);
+        $client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'files_base' => MOCK_URL]);
         $service = new FileService($client);
 
         $this->expectsRequest(

diff --git a/tests/Stripe/Service/InvoiceItemServiceTest.php b/tests/Stripe/Service/InvoiceItemServiceTest.php
@@ -23,7 +23,7 @@ final class InvoiceItemServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new InvoiceItemService($this->client);
     }
 

diff --git a/tests/Stripe/Service/InvoiceServiceTest.php b/tests/Stripe/Service/InvoiceServiceTest.php
@@ -23,7 +23,7 @@ final class InvoiceServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new InvoiceService($this->client);
     }
 

diff --git a/tests/Stripe/Service/Issuing/AuthorizationServiceTest.php b/tests/Stripe/Service/Issuing/AuthorizationServiceTest.php
@@ -23,7 +23,7 @@ final class AuthorizationServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new AuthorizationService($this->client);
     }
 

diff --git a/tests/Stripe/Service/Issuing/CardServiceTest.php b/tests/Stripe/Service/Issuing/CardServiceTest.php
@@ -23,7 +23,7 @@ final class CardServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new CardService($this->client);
     }
 

diff --git a/tests/Stripe/Service/Issuing/CardholderServiceTest.php b/tests/Stripe/Service/Issuing/CardholderServiceTest.php
@@ -23,7 +23,7 @@ final class CardholderServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new CardholderService($this->client);
     }
 

diff --git a/tests/Stripe/Service/Issuing/DisputeServiceTest.php b/tests/Stripe/Service/Issuing/DisputeServiceTest.php
@@ -23,7 +23,7 @@ final class DisputeServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new DisputeService($this->client);
     }
 

diff --git a/tests/Stripe/Service/Issuing/TransactionServiceTest.php b/tests/Stripe/Service/Issuing/TransactionServiceTest.php
@@ -23,7 +23,7 @@ final class TransactionServiceTest extends \PHPUnit\Framework\TestCase
      */
     protected function setUpService()
     {
-        $this->client = new \Stripe\StripeClient('sk_test_123', null, MOCK_URL);
+        $this->client = new \Stripe\StripeClient(['api_key' => 'sk_test_123', 'api_base' => MOCK_URL]);
         $this->service = new TransactionService($this->client);
     }