Skip to content

Commit 4699c5d

Browse files
ob-stripeob-stripe
committed
Modernize exceptions
1 parent 9621cb5 commit 4699c5d

File tree

109 files changed

+1096
-635
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+1096
-635
lines changed

‎examples/oauth.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
'grant_type' => 'authorization_code',
1616
'code' => $code,
1717
]);
18-
} catch (\Stripe\Error\OAuth\OAuthBase $e) {
18+
} catch (\Stripe\Exception\OAuth\OAuthErrorException $e) {
1919
exit("Error: " . $e->getMessage());
2020
}
2121

@@ -38,7 +38,7 @@
3838
\Stripe\OAuth::deauthorize([
3939
'stripe_user_id' => $accountId,
4040
]);
41-
} catch (\Stripe\Error\OAuth\OAuthBase $e) {
41+
} catch (\Stripe\Exception\OAuth\OAuthErrorException $e) {
4242
exit("Error: " . $e->getMessage());
4343
}
4444

‎init.php

+25-19
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,32 @@
1616
require(dirname(__FILE__) . '/lib/HttpClient/ClientInterface.php');
1717
require(dirname(__FILE__) . '/lib/HttpClient/CurlClient.php');
1818

19-
// Errors
20-
require(dirname(__FILE__) . '/lib/Error/Base.php');
21-
require(dirname(__FILE__) . '/lib/Error/Api.php');
22-
require(dirname(__FILE__) . '/lib/Error/ApiConnection.php');
23-
require(dirname(__FILE__) . '/lib/Error/Authentication.php');
24-
require(dirname(__FILE__) . '/lib/Error/Card.php');
25-
require(dirname(__FILE__) . '/lib/Error/Idempotency.php');
26-
require(dirname(__FILE__) . '/lib/Error/InvalidRequest.php');
27-
require(dirname(__FILE__) . '/lib/Error/Permission.php');
28-
require(dirname(__FILE__) . '/lib/Error/RateLimit.php');
29-
require(dirname(__FILE__) . '/lib/Error/SignatureVerification.php');
19+
// Exceptions
20+
require(dirname(__FILE__) . '/lib/Exception/ExceptionInterface.php');
21+
require(dirname(__FILE__) . '/lib/Exception/ApiErrorException.php');
22+
require(dirname(__FILE__) . '/lib/Exception/ApiConnectionException.php');
23+
require(dirname(__FILE__) . '/lib/Exception/AuthenticationException.php');
24+
require(dirname(__FILE__) . '/lib/Exception/BadMethodCallException.php');
25+
require(dirname(__FILE__) . '/lib/Exception/CardException.php');
26+
require(dirname(__FILE__) . '/lib/Exception/IdempotencyException.php');
27+
require(dirname(__FILE__) . '/lib/Exception/InvalidArgumentException.php');
28+
require(dirname(__FILE__) . '/lib/Exception/InvalidRequestException.php');
29+
require(dirname(__FILE__) . '/lib/Exception/PermissionException.php');
30+
require(dirname(__FILE__) . '/lib/Exception/RateLimitException.php');
31+
require(dirname(__FILE__) . '/lib/Exception/SignatureVerificationException.php');
32+
require(dirname(__FILE__) . '/lib/Exception/UnexpectedValueException.php');
33+
require(dirname(__FILE__) . '/lib/Exception/UnknownApiErrorException.php');
3034

31-
// OAuth errors
32-
require(dirname(__FILE__) . '/lib/Error/OAuth/OAuthBase.php');
33-
require(dirname(__FILE__) . '/lib/Error/OAuth/InvalidClient.php');
34-
require(dirname(__FILE__) . '/lib/Error/OAuth/InvalidGrant.php');
35-
require(dirname(__FILE__) . '/lib/Error/OAuth/InvalidRequest.php');
36-
require(dirname(__FILE__) . '/lib/Error/OAuth/InvalidScope.php');
37-
require(dirname(__FILE__) . '/lib/Error/OAuth/UnsupportedGrantType.php');
38-
require(dirname(__FILE__) . '/lib/Error/OAuth/UnsupportedResponseType.php');
35+
// OAuth exceptions
36+
require(dirname(__FILE__) . '/lib/Exception/OAuth/ExceptionInterface.php');
37+
require(dirname(__FILE__) . '/lib/Exception/OAuth/OAuthErrorException.php');
38+
require(dirname(__FILE__) . '/lib/Exception/OAuth/InvalidClientException.php');
39+
require(dirname(__FILE__) . '/lib/Exception/OAuth/InvalidGrantException.php');
40+
require(dirname(__FILE__) . '/lib/Exception/OAuth/InvalidRequestException.php');
41+
require(dirname(__FILE__) . '/lib/Exception/OAuth/InvalidScopeException.php');
42+
require(dirname(__FILE__) . '/lib/Exception/OAuth/UnknownOAuthErrorException.php');
43+
require(dirname(__FILE__) . '/lib/Exception/OAuth/UnsupportedGrantTypeException.php');
44+
require(dirname(__FILE__) . '/lib/Exception/OAuth/UnsupportedResponseTypeException.php');
3945

4046
// API operations
4147
require(dirname(__FILE__) . '/lib/ApiOperations/All.php');

‎lib/Account.php

+35-1
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ public function instanceUrl()
103103
* options array containing an `id` key.
104104
* @param array|string|null $opts
105105
*
106+
* @throws \Stripe\Exception\ApiErrorException if the request fails
107+
*
106108
* @return Account
107109
*/
108110
public static function retrieve($id = null, $opts = null)
@@ -118,6 +120,8 @@ public static function retrieve($id = null, $opts = null)
118120
* @param array|null $params
119121
* @param array|string|null $opts
120122
*
123+
* @throws \Stripe\Exception\ApiErrorException if the request fails
124+
*
121125
* @return Account The rejected account.
122126
*/
123127
public function reject($params = null, $opts = null)
@@ -132,6 +136,8 @@ public function reject($params = null, $opts = null)
132136
* @param array|null $clientId
133137
* @param array|string|null $opts
134138
*
139+
* @throws \Stripe\Exception\ApiErrorException if the request fails
140+
*
135141
* @return StripeObject Object containing the response from the API.
136142
*/
137143
public function deauthorize($clientId = null, $opts = null)
@@ -156,6 +162,8 @@ public function deauthorize($clientId = null, $opts = null)
156162
* @param array|null $params
157163
* @param array|string|null $opts
158164
*
165+
* @throws \Stripe\Exception\ApiErrorException if the request fails
166+
*
159167
* @return Capability
160168
*/
161169
public static function retrieveCapability($id, $capabilityId, $params = null, $opts = null)
@@ -181,6 +189,8 @@ public static function updateCapability($id, $capabilityId, $params = null, $opt
181189
* @param array|null $params
182190
* @param array|string|null $opts
183191
*
192+
* @throws \Stripe\Exception\ApiErrorException if the request fails
193+
*
184194
* @return Collection The list of capabilities.
185195
*/
186196
public static function allCapabilities($id, $params = null, $opts = null)
@@ -193,6 +203,8 @@ public static function allCapabilities($id, $params = null, $opts = null)
193203
* @param array|null $params
194204
* @param array|string|null $opts
195205
*
206+
* @throws \Stripe\Exception\ApiErrorException if the request fails
207+
*
196208
* @return BankAccount|Card
197209
*/
198210
public static function createExternalAccount($id, $params = null, $opts = null)
@@ -206,6 +218,8 @@ public static function createExternalAccount($id, $params = null, $opts = null)
206218
* @param array|null $params
207219
* @param array|string|null $opts
208220
*
221+
* @throws \Stripe\Exception\ApiErrorException if the request fails
222+
*
209223
* @return BankAccount|Card
210224
*/
211225
public static function retrieveExternalAccount($id, $externalAccountId, $params = null, $opts = null)
@@ -219,6 +233,8 @@ public static function retrieveExternalAccount($id, $externalAccountId, $params
219233
* @param array|null $params
220234
* @param array|string|null $opts
221235
*
236+
* @throws \Stripe\Exception\ApiErrorException if the request fails
237+
*
222238
* @return BankAccount|Card
223239
*/
224240
public static function updateExternalAccount($id, $externalAccountId, $params = null, $opts = null)
@@ -232,6 +248,8 @@ public static function updateExternalAccount($id, $externalAccountId, $params =
232248
* @param array|null $params
233249
* @param array|string|null $opts
234250
*
251+
* @throws \Stripe\Exception\ApiErrorException if the request fails
252+
*
235253
* @return BankAccount|Card
236254
*/
237255
public static function deleteExternalAccount($id, $externalAccountId, $params = null, $opts = null)
@@ -244,6 +262,8 @@ public static function deleteExternalAccount($id, $externalAccountId, $params =
244262
* @param array|null $params
245263
* @param array|string|null $opts
246264
*
265+
* @throws \Stripe\Exception\ApiErrorException if the request fails
266+
*
247267
* @return Collection The list of external accounts (BankAccount or Card).
248268
*/
249269
public static function allExternalAccounts($id, $params = null, $opts = null)
@@ -256,6 +276,8 @@ public static function allExternalAccounts($id, $params = null, $opts = null)
256276
* @param array|null $params
257277
* @param array|string|null $opts
258278
*
279+
* @throws \Stripe\Exception\ApiErrorException if the request fails
280+
*
259281
* @return LoginLink
260282
*/
261283
public static function createLoginLink($id, $params = null, $opts = null)
@@ -267,6 +289,8 @@ public static function createLoginLink($id, $params = null, $opts = null)
267289
* @param array|null $params
268290
* @param array|string|null $options
269291
*
292+
* @throws \Stripe\Exception\ApiErrorException if the request fails
293+
*
270294
* @return Collection The list of persons.
271295
*/
272296
public function persons($params = null, $options = null)
@@ -283,6 +307,8 @@ public function persons($params = null, $options = null)
283307
* @param array|null $params
284308
* @param array|string|null $opts
285309
*
310+
* @throws \Stripe\Exception\ApiErrorException if the request fails
311+
*
286312
* @return Person
287313
*/
288314
public static function createPerson($id, $params = null, $opts = null)
@@ -296,6 +322,8 @@ public static function createPerson($id, $params = null, $opts = null)
296322
* @param array|null $params
297323
* @param array|string|null $opts
298324
*
325+
* @throws \Stripe\Exception\ApiErrorException if the request fails
326+
*
299327
* @return Person
300328
*/
301329
public static function retrievePerson($id, $personId, $params = null, $opts = null)
@@ -309,6 +337,8 @@ public static function retrievePerson($id, $personId, $params = null, $opts = nu
309337
* @param array|null $params
310338
* @param array|string|null $opts
311339
*
340+
* @throws \Stripe\Exception\ApiErrorException if the request fails
341+
*
312342
* @return Person
313343
*/
314344
public static function updatePerson($id, $personId, $params = null, $opts = null)
@@ -322,6 +352,8 @@ public static function updatePerson($id, $personId, $params = null, $opts = null
322352
* @param array|null $params
323353
* @param array|string|null $opts
324354
*
355+
* @throws \Stripe\Exception\ApiErrorException if the request fails
356+
*
325357
* @return Person
326358
*/
327359
public static function deletePerson($id, $personId, $params = null, $opts = null)
@@ -334,6 +366,8 @@ public static function deletePerson($id, $personId, $params = null, $opts = null
334366
* @param array|null $params
335367
* @param array|string|null $opts
336368
*
369+
* @throws \Stripe\Exception\ApiErrorException if the request fails
370+
*
337371
* @return Collection The list of persons.
338372
*/
339373
public static function allPersons($id, $params = null, $opts = null)
@@ -370,7 +404,7 @@ private function serializeAdditionalOwners($legalEntity, $additionalOwners)
370404
$originalValue = [];
371405
}
372406
if (($originalValue) && (count($originalValue) > count($additionalOwners))) {
373-
throw new \InvalidArgumentException(
407+
throw new Exception\InvalidArgumentException(
374408
"You cannot delete an item from an array, you must instead set a new array"
375409
);
376410
}

‎lib/AlipayAccount.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public function instanceUrl()
2929
$path = 'sources';
3030
} else {
3131
$msg = "Alipay accounts cannot be accessed without a customer ID.";
32-
throw new Error\InvalidRequest($msg, null);
32+
throw new Exception\UnexpectedValueException($msg);
3333
}
3434
$parentExtn = urlencode(Util\Util::utf8($parent));
3535
$extn = urlencode(Util\Util::utf8($this['id']));
@@ -40,7 +40,7 @@ public function instanceUrl()
4040
* @param array|string $_id
4141
* @param array|string|null $_opts
4242
*
43-
* @throws \Stripe\Error\InvalidRequest
43+
* @throws \Stripe\Exception\BadMethodCallException
4444
*
4545
* @deprecated Alipay accounts are deprecated. Please use the sources API instead.
4646
* @link https://stripe.com/docs/sources/alipay
@@ -50,15 +50,15 @@ public static function retrieve($_id, $_opts = null)
5050
$msg = "Alipay accounts cannot be retrieved without a customer ID. " .
5151
"Retrieve an Alipay account using `Customer::retrieveSource(" .
5252
"'customer_id', 'alipay_account_id')`.";
53-
throw new Error\InvalidRequest($msg, null);
53+
throw new Exception\BadMethodCallException($msg);
5454
}
5555

5656
/**
5757
* @param string $_id
5858
* @param array|null $_params
5959
* @param array|string|null $_options
6060
*
61-
* @throws \Stripe\Error\InvalidRequest
61+
* @throws \Stripe\Exception\BadMethodCallException
6262
*
6363
* @deprecated Alipay accounts are deprecated. Please use the sources API instead.
6464
* @link https://stripe.com/docs/sources/alipay
@@ -68,6 +68,6 @@ public static function update($_id, $_params = null, $_options = null)
6868
$msg = "Alipay accounts cannot be updated without a customer ID. " .
6969
"Update an Alipay account using `Customer::updateSource(" .
7070
"'customer_id', 'alipay_account_id', \$updateParams)`.";
71-
throw new Error\InvalidRequest($msg, null);
71+
throw new Exception\BadMethodCallException($msg);
7272
}
7373
}

‎lib/ApiOperations/All.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ trait All
1313
* @param array|null $params
1414
* @param array|string|null $opts
1515
*
16+
* @throws \Stripe\Exception\ApiErrorException if the request fails
17+
*
1618
* @return \Stripe\Collection of ApiResources
1719
*/
1820
public static function all($params = null, $opts = null)
@@ -23,7 +25,7 @@ public static function all($params = null, $opts = null)
2325
list($response, $opts) = static::_staticRequest('get', $url, $params, $opts);
2426
$obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
2527
if (!($obj instanceof \Stripe\Collection)) {
26-
throw new \Stripe\Error\Api(
28+
throw new \Stripe\Exception\UnexpectedValueException(
2729
'Expected type ' . \Stripe\Collection::class . ', got "' . get_class($obj) . '" instead.'
2830
);
2931
}

‎lib/ApiOperations/Create.php

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ trait Create
1313
* @param array|null $params
1414
* @param array|string|null $options
1515
*
16+
* @throws \Stripe\Exception\ApiErrorException if the request fails
17+
*
1618
* @return static The created resource.
1719
*/
1820
public static function create($params = null, $options = null)

‎lib/ApiOperations/Delete.php

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ trait Delete
1313
* @param array|null $params
1414
* @param array|string|null $opts
1515
*
16+
* @throws \Stripe\Exception\ApiErrorException if the request fails
17+
*
1618
* @return static The deleted resource.
1719
*/
1820
public function delete($params = null, $opts = null)

‎lib/ApiOperations/NestedResource.php

+10
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ protected static function _nestedResourceUrl($id, $nestedPath, $nestedId = null)
4949
* @param array|null $params
5050
* @param array|string|null $options
5151
*
52+
* @throws \Stripe\Exception\ApiErrorException if the request fails
53+
*
5254
* @return \Stripe\StripeObject
5355
*/
5456
protected static function _createNestedResource($id, $nestedPath, $params = null, $options = null)
@@ -64,6 +66,8 @@ protected static function _createNestedResource($id, $nestedPath, $params = null
6466
* @param array|null $params
6567
* @param array|string|null $options
6668
*
69+
* @throws \Stripe\Exception\ApiErrorException if the request fails
70+
*
6771
* @return \Stripe\StripeObject
6872
*/
6973
protected static function _retrieveNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
@@ -79,6 +83,8 @@ protected static function _retrieveNestedResource($id, $nestedPath, $nestedId, $
7983
* @param array|null $params
8084
* @param array|string|null $options
8185
*
86+
* @throws \Stripe\Exception\ApiErrorException if the request fails
87+
*
8288
* @return \Stripe\StripeObject
8389
*/
8490
protected static function _updateNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
@@ -94,6 +100,8 @@ protected static function _updateNestedResource($id, $nestedPath, $nestedId, $pa
94100
* @param array|null $params
95101
* @param array|string|null $options
96102
*
103+
* @throws \Stripe\Exception\ApiErrorException if the request fails
104+
*
97105
* @return \Stripe\StripeObject
98106
*/
99107
protected static function _deleteNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
@@ -108,6 +116,8 @@ protected static function _deleteNestedResource($id, $nestedPath, $nestedId, $pa
108116
* @param array|null $params
109117
* @param array|string|null $options
110118
*
119+
* @throws \Stripe\Exception\ApiErrorException if the request fails
120+
*
111121
* @return \Stripe\StripeObject
112122
*/
113123
protected static function _allNestedResources($id, $nestedPath, $params = null, $options = null)

‎lib/ApiOperations/Request.php

+6-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ trait Request
1212
/**
1313
* @param array|null|mixed $params The list of parameters to validate
1414
*
15-
* @throws \Stripe\Error\Api if $params exists and is not an array
15+
* @throws \Stripe\Exception\InvalidArgumentException if $params exists and is not an array
1616
*/
1717
protected static function _validateParams($params = null)
1818
{
@@ -21,7 +21,7 @@ protected static function _validateParams($params = null)
2121
. "method calls. (HINT: an example call to create a charge "
2222
. "would be: \"Stripe\\Charge::create(['amount' => 100, "
2323
. "'currency' => 'usd', 'source' => 'tok_1234'])\")";
24-
throw new \Stripe\Error\Api($message);
24+
throw new \Stripe\Exception\InvalidArgumentException($message);
2525
}
2626
}
2727

@@ -31,6 +31,8 @@ protected static function _validateParams($params = null)
3131
* @param array $params list of parameters for the request
3232
* @param array|string|null $options
3333
*
34+
* @throws \Stripe\Exception\ApiErrorException if the request fails
35+
*
3436
* @return array tuple containing (the JSON response, $options)
3537
*/
3638
protected function _request($method, $url, $params = [], $options = null)
@@ -47,6 +49,8 @@ protected function _request($method, $url, $params = [], $options = null)
4749
* @param array $params list of parameters for the request
4850
* @param array|string|null $options
4951
*
52+
* @throws \Stripe\Exception\ApiErrorException if the request fails
53+
*
5054
* @return array tuple containing (the JSON response, $options)
5155
*/
5256
protected static function _staticRequest($method, $url, $params, $options)

0 commit comments

Comments
 (0)